Package com.broadleafcommerce.common.messaging.notification

Interface MessageFactory<T>

All Known Implementing Classes:

PersistenceMessageFactory

public interface MessageFactory<T>

Factory for creating a Message to be sent via NotificationHandler, based on an entity.

Author:

Jeff Fischer

Method Summary

Modifier and Type	Method	Description
org.springframework.messaging.Message<T>	createMessage(Object entity)	Create a Message based on an entity instance.
default org.springframework.messaging.Message<T>	createMessage(Object entity, Map<String,Object> attributes)	Create a Message based on an entity instance.

Method Details

createMessage

org.springframework.messaging.Message<T> createMessage(Object entity)

Create a Message based on an entity instance.

Parameters:

entity - The entity whose information informs the Message

Returns:

The message to send via the NotificationHandler

createMessage

default org.springframework.messaging.Message<T> createMessage(Object entity,
 Map<String,Object> attributes)

Create a Message based on an entity instance. This method is called when the originating entity is an instance of MessageAdditionalInformationAware. In this case, MessageAdditionalInformationAware.unwrap() is called for the entity parameter, and MessageAdditionalInformationAware.getAttributes() is called to fulfill the attributes parameter before entering this method. See DefaultNotificationHandler.notify(NotificationStateAware, NotificationState, NotificationStateRepository) for more information on caller behavior.

Parameters:

entity - The entity whose information informs the Message

attributes - Additional attributes used during Message creation

Returns:

The message to send via the NotificationHandler