Package com.broadleafcommerce.common.messaging.notification

Class DefaultNotificationManager

java.lang.Object

com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

All Implemented Interfaces:

NotificationManager

public class DefaultNotificationManager
extends Object
implements NotificationManager

Author:

Jeff Fischer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DefaultNotificationManager.VoidWork	Perform a task without response or exception notification

Constructor Summary

Constructors

Constructor	Description
DefaultNotificationManager(List<NotificationHandler> handlers)

Method Summary

Modifier and Type	Method	Description
protected void	executePostTransactionCommitOrNow(DefaultNotificationManager.VoidWork work)	Do a unit of work upon successful completion of the current transaction, or, execute the work immediately if transaction synchronization is not currently active.
void	handle(NotificationStateRepository repo, NotificationStateAware notifiable, String messageType)	Notify the system in some way about the state change for the notifiable param.
void	handleAsync(NotificationStateRepository repo, NotificationStateAware notifiable, String messageType)	Notify the system in some way about the state change for the notifiable param.
void	handleAsync(NotificationStateRepository repo, NotificationStateAware notifiable, String messageType, Runnable callback)	Notify the system in some way about the state change for the notifiable param.
void	init()
void	setEventPublisher(org.springframework.context.ApplicationEventPublisher eventPublisher)
void	setProperties(NotificationManagerProperties properties)

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultNotificationManager

public DefaultNotificationManager(List<NotificationHandler> handlers)

Method Details

init

@PostConstruct
public void init()

handle

public void handle(@NonNull
 NotificationStateRepository repo,
 @NonNull
 NotificationStateAware notifiable,
 @NonNull
 String messageType)

Description copied from interface: NotificationManager

Notify the system in some way about the state change for the notifiable param. Processing is handled through one or more NotificationHandler instances. This will update the given notifiable using repo. Subsequent checks of the latest notification state will require a re-read.

Specified by:

handle in interface NotificationManager

Parameters:

repo - The service responsible for making the state change. Usually a Repository instance.

notifiable - The object that experienced the state change. Usually a Spring Data entity instance.

messageType - The type of message correlating to DefaultNotificationHandler#messageType.

handleAsync

public void handleAsync(@NonNull
 NotificationStateRepository repo,
 @NonNull
 NotificationStateAware notifiable,
 @NonNull
 String messageType,
 @Nullable
 Runnable callback)

Description copied from interface: NotificationManager

Notify the system in some way about the state change for the notifiable param. Processing is handled through one or more NotificationHandler instances. This will update the given notifiable using repo. Subsequent checks of the latest notification state will require a re-read. Notably, this version will perform handling using a thread pool.

Specified by:

handleAsync in interface NotificationManager

Parameters:

repo - The service responsible for making the state change. Usually a Repository instance.

notifiable - The object that experienced the state change. Usually a Spring Data entity instance.

messageType - The type of message correlating to DefaultNotificationHandler#messageType.

callback - Code snippet to execute after all notification handling operations are complete

See Also:

• NotificationManagerProperties.getThreadPoolSize()

handleAsync

public void handleAsync(@NonNull
 NotificationStateRepository repo,
 @NonNull
 NotificationStateAware notifiable,
 @NonNull
 String messageType)

Description copied from interface: NotificationManager

Notify the system in some way about the state change for the notifiable param. Processing is handled through one or more NotificationHandler instances. This will update the given notifiable using repo. Subsequent checks of the latest notification state will require a re-read. Notably, this version will perform handling using a thread pool.

Specified by:

handleAsync in interface NotificationManager

Parameters:

repo - The service responsible for making the state change. Usually a Repository instance.

notifiable - The object that experienced the state change. Usually a Spring Data entity instance.

messageType - The type of message correlating to DefaultNotificationHandler#messageType.

See Also:

• NotificationManagerProperties.getThreadPoolSize()

executePostTransactionCommitOrNow

protected void executePostTransactionCommitOrNow(DefaultNotificationManager.VoidWork work)

Do a unit of work upon successful completion of the current transaction, or, execute the work immediately if transaction synchronization is not currently active.

Parameters:

work - The work to perform

setEventPublisher

@Autowired
public void setEventPublisher(@Nullable
 org.springframework.context.ApplicationEventPublisher eventPublisher)

setProperties

@Autowired
public void setProperties(@Nullable
 NotificationManagerProperties properties)