Package org.axonframework.eventsourcing.eventstore

Interface EventStoreTransaction

All Known Implementing Classes:

DefaultEventStoreTransaction

public interface EventStoreTransaction

Interface describing the actions that can be taken on a transaction to source a model from the EventStore based on the resulting MessageStream.

Note that this transaction includes operations for source(SourcingCondition) the model as well as appending events.

Since:

5.0.0

Author:

Allard Buijze, Steven van Beelen

Method Summary

Modifier and Type	Method	Description
void	appendEvent(EventMessage eventMessage)	Appends an eventMessage to be appended to an EventStore in this transaction with the given condition.
ConsistencyMarker	appendPosition()	Returns the position in the event store of the last appended event by this transaction.
void	onAppend(Consumer<EventMessage> callback)	Registers a callback to invoke when an event is appended to this transaction.
MessageStream<? extends EventMessage>	source(SourcingCondition condition)	Sources a MessageStream of type EventMessage based on the given condition that can be used to rehydrate a model.

Method Details

source

MessageStream<? extends EventMessage> source(@Nonnull
 SourcingCondition condition)

Sources a MessageStream of type EventMessage based on the given condition that can be used to rehydrate a model.

Note that the usage of criteria does not make sense for sourcing, as it is not recommended to source the entire event store.

Any EventStoreTransaction using the EventStorageEngine.source(SourcingCondition) is expected to filter the TerminalEventMessage with the ConsistencyMarker.

Parameters:

condition - The SourcingCondition used to retrieve the MessageStream containing the sequence of events that can rehydrate a model.

Returns:

The MessageStream of type EventMessage containing to the event sequence complying to the given condition.

appendEvent

void appendEvent(@Nonnull
 EventMessage eventMessage)

Appends an eventMessage to be appended to an EventStore in this transaction with the given condition.

Use the EventCriteria.havingAnyTag() when there are no consistency boundaries to validate during appending.

Parameters:

eventMessage - The EventMessage to append.

onAppend

void onAppend(@Nonnull
 Consumer<EventMessage> callback)

Registers a callback to invoke when an event is appended to this transaction.

Each callback registration adds a new callback that is invoked on the appendEvent(EventMessage, AppendCondition) operation.

Parameters:

callback - A Consumer to invoke when an event is appended in this transaction.

appendPosition

ConsistencyMarker appendPosition()

Returns the position in the event store of the last appended event by this transaction.

Will return ConsistencyMarker.ORIGIN if nothing has been appended yet.

Returns:

The position in the event store of the last appended event by this transaction.