Package com.broadleafcommerce.notification.service.messaging

Class AccountInviteAcceptanceMessageListener

java.lang.Object

com.broadleafcommerce.notification.service.messaging.AbstractEmailNotificationMessageListener

com.broadleafcommerce.notification.service.messaging.AccountInviteAcceptanceMessageListener

public class AccountInviteAcceptanceMessageListener
extends AbstractEmailNotificationMessageListener

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACCOUNT_ID
static final String	ACCOUNT_INVITE_ACCEPTANCE_SUBJECT
static final String	ACCOUNT_NAME
static final String	ADDL_ARGS
static final String	APPLICATION_ID_PATH
static final String	CUSTOMER_CONTEXT_ID_PATH
static final String	CUSTOMER_EMAIL
static final String	CUSTOMER_ID
static final String	CUSTOMER_NAME
static final String	IDENTIFIER_TYPE
static final String	IDENTIFIER_TYPE_PARAM
static final String	IDENTIFIER_VAL_PARAM
static final String	IDENTIFIER_VALUE
static final String	LOCALE
static final String	MESSAGE_TYPE
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

AccountInviteAcceptanceMessageListener(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, AccountNotificationProperties properties)

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	determineBaseUrl(String identifierType, String identifierValue)
protected void	determineSupportedResolutionTypes()
protected String	getAccountId(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getAccountName(com.jayway.jsonpath.DocumentContext jsonContext)
protected Map<String,Object>	getAdditionalArgs(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getClassName()	Get the class name to identify this listener for handling message idempotency.
protected String	getCustomerEmail(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getCustomerId(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getCustomerName(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getIdentifierType(com.jayway.jsonpath.DocumentContext context)
protected String	getIdentifierValue(com.jayway.jsonpath.DocumentContext context)
protected Locale	getLocale(com.jayway.jsonpath.DocumentContext jsonContext)
protected String	getLoginUrl(String identifierType, String identifierValue, com.jayway.jsonpath.DocumentContext jsonContext)
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 AccountNotificationProperties	getProperties()
protected String	getRecipientCommunicationPreferences(String accountId, String customerId, 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 void	modifyNotification(Notification notification, com.jayway.jsonpath.DocumentContext jsonContext, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)	Extension point to allow modifying the notification or context before sending to the notification service
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, processMessage, resolveApplicationById, setTenantProvider, setUserResolver

Methods inherited from class java.lang.Object

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

Field Details

CUSTOMER_EMAIL

public static final String CUSTOMER_EMAIL

See Also:

• Constant Field Values

CUSTOMER_NAME

public static final String CUSTOMER_NAME

See Also:

• Constant Field Values

ACCOUNT_NAME

public static final String ACCOUNT_NAME

See Also:

• Constant Field Values

CUSTOMER_ID

public static final String CUSTOMER_ID

See Also:

• Constant Field Values

ACCOUNT_ID

public static final String ACCOUNT_ID

See Also:

• Constant Field Values

ADDL_ARGS

public static final String ADDL_ARGS

See Also:

• Constant Field Values

APPLICATION_ID_PATH

public static final String APPLICATION_ID_PATH

See Also:

• Constant Field Values

TENANT_ID_PATH

public static final String TENANT_ID_PATH

See Also:

• Constant Field Values

CUSTOMER_CONTEXT_ID_PATH

public static final String CUSTOMER_CONTEXT_ID_PATH

See Also:

• Constant Field Values

LOCALE

public static final String LOCALE

See Also:

• Constant Field Values

IDENTIFIER_TYPE

public static final String IDENTIFIER_TYPE

See Also:

• Constant Field Values

IDENTIFIER_VALUE

public static final String IDENTIFIER_VALUE

See Also:

• Constant Field Values

MESSAGE_TYPE

public static final String MESSAGE_TYPE

See Also:

• Constant Field Values

ACCOUNT_INVITE_ACCEPTANCE_SUBJECT

public static final String ACCOUNT_INVITE_ACCEPTANCE_SUBJECT

See Also:

• Constant Field Values

IDENTIFIER_TYPE_PARAM

public static final String IDENTIFIER_TYPE_PARAM

See Also:

• Constant Field Values

IDENTIFIER_VAL_PARAM

public static final String IDENTIFIER_VAL_PARAM

See Also:

• Constant Field Values

Constructor Details

AccountInviteAcceptanceMessageListener

public AccountInviteAcceptanceMessageListener(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,
 AccountNotificationProperties properties)

Method Details

handleMessage

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

getAdditionalArgs

protected Map<String,Object> getAdditionalArgs(com.jayway.jsonpath.DocumentContext jsonContext)

getCustomerEmail

@Nullable
protected String getCustomerEmail(com.jayway.jsonpath.DocumentContext jsonContext)

getCustomerName

@Nullable
protected String getCustomerName(com.jayway.jsonpath.DocumentContext jsonContext)

getAccountName

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

getCustomerId

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

getAccountId

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

getLocale

protected Locale getLocale(com.jayway.jsonpath.DocumentContext jsonContext)

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

modifyNotification

protected void modifyNotification(Notification notification,
 com.jayway.jsonpath.DocumentContext jsonContext,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Description copied from class: AbstractEmailNotificationMessageListener

Extension point to allow modifying the notification or context before sending to the notification service

Overrides:

modifyNotification in class AbstractEmailNotificationMessageListener

Parameters:

notification - the Notification for the current message

jsonContext - the message payload

context - The context of the request

determineSupportedResolutionTypes

protected void determineSupportedResolutionTypes()

getLoginUrl

protected String getLoginUrl(String identifierType,
 String identifierValue,
 com.jayway.jsonpath.DocumentContext jsonContext)

determineBaseUrl

protected String determineBaseUrl(String identifierType,
 String identifierValue)

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

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

getRecipientCommunicationPreferences

protected String getRecipientCommunicationPreferences(String accountId,
 String customerId,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getIdentifierType

@Nullable
protected String getIdentifierType(com.jayway.jsonpath.DocumentContext context)

getIdentifierValue

@Nullable
protected String getIdentifierValue(com.jayway.jsonpath.DocumentContext context)

getProperties

protected AccountNotificationProperties getProperties()