Package org.springframework.modulith.events.core

Interface EventPublicationRepository

All Known Implementing Classes:

JdbcEventPublicationRepository, JdbcEventPublicationRepositoryV2, JpaEventPublicationRepository, MongoDbEventPublicationRepository, Neo4jEventPublicationRepository

public interface EventPublicationRepository

Repository to store TargetEventPublications.

Author:

Björn Kieling, Dmitry Belyaev, Oliver Drotbohm

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	EventPublicationRepository.FailedCriteria

Method Summary

Modifier and Type	Method	Description
default int	countByStatus(EventPublication.Status status)	Returns the number of EventPublications for the given status.
TargetEventPublication	create(TargetEventPublication publication)	Persists the given TargetEventPublication.
void	deleteCompletedPublications()	Deletes all publications that were already marked as completed.
void	deleteCompletedPublicationsBefore(Instant instant)	Deletes all publication that were already marked as completed with a completion date before the given one.
void	deletePublications(List<UUID> identifiers)	Deletes all publications with the given identifiers.
default List<TargetEventPublication>	findByStatus(EventPublication.Status status)	Returns all TargetEventPublications with the given EventPublication.Status.
default List<TargetEventPublication>	findCompletedPublications()	Returns all completed event publications currently found in the system.
default List<TargetEventPublication>	findFailedPublications(EventPublicationRepository.FailedCriteria criteria)
List<TargetEventPublication>	findIncompletePublications()	Returns all TargetEventPublications that have not been completed yet.
Optional<TargetEventPublication>	findIncompletePublicationsByEventAndTargetIdentifier(Object event, PublicationTargetIdentifier targetIdentifier)	Return the incomplete TargetEventPublication for the given serialized event and listener identifier.
List<TargetEventPublication>	findIncompletePublicationsPublishedBefore(Instant instant)	Returns all TargetEventPublications that have not been completed and were published before the given Instant.
void	markCompleted(Object event, PublicationTargetIdentifier identifier, Instant completionDate)	Marks the publication for the given event and PublicationTargetIdentifier to be completed at the given Instant.
void	markCompleted(UUID identifier, Instant completionDate)	Marks the publication with the given identifier completed at the given Instant.
default void	markCompleted(TargetEventPublication publication, Instant completionDate)	Marks the given TargetEventPublication as completed.
default void	markFailed(UUID identifier)	Marks the EventPublication with the given identifier as failed.
default void	markProcessing(UUID identifier)	Marks the EventPublication with the given identifier as processing.
default boolean	markResubmitted(UUID identifier, Instant resubmissionDate)	Marks the EventPublication with the given identifier as resubmitted.

Method Details

create

TargetEventPublication create(TargetEventPublication publication)

Persists the given TargetEventPublication.

Parameters:

publication - must not be null.

Returns:

will never be null.

markProcessing

default void markProcessing(UUID identifier)

Marks the EventPublication with the given identifier as processing.

Parameters:

identifier - must not be null.

Since:

2.0

See Also:

• EventPublication.Status.PROCESSING

markCompleted

default void markCompleted(TargetEventPublication publication,
 Instant completionDate)

Marks the given TargetEventPublication as completed.

Parameters:

publication - must not be null.

completionDate - must not be null.

markCompleted

void markCompleted(Object event,
 PublicationTargetIdentifier identifier,
 Instant completionDate)

Marks the publication for the given event and PublicationTargetIdentifier to be completed at the given Instant.

Parameters:

event - must not be null.

identifier - must not be null.

completionDate - must not be null.

See Also:

• EventPublication.Status.COMPLETED

markCompleted

void markCompleted(UUID identifier,
 Instant completionDate)

Marks the publication with the given identifier completed at the given Instant.

Parameters:

identifier - must not be null.

completionDate - must not be null.

Since:

1.3

See Also:

• EventPublication.Status.COMPLETED

markFailed

default void markFailed(UUID identifier)

Marks the EventPublication with the given identifier as failed.

Parameters:

identifier - must not be null.

Since:

2.0

See Also:

• EventPublication.Status.FAILED

markResubmitted

default boolean markResubmitted(UUID identifier,
 Instant resubmissionDate)

Marks the EventPublication with the given identifier as resubmitted. Returns false in case the update was not successful, which usually means that the instance identified might have been claimed for re-submission by another application instance.

Parameters:

identifier - must not be null.

resubmissionDate - must not be null.

Returns:

whether the EventPublication with the given identifier was marked as resubmitted.

Since:

2.0

See Also:

• EventPublication.Status.RESUBMITTED

findIncompletePublications

List<TargetEventPublication> findIncompletePublications()

Returns all TargetEventPublications that have not been completed yet.

Returns:

will never be null.

findIncompletePublicationsPublishedBefore

List<TargetEventPublication> findIncompletePublicationsPublishedBefore(Instant instant)

Returns all TargetEventPublications that have not been completed and were published before the given Instant.

Parameters:

instant - must not be null.

Returns:

will never be null.

Since:

1.1

findIncompletePublicationsByEventAndTargetIdentifier

Optional<TargetEventPublication> findIncompletePublicationsByEventAndTargetIdentifier(Object event,
 PublicationTargetIdentifier targetIdentifier)

Return the incomplete TargetEventPublication for the given serialized event and listener identifier.

Parameters:

event - must not be null.

targetIdentifier - must not be null.

Returns:

will never be null.

findCompletedPublications

default List<TargetEventPublication> findCompletedPublications()

Returns all completed event publications currently found in the system.

Returns:

will never be null.

Since:

1.1.2

deletePublications

void deletePublications(List<UUID> identifiers)

Deletes all publications with the given identifiers.

Parameters:

identifiers - must not be null.

Since:

1.1

deleteCompletedPublications

void deleteCompletedPublications()

Deletes all publications that were already marked as completed.

deleteCompletedPublicationsBefore

void deleteCompletedPublicationsBefore(Instant instant)

Deletes all publication that were already marked as completed with a completion date before the given one.

Parameters:

instant - must not be null.

findFailedPublications

default List<TargetEventPublication> findFailedPublications(EventPublicationRepository.FailedCriteria criteria)

Parameters:

criteria - must not be null.

Returns:

will never be null.

Since:

2.0

findByStatus

default List<TargetEventPublication> findByStatus(EventPublication.Status status)

Returns all TargetEventPublications with the given EventPublication.Status.

Parameters:

status - must not be null.

Returns:

will never be null.

Since:

2.0

countByStatus

default int countByStatus(EventPublication.Status status)

Returns the number of EventPublications for the given status.

Parameters:

status - must not be null.

Returns:

must not be negative

Since:

2.0