Interface EventPublication
- All Known Subinterfaces:
TargetEventPublication
- All Known Implementing Classes:
DefaultEventPublication
public interface EventPublication
An event publication.
- Since:
- 1.1
- Author:
- Oliver Drotbohm
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptiondefault intcompareTo(EventPublication that) default ApplicationEventReturns the event as SpringApplicationEvent: the event itself if it already is one, or the event wrapped into aPayloadApplicationEventotherwise.intReturns the number of completion attempts.Returns the completion date of the publication.getEvent()Returns the event that is published.Returns a unique identifier for this publication.default InstantReturns the date that the publication has been last published at.@Nullable InstantReturns the last time theEventPublicationwas resubmitted.Returns the time the event is published at.Return the publication'sEventPublication.Status.default booleanReturns whether the publication of the event has completed.
-
Method Details
-
getIdentifier
UUID getIdentifier()Returns a unique identifier for this publication.- Returns:
- will never be null.
-
getEvent
Object getEvent()Returns the event that is published.- Returns:
- will never be null.
-
getApplicationEvent
Returns the event as SpringApplicationEvent: the event itself if it already is one, or the event wrapped into aPayloadApplicationEventotherwise.- Returns:
- the underlying event as
ApplicationEvent.
-
getPublicationDate
Instant getPublicationDate()Returns the time the event is published at.- Returns:
- will never be null.
-
getCompletionDate
Returns the completion date of the publication.- Returns:
- will never be null.
-
isCompleted
default boolean isCompleted()Returns whether the publication of the event has completed.- Since:
- 1.3
-
getStatus
EventPublication.Status getStatus()Return the publication'sEventPublication.Status.- Returns:
- will never be null.
- Since:
- 2.0
-
getLastResubmissionDate
@Nullable Instant getLastResubmissionDate()Returns the last time theEventPublicationwas resubmitted.- Returns:
- can be null.
- Since:
- 2.0
-
getLastPublicationDate
Returns the date that the publication has been last published at. This will consider the most recent resubmission before falling back to the original publication date.- Returns:
- will never be null.
- Since:
- 2.2, 2.1.2, 2.0.9
- See Also:
-
getCompletionAttempts
int getCompletionAttempts()Returns the number of completion attempts.- Since:
- 2.0
-
compareTo
-