# Index

A B C E F L M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values

## A

Active - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  The LRA has not yet been asked to Close or Cancel
Active - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant has not yet been asked to Complete or Compensate
AfterLRA - Annotation Type in org.eclipse.microprofile.lra.annotation
  If a JAX-RS resource method is annotated with `LRA` and is invoked in the context of an LRA then the resource can ask to be notified when the LRA finishes by marking one of the other methods in the class with the `@AfterLRA` annotation.

## B

Builder() - Constructor for class org.eclipse.microprofile.lra.LRAResponse.Builder

## C

Cancelled - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  All participants associated with the LRA have successfully compensated for any work they performed when the LRA was active
Cancelling - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  The LRA is currently informing participants that they should compensate for any work they performed when the LRA was active
cancelOn() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  The cancelOn element can be set to indicate which HTTP response codes will cause the current LRA to cancel.
cancelOnFamily() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  The cancelOnFamily element can be set to indicate which families of HTTP response codes will cause the current LRA to cancel.
Closed - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  The LRA successfully told all participants to complete
Closing - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  The LRA is asking all participants to complete
Compensate - Annotation Type in org.eclipse.microprofile.lra.annotation
  If a resource method executes in the context of an LRA and if the containing class has a method annotated with `@Compensate` then this method will be invoked if the LRA is cancelled.
compensated() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
compensated() - Static method in class org.eclipse.microprofile.lra.LRAResponse
compensated(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
compensated(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
Compensated - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant has successfully compensated for any work it performed
compensating() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
compensating() - Static method in class org.eclipse.microprofile.lra.LRAResponse
compensating(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
compensating(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
Compensating - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant is currently compensating for any work it performed
Complete - Annotation Type in org.eclipse.microprofile.lra.annotation
  If a resource method executes in the context of an LRA and if the containing class has a method annotated with `@Complete` (as well as method annotated with `@Compensate`) then this Complete method will be invoked if the LRA is closed.
completed() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
completed() - Static method in class org.eclipse.microprofile.lra.LRAResponse
completed(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
completed(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
Completed - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant has confirmed that is has completed any tidy-up actions
completing() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
completing() - Static method in class org.eclipse.microprofile.lra.LRAResponse
completing(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
completing(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
Completing - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant is tidying up after being told to complete

## E

end() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  If the annotated method runs with an LRA context then this element determines whether or not it is closed when the method returns.

## F

FailedToCancel - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  One or more participants associated with the LRA were not able to compensate for the work they performed when the LRA was active
FailedToClose - Enum constant in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  One or more participants associated with the LRA were not able to complete the work they performed when the LRA was active
failedToCompensate() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
failedToCompensate() - Static method in class org.eclipse.microprofile.lra.LRAResponse
failedToCompensate(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
failedToCompensate(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
FailedToCompensate - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant was not able to compensate for the work it performed (and it must remember it could not compensate until such time that it receives a forget message (`Forget`)
failedToComplete() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
failedToComplete() - Static method in class org.eclipse.microprofile.lra.LRAResponse
failedToComplete(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
failedToComplete(Object) - Static method in class org.eclipse.microprofile.lra.LRAResponse
FailedToComplete - Enum constant in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  The participant was unable to tidy-up
Forget - Annotation Type in org.eclipse.microprofile.lra.annotation
  If a participant is unable to complete or compensate immediately (i.e., it has indicated that the request has been accepted and is in progress) or because of a failure (i.e., will never be able to finish) then it must remember the fact (by reporting it when asked for its `Status`) until explicitly told that it can clean up using this `@Forget` annotation.

## L

Leave - Annotation Type in org.eclipse.microprofile.lra.annotation.ws.rs
  If a resource method is annotated with `@Leave` and is invoked in the context of an LRA and if the bean class has registered a participant with that LRA then it will be removed from the LRA just before the bean method is entered.
LRA - Annotation Type in org.eclipse.microprofile.lra.annotation.ws.rs
  An annotation for controlling the lifecycle of Long Running Actions (LRAs).
LRA_HTTP_CONTEXT_HEADER - Static variable in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  When a JAX-RS invocation is made with an active LRA, it is made available via an HTTP header field with the following name.
LRA_HTTP_ENDED_CONTEXT_HEADER - Static variable in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  The header name holding the LRA context of an LRA that has finished - to be used in conjunction with the `AfterLRA` annotation.
LRA_HTTP_PARENT_CONTEXT_HEADER - Static variable in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  When an implementation of the LRA specification invokes any of the participant callbacks (namely `Compensate`, `Complete`, `Status`, `Forget`, and `AfterLRA`) in the context of a nested LRA it must ensure that the parent LRA is made available via an HTTP header field with the following name.
LRA_HTTP_RECOVERY_HEADER - Static variable in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  the name of the HTTP header field that contains a recovery URI corresponding to a participant enlistment in an LRA.
LRA.Type - Enum in org.eclipse.microprofile.lra.annotation.ws.rs
LRAResponse - Class in org.eclipse.microprofile.lra
  The utility class that will create the correct `Response` or `Response.ResponseBuilder` for the response that should be returned from the LRA JAX-RS methods.
LRAResponse.Builder - Class in org.eclipse.microprofile.lra
LRAStatus - Enum in org.eclipse.microprofile.lra.annotation
  A representation of the status of a Long Running Action according to a LRA state model: The initial state `LRAStatus.Active` is entered when an LRA is created.

## M

MANDATORY - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  If called outside an LRA context the method is not executed and a `412 Precondition Failed` HTTP status code is returned to the caller.

## N

NESTED - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  An LRA (called the child) can be scoped within an existing LRA (called the parent) using the NESTED element value.
NEVER - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  If called outside an LRA context, i.e., `LRA.LRA_HTTP_CONTEXT_HEADER` is not present, the resource method execution must then continue outside an LRA context.
NOT_SUPPORTED - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  The resource method is executed without an LRA context.

## O

org.eclipse.microprofile.lra - package org.eclipse.microprofile.lra
  Microprofile LRA Support.
org.eclipse.microprofile.lra.annotation - package org.eclipse.microprofile.lra.annotation
org.eclipse.microprofile.lra.annotation.ws.rs - package org.eclipse.microprofile.lra.annotation.ws.rs

## P

ParticipantStatus - Enum in org.eclipse.microprofile.lra.annotation
  A representation of the status of a participant according to a participant state model: The initial state `ParticipantStatus.Active` is entered when a participant is first associated with a Long Running Action.

## R

REQUIRED - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  If called outside an LRA context the invoked method will run with a new context.
REQUIRES_NEW - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  If called outside an LRA context the invoked method will run with a new context.

## S

Status - Annotation Type in org.eclipse.microprofile.lra.annotation
  The LRA specification supports distributed communications amongst software components and due to the unreliable nature of networks, messages/requests can be lost, delayed, duplicated, etc., so the implementation component responsible for invoking `Compensate` and `Complete` annotated methods may lose track of the status of a participant.
SUPPORTS - Enum constant in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  If called outside an LRA context the resource method execution must then continue outside an LRA context.

## T

timeLimit() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  If the annotated method runs with an LRA context then this element determines the period for which the LRA will remain valid.
timeUnit() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA

## V

value() - Element in annotation type org.eclipse.microprofile.lra.annotation.ws.rs.LRA
  The `LRA.Type` element of the LRA annotation indicates whether a resource method is to be executed within the context of an LRA.
valueOf(String) - Static method in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.lra.annotation.LRAStatus
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.lra.annotation.ParticipantStatus
  Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.eclipse.microprofile.lra.annotation.ws.rs.LRA.Type
  Returns an array containing the constants of this enum type, in the order they are declared.

A B C E F L M N O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values