org.axonframework.spring.stereotype

Annotation Type Aggregate

@Target(value={TYPE,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Component
 @Scope(value="prototype")
 @AggregateRoot
public @interface Aggregate

Annotation that informs Axon's auto configurer for Spring that a given Component is an aggregate instance.

Since:

3.0

Author:

Allard Buijze

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	cache Sets the name of the bean providing the caching.
String	commandTargetResolver Selects the name of the CommandTargetResolver bean.
boolean	filterEventsByType Sets whether or not to filter events by Aggregate type.
String	lockFactory Sets the name of the bean providing the LockFactory.
String	repository Selects the name of the AggregateRepository bean.
String	snapshotFilter Sets the name of the bean providing the SnapshotFilter.
String	snapshotTriggerDefinition Sets the name of the bean providing the snapshot trigger definition.
String	type Get the String representation of the aggregate's type.

Element Detail

repository

public abstract String repository

Selects the name of the AggregateRepository bean. If left empty a new repository is created. In that case the name of the repository will be based on the simple name of the aggregate's class.

Default:

""

snapshotTriggerDefinition

public abstract String snapshotTriggerDefinition

Sets the name of the bean providing the snapshot trigger definition. If none is provided, no snapshots are created, unless explicitly configured on the referenced repository.

Note that the use of repository(), or provisioning a Repository to the Spring context using the default naming scheme overrides this setting, as a Repository explicitly defines the snapshot trigger definition. The default name corresponds to "[aggregate-name]Repository", thus a Trade Aggregate would by default create/look for a bean named "tradeRepository".

Default:

""

snapshotFilter

public abstract String snapshotFilter

Sets the name of the bean providing the SnapshotFilter. If none is provided, all snapshots will be taken into account unless explicitly configured on the event store.

Default:

""

type

public abstract String type

Get the String representation of the aggregate's type. Optional. This defaults to the simple name of the annotated class.

Default:

""

commandTargetResolver

public abstract String commandTargetResolver

Selects the name of the CommandTargetResolver bean. If left empty, CommandTargetResolver bean from application context will be used. If the bean is not defined in the application context, AnnotationCommandTargetResolver will be used.

Default:

""

filterEventsByType

public abstract boolean filterEventsByType

Sets whether or not to filter events by Aggregate type. This is used to support installations where multiple Aggregate types can have overlapping Aggregate identifiers. This is only meaningful for event-sourced Aggregates.

Default:

false

cache

public abstract String cache

Sets the name of the bean providing the caching. If none is provided, no cache is created, unless explicitly configured on the referenced repository.

Note that the use of repository(), or adding a Repository bean to the Spring context with the default naming scheme overrides this setting, as a Repository may explicitly define the cache. The default name corresponds to "[aggregate-name]Repository", thus a Trade Aggregate would by default create/look for a bean named "tradeRepository".

Default:

""

lockFactory

public abstract String lockFactory

Sets the name of the bean providing the LockFactory. If none is provided, the Repository implementation's default is used, unless explicitly configured on the referenced repository.

Note that the use of repository(), or adding a Repository bean to the Spring context with the default naming scheme overrides this setting, as a Repository explicitly defines the lock factory. The default name corresponds to "[aggregate-name]Repository", thus a Trade Aggregate would by default create/look for a bean named "tradeRepository".

Default:

""