org.axonframework.commandhandling.disruptor

Class CommandHandlingEntry

java.lang.Object

org.axonframework.messaging.unitofwork.AbstractUnitOfWork<T>

org.axonframework.commandhandling.disruptor.DisruptorUnitOfWork<CommandMessage<?>>

org.axonframework.commandhandling.disruptor.CommandHandlingEntry

All Implemented Interfaces:

UnitOfWork<CommandMessage<?>>

public class CommandHandlingEntry
extends DisruptorUnitOfWork<CommandMessage<?>>

DataHolder for the DisruptorCommandBus. The CommandHandlingEntry maintains all information required for or produced by the command handling process.

Since:

2.0

Author:

Allard Buijze

Nested Class Summary

Nested classes/interfaces inherited from interface org.axonframework.messaging.unitofwork.UnitOfWork

UnitOfWork.Phase

Constructor Summary

Constructors

Constructor and Description
CommandHandlingEntry() Initializes the CommandHandlingEntry

Method Summary

Modifier and Type	Method and Description
String	getAggregateIdentifier() Returns the identifier of the aggregate to recover.
BlacklistDetectingCallback	getCallback() Returns the CommandCallback instance for the executed command.
Exception	getExceptionResult() Returns the exception that occurred while processing the incoming command, or null if processing did not result in an exception or if execution is not yet finished.
InterceptorChain	getInvocationInterceptorChain() Returns the InterceptorChain for the invocation process registered with this entry, or null if none is available.
int	getInvokerId() Returns the Identifier of the invoker that is chosen to handle this entry.
int	getPublisherId() Returns the Identifier of the publisher that is chosen to handle this entry.
InterceptorChain	getPublisherInterceptorChain() Returns the InterceptorChain for the publication process registered with this entry, or null if none is available.
Object	getResult() Returns the result of the command's execution, or null if the command is not yet executed or resulted in an exception.
boolean	isRecoverEntry() Indicates whether this entry is a recovery entry.
void	registerAggregateIdentifier(String aggregateIdentifier) Registers the identifier of the aggregate that will process the next command.
void	reset(CommandMessage<?> newCommand, MessageHandler<? super CommandMessage<?>> newCommandHandler, int newInvokerSegmentId, int newPublisherSegmentId, BlacklistDetectingCallback newCallback, List<MessageHandlerInterceptor<? super CommandMessage<?>>> invokerInterceptors, List<MessageHandlerInterceptor<? super CommandMessage<?>>> publisherInterceptors) Resets this entry, preparing it for use for another command.
void	resetAsCallable(Callable<Object> callable, int newInvokerSegmentId, int newPublisherSegmentId, BlacklistDetectingCallback<Object,Object> newCallback) Resets this entry, preparing it to run given callable from within the invocationInterceptorChain.
void	resetAsRecoverEntry(String newAggregateIdentifier) Resets this entry, preparing it for use as a recovery entry.
void	setExceptionResult(Exception exceptionResult) Registers the exception that occurred while processing the incoming command.
void	setResult(Object result) Registers the result of the command's execution, if successful.

Methods inherited from class org.axonframework.commandhandling.disruptor.DisruptorUnitOfWork

addHandler, executeWithResult, getExecutionResult, getMessage, notifyHandlers, parent, pause, reset, resume, setExecutionResult, setRollbackCause, transformMessage

Methods inherited from class org.axonframework.messaging.unitofwork.AbstractUnitOfWork

afterCommit, changePhase, commit, correlationDataProviders, getCorrelationData, isRolledBack, onCleanup, onCommit, onPrepareCommit, onRollback, phase, registerCorrelationDataProvider, resources, rollback, setPhase, start

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.messaging.unitofwork.UnitOfWork

attachTransaction, execute, execute, executeWithResult, getOrComputeResource, getOrDefaultResource, getResource, isActive, isCurrent, isRoot, rollback, root

Constructor Detail

CommandHandlingEntry

public CommandHandlingEntry()

Initializes the CommandHandlingEntry

Method Detail

getInvocationInterceptorChain

public InterceptorChain getInvocationInterceptorChain()

Returns the InterceptorChain for the invocation process registered with this entry, or null if none is available.

Returns:

the InterceptorChain for the invocation process registered with this entry

getPublisherInterceptorChain

public InterceptorChain getPublisherInterceptorChain()

Returns the InterceptorChain for the publication process registered with this entry, or null if none is available.

Returns:

the InterceptorChain for the publication process registered with this entry

setExceptionResult

public void setExceptionResult(Exception exceptionResult)

Registers the exception that occurred while processing the incoming command.

Parameters:

exceptionResult - the exception that occurred while processing the incoming command

getExceptionResult

public Exception getExceptionResult()

Returns the exception that occurred while processing the incoming command, or null if processing did not result in an exception or if execution is not yet finished.

Returns:

the exception that occurred while processing the incoming command, if any.

setResult

public void setResult(Object result)

Registers the result of the command's execution, if successful.

Parameters:

result - the result of the command's execution, if successful

getResult

public Object getResult()

Returns the result of the command's execution, or null if the command is not yet executed or resulted in an exception.

Returns:

the result of the command's execution, if any

getCallback

public BlacklistDetectingCallback getCallback()

Returns the CommandCallback instance for the executed command.

Returns:

the CommandCallback instance for the executed command

isRecoverEntry

public boolean isRecoverEntry()

Indicates whether this entry is a recovery entry. When true, this entry does not contain any command handling information.

Returns:

true if this entry represents a recovery request, otherwise false.

getAggregateIdentifier

public String getAggregateIdentifier()

Returns the identifier of the aggregate to recover. Returns null when isRecoverEntry() returns false.

Returns:

the identifier of the aggregate to recover

getInvokerId

public int getInvokerId()

Returns the Identifier of the invoker that is chosen to handle this entry.

Returns:

the Identifier of the invoker that is chosen to handle this entry

getPublisherId

public int getPublisherId()

Returns the Identifier of the publisher that is chosen to handle this entry.

Returns:

the Identifier of the publisher that is chosen to handle this entry

reset

public void reset(CommandMessage<?> newCommand,
                  MessageHandler<? super CommandMessage<?>> newCommandHandler,
                  int newInvokerSegmentId,
                  int newPublisherSegmentId,
                  BlacklistDetectingCallback newCallback,
                  List<MessageHandlerInterceptor<? super CommandMessage<?>>> invokerInterceptors,
                  List<MessageHandlerInterceptor<? super CommandMessage<?>>> publisherInterceptors)

Resets this entry, preparing it for use for another command.

Parameters:

newCommand - The new command the entry is used for

newCommandHandler - The Command Handler responsible for handling newCommand

newInvokerSegmentId - The SegmentID of the invoker that should process this entry

newPublisherSegmentId - The SegmentID of the publisher that should process this entry

newCallback - The callback to report the result of command execution to

invokerInterceptors - The interceptors to invoke during the command handler invocation phase

publisherInterceptors - The interceptors to invoke during the publication phase

resetAsRecoverEntry

public void resetAsRecoverEntry(String newAggregateIdentifier)

Resets this entry, preparing it for use as a recovery entry.

Parameters:

newAggregateIdentifier - The identifier of the aggregate to recover

resetAsCallable

public void resetAsCallable(Callable<Object> callable,
                            int newInvokerSegmentId,
                            int newPublisherSegmentId,
                            BlacklistDetectingCallback<Object,Object> newCallback)

Resets this entry, preparing it to run given callable from within the invocationInterceptorChain.

Parameters:

callable - a Callable which performs a task in the invocationInterceptorChain, for example publishing a scheduled DeadlineMessage

newInvokerSegmentId - The SegmentId of the invoker that should process this entry

newPublisherSegmentId - The SegmentId of the publisher that should process this entry

newCallback - The callback to report the result of command execution to

registerAggregateIdentifier

public void registerAggregateIdentifier(String aggregateIdentifier)

Registers the identifier of the aggregate that will process the next command.

Parameters:

aggregateIdentifier - identifier of the aggregate that will handle the command