org.axonframework.eventsourcing.eventstore

Class BatchingEventStorageEngine.Builder

java.lang.Object

org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine.Builder

org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine.Builder

Direct Known Subclasses:

JdbcEventStorageEngine.Builder, JpaEventStorageEngine.Builder, JpaEventStorageEngine.Builder

Enclosing class:

BatchingEventStorageEngine

public abstract static class BatchingEventStorageEngine.Builder
extends AbstractEventStorageEngine.Builder

Abstract Builder class to instantiate a BatchingEventStorageEngine.

The EventUpcaster defaults to a NoOpEventUpcaster, the snapshotFilter defaults to a SnapshotFilter.allowAll() instance and the batchSize is defaulted to an integer of size 100.

The event and snapshot Serializer are hard requirements and as such should be provided.

Field Summary

Fields inherited from class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine.Builder

upcasterChain

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
BatchingEventStorageEngine.Builder	batchSize(int batchSize) Sets the batchSize specifying the number of events that should be read at each database access.
BatchingEventStorageEngine.Builder	eventSerializer(Serializer eventSerializer) Sets the Serializer used to serialize and deserialize the Event Message's payload and MetaData with.
BatchingEventStorageEngine.Builder	finalAggregateBatchPredicate(Predicate<List<? extends DomainEventData<?>>> finalAggregateBatchPredicate) Defines the predicate to use to recognize the terminal batch when reading an event stream for an aggregate.
BatchingEventStorageEngine.Builder	persistenceExceptionResolver(PersistenceExceptionResolver persistenceExceptionResolver) Sets the PersistenceExceptionResolver used to detect concurrency exceptions from the backing database.
BatchingEventStorageEngine.Builder	snapshotFilter(Predicate<? super DomainEventData<?>> snapshotFilter) Deprecated. in favor of snapshotFilter(SnapshotFilter)
BatchingEventStorageEngine.Builder	snapshotFilter(SnapshotFilter snapshotFilter) Sets the snapshotFilter deciding whether to take a snapshot into account.
BatchingEventStorageEngine.Builder	snapshotSerializer(Serializer snapshotSerializer) Sets the Serializer used to serialize and deserialize snapshots.
BatchingEventStorageEngine.Builder	upcasterChain(EventUpcaster upcasterChain) Sets the EventUpcaster used to deserialize events of older revisions.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

snapshotSerializer

public BatchingEventStorageEngine.Builder snapshotSerializer(Serializer snapshotSerializer)

Description copied from class: AbstractEventStorageEngine.Builder

Sets the Serializer used to serialize and deserialize snapshots.

Overrides:

snapshotSerializer in class AbstractEventStorageEngine.Builder

Parameters:

snapshotSerializer - a Serializer used to serialize and deserialize snapshots

Returns:

the current Builder instance, for fluent interfacing

upcasterChain

public BatchingEventStorageEngine.Builder upcasterChain(EventUpcaster upcasterChain)

Description copied from class: AbstractEventStorageEngine.Builder

Sets the EventUpcaster used to deserialize events of older revisions. Defaults to a NoOpEventUpcaster.

Overrides:

upcasterChain in class AbstractEventStorageEngine.Builder

Parameters:

upcasterChain - an EventUpcaster used to deserialize events of older revisions

Returns:

the current Builder instance, for fluent interfacing

persistenceExceptionResolver

public BatchingEventStorageEngine.Builder persistenceExceptionResolver(PersistenceExceptionResolver persistenceExceptionResolver)

Description copied from class: AbstractEventStorageEngine.Builder

Sets the PersistenceExceptionResolver used to detect concurrency exceptions from the backing database. If the persistenceExceptionResolver is not specified, persistence exceptions are not explicitly resolved.

Overrides:

persistenceExceptionResolver in class AbstractEventStorageEngine.Builder

Parameters:

persistenceExceptionResolver - the PersistenceExceptionResolver used to detect concurrency exceptions from the backing database

Returns:

the current Builder instance, for fluent interfacing

eventSerializer

public BatchingEventStorageEngine.Builder eventSerializer(Serializer eventSerializer)

Description copied from class: AbstractEventStorageEngine.Builder

Sets the Serializer used to serialize and deserialize the Event Message's payload and MetaData with.

Overrides:

eventSerializer in class AbstractEventStorageEngine.Builder

Parameters:

eventSerializer - The serializer to serialize the Event Message's payload and MetaData with

Returns:

the current Builder instance, for fluent interfacing

finalAggregateBatchPredicate

public BatchingEventStorageEngine.Builder finalAggregateBatchPredicate(Predicate<List<? extends DomainEventData<?>>> finalAggregateBatchPredicate)

Defines the predicate to use to recognize the terminal batch when reading an event stream for an aggregate. The default behavior is implementation-specific.

Parameters:

finalAggregateBatchPredicate - The predicate that indicates whether a given batch is to be considered the final batch of an event stream.

Returns:

the current Builder instance, for fluent interfacing

snapshotFilter

@Deprecated
public BatchingEventStorageEngine.Builder snapshotFilter(Predicate<? super DomainEventData<?>> snapshotFilter)

Deprecated. in favor of snapshotFilter(SnapshotFilter)

Sets the snapshotFilter deciding whether to take a snapshot into account. Can be set to filter out specific snapshot revisions which should not be applied. Defaults to a Predicate which returns true regardless.

Overrides:

snapshotFilter in class AbstractEventStorageEngine.Builder

Parameters:

snapshotFilter - a Predicate which decides whether to take a snapshot into account

Returns:

the current Builder instance, for fluent interfacing

snapshotFilter

public BatchingEventStorageEngine.Builder snapshotFilter(SnapshotFilter snapshotFilter)

Description copied from class: AbstractEventStorageEngine.Builder

Sets the snapshotFilter deciding whether to take a snapshot into account. Can be set to filter out specific snapshot revisions which should not be applied. Defaults to SnapshotFilter.allowAll().

Note that SnapshotFilter instances can be combined and should return true if they handle a snapshot they wish to ignore.

Overrides:

snapshotFilter in class AbstractEventStorageEngine.Builder

Parameters:

snapshotFilter - a SnapshotFilter which decides whether to take a snapshot into account

Returns:

the current Builder instance, for fluent interfacing

batchSize

public BatchingEventStorageEngine.Builder batchSize(int batchSize)

Sets the batchSize specifying the number of events that should be read at each database access. When more than this number of events must be read to rebuild an aggregate's state, the events are read in batches of this size. Defaults to an integer of 100.

Tip: if you use a snapshotter, make sure to choose snapshot trigger and batch size such that a single batch will generally retrieve all events required to rebuild an aggregate's state.

Parameters:

batchSize - an int specifying the number of events that should be read at each database access

Returns:

the current Builder instance, for fluent interfacing

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Overrides:

validate in class AbstractEventStorageEngine.Builder

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications