org.eclipse.microprofile.lra.annotation

Enum LRA.Type

java.lang.Object

java.lang.Enum<LRA.Type>

org.eclipse.microprofile.lra.annotation.LRA.Type

All Implemented Interfaces:

Serializable, Comparable<LRA.Type>

Enclosing class:

LRA

public static enum LRA.Type
extends Enum<LRA.Type>

The Type element of the annotation indicates whether a bean method is to be executed within a compensatable transaction (aka LRA) context where the values provide the following behaviors:

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANDATORY If called outside a transaction context, the method call will return with a 412 Precondition Failed HTTP status code If called inside a transaction context the bean method execution will then continue within that context.
NEVER If called outside a LRA context the managed bean method execution must then continue outside a LRA context.
NOT_SUPPORTED The bean method is executed without a LRA context.
REQUIRED If called outside a LRA context a JAX-RS filter will begin a new LRA for the duration of the method call and when the call completes another JAX-RS filter will complete the LRA.
REQUIRES_NEW If called outside a LRA context a JAX-RS filter will begin a new LRA for the duration of the method call and when the call completes another JAX-RS filter will complete the LRA.
SUPPORTS If called outside a LRA context the bean method execution must then continue outside a LRA context.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

REQUIRED

public static final LRA.Type REQUIRED

If called outside a LRA context a JAX-RS filter will begin a new LRA for the duration of the method call and when the call completes another JAX-RS filter will complete the LRA.

REQUIRES_NEW

public static final LRA.Type REQUIRES_NEW

If called outside a LRA context a JAX-RS filter will begin a new LRA for the duration of the method call and when the call completes another JAX-RS filter will complete the LRA. If called inside a LRA context a JAX-RS filter will suspend it and begin a new LRA for the duration of the method call and when the call completes another JAX-RS filter will complete the LRA and resume the one that was active on entry to the method.

MANDATORY

public static final LRA.Type MANDATORY

If called outside a transaction context, the method call will return with a 412 Precondition Failed HTTP status code If called inside a transaction context the bean method execution will then continue within that context.

SUPPORTS

public static final LRA.Type SUPPORTS

If called outside a LRA context the bean method execution must then continue outside a LRA context. If called inside a LRA context the managed bean method execution must then continue inside this LRA context.

NOT_SUPPORTED

public static final LRA.Type NOT_SUPPORTED

The bean method is executed without a LRA context. If a context is present on entry then it is suspended and then resumed after the execution has completed.

NEVER

public static final LRA.Type NEVER

If called outside a LRA context the managed bean method execution must then continue outside a LRA context. If called inside a LRA context the method is not executed and a 412 Precondition Failed HTTP status code is returned to the caller.

Method Detail

values

public static LRA.Type[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (LRA.Type c : LRA.Type.values())
    System.out.println(c);

Returns:

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

valueOf

public static LRA.Type valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null