org.axonframework.axonserver.connector

Class AxonServerConfiguration.PersistentStreamSettings

java.lang.Object

org.axonframework.axonserver.connector.AxonServerConfiguration.PersistentStreamSettings

Enclosing class:

AxonServerConfiguration

public static class AxonServerConfiguration.PersistentStreamSettings
extends Object

Constructor Summary

Constructors

Constructor and Description
PersistentStreamSettings()

Method Summary

Modifier and Type	Method and Description
int	getBatchSize() The maximum number of events to process in a single transaction when reading a persistent stream.
String	getFilter() Expression to filter out events in a persistent stream, using Axon Server Query Language as its syntax.
String	getInitialPosition() The initial token position for the persistent stream.
int	getInitialSegmentCount() The number of segments for the persistent stream if it needs to be created.
String	getName() The name for the persistent stream.
String	getSequencingPolicy() The sequencing policy to use for the persistent stream.
List<String>	getSequencingPolicyParameters() Parameters specified for the sequencing policy.
int	getThreadCount() The number of threads used to process tasks (e.g.
void	setBatchSize(int batchSize) Sets the maximum number of events to process in a single transaction when reading a persistent stream.
void	setFilter(String filter) Sets the expression to filter out events in a persistent stream, expecting the Axon Server Query Language as its syntax.
void	setInitialPosition(String initialPosition) Sets the initial token for the persistent stream.
void	setInitialSegmentCount(int initialSegmentCount) Sets the number of segments for the persistent stream if it needs to be created.
void	setName(String name) Assigns a name for the persistent stream.
void	setSequencingPolicy(String sequencingPolicy) Sets the sequencing policy to use for the persistent stream.
void	setSequencingPolicyParameters(List<String> sequencingPolicyParameters) Sets the parameters specified for the sequencing policy.
void	setThreadCount(int threadCount) Sets the number of threads used to process tasks (e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistentStreamSettings

public PersistentStreamSettings()

Method Detail

getInitialSegmentCount

public int getInitialSegmentCount()

The number of segments for the persistent stream if it needs to be created.

Returns:

the number of segments for the persistent stream if it needs to be created

setInitialSegmentCount

public void setInitialSegmentCount(int initialSegmentCount)

Sets the number of segments for the persistent stream if it needs to be created.

Parameters:

initialSegmentCount - the number of segments

getThreadCount

public int getThreadCount()

The number of threads used to process tasks (e.g. event handling) for the persistent stream. Defaults to 1.

Returns:

The number of threads used to process tasks (e.g. event handling) for the persistent stream.

setThreadCount

public void setThreadCount(int threadCount)

Sets the number of threads used to process tasks (e.g. event handling) for the persistent stream.

Parameters:

threadCount - The number of threads used to process tasks (e.g. event handling) for the persistent stream.

getSequencingPolicy

public String getSequencingPolicy()

The sequencing policy to use for the persistent stream.

Returns:

the sequencing policy name

setSequencingPolicy

public void setSequencingPolicy(String sequencingPolicy)

Sets the sequencing policy to use for the persistent stream.

Supported sequencing policies are:

• SequentialPerAggregatePolicy (default)
• FullConcurrencyPolicy
• SequentialPolicy
• PropertySequencingPolicy
• MetaDataSequencingPolicy

This value is only used for creating the persistent stream.

Parameters:

sequencingPolicy - The sequencing policy name.

getSequencingPolicyParameters

public List<String> getSequencingPolicyParameters()

Parameters specified for the sequencing policy.

Returns:

A list of parameters specified for the sequencing policy.

setSequencingPolicyParameters

public void setSequencingPolicyParameters(List<String> sequencingPolicyParameters)

Sets the parameters specified for the sequencing policy.

The PropertySequencingPolicy and MetaDataSequencingPolicy require parameters.

This value is only used for creating the persistent stream.

Parameters:

sequencingPolicyParameters - A list of parameters specified for the sequencing policy.

getFilter

public String getFilter()

Expression to filter out events in a persistent stream, using Axon Server Query Language as its syntax.

Note that it is not possible to change the filter once the persistent stream has been created! When doing so, Axon Server will typically throw an AXONIQ-0001 exception.

Returns:

The filter expression.

setFilter

public void setFilter(String filter)

Sets the expression to filter out events in a persistent stream, expecting the Axon Server Query Language as its syntax.

Note that it is not possible to change the filter once the persistent stream has been created! When doing so, Axon Server will typically throw an AXONIQ-0001 exception.

Parameters:

filter - The filter expression.

getName

public String getName()

The name for the persistent stream.

Returns:

The given name for a persistent stream.

setName

public void setName(String name)

Assigns a name for the persistent stream.

This value is only used for creating the persistent stream.

Parameters:

name - The given name for a persistent stream.

getBatchSize

public int getBatchSize()

The maximum number of events to process in a single transaction when reading a persistent stream.

Returns:

The batch size.

setBatchSize

public void setBatchSize(int batchSize)

Sets the maximum number of events to process in a single transaction when reading a persistent stream. The default value is 1.

Parameters:

batchSize - The batch size.

getInitialPosition

public String getInitialPosition()

The initial token position for the persistent stream. This can be a global sequence in the event store or the keywords "HEAD" or "TAIL" for a respective position at the head or tail of the stream.

Returns:

The initial token position.

setInitialPosition

public void setInitialPosition(String initialPosition)

Sets the initial token for the persistent stream. The default value is 0, starting the persistent stream from the first event in the event store.

You can use values "HEAD" or "TAIL" to start from the head or tail of the event stream.

This value is only used for creating the persistent stream.

Parameters:

initialPosition - The initial token position.