Package org.springframework.modulith.events.jpa

Class JpaEventPublicationRepository

java.lang.Object

org.springframework.modulith.events.jpa.JpaEventPublicationRepository

All Implemented Interfaces:

EventPublicationRepository

@Transactional
@Repository
class JpaEventPublicationRepository
extends Object
implements EventPublicationRepository

Repository to store TargetEventPublications.

Author:

Oliver Drotbohm, Dmitry Belyaev, Björn Kieling, Cora Iberkleid

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.modulith.events.core.EventPublicationRepository

EventPublicationRepository.FailedCriteria

Constructor Summary

Constructors

Constructor	Description
JpaEventPublicationRepository(jakarta.persistence.EntityManager entityManager, EventSerializer serializer, CompletionMode completionMode)	Creates a new JpaEventPublicationRepository for the given EntityManager and EventSerializer.

Method Summary

Modifier and Type	Method	Description
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.
List<TargetEventPublication>	findByStatus(EventPublication.Status status)	Returns all TargetEventPublications with the given EventPublication.Status.
List<TargetEventPublication>	findCompletedPublications()	Returns all completed event publications currently found in the system.
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.
Class<? extends JpaEventPublication>	getCompletedEntityType()	Returns the type representing completed event publications.
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.
void	markFailed(UUID identifier)	Marks the EventPublication with the given identifier as failed.
void	markProcessing(UUID identifier)	Marks the EventPublication with the given identifier as processing.
boolean	markResubmitted(UUID identifier, Instant resubmissionDate)	Marks the EventPublication with the given identifier as resubmitted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.modulith.events.core.EventPublicationRepository

markCompleted

Constructor Details

JpaEventPublicationRepository

public JpaEventPublicationRepository(jakarta.persistence.EntityManager entityManager,
 EventSerializer serializer,
 CompletionMode completionMode)

Creates a new JpaEventPublicationRepository for the given EntityManager and EventSerializer.

Parameters:

entityManager - must not be null.

serializer - must not be null.

Method Details

create

public TargetEventPublication create(TargetEventPublication publication)

Description copied from interface: EventPublicationRepository

Persists the given TargetEventPublication.

Specified by:

create in interface EventPublicationRepository

Parameters:

publication - must not be null.

Returns:

will never be null.

markProcessing

public void markProcessing(UUID identifier)

Description copied from interface: EventPublicationRepository

Marks the EventPublication with the given identifier as processing.

Specified by:

markProcessing in interface EventPublicationRepository

Parameters:

identifier - must not be null.

See Also:

• EventPublication.Status.PROCESSING

markCompleted

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

Description copied from interface: EventPublicationRepository

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

Specified by:

markCompleted in interface EventPublicationRepository

Parameters:

event - must not be null.

identifier - must not be null.

completionDate - must not be null.

See Also:

• EventPublication.Status.COMPLETED

markCompleted

public void markCompleted(UUID identifier,
 Instant completionDate)

Description copied from interface: EventPublicationRepository

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

Specified by:

markCompleted in interface EventPublicationRepository

Parameters:

identifier - must not be null.

completionDate - must not be null.

See Also:

• EventPublication.Status.COMPLETED

markFailed

public void markFailed(UUID identifier)

Description copied from interface: EventPublicationRepository

Marks the EventPublication with the given identifier as failed.

Specified by:

markFailed in interface EventPublicationRepository

Parameters:

identifier - must not be null.

See Also:

• EventPublication.Status.FAILED

markResubmitted

public boolean markResubmitted(UUID identifier,
 Instant resubmissionDate)

Description copied from interface: EventPublicationRepository

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.

Specified by:

markResubmitted in interface EventPublicationRepository

Parameters:

identifier - must not be null.

resubmissionDate - must not be null.

Returns:

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

See Also:

• EventPublication.Status.RESUBMITTED

findIncompletePublications

@Transactional(readOnly=true)
public List<TargetEventPublication> findIncompletePublications()

Description copied from interface: EventPublicationRepository

Returns all TargetEventPublications that have not been completed yet.

Specified by:

findIncompletePublications in interface EventPublicationRepository

Returns:

will never be null.

findIncompletePublicationsPublishedBefore

@Transactional(readOnly=true)
public List<TargetEventPublication> findIncompletePublicationsPublishedBefore(Instant instant)

Description copied from interface: EventPublicationRepository

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

Specified by:

findIncompletePublicationsPublishedBefore in interface EventPublicationRepository

Parameters:

instant - must not be null.

Returns:

will never be null.

findIncompletePublicationsByEventAndTargetIdentifier

@Transactional(readOnly=true)
public Optional<TargetEventPublication> findIncompletePublicationsByEventAndTargetIdentifier(Object event,
 PublicationTargetIdentifier targetIdentifier)

Description copied from interface: EventPublicationRepository

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

Specified by:

findIncompletePublicationsByEventAndTargetIdentifier in interface EventPublicationRepository

Parameters:

event - must not be null.

targetIdentifier - must not be null.

Returns:

will never be null.

findCompletedPublications

public List<TargetEventPublication> findCompletedPublications()

Description copied from interface: EventPublicationRepository

Returns all completed event publications currently found in the system.

Specified by:

findCompletedPublications in interface EventPublicationRepository

Returns:

will never be null.

findFailedPublications

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

Specified by:

findFailedPublications in interface EventPublicationRepository

Parameters:

criteria - must not be null.

Returns:

will never be null.

deletePublications

public void deletePublications(List<UUID> identifiers)

Description copied from interface: EventPublicationRepository

Deletes all publications with the given identifiers.

Specified by:

deletePublications in interface EventPublicationRepository

Parameters:

identifiers - must not be null.

deleteCompletedPublications

public void deleteCompletedPublications()

Description copied from interface: EventPublicationRepository

Deletes all publications that were already marked as completed.

Specified by:

deleteCompletedPublications in interface EventPublicationRepository

deleteCompletedPublicationsBefore

public void deleteCompletedPublicationsBefore(Instant instant)

Description copied from interface: EventPublicationRepository

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

Specified by:

deleteCompletedPublicationsBefore in interface EventPublicationRepository

Parameters:

instant - must not be null.

findByStatus

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

Description copied from interface: EventPublicationRepository

Returns all TargetEventPublications with the given EventPublication.Status.

Specified by:

findByStatus in interface EventPublicationRepository

Parameters:

status - must not be null.

Returns:

will never be null.

countByStatus

public int countByStatus(EventPublication.Status status)

Description copied from interface: EventPublicationRepository

Returns the number of EventPublications for the given status.

Specified by:

countByStatus in interface EventPublicationRepository

Parameters:

status - must not be null.

Returns:

must not be negative

getCompletedEntityType

public Class<? extends JpaEventPublication> getCompletedEntityType()

Returns the type representing completed event publications.

Returns:

will never be null.

Since:

1.3