Package org.axonframework.modelling.saga

@NullMarked package org.axonframework.modelling.saga

Association values, the means by which an event is correlated to the saga instances that should handle it.

An AssociationValue is a key-value pair that a saga registers itself under; AssociationValues tracks a saga's current set together with the additions and removals made since it was last stored, which is what a SagaStore persists.

These types carry the Axon Framework 4 API unchanged, to ease migration of projects that cannot move off it in one go.

Related Packages

Package	Description
org.axonframework.modelling	Root package for Axon Modelling.
org.axonframework.modelling.saga.metamodel	Meta-model support for describing the structure and event handling capabilities of Axon Framework 4 style annotated Sagas.
org.axonframework.modelling.saga.repository	The SagaStore abstraction and the decorators over it.

Class	Description
AbstractSagaManager<T>	Abstract implementation of the SagaManager interface that provides basic functionality required by most SagaManager implementations.
AbstractSagaManager.Builder<T>	Abstract Builder class to instantiate AbstractSagaManager implementations.
AnnotatedSaga<T>	Implementation of the interface that allows for a POJO instance with annotated message handlers to act as a Saga.
AnnotatedSagaManager<T>	Implementation of the SagaManager that uses annotations on the Sagas to describe the lifecycle management.
AnnotatedSagaManager.Builder<T>	Builder class to instantiate a AnnotatedSagaManager.
AssociationResolver	Used to derive the value of an association property as designated by the association property name.
AssociationValue	A combination of key and value by which a Saga can be found.
AssociationValues	Interface describing a container of Association Values for a single saga instance.
AssociationValuesImpl	Default implementation of the AssociationValues interface.
EndSaga	Indicates that the annotated SagaEventHandler method indicates the end of a Saga instance's lifecycle.
EndSagaMessageHandlerDefinition	A HandlerEnhancerDefinition inspecting the existence of the EndSaga annotation on MessageHandlingMembers.
EndSagaMessageHandlerDefinition.EndSageMessageHandlingMember<T>	A WrappedMessageHandlingMember implementation dedicated towards MessageHandlingMembers annotated with EndSaga.
MetadataAssociationResolver	Used to derive the value of an association property by looking it up the event message's Metadata.
PayloadAssociationResolver	Used to derive the value of an association property by looking it up the event message's payload.
Saga<T>	Interface describing an implementation of a Saga.
SagaCreationPolicy	Enumeration containing the possible Creation Policies for Sagas.
SagaEventHandler	Method-level annotation indicating that the annotated method is an event handler method for the saga instance.
SagaExecutionException	Exception triggered by a saga while it is processing an event or processing a task.
SagaInitializationPolicy	Describes the conditions under which a Saga should be created, and which AssociationValue it should be initialized with.
SagaInstantiationException	Exception triggered during initialization of a Saga.
SagaLifecycle	Component giving a Saga's event handler methods access to lifecycle operations, such as managing AssociationValues and ending the Saga.
SagaLifecycleParameterResolverFactory	ParameterResolverFactory that resolves the SagaLifecycle registered on the ProcessingContext for any @SagaEventHandler method that declares a SagaLifecycle-typed parameter.
SagaMethodMessageHandlerDefinition	Utility class that inspects annotation on a Saga instance and returns the relevant configuration for its Event Handlers.
SagaMethodMessageHandlingMember<T>	A data holder containing information of SagaEventHandler annotated methods.
SagaRepository<T>	Interface towards the storage mechanism of Saga instances.
SagaScopeDescriptor	Describes the scope of a Saga by means of its type and identifier.
SagaStorageException	Exception indicating that an error has occurred while storing a Saga.
StartSaga	Deprecated, for removal: This API element is subject to removal in a future version. The axon-legacy module exists to let already-running Axon Framework 4 Sagas drain out, not to start new ones.