Package org.axonframework.messaging.core.unitofwork

Interface ProcessingLifecycle

All Known Subinterfaces:

ProcessingContext

All Known Implementing Classes:

LegacyMessageSupportingContext, ResourceOverridingProcessingContext, UnitOfWork

public interface ProcessingLifecycle

Interface dedicate to managing the lifecycle of any process.

Throughout the lifecycle of any process, actions need to be taken in different phases. Numerous default phases are defined that are used throughout the framework for these actions. The ProcessingLifecycle has shorthand operations corresponding to these DefaultPhases. For example, the onPreInvocation(Function) uses the ProcessingLifecycle.DefaultPhases.PRE_INVOCATION phase.

When the ProcessingLifecycle is started, the phases are invoked beginning with the lowest ProcessingLifecycle.Phase.order(), moving up until all phase actions are executed. Note that actions registered in a Phase with the same order may be executed in parallel.

If necessary, a custom ProcessingLifecycle.Phase can be defined that can be invoked before or after any other Phase. To ensure it is invoked before/after one of the DefaultPhases, set the ProcessingLifecycle.Phase.order() to a value higher/lower than the DefaultPhase you want the step to occur before or after.

Since:

5.0.0

Author:

Allard Buijze, Gerard Klijs, Milan Savić, Mitchell Herrijgers, Sara Pellegrini, Steven van Beelen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ProcessingLifecycle.DefaultPhases	Default phases used for the shorthand methods in the ProcessingLifecycle.
static interface	ProcessingLifecycle.ErrorHandler	Functional interface describing an operation that's invoked when an error is detected within the ProcessingLifecycle.
static interface	ProcessingLifecycle.Phase	Interface describing a possible phase for the ProcessingLifecycle to perform steps in.

Method Summary

Modifier and Type	Method	Description
default ProcessingLifecycle	doFinally(Consumer<ProcessingContext> action)	Registers the provided action to be executed on error of and when completing this ProcessingLifecycle.
boolean	isCommitted()	Returns true when this ProcessingLifecycle is committed, false otherwise.
boolean	isCompleted()	Returns true when this ProcessingLifecycle is completed, false otherwise.
boolean	isError()	Returns true when this ProcessingLifecycle is in error, false otherwise.
boolean	isStarted()	Returns true when this ProcessingLifecycle is started, false otherwise.
ProcessingLifecycle	on(ProcessingLifecycle.Phase phase, Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the given phase.
default ProcessingLifecycle	onAfterCommit(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the after commit phase.
default ProcessingLifecycle	onCommit(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the commit phase.
ProcessingLifecycle	onError(ProcessingLifecycle.ErrorHandler action)	Registers the provided action to be executed when this ProcessingLifecycle encounters an error during the action of any ProcessingLifecycle.Phase.
default ProcessingLifecycle	onInvocation(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the invocation phase.
default ProcessingLifecycle	onPostInvocation(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the post invocation phase.
default ProcessingLifecycle	onPreInvocation(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the pre-invocation phase.
default ProcessingLifecycle	onPrepareCommit(Function<ProcessingContext,CompletableFuture<?>> action)	Registers the provided action to be executed in the prepare commit phase.
default ProcessingLifecycle	runOn(ProcessingLifecycle.Phase phase, Consumer<ProcessingContext> action)	Registers the provided action to be executed in the given phase.
default ProcessingLifecycle	runOnAfterCommit(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the after commit phase.
default ProcessingLifecycle	runOnCommit(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the commit phase.
default ProcessingLifecycle	runOnInvocation(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the invocation phase.
default ProcessingLifecycle	runOnPostInvocation(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the post invocation phase.
default ProcessingLifecycle	runOnPreInvocation(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the pre-invocation phase.
default ProcessingLifecycle	runOnPrepareCommit(Consumer<ProcessingContext> action)	Registers the provided action to be executed in the prepare commit phase.
ProcessingLifecycle	whenComplete(Consumer<ProcessingContext> action)	Registers the provided action to be executed when this ProcessingLifecycle completes all registered actions.

Method Details

isStarted

boolean isStarted()

Returns true when this ProcessingLifecycle is started, false otherwise.

Returns:

true when this ProcessingLifecycle is started, false otherwise.

isError

boolean isError()

Returns true when this ProcessingLifecycle is in error, false otherwise.

When true, the registered ErrorHandlers will be invoked.

Returns:

true when this ProcessingLifecycle is in error, false otherwise.

isCommitted

boolean isCommitted()

Returns true when this ProcessingLifecycle is committed, false otherwise.

Returns:

true when this ProcessingLifecycle is committed, false otherwise.

isCompleted

boolean isCompleted()

Returns true when this ProcessingLifecycle is completed, false otherwise.

Note that this ProcessingLifecycle is marked as completed for a successful and failed completion.

Returns:

true when this ProcessingLifecycle is completed, false otherwise.

on

ProcessingLifecycle on(@Nonnull
 ProcessingLifecycle.Phase phase,
 @Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the given phase. Uses the CompletableFuture returned by the action to compose actions and to carry the action's result.

Use this operation when the return value of the action is important.

Parameters:

phase - The ProcessingLifecycle.Phase to execute the given action in.

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOn

default ProcessingLifecycle runOn(@Nonnull
 ProcessingLifecycle.Phase phase,
 @Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the given phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

phase - The ProcessingLifecycle.Phase to execute the given action in.

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onPreInvocation

default ProcessingLifecycle onPreInvocation(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the pre-invocation phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnPreInvocation

default ProcessingLifecycle runOnPreInvocation(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the pre-invocation phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onInvocation

default ProcessingLifecycle onInvocation(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the invocation phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnInvocation

default ProcessingLifecycle runOnInvocation(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the invocation phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onPostInvocation

default ProcessingLifecycle onPostInvocation(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the post invocation phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnPostInvocation

default ProcessingLifecycle runOnPostInvocation(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the post invocation phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onPrepareCommit

default ProcessingLifecycle onPrepareCommit(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the prepare commit phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnPrepareCommit

default ProcessingLifecycle runOnPrepareCommit(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the prepare commit phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onCommit

default ProcessingLifecycle onCommit(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the commit phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnCommit

default ProcessingLifecycle runOnCommit(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the commit phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onAfterCommit

default ProcessingLifecycle onAfterCommit(@Nonnull
 Function<ProcessingContext,CompletableFuture<?>> action)

Registers the provided action to be executed in the after commit phase.

Use this operation when the return value of the action is important.

Parameters:

action - The Function that's given the active ProcessingContext and returns a CompletableFuture for chaining purposes and to carry the action's result.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

runOnAfterCommit

default ProcessingLifecycle runOnAfterCommit(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed in the after commit phase.

Use this operation when there is no need for a return value of the registered action.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

onError

ProcessingLifecycle onError(@Nonnull
 ProcessingLifecycle.ErrorHandler action)

Registers the provided action to be executed when this ProcessingLifecycle encounters an error during the action of any ProcessingLifecycle.Phase. This includes failures from actions registered through whenComplete(Consumer).

When the given ErrorHandlers are invoked isError() and isCompleted() will return true.

Parameters:

action - The error handler to execute when this ProcessingLifecycle encounters an error during phase execution.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

whenComplete

ProcessingLifecycle whenComplete(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed when this ProcessingLifecycle completes all registered actions.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.

doFinally

default ProcessingLifecycle doFinally(@Nonnull
 Consumer<ProcessingContext> action)

Registers the provided action to be executed on error of and when completing this ProcessingLifecycle.

Note that if the given action throws an exception when completing this ProcessingLifecycle it will be invoked again as an on ProcessingLifecycle.ErrorHandler.

Parameters:

action - A Consumer that's given the active ProcessingContext to perform its action.

Returns:

This ProcessingLifecycle instance for fluent interfacing.