Skip navigation links
C D F G I J L N O R S T U V 

C

cancelLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Attempt to cancel an LRA Trigger compensation of all participants enlisted with the LRA (ie the compensate message will be sent to each participant).
close() - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Explicitly dispose of all resources.
closeLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Attempt to close an LRA Tells the LRA to close normally.
Compensate - Annotation Type in org.eclipse.microprofile.lra.annotation
When a bean method executes in the context of an LRA any methods in the bean class that are annotated with @Compensate will be used as a participant for that LRA.
compensateWork(URL) - Method in interface org.eclipse.microprofile.lra.participant.LRAParticipant
Notifies the participant that the LRA is cancelling
CompensatorStatus - Enum in org.eclipse.microprofile.lra.annotation
The status of a participant.
Complete - Annotation Type in org.eclipse.microprofile.lra.annotation
When a bean method executes in the context of an LRA any methods in the bean class that are annotated with @Complete will be used as a participant for that LRA.
completeWork(URL) - Method in interface org.eclipse.microprofile.lra.participant.LRAParticipant
Notifies the participant that the LRA is closing
connectTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Set the connect timeout for subsequent client requests.

D

deserialize(URL, byte[]) - Method in interface org.eclipse.microprofile.lra.participant.LRAParticipantDeserializer
Ask the deserializer to recreate a participant from its persistent state If the deserializer does not know how to convert the recoveryState into a suitable object it should return null

F

Forget - Annotation Type in org.eclipse.microprofile.lra.annotation
If a participant is unable to compensate it must remember the fact (by reporting it when asked for its' Status) until it is explicitly told to forget.

G

GenericLRAException - Exception in org.eclipse.microprofile.lra.client
 
GenericLRAException(URL, int, String, Throwable) - Constructor for exception org.eclipse.microprofile.lra.client.GenericLRAException
 
getActiveLRAs() - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Lookup active LRAs
getAllLRAs() - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Returns all (both active and recovering) LRAs
getClientId() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
getCurrent() - Method in interface org.eclipse.microprofile.lra.client.LRAClient
checks whether there is an LRA associated with the calling thread (this method provides an alternative to relying on the presence of the LRAClient.LRA_HTTP_HEADER HTTP header fields since not all users of the API are being called in the context of JAX-RS resource requests).
getFinishTime() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
Report the time in milliseconds when this LRA was asked to finish.
getLraId() - Method in exception org.eclipse.microprofile.lra.client.GenericLRAException
 
getLraId() - Method in exception org.eclipse.microprofile.lra.client.IllegalLRAStateException
 
getLraId() - Method in exception org.eclipse.microprofile.lra.client.InvalidLRAIdException
 
getLraId() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
getLraId() - Method in exception org.eclipse.microprofile.lra.participant.JoinLRAException
 
getLRAInfo(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Return detailed information corresponding to an LRA id
getOperation() - Method in exception org.eclipse.microprofile.lra.client.IllegalLRAStateException
 
getRecoveringLRAs() - Method in interface org.eclipse.microprofile.lra.client.LRAClient
List recovering Long Running Actions
getStartTime() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
report the time in milliseconds when this LRA was started.
getStatus(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Lookup the status of an LRA
getStatus() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
The current status of this LRA.
getStatusCode() - Method in exception org.eclipse.microprofile.lra.client.GenericLRAException
 
getStatusCode() - Method in exception org.eclipse.microprofile.lra.participant.JoinLRAException
 
getTimeNow() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
report the time in milliseconds when the client requested this data
getZoneOffset() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
time-zone offset from Greenwich/UTC that the start, finish and current times are being reported from

I

IllegalLRAStateException - Exception in org.eclipse.microprofile.lra.client
 
IllegalLRAStateException(String, String, String) - Constructor for exception org.eclipse.microprofile.lra.client.IllegalLRAStateException
Creation of LRA state exception.
InvalidLRAIdException - Exception in org.eclipse.microprofile.lra.client
 
InvalidLRAIdException(String, String, Throwable) - Constructor for exception org.eclipse.microprofile.lra.client.InvalidLRAIdException
Invalid LRA id exception.
isActive() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
isActiveLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Indicates whether an LRA is active.
isCompensated() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
isCompensatedLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Indicates whether an LRA was compensated.
isComplete() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
isCompletedLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Indicates whether an LRA is complete.
isRecovering() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 
isTopLevel() - Method in interface org.eclipse.microprofile.lra.client.LRAInfo
 

J

joinLRA(URL, Long, URL, URL, URL, URL, URL, String) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
A participant can join with the LRA at any time prior to the completion of an activity.
joinLRA(URL, Class<?>, URI, String) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Join an LRA passing in a class that will act as the participant.
joinLRA(LRAParticipant, URL, Long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.participant.LRAManagement
Join an existing LRA.
joinLRA(LRAParticipant, URL) - Method in interface org.eclipse.microprofile.lra.participant.LRAManagement
Join an existing LRA.
JoinLRAException - Exception in org.eclipse.microprofile.lra.participant
An exception used to report failures during enlistment of a participant in an LRA
JoinLRAException(URL, int, String, Throwable) - Constructor for exception org.eclipse.microprofile.lra.participant.JoinLRAException
 

L

Leave - Annotation Type in org.eclipse.microprofile.lra.annotation
If a JAX-RS resource method is invoked in the context of an LRA and there are participant annotations on the class it will join the LRA (as a participant).
leaveLRA(URL, String) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
A Compensator can resign from the LRA at any time prior to the completion of an activity
LRA - Annotation Type in org.eclipse.microprofile.lra.annotation
An annotation for controlling the lifecycle of Long Running Actions (LRAs).
LRA.Type - Enum in org.eclipse.microprofile.lra.annotation
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:
LRA_COORDINATOR_HOST_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which host a coordinator is running on
LRA_COORDINATOR_PATH_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which JAX-RS path a coordinator is running on
LRA_COORDINATOR_PORT_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which port a coordinator is running on
LRA_HTTP_HEADER - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
the name of the HTTP header field that contains the LRA id associated with a request/response
LRA_HTTP_RECOVERY_HEADER - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
the name of the HTTP header field that contains a recovery URL corresponding to a participant enlistment in an LRA LRAClient.updateCompensator(java.net.URL, java.net.URL, java.net.URL, java.net.URL, java.net.URL, java.lang.String)
LRA_RECOVERY_HOST_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which JAX-RS path a recovery coordinator is running on
LRA_RECOVERY_PATH_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which JAX-RS path a recovery coordinator is running on
LRA_RECOVERY_PORT_KEY - Static variable in interface org.eclipse.microprofile.lra.client.LRAClient
Key for looking up the config property that specifies which JAX-RS path a recovery coordinator is running on
LRAClient - Interface in org.eclipse.microprofile.lra.client
 
LRAInfo - Interface in org.eclipse.microprofile.lra.client
Data object carrying information about an instance of LRA (specified by lra id) and it's status.
LRAManagement - Interface in org.eclipse.microprofile.lra.participant
 
LRAParticipant - Interface in org.eclipse.microprofile.lra.participant
The API for notifying participants that a LRA is completing or cancelling.
LRAParticipantDeserializer - Interface in org.eclipse.microprofile.lra.participant
 

N

NestedLRA - Annotation Type in org.eclipse.microprofile.lra.annotation
Used on the interface or class.

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.client - package org.eclipse.microprofile.lra.client
 
org.eclipse.microprofile.lra.participant - package org.eclipse.microprofile.lra.participant
 

R

readTimeout(long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Set the read timeout for subsequent client requests.
registerDeserializer(LRAParticipantDeserializer) - Method in interface org.eclipse.microprofile.lra.participant.LRAManagement
Register an object for recreating participants during recovery.
renewTimeLimit(URL, long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
LRAs can be created with timeouts after which they are cancelled.

S

setCoordinatorURI(URI) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Set the endpoint on which the coordinator is available
setCurrentLRA(URL) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Update the clients notion of the current coordinator.
setRecoveryCoordinatorURI(URI) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Set the endpoint on which the recovery coordinator is available
startLRA(URL, String, Long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Start a new LRA If the LRA was started during a JAX-RS resource method invocation then the id of the new LRA will be made available as the JAX-RS response header LRAClient.LRA_HTTP_HEADER
startLRA(String, Long, TimeUnit) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Start a top level LRA (ie similar to LRAClient.startLRA(URL, String, Long, TimeUnit)
Status - Annotation Type in org.eclipse.microprofile.lra.annotation
In order to support recovery compensators must be able to report their status once the completion part of the protocol starts.

T

TerminationException - Exception in org.eclipse.microprofile.lra.participant
 
TerminationException() - Constructor for exception org.eclipse.microprofile.lra.participant.TerminationException
 
TimeLimit - Annotation Type in org.eclipse.microprofile.lra.annotation
Used on (LRA and Compensate annotations to indicate the maximum time that the LRA or participant should remain active for.

U

unregisterDeserializer(LRAParticipantDeserializer) - Method in interface org.eclipse.microprofile.lra.participant.LRAManagement
Unregister a participant deserializer.
updateCompensator(URL, URL, URL, URL, URL, String) - Method in interface org.eclipse.microprofile.lra.client.LRAClient
Change the endpoints that a participant can be contacted on.

V

valueOf(String) - Static method in enum org.eclipse.microprofile.lra.annotation.CompensatorStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.eclipse.microprofile.lra.annotation.LRA.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.eclipse.microprofile.lra.annotation.CompensatorStatus
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.LRA.Type
Returns an array containing the constants of this enum type, in the order they are declared.
C D F G I J L N O R S T U V 
Skip navigation links

Copyright © 2018 Eclipse Foundation. All rights reserved.