Package org.axonframework.eventsourcing.eventstore

Class DefaultEventStoreTransaction

java.lang.Object

org.axonframework.eventsourcing.eventstore.DefaultEventStoreTransaction

All Implemented Interfaces:

EventStoreTransaction

public class DefaultEventStoreTransaction
extends Object
implements EventStoreTransaction

The default EventStoreTransaction.

While sourcing it will map the SourcingCondition into an AppendCondition for appending, taking into account several sourcing invocation might have occurred in the same ProcessingContext. During appending it will pass along a collection of events to an EventStorageEngine is part of the prepare commit phase of the ProcessingContext.

Since:

5.0.0

Author:

Steven van Beelen

Constructor Summary

Constructors

Constructor	Description
DefaultEventStoreTransaction(EventStorageEngine eventStorageEngine, ProcessingContext processingContext, Function<EventMessage,TaggedEventMessage<?>> eventTagger)	Constructs a DefaultEventStoreTransaction using the given eventStorageEngine to append events originating from the given context.

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.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultEventStoreTransaction

public DefaultEventStoreTransaction(@Nonnull
 EventStorageEngine eventStorageEngine,
 @Nonnull
 ProcessingContext processingContext,
 @Nonnull
 Function<EventMessage,TaggedEventMessage<?>> eventTagger)

Constructs a DefaultEventStoreTransaction using the given eventStorageEngine to append events originating from the given context.

Parameters:

eventStorageEngine - The EventStorageEngine used to append events with.

processingContext - The ProcessingContext from which to append events and attach resources to.

eventTagger - A function that will process each EventMessage to attach Tags, before it is added to the transaction.

Method Details

source

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

Description copied from interface: EventStoreTransaction

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.

Specified by:

source in interface EventStoreTransaction

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

public void appendEvent(@Nonnull
 EventMessage eventMessage)

Description copied from interface: EventStoreTransaction

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.

Specified by:

appendEvent in interface EventStoreTransaction

Parameters:

eventMessage - The EventMessage to append.

onAppend

public void onAppend(@Nonnull
 Consumer<EventMessage> callback)

Description copied from interface: EventStoreTransaction

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.

Specified by:

onAppend in interface EventStoreTransaction

Parameters:

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

appendPosition

public ConsistencyMarker appendPosition()

Description copied from interface: EventStoreTransaction

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.

Specified by:

appendPosition in interface EventStoreTransaction

Returns:

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