org.finra.herd.service.helper.notification

Class AbstractNotificationMessageBuilder

java.lang.Object

org.finra.herd.service.helper.notification.AbstractNotificationMessageBuilder

Direct Known Subclasses:

BusinessObjectDataStatusChangeMessageBuilder, BusinessObjectDefinitionDescriptionSuggestionChangeMessageBuilder, BusinessObjectFormatVersionChangeMessageBuilder, StorageUnitStatusChangeMessageBuilder, UserNamespaceAuthorizationChangeMessageBuilder

public abstract class AbstractNotificationMessageBuilder
extends Object

This is an abstract class that helps build a notification message.

Constructor Summary

Constructors

Constructor and Description
AbstractNotificationMessageBuilder()

Method Summary

Modifier and Type	Method and Description
protected void	addObjectPropertyToContext(Map<String,Object> context, String propertyName, Object propertyValue, Object jsonEscapedPropertyValue, Object xmlEscapedPropertyValue) Adds string property to the specified context along with the relative JSON and XML escaped copies of the property.
protected void	addStringPropertyToContext(Map<String,Object> context, String propertyName, String propertyValue) Adds string property to the specified context along with the relative JSON and XML escaped copies of the property.
List<NotificationMessage>	buildNotificationMessages(NotificationEvent notificationEvent) Builds a list of notification messages for the change event.
protected String	escapeJson(String input) JSON escapes a specified string.
protected String	escapeXml(String input) XML escapes a specified string.
protected String	evaluateVelocityTemplate(String velocityTemplate, Map<String,Object> contextMap, String velocityTemplateName) Evaluates a velocity template if one is defined for the specified configuration value.
Map<Class<?>,ConfigurationValue>	getEventTypeMessageDefinitionKeyMap() Get the event type to Message Definition Key map
abstract Map<String,Object>	getNotificationMessageVelocityContextMap(NotificationEvent notificationEvent) Returns Velocity context map of additional keys and values relating to the notification message body to place in the velocity context.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractNotificationMessageBuilder

public AbstractNotificationMessageBuilder()

Method Detail

getEventTypeMessageDefinitionKeyMap

public Map<Class<?>,ConfigurationValue> getEventTypeMessageDefinitionKeyMap()

Get the event type to Message Definition Key map

Returns:

the event type to Message Definition Key map

getNotificationMessageVelocityContextMap

public abstract Map<String,Object> getNotificationMessageVelocityContextMap(NotificationEvent notificationEvent)

Returns Velocity context map of additional keys and values relating to the notification message body to place in the velocity context.

Parameters:

notificationEvent - the notification event

Returns:

the Velocity context map

buildNotificationMessages

public List<NotificationMessage> buildNotificationMessages(NotificationEvent notificationEvent)

Builds a list of notification messages for the change event. The result list might be empty if if no messages should be sent.

Parameters:

notificationEvent - the notification event

Returns:

the list of notification messages

escapeJson

protected String escapeJson(String input)

JSON escapes a specified string. This method is null-safe.

Parameters:

input - the input string

Returns:

the XML escaped string

escapeXml

protected String escapeXml(String input)

XML escapes a specified string. This method is null-safe.

Parameters:

input - the input string

Returns:

the XML escaped string

addStringPropertyToContext

protected void addStringPropertyToContext(Map<String,Object> context,
                                          String propertyName,
                                          String propertyValue)

Adds string property to the specified context along with the relative JSON and XML escaped copies of the property.

Parameters:

context - the context map

propertyName - the name of the property

propertyValue - the value of the property, maybe null

addObjectPropertyToContext

protected void addObjectPropertyToContext(Map<String,Object> context,
                                          String propertyName,
                                          Object propertyValue,
                                          Object jsonEscapedPropertyValue,
                                          Object xmlEscapedPropertyValue)

Adds string property to the specified context along with the relative JSON and XML escaped copies of the property.

Parameters:

context - the context map

propertyName - the name of the property

propertyValue - the value of the property, maybe null

jsonEscapedPropertyValue - the JSON escaped value of the property, maybe null

xmlEscapedPropertyValue - the XML escaped value of the property, maybe null

evaluateVelocityTemplate

protected String evaluateVelocityTemplate(String velocityTemplate,
                                          Map<String,Object> contextMap,
                                          String velocityTemplateName)

Evaluates a velocity template if one is defined for the specified configuration value. If velocity template is null, null will be returned.

Parameters:

velocityTemplate - the optional velocity template, may be null

contextMap - the optional context map of additional keys and values to place in the velocity context. This can be useful if you have values from an incoming request message you want to make available to velocity to use in the building of the outgoing response message.

velocityTemplateName - the velocity template name used when Velocity logs error messages.

Returns:

the evaluated velocity template