Skip navigation links

MicroProfile LRA API v1.0
A B C F L O P S V 

A

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

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(Object) - 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
 
compensating() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
 
compensating(Object) - 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
 
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(Object) - 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
 
completing() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
 
completing(Object) - 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
 

F

failedToCompensate() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
 
failedToCompensate(Object) - 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
 
failedToComplete() - Static method in class org.eclipse.microprofile.lra.LRAResponse.Builder
 
failedToComplete(Object) - 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
 
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.Type - Enum in org.eclipse.microprofile.lra.annotation.ws.rs
 
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.
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.

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.

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.

V

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 F L O P S V 
Skip navigation links

MicroProfile LRA API v1.0

Copyright © 2018 – 2021 Eclipse Foundation. All rights reserved.
Use is subject to license terms.