com.neurosys.q.notification.service

Class AbstractNotificationHelper<T extends Token<T>>

java.lang.Object

com.neurosys.q.notification.service.AbstractNotificationHelper<T>

public abstract class AbstractNotificationHelper<T extends Token<T>>
extends Object

A Helper that encapsulates common task non-biz logic details around Notification.

TODO: Consider moving it to more generic usage and not specific to Token.

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected Properties	appProperties
protected TokenNotificationTrackerService<T>	notificationCountTracker

Constructor Summary

Constructors

Constructor and Description
AbstractNotificationHelper()

Method Summary

Modifier and Type	Method and Description
Map	addFeedback(ChildTokenEvent<T> event, T token, Feedback feedback) TokenNotificationTrackerService.keepCount(Token, FlowStatus) + Add Feedback
Map	addFeedback(TokenEvent<T> causeEvent, FlowStatus status, T token, Feedback feedback) Add Feedback
protected Map<String,String>	defineMessageAttributes(Attributes entity, Map<String,?> entityAttributes) Using Entity Attributes convert them into message attributes such that final keys are {$<entity class simple name>.<attrib name>}
boolean	evaluateCurrentActionNotifyConfigs(String notifyActionConfigSuffix, Behaviors behaviorsContainer) Check for Server config (constructed key by using the param notifyActionConfigSuffix), and if none exists then rely on any override, and if even that does not exist then by default return true,
String	getBroadcastMessage(String broadCastId, String shiftName) Message template variables {N} where N is: {0} - Displayable.getDisplayName() - Shift Display Name
protected String	getMessage(String fullKey, Map<String,String> attributes, String... params)
String	getMessage(TokenEvent.TokenEventType e, String shiftName, String tokenName) Deprecated.
String	getMessage(TokenEvent.TokenEventType e, T token) Message template variables {N} where N is: {0} - Displayable.getDisplayName() - Shift Display Name {1} - Displayable.getDisplayName() - Token Display Name
abstract Integer	getNextNToNotify() Smart notifications > Ripple effect : If >0 means N other people who are impacted by a status update of someone else will also be notified. access.q.user.notify.nextNToNotify <=0; means this is false else true
TokenNotificationTrackerService<T>	getNotificationCountTracker()
protected abstract String	getNotifyMessagesKeyPrefix()
org.springframework.context.MessageSource	getNotifyMsgResource()
String	getProperty(String fullKey) Get a property from the settings (static or dynamic).
abstract <C> boolean	ignore(C consumer) To ignore the Consumer or contact.
void	init()
abstract boolean	isNotificationEnabled() true if notifications enabled else false for global shut
Boolean	isNotifyOn(Object action) Generic service method for notification on any action.
abstract boolean	isNotifyOthers() Smart notifications > Ripple effect : If true means other people who are impacted by a status update of someone else will also be notified.
void	setNotificationCountTracker(TokenNotificationTrackerService<T> notificationCountTracker)
void	setNotifyMsgResource(org.springframework.context.MessageSource notifyMsgResource)
<E extends ChildTokenEvent<T>> void	setupNotificationEvent(TokenEvent<T> parentEvent, E notifyCustomerEvent, List<E> notifyEvents) A wrapper to make a relation between a core TokenEvent and ChildTokenEvent like MessageTokenEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

appProperties

@Autowired
 @Qualifier(value="appConfiguration")
protected Properties appProperties

notificationCountTracker

protected TokenNotificationTrackerService<T extends Token<T>> notificationCountTracker

Constructor Detail

AbstractNotificationHelper

public AbstractNotificationHelper()

Method Detail

init

@PostConstruct
public void init()

addFeedback

public Map addFeedback(ChildTokenEvent<T> event,
                       T token,
                       Feedback feedback)

TokenNotificationTrackerService.keepCount(Token, FlowStatus) + Add Feedback

Parameters:

event - as ChildTokenEvent causing the feedback. This event could represent a ripple effect or first impact. (not nec.. root event)

token - as Token whose feedback to add

feedback - as Feedback

Returns:

as notificationFeedback of type Map of Token Id and Notification type sent

setupNotificationEvent

public <E extends ChildTokenEvent<T>> void setupNotificationEvent(TokenEvent<T> parentEvent,
                                                                  E notifyCustomerEvent,
                                                                  List<E> notifyEvents)

A wrapper to make a relation between a core TokenEvent and ChildTokenEvent like MessageTokenEvent

Parameters:

parentEvent - as TokenEvent, nullable true

notifyCustomerEvent - as MessageTokenEvent, not nullable

notifyEvents - as batch of MessageTokenEvents to generate for batch notification, not nullable

addFeedback

public Map addFeedback(TokenEvent<T> causeEvent,
                       FlowStatus status,
                       T token,
                       Feedback feedback)

Add Feedback

Parameters:

causeEvent - as TokenEvent that cause of the current Feedback for the current Token

status - as FlowStatus

token - as Token for which we want to add Feedback

feedback - as Feedback

Returns:

as notificationFeedback of type Map of Token Id and Notification type sent

getMessage

public String getMessage(TokenEvent.TokenEventType e,
                         T token)

Message template variables {N} where N is:

• {0} - Displayable.getDisplayName() - Shift Display Name
• {1} - Displayable.getDisplayName() - Token Display Name

Parameters:

e - as TokenEvent.TokenEventType

token - as Token

Returns:

message as String

See Also:

#getNotifyMessagesKeyPrefix()}, getBroadcastMessage(String, String)

getMessage

@Deprecated
public String getMessage(TokenEvent.TokenEventType e,
                                     String shiftName,
                                     String tokenName)

Deprecated.

Parameters:

e - as TokenEvent.TokenEventType

shiftName - aa String for TokenContainer.getName()

tokenName - as String for Displayable.getDisplayName()

Returns:

message as String

See Also:

#getMessage(TokenEventType, Token)

getBroadcastMessage

public String getBroadcastMessage(String broadCastId,
                                  String shiftName)

Message template variables {N} where N is:

• {0} - Displayable.getDisplayName() - Shift Display Name

Parameters:

broadCastId - is the TokenEvent.TokenEventType name or any other it that is appended to getNotifyMessagesKeyPrefix()

shiftName - as String

Returns:

message as String

See Also:

#getNotifyMessagesKeyPrefix()}

getNotifyMessagesKeyPrefix

protected abstract String getNotifyMessagesKeyPrefix()

getProperty

public String getProperty(String fullKey)

Get a property from the settings (static or dynamic). By default static properties are used.

Parameters:

fullKey - as String includes namespace

Returns:

property value

See Also:

appProperties

getMessage

protected String getMessage(String fullKey,
                            Map<String,String> attributes,
                            String... params)

Parameters:

fullKey -

attributes - as Map of String to Strin, of key / values to substitute in message. Where an attribute key will be searched in the String, if it matches then will be replaced by value

params - as String .s | {0} Shift Name , {1} Token Display Code

Returns:

String with variables substituted

defineMessageAttributes

protected Map<String,String> defineMessageAttributes(Attributes entity,
                                                     Map<String,?> entityAttributes)

Using Entity Attributes convert them into message attributes such that final keys are {$<entity class simple name>.<attrib name>}

Parameters:

entity - to use as prefix. If null then only attribute name is used within {$...}

entityAttributes - as the core Entity Attributes, key is String and value is of type Attribute

Returns:

Map of message key attribute name to search in the message template and its corresponding value to replace with. @nullable true

isNotificationEnabled

public abstract boolean isNotificationEnabled()

true if notifications enabled else false for global shut

Returns:

boolean

isNotifyOn

public Boolean isNotifyOn(Object action)

Generic service method for notification on any action.

Default Behavior: Looks for a CurrentActionNotifyBehavior else an action defined in the properties as getNotifyMessagesKeyPrefix().<action>Notify, where action can be String or Enum.name().

If nothing is satisfied, by default it will return true.

Parameters:

action - as String (property name or name of an action) or AddOnBehavior or any app specific type or TokenEvent.TokenEventType

Returns:

Boolean; null means un-specified.

See Also:

getNotifyMessagesKeyPrefix()

evaluateCurrentActionNotifyConfigs

public boolean evaluateCurrentActionNotifyConfigs(String notifyActionConfigSuffix,
                                                  Behaviors behaviorsContainer)

Check for Server config (constructed key by using the param notifyActionConfigSuffix), and if none exists then rely on any override, and if even that does not exist then by default return true,

Parameters:

notifyActionConfigSuffix - as String appended. See NotificationHelper#isNotifyOn(Object)

behaviorsContainer - as Behaviors

Returns:

@default true if no configs available

isNotifyOthers

public abstract boolean isNotifyOthers()

Smart notifications > Ripple effect : If true means other people who are impacted by a status update of someone else will also be notified.

Returns:

boolean

See Also:

#

getNextNToNotify

public abstract Integer getNextNToNotify()

Smart notifications > Ripple effect : If >0 means N other people who are impacted by a status update of someone else will also be notified.
access.q.user.notify.nextNToNotify <=0; means this is false else true

ignore

public abstract <C> boolean ignore(C consumer)

To ignore the Consumer or contact. true = ignore.

Parameters:

token - as Consumer or contact number

Returns:

boolean

getNotifyMsgResource

public org.springframework.context.MessageSource getNotifyMsgResource()

setNotifyMsgResource

public void setNotifyMsgResource(org.springframework.context.MessageSource notifyMsgResource)

getNotificationCountTracker

public TokenNotificationTrackerService<T> getNotificationCountTracker()

setNotificationCountTracker

public void setNotificationCountTracker(TokenNotificationTrackerService<T> notificationCountTracker)