org.eclipse.microprofile.lra.participant

Interface LRAManagement

@ApplicationScoped
public interface LRAManagement

Method Summary

Modifier and Type	Method and Description
String	joinLRA(LRAParticipant participant, URL lraId) Join an existing LRA.
String	joinLRA(LRAParticipant participant, URL lraId, Long timeLimit, TimeUnit unit) Join an existing LRA.
void	registerDeserializer(LRAParticipantDeserializer deserializer) Register an object for recreating participants during recovery.
void	unregisterDeserializer(LRAParticipantDeserializer deserializer) Unregister a participant deserializer.

Method Detail

joinLRA

String joinLRA(LRAParticipant participant,
               URL lraId,
               Long timeLimit,
               TimeUnit unit)
        throws JoinLRAException

Join an existing LRA.

Parameters:

participant - an instance of a LRAParticipant that will be notified when the target LRA ends

lraId - the LRA that the join request pertains to @param timeLimit the time for which the participant should remain valid. When this time limit is exceeded the participant may longer be able to fulfil the protocol guarantees.

unit - the unit that the timeLimit parameter is expressed in

Returns:

a recovery URL for this enlistment

Throws:

JoinLRAException - if the request to the coordinator failed. Throwable.getCause() and/or JoinLRAException.getStatusCode() may provide a more specific reason

joinLRA

String joinLRA(LRAParticipant participant,
               URL lraId)
        throws JoinLRAException

Join an existing LRA. In contrast to the other form of registration this method does not indicate a time limit for the participant meaning that the participant registration will remain valid until it terminates successfully or unsuccessfully (ie it will never be timed out externally).

Parameters:

participant - an instance of a LRAParticipant that will be notified when the target LRA ends

lraId - the LRA that the join request pertains to

Returns:

a recovery URL for this enlistment

Throws:

JoinLRAException - if the request to the coordinator failed. Throwable.getCause() and/or JoinLRAException.getStatusCode() may provide a more specific reason

registerDeserializer

void registerDeserializer(LRAParticipantDeserializer deserializer)

Register an object for recreating participants during recovery. Use this mechanism after a JVM that hosted a LRA participant has terminated with outstanding LRAs. The LRA recovery coordinator will use this to ask the application to recreate an instance of LRAParticipant that will be notified when an LRA is closing or canceling.

Parameters:

deserializer - an object that knows how to recreate participants. Note that when the LRA manager is recreating a participant it may run through all registered deserializers. In recovery scenarios the first such deserializer returning a valid LRAParticipant is used for sending completion or compensation notifications

unregisterDeserializer

void unregisterDeserializer(LRAParticipantDeserializer deserializer)

Unregister a participant deserializer. The first deserializer registered with the LRA manager for which the equals method returns true is removed from LRA manager

Parameters:

deserializer - the deserializer to unregister