Package org.apache.camel.processor.saga

Enum Class SagaPropagation

java.lang.Object

java.lang.Enum<SagaPropagation>

org.apache.camel.processor.saga.SagaPropagation

All Implemented Interfaces:

Serializable, Comparable<SagaPropagation>, Constable

public enum SagaPropagation
extends Enum<SagaPropagation>

Enumerates all saga propagation modes.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MANDATORY	A saga must be already present.
NEVER	The current block must never be invoked within a saga.
NOT_SUPPORTED	If a saga already exists, it is suspended and resumed when the current block completes.
REQUIRED	Join the existing saga or create a new one if it does not exist.
REQUIRES_NEW	Always create a new saga.
SUPPORTS	If a saga already exists, then join it.

Method Summary

Modifier and Type	Method	Description
static SagaPropagation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SagaPropagation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REQUIRED

public static final SagaPropagation REQUIRED

Join the existing saga or create a new one if it does not exist.

REQUIRES_NEW

public static final SagaPropagation REQUIRES_NEW

Always create a new saga. Suspend the old saga and resume it when the new one terminates.

MANDATORY

public static final SagaPropagation MANDATORY

A saga must be already present. The existing saga is joined.

SUPPORTS

public static final SagaPropagation SUPPORTS

If a saga already exists, then join it.

NOT_SUPPORTED

public static final SagaPropagation NOT_SUPPORTED

If a saga already exists, it is suspended and resumed when the current block completes.

NEVER

public static final SagaPropagation NEVER

The current block must never be invoked within a saga.

Method Details

values

public static SagaPropagation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SagaPropagation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null