org.axonframework.modelling.saga

Class AnnotatedSaga<T>

java.lang.Object

org.axonframework.messaging.Scope

org.axonframework.modelling.saga.SagaLifecycle

org.axonframework.modelling.saga.AnnotatedSaga<T>

All Implemented Interfaces:

EventMessageHandler, MessageHandler<EventMessage<?>>, Saga<T>

public class AnnotatedSaga<T>
extends SagaLifecycle
implements Saga<T>

Implementation of the interface that allows for a POJO instance with annotated message handlers to act as a Saga. The POJO instance can access static methods on SagaLifecycle as long as it is access via the execute(Consumer) or invoke(Function) methods.

Since:

3.0

Author:

Allard Buijze

Constructor Summary

Constructors

Constructor and Description
AnnotatedSaga(String sagaId, Set<AssociationValue> associationValues, T annotatedSaga, SagaModel<T> metaModel) Creates an AnnotatedSaga instance to wrap the given annotatedSaga, identifier with the given sagaId and associated with the given associationValues.

Method Summary

Modifier and Type	Method and Description
boolean	canHandle(EventMessage<?> event) Indicates whether this handler can handle the given message
protected void	doAssociateWith(AssociationValue property) Registers a AssociationValue with the given saga.
protected void	doEnd() Marks the saga as ended.
protected void	doRemoveAssociation(AssociationValue property) Removes the given association from this Saga.
void	execute(Consumer<T> invocation) Execute the given invocation against the root object of this Saga instance.
AssociationValues	getAssociationValues() Returns a view on the Association Values for this saga instance.
String	getSagaIdentifier() Retrieve a String denoting the identifier of this Saga.
Object	handle(EventMessage<?> event) Process the given event.
<R> R	invoke(Function<T,R> invocation) Execute the given invocation against the root object of this Saga instance.
boolean	isActive() Indicates whether or not this saga is active.
T	root() Returns the (annotated) Saga instance.
protected String	type() Retrieve a String denoting the type of this Saga.

Methods inherited from class org.axonframework.modelling.saga.SagaLifecycle

associateWith, associateWith, associateWith, describeScope, end, execute, getInstance, removeAssociationWith, removeAssociationWith

Methods inherited from class org.axonframework.messaging.Scope

describeCurrentScope, endScope, executeWithResult, getCurrentScope, startScope

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.modelling.saga.Saga

prepareReset, prepareReset, supportsReset

Methods inherited from interface org.axonframework.messaging.MessageHandler

canHandleType, getTargetType

Constructor Detail

AnnotatedSaga

public AnnotatedSaga(String sagaId,
                     Set<AssociationValue> associationValues,
                     T annotatedSaga,
                     SagaModel<T> metaModel)

Creates an AnnotatedSaga instance to wrap the given annotatedSaga, identifier with the given sagaId and associated with the given associationValues. The metaModel provides the description of the structure of the Saga.

Parameters:

sagaId - The identifier of this Saga instance

associationValues - The current associations of this Saga

annotatedSaga - The object instance representing the Saga

metaModel - The model describing Saga structure

Method Detail

getSagaIdentifier

public String getSagaIdentifier()

Description copied from class: SagaLifecycle

Retrieve a String denoting the identifier of this Saga.

Specified by:

getSagaIdentifier in interface Saga<T>

Specified by:

getSagaIdentifier in class SagaLifecycle

Returns:

a String denoting the identifier of this Saga

getAssociationValues

public AssociationValues getAssociationValues()

Description copied from interface: Saga

Returns a view on the Association Values for this saga instance. The returned instance is mutable.

Specified by:

getAssociationValues in interface Saga<T>

Returns:

a view on the Association Values for this saga instance

invoke

public <R> R invoke(Function<T,R> invocation)

Description copied from interface: Saga

Execute the given invocation against the root object of this Saga instance.

Specified by:

invoke in interface Saga<T>

Type Parameters:

R - The type of return value expected

Parameters:

invocation - the function to invoke. The root object of the Saga is input to the function, the result is the result of the execution.

Returns:

The result of the invocation on the Saga.

execute

public void execute(Consumer<T> invocation)

Description copied from interface: Saga

Execute the given invocation against the root object of this Saga instance.

Specified by:

execute in interface Saga<T>

Parameters:

invocation - the function to invoke. The root object of the Saga is input to the function.

canHandle

public final boolean canHandle(EventMessage<?> event)

Description copied from interface: MessageHandler

Indicates whether this handler can handle the given message

Specified by:

canHandle in interface MessageHandler<EventMessage<?>>

Parameters:

event - The message to verify

Returns:

true if this handler can handle the message, otherwise false

handle

public final Object handle(EventMessage<?> event)

Description copied from interface: EventMessageHandler

Process the given event. The implementation may decide to process or skip the given event. It is highly unrecommended to throw any exception during the event handling process.

Specified by:

handle in interface EventMessageHandler

Specified by:

handle in interface MessageHandler<EventMessage<?>>

Parameters:

event - the event to handle

Returns:

the result of the event handler invocation. Is generally ignored

isActive

public boolean isActive()

Description copied from interface: Saga

Indicates whether or not this saga is active. A Saga is active when its life cycle has not been ended.

Specified by:

isActive in interface Saga<T>

Returns:

true if this saga is active, false otherwise.

root

public T root()

Returns the (annotated) Saga instance. This method should not be used to modify the Saga's state, as it doesn't allow the instance to access the static methods on SagaLifecycle.

Returns:

the Saga instance

doEnd

protected void doEnd()

Marks the saga as ended. Ended saga's may be cleaned up by the repository when they are committed.

Specified by:

doEnd in class SagaLifecycle

doAssociateWith

protected void doAssociateWith(AssociationValue property)

Registers a AssociationValue with the given saga. When the saga is committed, it can be found using the registered property.

Specified by:

doAssociateWith in class SagaLifecycle

Parameters:

property - The value to associate this saga with.

type

protected String type()

Description copied from class: SagaLifecycle

Retrieve a String denoting the type of this Saga.

Specified by:

type in class SagaLifecycle

Returns:

a String denoting the type of this Saga

doRemoveAssociation

protected void doRemoveAssociation(AssociationValue property)

Removes the given association from this Saga. When the saga is committed, it can no longer be found using the given association. If the given property wasn't registered with the saga, nothing happens.

Specified by:

doRemoveAssociation in class SagaLifecycle

Parameters:

property - the association value to remove from the saga.