org.axonframework.commandhandling.model

Class AggregateLifecycle

java.lang.Object

org.axonframework.commandhandling.model.AggregateLifecycle

Direct Known Subclasses:

AnnotatedAggregate, StubAggregateLifecycle

public abstract class AggregateLifecycle
extends Object

Abstract base class of a component that models an aggregate's life cycle.

Constructor Summary

Constructors

Constructor and Description
AggregateLifecycle()

Method Summary

Modifier and Type	Method and Description
static ApplyMore	apply(Object payload) Apply a DomainEventMessage with given payload without metadata (though interceptors can also be used to provide metadata).
static ApplyMore	apply(Object payload, MetaData metaData) Apply a DomainEventMessage with given payload and metadata (metadata from interceptors will be combined with the provided metadata).
protected abstract <T> ApplyMore	doApply(T payload, MetaData metaData) Apply a DomainEventMessage with given payload and metadata (metadata from interceptors will be combined with the provided metadata).
protected abstract void	doMarkDeleted() Marks this aggregate as deleted.
protected void	execute(Runnable task) Executes the given task.
protected <V> V	executeWithResult(Callable<V> task) Executes the given task and returns the result of the task.
protected static AggregateLifecycle	getInstance() Returns the AggregateLifecycle for the current aggregate.
protected abstract boolean	getIsLive() Indicates whether this Aggregate instance is 'live'.
static boolean	isLive() Indicates whether this Aggregate instance is 'live'.
static void	markDeleted() Marks this aggregate as deleted, instructing a repository to remove that aggregate at an appropriate time.
protected Runnable	registerAsCurrent() Registers the current AggregateLifecycle as the current lifecycle.
protected void	registerWithUnitOfWork() Registers this aggregate with the current unit of work if one is started.

Methods inherited from class java.lang.Object

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

Constructor Detail

AggregateLifecycle

public AggregateLifecycle()

Method Detail

apply

public static ApplyMore apply(Object payload,
                              MetaData metaData)

Apply a DomainEventMessage with given payload and metadata (metadata from interceptors will be combined with the provided metadata). Applying events means they are immediately applied (published) to the aggregate and scheduled for publication to other event handlers.

The event is applied on all entities part of this aggregate. If the event is applied from an event handler of the aggregate and additional events need to be applied that depends on state changes brought about by the first event use the returned ApplyMore instance.

Parameters:

payload - the payload of the event to apply

metaData - any meta-data that must be registered with the Event

Returns:

a gizmo to apply additional events after the given event has been processed by the entire aggregate

See Also:

ApplyMore

apply

public static ApplyMore apply(Object payload)

Apply a DomainEventMessage with given payload without metadata (though interceptors can also be used to provide metadata). Applying events means they are immediately applied (published) to the aggregate and scheduled for publication to other event handlers.

The event is applied on all entities part of this aggregate. If the event is applied from an event handler of the aggregate and additional events need to be applied that depends on state changes brought about by the first event use the returned ApplyMore instance.

Parameters:

payload - the payload of the event to apply

Returns:

a gizmo to apply additional events after the given event has been processed by the entire aggregate

See Also:

ApplyMore

isLive

public static boolean isLive()

Indicates whether this Aggregate instance is 'live'. Events applied to a 'live' Aggregate represent events that are currently happening, as opposed to events representing historic decisions used to reconstruct the Aggregate's state.

Returns:

true if the aggregate is 'live', false if the aggregate is initializing state based on historic events

markDeleted

public static void markDeleted()

Marks this aggregate as deleted, instructing a repository to remove that aggregate at an appropriate time.

Note that different repository implementations may react differently to aggregates marked for deletion. Typically, Event Sourced Repositories will ignore the marking and expect deletion to be provided as part of Event information.

getInstance

protected static AggregateLifecycle getInstance()

Returns the AggregateLifecycle for the current aggregate. If none was defined this method will throw an exception.

Returns:

the AggregateLifecycle for the current aggregate

getIsLive

protected abstract boolean getIsLive()

Indicates whether this Aggregate instance is 'live'. This means events currently applied represent events that are currently happening, as opposed to events representing historic decisions.

Returns:

true if the aggregate is 'live', false if the aggregate is initializing state based on historic events

doMarkDeleted

protected abstract void doMarkDeleted()

Marks this aggregate as deleted. Implementations may react differently to aggregates marked for deletion. Typically, Event Sourced Repositories will ignore the marking and expect deletion to be provided as part of Event information.

registerWithUnitOfWork

protected void registerWithUnitOfWork()

Registers this aggregate with the current unit of work if one is started.

doApply

protected abstract <T> ApplyMore doApply(T payload,
                                         MetaData metaData)

Apply a DomainEventMessage with given payload and metadata (metadata from interceptors will be combined with the provided metadata). The event should be applied to the aggregate immediately and scheduled for publication to other event handlers.

The event should be applied on all entities part of this aggregate. If the event is applied from an event handler of the aggregate and additional events need to be applied that depends on state changes brought about by the first event the returned ApplyMore instance should allow for additional events to be applied after this event.

Parameters:

payload - the payload of the event to apply

metaData - any meta-data that must be registered with the Event

Returns:

a gizmo to apply additional events after the given event has been processed by the entire aggregate

See Also:

ApplyMore

executeWithResult

protected <V> V executeWithResult(Callable<V> task)
                           throws Exception

Executes the given task and returns the result of the task. While the task is being executed the current aggregate will be registered with the current thread as the 'current' aggregate.

Type Parameters:

V - the result of the task

Parameters:

task - the task to execute on the aggregate

Returns:

the task's result

Throws:

Exception - if executing the task causes an exception

registerAsCurrent

protected Runnable registerAsCurrent()

Registers the current AggregateLifecycle as the current lifecycle. The returned Runnable should be executed to restore the lifecycle to the previous state.

Returns:

a runnable that must be executed to return the lifecycle to the original state

execute

protected void execute(Runnable task)

Executes the given task. While the task is being executed the current aggregate will be registered with the current thread as the 'current' aggregate.

Parameters:

task - the task to execute on the aggregate