Package org.springframework.modulith.events.core

Class DefaultEventPublicationRegistry

java.lang.Object

org.springframework.modulith.events.core.DefaultEventPublicationRegistry

All Implemented Interfaces:

DisposableBean, CompletedEventPublications, EventPublicationRegistry

public class DefaultEventPublicationRegistry
extends Object
implements DisposableBean, EventPublicationRegistry, CompletedEventPublications

A registry to capture event publications to ApplicationListeners. Allows to register those publications, mark them as completed and lookup incomplete publications.

Author:

Oliver Drotbohm, Björn Kieling, Dmitry Belyaev

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	DefaultEventPublicationRegistry.PublicationsInProgress	All TargetEventPublications currently processed.

Constructor Summary

Constructors

Constructor	Description
DefaultEventPublicationRegistry(EventPublicationRepository events, Clock clock)	Creates a new DefaultEventPublicationRegistry for the given EventPublicationRepository.

Method Summary

Modifier and Type	Method	Description
void	deleteCompletedPublicationsOlderThan(Duration duration)	Deletes all completed TargetEventPublications that have been completed before the given Duration.
void	deletePublications(Predicate<EventPublication> filter)	Deletes all EventPublications matching the given Predicate.
void	deletePublicationsOlderThan(Duration duration)	Deletes all EventPublications whose completion date is older than the given Duration.
void	destroy()
Collection<? extends TargetEventPublication>	findAll()	Returns all EventPublications that have already been completed.
Collection<TargetEventPublication>	findIncompletePublications()	Returns all TargetEventPublications that have not been completed yet.
Collection<TargetEventPublication>	findIncompletePublicationsOlderThan(Duration duration)	Returns all TargetEventPublications that have not been completed yet and have been published before the given duration in relation to "now".
(package private) DefaultEventPublicationRegistry.PublicationsInProgress	getPublicationsInProgress()	Returns all DefaultEventPublicationRegistry.PublicationsInProgress.
void	markCompleted(Object event, PublicationTargetIdentifier targetIdentifier)	Marks the publication for the given event and PublicationTargetIdentifier as completed.
void	markFailed(Object event, PublicationTargetIdentifier targetIdentifier)	Marks the publication for the given event and PublicationTargetIdentifier as failed.
(package private) void	markFailed(TargetEventPublication publication)	Marks the given TargetEventPublication as failed.
void	markProcessing(Object event, PublicationTargetIdentifier identifier)	Marks the publication for the given event and PublicationTargetIdentifier as processing.
void	markStalePublicationsFailed(Staleness staleness)	Marks all EventPublications considered stale as failed.
void	processFailedPublications(ResubmissionOptions options, Consumer<TargetEventPublication> consumer)	Processes all failed EventPublications matching the given ResubmissionOptions with the given Consumer.
void	processIncompletePublications(Predicate<EventPublication> filter, Consumer<TargetEventPublication> consumer, @Nullable Duration duration)	Processes all incomplete event publications that have been published before the given duration in relation to "now" by applying the given filter passing all remaining instances to the given Consumer.
Collection<TargetEventPublication>	store(Object event, Stream<PublicationTargetIdentifier> listeners)	Stores TargetEventPublications for the given event and ApplicationListeners.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventPublicationRegistry

public DefaultEventPublicationRegistry(EventPublicationRepository events,
 Clock clock)

Creates a new DefaultEventPublicationRegistry for the given EventPublicationRepository.

Parameters:

events - must not be null.

clock - must not be null.

Method Details

store

public Collection<TargetEventPublication> store(Object event,
 Stream<PublicationTargetIdentifier> listeners)

Description copied from interface: EventPublicationRegistry

Stores TargetEventPublications for the given event and ApplicationListeners.

Specified by:

store in interface EventPublicationRegistry

Parameters:

event - must not be null.

listeners - must not be null.

findIncompletePublications

public Collection<TargetEventPublication> findIncompletePublications()

Description copied from interface: EventPublicationRegistry

Returns all TargetEventPublications that have not been completed yet.

Specified by:

findIncompletePublications in interface EventPublicationRegistry

Returns:

will never be null.

findIncompletePublicationsOlderThan

public Collection<TargetEventPublication> findIncompletePublicationsOlderThan(Duration duration)

Description copied from interface: EventPublicationRegistry

Returns all TargetEventPublications that have not been completed yet and have been published before the given duration in relation to "now".

Specified by:

findIncompletePublicationsOlderThan in interface EventPublicationRegistry

Parameters:

duration - must not be null.

Returns:

will never be null.

markProcessing

@Transactional(propagation=REQUIRES_NEW)
public void markProcessing(Object event,
 PublicationTargetIdentifier identifier)

Description copied from interface: EventPublicationRegistry

Marks the publication for the given event and PublicationTargetIdentifier as processing.

Specified by:

markProcessing in interface EventPublicationRegistry

Parameters:

event - must not be null.

identifier - must not be null.

See Also:

• EventPublication.Status

markCompleted

@Transactional(propagation=REQUIRES_NEW)
public void markCompleted(Object event,
 PublicationTargetIdentifier targetIdentifier)

Description copied from interface: EventPublicationRegistry

Marks the publication for the given event and PublicationTargetIdentifier as completed.

Specified by:

markCompleted in interface EventPublicationRegistry

Parameters:

event - must not be null.

targetIdentifier - must not be null.

See Also:

• EventPublication.Status

markFailed

@Transactional(propagation=REQUIRES_NEW)
public void markFailed(Object event,
 PublicationTargetIdentifier targetIdentifier)

Description copied from interface: EventPublicationRegistry

Marks the publication for the given event and PublicationTargetIdentifier as failed.

Specified by:

markFailed in interface EventPublicationRegistry

Parameters:

event - must not be null.

targetIdentifier - must not be null.

See Also:

• EventPublication.Status

deleteCompletedPublicationsOlderThan

public void deleteCompletedPublicationsOlderThan(Duration duration)

Description copied from interface: EventPublicationRegistry

Deletes all completed TargetEventPublications that have been completed before the given Duration.

Specified by:

deleteCompletedPublicationsOlderThan in interface EventPublicationRegistry

Parameters:

duration - must not be null.

findAll

public Collection<? extends TargetEventPublication> findAll()

Description copied from interface: CompletedEventPublications

Returns all EventPublications that have already been completed.

Specified by:

findAll in interface CompletedEventPublications

Returns:

will never be null.

deletePublications

public void deletePublications(Predicate<EventPublication> filter)

Description copied from interface: CompletedEventPublications

Deletes all EventPublications matching the given Predicate. Note that implementations will iterate all completed EventPublications and apply the predicate in memory.

Specified by:

deletePublications in interface CompletedEventPublications

Parameters:

filter - must not be null.

deletePublicationsOlderThan

public void deletePublicationsOlderThan(Duration duration)

Description copied from interface: CompletedEventPublications

Deletes all EventPublications whose completion date is older than the given Duration.

Specified by:

deletePublicationsOlderThan in interface CompletedEventPublications

Parameters:

duration - must not be null.

processIncompletePublications

public void processIncompletePublications(Predicate<EventPublication> filter,
 Consumer<TargetEventPublication> consumer,
 @Nullable Duration duration)

Description copied from interface: EventPublicationRegistry

Processes all incomplete event publications that have been published before the given duration in relation to "now" by applying the given filter passing all remaining instances to the given Consumer.

Specified by:

processIncompletePublications in interface EventPublicationRegistry

Parameters:

filter - must not be null.

consumer - must not be null.

duration - can be null.

processFailedPublications

public void processFailedPublications(ResubmissionOptions options,
 Consumer<TargetEventPublication> consumer)

Description copied from interface: EventPublicationRegistry

Processes all failed EventPublications matching the given ResubmissionOptions with the given Consumer.

Specified by:

processFailedPublications in interface EventPublicationRegistry

Parameters:

options - must not be null.

consumer - must not be null.

markStalePublicationsFailed

public void markStalePublicationsFailed(Staleness staleness)

Description copied from interface: EventPublicationRegistry

Marks all EventPublications considered stale as failed. Which EventPublications will be affected can differ from implementation to implementation.

Specified by:

markStalePublicationsFailed in interface EventPublicationRegistry

Parameters:

staleness - must not be null.

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

getPublicationsInProgress

DefaultEventPublicationRegistry.PublicationsInProgress getPublicationsInProgress()

Returns all DefaultEventPublicationRegistry.PublicationsInProgress.

Returns:

will never be null.

Since:

1.3

markFailed

void markFailed(TargetEventPublication publication)

Marks the given TargetEventPublication as failed.

Parameters:

publication - must not be null.

Since:

1.3

See Also:

• markFailed(Object, PublicationTargetIdentifier)