JdbcEventStorageEngine.Builder (Axon Framework 4.1.1 API)

java.lang.Object
- org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine.Builder
- - org.axonframework.eventsourcing.eventstore.BatchingEventStorageEngine.Builder
  - - org.axonframework.eventsourcing.eventstore.jdbc.JdbcEventStorageEngine.Builder

Enclosing class:

JdbcEventStorageEngine
```
public static class JdbcEventStorageEngine.Builder
extends BatchingEventStorageEngine.Builder
```
Builder class to instantiate a JdbcEventStorageEngine.
The following configurable fields have defaults:
- The snapshot Serializer defaults to XStreamSerializer.
- The EventUpcaster defaults to an NoOpEventUpcaster.
- The PersistenceExceptionResolver is defaulted to a JdbcSQLErrorCodesResolver
- The event Serializer defaults to a XStreamSerializer.
- The snapshotFilter defaults to a Predicate which returns true regardless.
- The batchSize defaults to an integer of size 100.
- The dataType is defaulted to the byte[] type.
- The EventSchema defaults to an EventSchema.EventSchema() call.
- The maxGapOffset defaults to an integer of size 10000.
- The lowestGlobalSequence defaults to a long of size 1.
- The gapTimeout defaults to an integer of size 60000 (1 minute).
- The gapCleaningThreshold defaults to an integer of size 250.
- The extendedGapCheckEnabled defaults to true.
The ConnectionProvider and TransactionManager are hard requirements and as such should be provided.

Field Summary
- Fields inherited from class org.axonframework.eventsourcing.eventstore.AbstractEventStorageEngine.Builder
  upcasterChain

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`JdbcEventStorageEngine.Builder`	`batchSize(int batchSize)` Sets the `batchSize` specifying the number of events that should be read at each database access.
`JdbcEventStorageEngine`	`build()` Initializes a `JdbcEventStorageEngine` as specified through this Builder.
`JdbcEventStorageEngine.Builder`	`connectionProvider(ConnectionProvider connectionProvider)` Sets the `ConnectionProvider` which provides access to a JDBC connection.
`JdbcEventStorageEngine.Builder`	`dataType(Class<?> dataType)` Sets the `dataType` specifying the serialized type of the Event Message's payload and Meta Data.
`JdbcEventStorageEngine.Builder`	`eventSerializer(Serializer eventSerializer)` Sets the `Serializer` used to serialize and deserialize the Event Message's payload and Meta Data with.
`JdbcEventStorageEngine.Builder`	`extendedGapCheckEnabled(boolean extendedGapCheckEnabled)` Indicates whether an extra query should be performed to verify for gaps in the `globalSequence` larger than the configured batch size.
`JdbcEventStorageEngine.Builder`	`gapCleaningThreshold(int gapCleaningThreshold)` Sets the threshold of number of gaps in a token before an attempt to clean gaps up is taken.
`JdbcEventStorageEngine.Builder`	`gapTimeout(int gapTimeout)` Sets the amount of time until a 'gap' in a TrackingToken may be considered timed out.
`JdbcEventStorageEngine.Builder`	`lowestGlobalSequence(long lowestGlobalSequence)` Sets the `lowestGlobalSequence` specifying the first expected auto generated sequence number.
`JdbcEventStorageEngine.Builder`	`maxGapOffset(int maxGapOffset)` Sets the `maxGapOffset` specifying the maximum distance in sequence numbers between a missing event and the event with the highest known index.
`JdbcEventStorageEngine.Builder`	`persistenceExceptionResolver(PersistenceExceptionResolver persistenceExceptionResolver)` Sets the `PersistenceExceptionResolver` used to detect concurrency exceptions from the backing database.
`JdbcEventStorageEngine.Builder`	`schema(EventSchema schema)` Sets the `EventSchema` describing the database schema of event entries.
`JdbcEventStorageEngine.Builder`	`snapshotFilter(Predicate<? super DomainEventData<?>> snapshotFilter)` Sets the `snapshotFilter` deciding whether to take a snapshot into account.
`JdbcEventStorageEngine.Builder`	`snapshotSerializer(Serializer snapshotSerializer)` Sets the `Serializer` used to serialize and deserialize snapshots.
`JdbcEventStorageEngine.Builder`	`transactionManager(TransactionManager transactionManager)` Sets the `TransactionManager` used to manage transactions around fetching event data.
`JdbcEventStorageEngine.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

- Method Detail
  - snapshotSerializer
```
public JdbcEventStorageEngine.Builder snapshotSerializer(Serializer snapshotSerializer)
```
    Description copied from class: AbstractEventStorageEngine.Builder
    
    Sets the Serializer used to serialize and deserialize snapshots. Defaults to a XStreamSerializer.
    
    Overrides:
    
    snapshotSerializer in class BatchingEventStorageEngine.Builder
    
    Parameters:
    
    snapshotSerializer - a Serializer used to serialize and deserialize snapshots
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - upcasterChain
```
public JdbcEventStorageEngine.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 BatchingEventStorageEngine.Builder
    
    Parameters:
    
    upcasterChain - an EventUpcaster used to deserialize events of older revisions
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - persistenceExceptionResolver
```
public JdbcEventStorageEngine.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. Defaults to a JdbcSQLErrorCodesResolver.
    
    Overrides:
    
    persistenceExceptionResolver in class BatchingEventStorageEngine.Builder
    
    Parameters:
    
    persistenceExceptionResolver - the PersistenceExceptionResolver used to detect concurrency exceptions from the backing database
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - eventSerializer
```
public JdbcEventStorageEngine.Builder eventSerializer(Serializer eventSerializer)
```
    Description copied from class: AbstractEventStorageEngine.Builder
    
    Sets the Serializer used to serialize and deserialize the Event Message's payload and Meta Data with. Defaults to a XStreamSerializer.
    
    Overrides:
    
    eventSerializer in class BatchingEventStorageEngine.Builder
    
    Parameters:
    
    eventSerializer - The serializer to serialize the Event Message's payload and Meta Data with
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - snapshotFilter
```
public JdbcEventStorageEngine.Builder snapshotFilter(Predicate<? super DomainEventData<?>> 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 a Predicate which returns true regardless.
    
    Overrides:
    
    snapshotFilter in class BatchingEventStorageEngine.Builder
    
    Parameters:
    
    snapshotFilter - a Predicate which decides whether to take a snapshot into account
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - batchSize
```
public JdbcEventStorageEngine.Builder batchSize(int batchSize)
```
    Description copied from class: BatchingEventStorageEngine.Builder
    
    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.
    
    Overrides:
    
    batchSize in class BatchingEventStorageEngine.Builder
    
    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
  - connectionProvider
```
public JdbcEventStorageEngine.Builder connectionProvider(ConnectionProvider connectionProvider)
```
    Sets the ConnectionProvider which provides access to a JDBC connection.
    
    Parameters:
    
    connectionProvider - a ConnectionProvider which provides access to a JDBC connection
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - transactionManager
```
public JdbcEventStorageEngine.Builder transactionManager(TransactionManager transactionManager)
```
    Sets the TransactionManager used to manage transactions around fetching event data. Required by certain databases for reading blob data.
    
    Parameters:
    
    transactionManager - a TransactionManager used to manage transactions around fetching event data
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - dataType
```
public JdbcEventStorageEngine.Builder dataType(Class<?> dataType)
```
    Sets the dataType specifying the serialized type of the Event Message's payload and Meta Data. Defaults to the byte[] Class.
    
    Parameters:
    
    dataType - a Class specifying the serialized type of the Event Message's payload and Meta Data
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - schema
```
public JdbcEventStorageEngine.Builder schema(EventSchema schema)
```
    Sets the EventSchema describing the database schema of event entries. Defaults to EventSchema.EventSchema().
    
    Parameters:
    
    schema - the EventSchema describing the database schema of event entries
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - maxGapOffset
```
public JdbcEventStorageEngine.Builder maxGapOffset(int maxGapOffset)
```
    Sets the maxGapOffset specifying the maximum distance in sequence numbers between a missing event and the event with the highest known index. If the gap is bigger it is assumed that the missing event will not be committed to the store anymore. This event storage engine will no longer look for those events the next time a batch is fetched. Defaults to an integer of 10000 (JdbcEventStorageEngine.DEFAULT_MAX_GAP_OFFSET.
    
    Parameters:
    
    maxGapOffset - an int specifying the maximum distance in sequence numbers between a missing event and the event with the highest known index
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - lowestGlobalSequence
```
public JdbcEventStorageEngine.Builder lowestGlobalSequence(long lowestGlobalSequence)
```
    Sets the lowestGlobalSequence specifying the first expected auto generated sequence number. For most data stores this is 1 unless the table has contained entries before. Defaults to a long of 1 (JdbcEventStorageEngine.DEFAULT_LOWEST_GLOBAL_SEQUENCE).
    
    Parameters:
    
    lowestGlobalSequence - a long specifying the first expected auto generated sequence number
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - gapTimeout
```
public JdbcEventStorageEngine.Builder gapTimeout(int gapTimeout)
```
    Sets the amount of time until a 'gap' in a TrackingToken may be considered timed out. This setting will affect the cleaning process of gaps. Gaps that have timed out will be removed from Tracking Tokens to improve performance of reading events. Defaults to an integer of 60000 (JdbcEventStorageEngine.DEFAULT_GAP_TIMEOUT), thus 1 minute.
    
    Parameters:
    
    gapTimeout - an int specifying the amount of time until a 'gap' in a TrackingToken may be considered timed out
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - gapCleaningThreshold
```
public JdbcEventStorageEngine.Builder gapCleaningThreshold(int gapCleaningThreshold)
```
    Sets the threshold of number of gaps in a token before an attempt to clean gaps up is taken. Defaults to an integer of 250 (JdbcEventStorageEngine.DEFAULT_GAP_CLEANING_THRESHOLD).
    
    Parameters:
    
    gapCleaningThreshold - an int specifying the threshold of number of gaps in a token before an attempt to clean gaps up is taken
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - extendedGapCheckEnabled
```
public JdbcEventStorageEngine.Builder extendedGapCheckEnabled(boolean extendedGapCheckEnabled)
```
    Indicates whether an extra query should be performed to verify for gaps in the globalSequence larger than the configured batch size. These gaps could trick the storage engine into believing there are no more events to read, while there are still positions ahead.
    This check comes at a cost of an extra query when a batch retrieval yields an empty result. This may increase database pressure when processors are at the HEAD of a stream, as each batch retrieval will result in an extra query, if there are no results.
    Note that the extra query checks for the smallest globalSequence, higher than the last one seen. This query can be executed using an index, which should be a relatively cheap query for most databases.
    Defaults to true
    
    Parameters:
    
    extendedGapCheckEnabled - whether to enable the "extended gap check". Defaults to true.
    
    Returns:
    
    the current Builder instance, for fluent interfacing
  - build
```
public JdbcEventStorageEngine build()
```
    Initializes a JdbcEventStorageEngine as specified through this Builder.
    
    Returns:
    
    a JdbcEventStorageEngine as specified through this Builder
  - validate
```
protected void validate()
                 throws AxonConfigurationException
```
    Validates whether the fields contained in this Builder are set accordingly.
    
    Overrides:
    
    validate in class BatchingEventStorageEngine.Builder
    
    Throws:
    
    AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications

Class JdbcEventStorageEngine.Builder

Field Summary

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

Method Summary

Methods inherited from class java.lang.Object

Method Detail

snapshotSerializer

upcasterChain

persistenceExceptionResolver

eventSerializer

snapshotFilter

batchSize

connectionProvider

transactionManager

dataType

schema

maxGapOffset

lowestGlobalSequence

gapTimeout

gapCleaningThreshold

extendedGapCheckEnabled

build

validate