org.eclipse.microprofile.lra.participant

Interface LRAParticipant

All Superinterfaces:

Serializable

public interface LRAParticipant
extends Serializable

The API for notifying participants that a LRA is completing or cancelling. A participant joins with an LRA via a call to LRAManagement.joinLRA(LRAParticipant, URL, Long, java.util.concurrent.TimeUnit)

Method Summary

Modifier and Type	Method and Description
Future<Void>	compensateWork(URL lraId) Notifies the participant that the LRA is cancelling
Future<Void>	completeWork(URL lraId) Notifies the participant that the LRA is closing

Method Detail

completeWork

Future<Void> completeWork(URL lraId)
                   throws javax.ws.rs.NotFoundException,
                          TerminationException

Notifies the participant that the LRA is closing

Parameters:

lraId - the LRA that is closing

Returns:

null if the participant completed successfully. If the participant cannot complete immediately it should return a future that the caller can useto monitor progress. If the JVM crashes before the participant can finish it should expect this method to be called again. If the participant fails to complete it must cancel the future or throw a TerminationException.

Throws:

javax.ws.rs.NotFoundException - the participant does not know about this LRA

TerminationException - the participant was unable to complete and will never be able to do so

compensateWork

Future<Void> compensateWork(URL lraId)
                     throws javax.ws.rs.NotFoundException,
                            TerminationException

Notifies the participant that the LRA is cancelling

Parameters:

lraId - the LRA that is closing

Returns:

null if the participant completed successfully. If the participant cannot complete immediately it should return a future that the caller can use to monitor progress. If the JVM crashes before the participant can finish it should expect this method to be called again. If the participant fails to complete it must cancel the future or throw a TerminationException.

Throws:

javax.ws.rs.NotFoundException - the participant does not know about this LRA

TerminationException - the participant was unable to complete and will never be able to do so