Interface CoordinatorManager
- All Superinterfaces:
UserCoordinator
The CoordinatorManager is the way in which services can enlist
participants with the current coordinator.
- Since:
- 1.0.
- Version:
- $Id: CoordinatorManager.java,v 1.4 2005/05/19 12:13:24 nmcl Exp $
- Author:
- Mark Little (mark.little@arjuna.com)
-
Method Summary
Modifier and TypeMethodDescriptionvoid
delistParticipant
(String participantId) Remove the specified participant from the coordinator associated with the current thread.void
Enrol the specified participant with the coordinator associated with the current thread.void
participantCannotComplete
(String participantId) A participant cannot complete during normal execution or compensation.void
participantCompleted
(String participantId) The participant has completed its work and it ready to compensate if necessary.void
participantFaulted
(String participantId) A participant has faulted during normal execution or compensation.Methods inherited from interface com.arjuna.mw.wscf.model.sagas.api.UserCoordinator
begin, begin, cancel, close, complete, currentActivity, getTimeout, identifier, resume, setCancelOnly, setTimeout, status, suspend
-
Method Details
-
enlistParticipant
void enlistParticipant(Participant act) throws NoActivityException, WrongStateException, DuplicateParticipantException, InvalidParticipantException, SystemException Enrol the specified participant with the coordinator associated with the current thread.- Parameters:
act
- The participant.- Throws:
NoActivityException
- Thrown if there is no activity associated with the current thread.WrongStateException
- Thrown if the coordinator is not in a state that allows participants to be enrolled.DuplicateParticipantException
- Thrown if the participant has already been enrolled and the coordination protocol does not support multiple entries.InvalidParticipantException
- Thrown if the participant is invalid.SystemException
- Thrown if any other error occurs.
-
delistParticipant
void delistParticipant(String participantId) throws NoActivityException, InvalidParticipantException, WrongStateException, SystemException Remove the specified participant from the coordinator associated with the current thread.- Parameters:
participantId
- The participant to remove.- Throws:
NoActivityException
- Thrown if there is no activity associated with the current thread.WrongStateException
- Thrown if the coordinator is not in a state that allows participants to be removed.InvalidParticipantException
- Thrown if the participant is invalid.SystemException
- Thrown if any other error occurs.
-
participantCompleted
void participantCompleted(String participantId) throws NoActivityException, InvalidParticipantException, WrongStateException, SystemException The participant has completed its work and it ready to compensate if necessary.- Parameters:
participantId
- The participant.- Throws:
NoActivityException
- Thrown if there is no activity associated with the current thread.WrongStateException
- Thrown if the coordinator is not in a state that allows participants to be removed.InvalidParticipantException
- Thrown if the participant is invalid.SystemException
- Thrown if any other error occurs.
-
participantFaulted
void participantFaulted(String participantId) throws NoActivityException, InvalidParticipantException, SystemException A participant has faulted during normal execution or compensation. The saga will attempt to undo. The WS-T specification is a little vague here - we assume the entire transaction has to undo and a heuristic hazard needs to be logged.- Parameters:
participantId
- The participant.- Throws:
NoActivityException
- Thrown if there is no activity associated with the current thread.InvalidParticipantException
- Thrown if the participant is invalid.SystemException
- Thrown if any other error occurs.
-
participantCannotComplete
void participantCannotComplete(String participantId) throws NoActivityException, InvalidParticipantException, WrongStateException, SystemException A participant cannot complete during normal execution or compensation. The saga will attempt to undo. The WS-T specification is a little vague here - we assume the entire transaction has to undo.- Parameters:
participantId
- The participant.- Throws:
NoActivityException
- Thrown if there is no activity associated with the current thread.InvalidParticipantException
- Thrown if the participant is invalid.SystemException
- Thrown if any other error occurs.WrongStateException
-