Package org.springframework.modulith.events.jdbc

Class JdbcEventPublicationRepository

java.lang.Object

org.springframework.modulith.events.jdbc.JdbcEventPublicationRepository

All Implemented Interfaces:

Aware, BeanClassLoaderAware, EventPublicationRepository

class JdbcEventPublicationRepository
extends Object
implements EventPublicationRepository, BeanClassLoaderAware

JDBC-based repository to store TargetEventPublications.

Author:

Dmitry Belyaev, Björn Kieling, Oliver Drotbohm, Raed Ben Hamouda, Cora Iberkleid

Nested Class Summary

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

EventPublicationRepository.FailedCriteria

Constructor Summary

Constructors

Constructor	Description
JdbcEventPublicationRepository(JdbcOperations operations, EventSerializer serializer, JdbcRepositorySettings settings)	Creates a new JdbcEventPublicationRepository for the given JdbcOperations, EventSerializer, DatabaseType and JdbcConfigurationProperties.

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>	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.
void	setBeanClassLoader(ClassLoader classLoader)

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

findFailedPublications, markCompleted, markFailed, markProcessing, markResubmitted

Constructor Details

JdbcEventPublicationRepository

public JdbcEventPublicationRepository(JdbcOperations operations,
 EventSerializer serializer,
 JdbcRepositorySettings settings)

Creates a new JdbcEventPublicationRepository for the given JdbcOperations, EventSerializer, DatabaseType and JdbcConfigurationProperties.

Parameters:

operations - must not be null.

serializer - must not be null.

settings - must not be null.

Method Details

setBeanClassLoader

public void setBeanClassLoader(ClassLoader classLoader)

Specified by:

setBeanClassLoader in interface BeanClassLoaderAware

create

@Transactional
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.

markCompleted

@Transactional
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

@Transactional
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

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.

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

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.

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