Package org.springframework.modulith.events.support

Class PersistentApplicationEventMulticaster

java.lang.Object

org.springframework.context.event.AbstractApplicationEventMulticaster

org.springframework.context.event.SimpleApplicationEventMulticaster

org.springframework.modulith.events.support.PersistentApplicationEventMulticaster

All Implemented Interfaces:

Aware, BeanClassLoaderAware, BeanFactoryAware, SmartInitializingSingleton, ApplicationEventMulticaster, FailedEventPublications, IncompleteEventPublications

public class PersistentApplicationEventMulticaster
extends SimpleApplicationEventMulticaster
implements FailedEventPublications, IncompleteEventPublications, SmartInitializingSingleton

An ApplicationEventMulticaster to register EventPublications in an EventPublicationRegistry so that potentially failing transactional event listeners can get re-invoked upon application restart or via a schedule.

Republication is handled in afterSingletonsInstantiated() inspecting the EventPublicationRegistry for incomplete publications.

Author:

Oliver Drotbohm, Seonwoo Jung

See Also:

• CompletionRegisteringAdvisor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PersistentApplicationEventMulticaster.TransactionalEventListeners	First-class collection to work with transactional event listeners, i.e.

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	REPUBLISH_ON_RESTART
(package private) static final String	REPUBLISH_ON_RESTART_LEGACY

Constructor Summary

Constructors

Constructor	Description
PersistentApplicationEventMulticaster(Supplier<EventPublicationRegistry> registry, Supplier<Environment> environment)	Creates a new PersistentApplicationEventMulticaster for the given EventPublicationRegistry.

Method Summary

Modifier and Type	Method	Description
void	afterSingletonsInstantiated()
void	multicastEvent(ApplicationEvent event)
void	multicastEvent(ApplicationEvent event, @Nullable ResolvableType eventType)
void	resubmit(ResubmissionOptions options)	Initiate the re-submission of failed EventPublication according to the given ResubmissionOptions.
void	resubmitIncompletePublications(Predicate<EventPublication> filter)	Triggers the re-submission of events for which incomplete EventPublications are registered.
void	resubmitIncompletePublications(ResubmissionOptions options)	Triggers the re-submission of incomplete EventPublications matching the given ResubmissionOptions.
void	resubmitIncompletePublicationsOlderThan(Duration duration)	Triggers the re-submission of events for which incomplete EventPublications are registered that exceed a certain age regarding their original publication date.

Methods inherited from class org.springframework.context.event.SimpleApplicationEventMulticaster

getErrorHandler, getTaskExecutor, invokeListener, setErrorHandler, setTaskExecutor

Methods inherited from class org.springframework.context.event.AbstractApplicationEventMulticaster

addApplicationListener, addApplicationListenerBean, getApplicationListeners, getApplicationListeners, removeAllListeners, removeApplicationListener, removeApplicationListenerBean, removeApplicationListenerBeans, removeApplicationListeners, setBeanClassLoader, setBeanFactory, supportsEvent, supportsEvent

Methods inherited from class java.lang.Object

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

Field Details

REPUBLISH_ON_RESTART

static final String REPUBLISH_ON_RESTART

See Also:

• Constant Field Values

REPUBLISH_ON_RESTART_LEGACY

static final String REPUBLISH_ON_RESTART_LEGACY

See Also:

• Constant Field Values

Constructor Details

PersistentApplicationEventMulticaster

public PersistentApplicationEventMulticaster(Supplier<EventPublicationRegistry> registry,
 Supplier<Environment> environment)

Creates a new PersistentApplicationEventMulticaster for the given EventPublicationRegistry.

Parameters:

registry - must not be null.

environment - must not be null.

Method Details

multicastEvent

public void multicastEvent(ApplicationEvent event)

Specified by:

multicastEvent in interface ApplicationEventMulticaster

Overrides:

multicastEvent in class SimpleApplicationEventMulticaster

multicastEvent

public void multicastEvent(ApplicationEvent event,
 @Nullable ResolvableType eventType)

Specified by:

multicastEvent in interface ApplicationEventMulticaster

Overrides:

multicastEvent in class SimpleApplicationEventMulticaster

resubmitIncompletePublications

public void resubmitIncompletePublications(Predicate<EventPublication> filter)

Description copied from interface: IncompleteEventPublications

Triggers the re-submission of events for which incomplete EventPublications are registered. Note, that this will materialize all incomplete event publications.

Specified by:

resubmitIncompletePublications in interface IncompleteEventPublications

Parameters:

filter - a Predicate to select the event publications for which to resubmit events.

resubmitIncompletePublicationsOlderThan

public void resubmitIncompletePublicationsOlderThan(Duration duration)

Description copied from interface: IncompleteEventPublications

Triggers the re-submission of events for which incomplete EventPublications are registered that exceed a certain age regarding their original publication date.

Specified by:

resubmitIncompletePublicationsOlderThan in interface IncompleteEventPublications

Parameters:

duration - must not be null.

resubmitIncompletePublications

public void resubmitIncompletePublications(ResubmissionOptions options)

Description copied from interface: IncompleteEventPublications

Triggers the re-submission of incomplete EventPublications matching the given ResubmissionOptions.

Specified by:

resubmitIncompletePublications in interface IncompleteEventPublications

Parameters:

options - must not be null.

resubmit

public void resubmit(ResubmissionOptions options)

Description copied from interface: FailedEventPublications

Initiate the re-submission of failed EventPublication according to the given ResubmissionOptions.

Specified by:

resubmit in interface FailedEventPublications

Parameters:

options - must not be null.

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton