org.eclipse.microprofile.lra.annotation

Annotation Type LRA

@Inherited
 @Retention(value=RUNTIME)
 @Target(value={TYPE,METHOD})
public @interface LRA

An annotation for controlling the lifecycle of Long Running Actions (LRAs). Newly created LRAs are uniquely identified and the id is referred to as the LRA context. The context is passed around using a JAX-RS request/response header called LRAClient.LRA_HTTP_HEADER. The implementation (of the LRA specification) is expected to manage this context and the application developer is expected to declaratively control the creation, propagation and destruction of LRAs using the @LRA annotation. When a JAX-RS bean method is invoked in the context of an LRA any JAX-RS client requests that it performs will carry the same header so that the receiving resource knows that it is inside an LRA context (typically achieved using JAX-RS client filters). Resource methods can access the context id, if required, by injecting it via the JAX-RS @HeaderParam annotation. This may be useful, for example, for associating business work with an LRA.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
javax.ws.rs.core.Response.Status[]	cancelOn The cancelOn element can be set to indicate which HTTP response codes will cause the LRA to cancel
javax.ws.rs.core.Response.Status.Family[]	cancelOnFamily The cancelOnFamily element can be set to indicate which families of HTTP response codes will cause the LRA to cancel.
boolean	delayClose Some annotations (such as REQUIRES_NEW) will start an LRA on entry to a method and end it on exit.
boolean	join If true then the annotated class will be checked for participant annotations and when present the class will be enlisted with any LRA that is associated with the invocation
boolean	terminal Normally if an LRA is present when a bean method is executed it will not be ended when the method returns.
LRA.Type	value The Type element of the LRA annotation indicates whether a bean method is to be executed within a compensatable LRA context.

Element Detail

value

public abstract LRA.Type value

The Type element of the LRA annotation indicates whether a bean method is to be executed within a compensatable LRA context.

Returns:

whether a bean method is to be executed within a transaction context.

Default:

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

delayClose

public abstract boolean delayClose

Some annotations (such as REQUIRES_NEW) will start an LRA on entry to a method and end it on exit. For some business activities it is desirable for the action to survive method execution and be completed elsewhere.

Returns:

whether or not newly created LRAs will survive after the method has finished executing.

Default:

false

terminal

public abstract boolean terminal

Normally if an LRA is present when a bean method is executed it will not be ended when the method returns. To override this behaviour and force LRA termination on exit use the terminal element

Returns:

true if an LRA that was present before method execution will be terminated when the bean method finishes.

Default:

false

join

public abstract boolean join

If true then the annotated class will be checked for participant annotations and when present the class will be enlisted with any LRA that is associated with the invocation

Returns:

whether or not to automatically enlist a participant

Default:

true

cancelOnFamily

public abstract javax.ws.rs.core.Response.Status.Family[] cancelOnFamily

The cancelOnFamily element can be set to indicate which families of HTTP response codes will cause the LRA to cancel. By default client errors (4xx codes) and server errors (5xx codes) will result in cancellation of the LRA.

Returns:

the Response.Status.Family families that will cause cancellation of the LRA

Default:

{}

cancelOn

public abstract javax.ws.rs.core.Response.Status[] cancelOn

The cancelOn element can be set to indicate which HTTP response codes will cause the LRA to cancel

Returns:

the Response.Status HTTP status codes that will cause cancellation of the LRA

Default:

{}