Package com.broadleafcommerce.notification.service.messaging

Class NotificationAuthenticationMessageListener

java.lang.Object

com.broadleafcommerce.notification.service.messaging.AbstractEmailNotificationMessageListener

com.broadleafcommerce.notification.service.messaging.NotificationAuthenticationMessageListener

public class NotificationAuthenticationMessageListener
extends AbstractEmailNotificationMessageListener

A message listener that triggers when an authentication event is received. Responsible for creating the reset password and password changed email notifications.

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ADMIN_TYPE
protected static final String	CUSTOMER_EMAIL_PATH
protected static final String	CUSTOMER_ID_PATH
protected static final String	CUSTOMER_NAME_PATH
protected static final String	CUSTOMER_TYPE_PATH
protected static final String	MESSAGE_TYPE_PATH

Fields inherited from class com.broadleafcommerce.notification.service.messaging.AbstractEmailNotificationMessageListener

EMAIL_DELIVERY, messages, notificationService, tenantProvider, typeFactory, userResolver

Constructor Summary

Constructors

Constructor	Description
NotificationAuthenticationMessageListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService, NotificationService<Notification> notificationService, org.springframework.context.MessageSource messages, com.fasterxml.jackson.databind.ObjectMapper objectMapper, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected com.broadleafcommerce.data.tracking.core.context.ContextInfo	buildNotificationContext(com.jayway.jsonpath.DocumentContext jsonContext)	Build the ContextInfo for the current message
protected String	getClassName()	Get the class name to identify this listener for handling message idempotency.
protected String	getMessageType(com.jayway.jsonpath.DocumentContext jsonContext)	Determine which message type should be sent.
protected String	getNotificationSubject(com.jayway.jsonpath.DocumentContext jsonContext)	Determine the subject to use for the email notification.
protected String	getRecipientCommunicationPreferences(String userId, String userType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<Recipient>	getRecipients(com.jayway.jsonpath.DocumentContext jsonContext)	Determine the recipients to use for the email notification.
void	handleMessage(org.springframework.messaging.Message<String> message)
protected boolean	validateShouldSendNotification(com.jayway.jsonpath.DocumentContext jsonContext)	Validates the message type is present to send the email.

Methods inherited from class com.broadleafcommerce.notification.service.messaging.AbstractEmailNotificationMessageListener

buildNotification, buildNotification, getDocumentContext, getIdempotentConsumptionService, getMessages, getNotificationService, getObjectMapper, getPayload, getTenantProvider, getTypeFactory, getUserResolver, handleMessageInternal, modifyNotification, modifyNotification, processMessage, resolveApplicationById, setTenantProvider, setUserResolver

Methods inherited from class java.lang.Object

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

Field Details

MESSAGE_TYPE_PATH

protected static final String MESSAGE_TYPE_PATH

See Also:

• Constant Field Values

CUSTOMER_NAME_PATH

protected static final String CUSTOMER_NAME_PATH

See Also:

• Constant Field Values

CUSTOMER_EMAIL_PATH

protected static final String CUSTOMER_EMAIL_PATH

See Also:

• Constant Field Values

CUSTOMER_ID_PATH

protected static final String CUSTOMER_ID_PATH

See Also:

• Constant Field Values

CUSTOMER_TYPE_PATH

protected static final String CUSTOMER_TYPE_PATH

See Also:

• Constant Field Values

ADMIN_TYPE

protected static final String ADMIN_TYPE

See Also:

• Constant Field Values

Constructor Details

NotificationAuthenticationMessageListener

public NotificationAuthenticationMessageListener(com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService idempotentConsumptionService,
 NotificationService<Notification> notificationService,
 org.springframework.context.MessageSource messages,
 com.fasterxml.jackson.databind.ObjectMapper objectMapper,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

handleMessage

@StreamListener("authenticationMessageInputNotification")
public void handleMessage(org.springframework.messaging.Message<String> message)

getClassName

protected String getClassName()

Description copied from class: AbstractEmailNotificationMessageListener

Get the class name to identify this listener for handling message idempotency.

Specified by:

getClassName in class AbstractEmailNotificationMessageListener

Returns:

the listener's class name

validateShouldSendNotification

protected boolean validateShouldSendNotification(com.jayway.jsonpath.DocumentContext jsonContext)

Validates the message type is present to send the email.

Specified by:

validateShouldSendNotification in class AbstractEmailNotificationMessageListener

Parameters:

jsonContext - the message payload

Returns:

whether the email should be sent

getMessageType

protected String getMessageType(com.jayway.jsonpath.DocumentContext jsonContext)

Description copied from class: AbstractEmailNotificationMessageListener

Determine which message type should be sent.

Specified by:

getMessageType in class AbstractEmailNotificationMessageListener

Parameters:

jsonContext - the message payload

Returns:

the message type to send

getNotificationSubject

protected String getNotificationSubject(com.jayway.jsonpath.DocumentContext jsonContext)

Description copied from class: AbstractEmailNotificationMessageListener

Determine the subject to use for the email notification.

Specified by:

getNotificationSubject in class AbstractEmailNotificationMessageListener

Parameters:

jsonContext - the message payload

Returns:

the subject to use for the email notification

getRecipients

protected List<Recipient> getRecipients(com.jayway.jsonpath.DocumentContext jsonContext)

Description copied from class: AbstractEmailNotificationMessageListener

Determine the recipients to use for the email notification.

Specified by:

getRecipients in class AbstractEmailNotificationMessageListener

Parameters:

jsonContext - the message payload

Returns:

the recipients to use for the email notification

getRecipientCommunicationPreferences

protected String getRecipientCommunicationPreferences(String userId,
 String userType,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

buildNotificationContext

protected com.broadleafcommerce.data.tracking.core.context.ContextInfo buildNotificationContext(com.jayway.jsonpath.DocumentContext jsonContext)

Description copied from class: AbstractEmailNotificationMessageListener

Build the ContextInfo for the current message

Specified by:

buildNotificationContext in class AbstractEmailNotificationMessageListener

Parameters:

jsonContext - the payload of the message

Returns:

the NotificationContext for the current message