Package com.broadleafcommerce.notification.service.messaging

Class NotificationCartApprovalRequestListener

java.lang.Object

com.broadleafcommerce.notification.service.messaging.AbstractEmailNotificationMessageListener

com.broadleafcommerce.notification.service.messaging.NotificationCartApprovalRequestListener

public class NotificationCartApprovalRequestListener
extends AbstractEmailNotificationMessageListener

Author:

Nathan Moore (nathandmoore)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NotificationCartApprovalRequestListener.ApproverRef	Represents a summary of an Approver.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ACCOUNT_ID_PATH
protected static final String	APPLICATION_ID_PATH
protected static final String	APPROVERS
protected static final String	CART_NEW_STATUS_PATH
protected static final String	CUSTOMER_CONTEXT_ID_PATH
protected static final String	EXPECTED_STATUS
protected static final String	LOCALE
protected static final String	MESSAGE_TYPE
protected static final String	SUBJECT_MESSAGE
protected static final String	SUBMITTER_FULL_NAME
protected static final String	TENANT_ID_PATH

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

EMAIL_DELIVERY, messages, notificationService, tenantProvider, typeFactory, userResolver

Constructor Summary

Constructors

Constructor	Description
NotificationCartApprovalRequestListener(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 Map<String,String>	getApproverCommunicationPreferenceMap(String accountId, @NonNull List<String> approverIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
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 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)	Validate that the message state is valid 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

EXPECTED_STATUS

protected static final String EXPECTED_STATUS

See Also:

• Constant Field Values

MESSAGE_TYPE

protected static final String MESSAGE_TYPE

See Also:

• Constant Field Values

SUBJECT_MESSAGE

protected static final String SUBJECT_MESSAGE

See Also:

• Constant Field Values

CART_NEW_STATUS_PATH

protected static final String CART_NEW_STATUS_PATH

See Also:

• Constant Field Values

APPLICATION_ID_PATH

protected static final String APPLICATION_ID_PATH

See Also:

• Constant Field Values

TENANT_ID_PATH

protected static final String TENANT_ID_PATH

See Also:

• Constant Field Values

CUSTOMER_CONTEXT_ID_PATH

protected static final String CUSTOMER_CONTEXT_ID_PATH

See Also:

• Constant Field Values

SUBMITTER_FULL_NAME

protected static final String SUBMITTER_FULL_NAME

See Also:

• Constant Field Values

APPROVERS

protected static final String APPROVERS

See Also:

• Constant Field Values

LOCALE

protected static final String LOCALE

See Also:

• Constant Field Values

ACCOUNT_ID_PATH

protected static final String ACCOUNT_ID_PATH

See Also:

• Constant Field Values

Constructor Details

NotificationCartApprovalRequestListener

public NotificationCartApprovalRequestListener(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("cartApprovalRequestNotificationInput")
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)

Description copied from class: AbstractEmailNotificationMessageListener

Validate that the message state is valid 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

getApproverCommunicationPreferenceMap

protected Map<String,String> getApproverCommunicationPreferenceMap(String accountId,
 @NonNull
 @NonNull List<String> approverIds,
 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