Package org.springframework.modulith.events.core

Interface EventPublicationRegistry

All Known Implementing Classes:

DefaultEventPublicationRegistry

public interface EventPublicationRegistry

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

Method Summary

Modifier and Type	Method	Description
void	deleteCompletedPublicationsOlderThan(Duration duration)	Deletes all completed TargetEventPublications that have been completed before the given Duration.
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".
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.
void	processIncompletePublications(Predicate<EventPublication> filter, Consumer<TargetEventPublication> consumer, 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.

Method Details

store

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

Stores TargetEventPublications for the given event and ApplicationListeners.

Parameters:

event - must not be null.

listeners - must not be null.

findIncompletePublications

Collection<TargetEventPublication> findIncompletePublications()

Returns all TargetEventPublications that have not been completed yet.

Returns:

will never be null.

findIncompletePublicationsOlderThan

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".

Parameters:

duration - must not be null.

Returns:

will never be null.

Since:

1.1

markCompleted

void markCompleted(Object event,
 PublicationTargetIdentifier targetIdentifier)

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

Parameters:

event - must not be null.

targetIdentifier - must not be null.

markFailed

void markFailed(Object event,
 PublicationTargetIdentifier targetIdentifier)

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

Parameters:

event - must not be null.

targetIdentifier - must not be null.

Since:

1.3

deleteCompletedPublicationsOlderThan

void deleteCompletedPublicationsOlderThan(Duration duration)

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

Parameters:

duration - must not be null.

processIncompletePublications

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.

Parameters:

filter - must not be null.

consumer - must not be null.

duration - can be null.

Since:

1.3