Package org.axonframework.extension.spring.stereotype

Annotation Interface EventSourced

@Target({TYPE,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Component
@Scope("prototype")
public @interface EventSourced

Annotation that informs Axon's auto configurer for Spring that a given Component is an event-sourced entity instance.

This annotation is a meta-annotation of EventSourcedEntity allowing to put the configuration directly.

Since:

3.0

Author:

Allard Buijze, Simon Zambrovski

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
Class<?>[]	concreteTypes	If the entity is a polymorphic entity, any subclasses that should be considered concrete types of the entity should be specified here.
Class<? extends CriteriaResolverDefinition>	criteriaResolverDefinition	The definition of the CriteriaResolver to use to resolve the EventCriteria for the entity.
Class<? extends EventSourcedEntityFactoryDefinition>	entityFactoryDefinition	The definition of the EventSourcedEntityFactory to use to create a new instance of the entity.
Class<? extends EntityIdResolverDefinition>	entityIdResolverDefinition	The definition of the EntityIdResolverDefinition to use to resolve the entity id from a command message.
Class<?>	idType	Get the Class of entity's id type, important for construction of the
String	tagKey	The tag name to use when resolving the EventCriteria for the entity.
String	type	Get the String representation of the entity's type.

Element Details

type

String type

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

Returns:

The type of the entity.

Default:

""

idType

Class<?> idType

Get the Class of entity's id type, important for construction of the

Returns:

The class of the entity id.

Default:

java.lang.String.class

tagKey

@AliasFor(annotation=EventSourcedEntity.class,
          attribute="tagKey")
String tagKey

The tag name to use when resolving the EventCriteria for the entity. If empty, the simple name of the entity class will be used.

This value does not take effect if a matching EventCriteriaBuilder is found, or a custom criteriaResolverDefinition() is provided.

Returns:

The tag name to use when resolving the EventCriteria for the entity.

Default:

""

concreteTypes

@AliasFor(annotation=EventSourcedEntity.class,
          attribute="concreteTypes")
Class<?>[] concreteTypes

If the entity is a polymorphic entity, any subclasses that should be considered concrete types of the entity should be specified here. Classes that are not specified here will not be scanned.

Returns:

The concrete types of the entity that should be considered when building the AnnotatedEntityMetamodel.

Default:

{}

criteriaResolverDefinition

@AliasFor(annotation=EventSourcedEntity.class,
          attribute="criteriaResolverDefinition")
Class<? extends CriteriaResolverDefinition> criteriaResolverDefinition

The definition of the CriteriaResolver to use to resolve the EventCriteria for the entity. A custom definition can be provided to override the default behavior of the AnnotationBasedEventCriteriaResolver.

Returns:

The definition to construct a CriteriaResolverDefinition.

Default:

org.axonframework.eventsourcing.annotation.AnnotationBasedEventCriteriaResolverDefinition.class

entityFactoryDefinition

@AliasFor(annotation=EventSourcedEntity.class,
          attribute="entityFactoryDefinition")
Class<? extends EventSourcedEntityFactoryDefinition> entityFactoryDefinition

The definition of the EventSourcedEntityFactory to use to create a new instance of the entity. A custom definition can be provided to override the default behavior of the AnnotationBasedEventSourcedEntityFactoryDefinition.

Returns:

The definition to construct an EventSourcedEntityFactory.

Default:

org.axonframework.eventsourcing.annotation.reflection.AnnotationBasedEventSourcedEntityFactoryDefinition.class

entityIdResolverDefinition

@AliasFor(annotation=EventSourcedEntity.class,
          attribute="entityIdResolverDefinition")
Class<? extends EntityIdResolverDefinition> entityIdResolverDefinition

The definition of the EntityIdResolverDefinition to use to resolve the entity id from a command message. Defaults to the AnnotatedEntityIdResolverDefinition, which resolves the entity id based on the TargetEntityId annotation on a payload field or method, after converting the payload to the representation wanted by the entity.

Returns:

The definition to construct an EntityIdResolverDefinition.

Default:

org.axonframework.modelling.entity.annotation.AnnotatedEntityIdResolverDefinition.class