Package org.axonframework.eventsourcing.eventstore

Class AbstractEventStorageEngine.Builder

java.lang.Object

org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine.Builder

Direct Known Subclasses:

BatchingEventStorageEngine.Builder

Enclosing class:

AbstractEventStorageEngine

public abstract static class AbstractEventStorageEngine.Builder
extends Object

Abstract Builder class to instantiate an AbstractEventStorageEngine.

The EventUpcaster defaults to a NoOpEventUpcaster and the snapshotFilter defaults to a SnapshotFilter.allowAll() instance.

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

Field Summary

Fields

Modifier and Type	Field	Description
protected EventUpcaster	upcasterChain

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
AbstractEventStorageEngine.Builder	eventSerializer(Serializer eventSerializer)	Sets the Serializer used to serialize and deserialize the Event Message's payload and MetaData with.
AbstractEventStorageEngine.Builder	persistenceExceptionResolver(PersistenceExceptionResolver persistenceExceptionResolver)	Sets the PersistenceExceptionResolver used to detect concurrency exceptions from the backing database.
AbstractEventStorageEngine.Builder	snapshotFilter(Predicate<? super DomainEventData<?>> snapshotFilter)	Deprecated. in favor of snapshotFilter(SnapshotFilter)
AbstractEventStorageEngine.Builder	snapshotFilter(SnapshotFilter snapshotFilter)	Sets the snapshotFilter deciding whether to take a snapshot into account.
AbstractEventStorageEngine.Builder	snapshotSerializer(Serializer snapshotSerializer)	Sets the Serializer used to serialize and deserialize snapshots.
AbstractEventStorageEngine.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

Field Details

upcasterChain

protected EventUpcaster upcasterChain

Constructor Details

Builder

public Builder()

Method Details

snapshotSerializer

public AbstractEventStorageEngine.Builder snapshotSerializer(Serializer snapshotSerializer)

Sets the Serializer used to serialize and deserialize snapshots.

Parameters:

snapshotSerializer - a Serializer used to serialize and deserialize snapshots

Returns:

the current Builder instance, for fluent interfacing

upcasterChain

public AbstractEventStorageEngine.Builder upcasterChain(EventUpcaster upcasterChain)

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

Parameters:

upcasterChain - an EventUpcaster used to deserialize events of older revisions

Returns:

the current Builder instance, for fluent interfacing

persistenceExceptionResolver

public AbstractEventStorageEngine.Builder persistenceExceptionResolver(PersistenceExceptionResolver persistenceExceptionResolver)

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

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

eventSerializer

public AbstractEventStorageEngine.Builder eventSerializer(Serializer eventSerializer)

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

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

snapshotFilter

@Deprecated
public AbstractEventStorageEngine.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.

Parameters:

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

Returns:

the current Builder instance, for fluent interfacing

snapshotFilter

public AbstractEventStorageEngine.Builder snapshotFilter(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 SnapshotFilter.allowAll().

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

Parameters:

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

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.

Throws:

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