com.arjuna.mw.wscf.model.twophase.api

Interface CoordinatorManager

All Superinterfaces:

UserCoordinator

All Known Implementing Classes:

CoordinatorServiceImple

public interface CoordinatorManager
extends 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.3 2005/05/19 12:13:25 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Method Summary

Modifier and Type	Method and Description
void	delistParticipant(Participant act) Remove the specified participant from the coordinator associated with the current thread.
void	delistSynchronization(Synchronization act) Remove the specified synchronization from the coordinator associated with the current thread.
void	enlistParticipant(Participant act) Enrol the specified participant with the coordinator associated with the current thread.
void	enlistSynchronization(Synchronization act) Enrol the specified synchronization with the coordinator associated with the current thread.
void	participantReadOnly(String participantId) A participant is readonly.
void	participantRolledback(String participantId) The participant has rolled back.

Methods inherited from interface com.arjuna.mw.wscf.model.twophase.api.UserCoordinator

begin, begin, cancel, confirm, currentActivity, getTimeout, identifier, resume, setCancelOnly, setTimeout, status, suspend

Method Detail

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(Participant act)
                throws NoActivityException,
                       InvalidParticipantException,
                       WrongStateException,
                       SystemException

Remove the specified participant from the coordinator associated with the current thread.

Parameters:

act - 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.

enlistSynchronization

void enlistSynchronization(Synchronization act)
                    throws NoActivityException,
                           WrongStateException,
                           DuplicateSynchronizationException,
                           InvalidSynchronizationException,
                           SystemException

Enrol the specified synchronization with the coordinator associated with the current thread.

Parameters:

act - The synchronization to add.

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.

DuplicateSynchronizationException - Thrown if the participant has already been enrolled and the coordination protocol does not support multiple entries.

InvalidSynchronizationException - Thrown if the participant is invalid.

SystemException - Thrown if any other error occurs.

delistSynchronization

void delistSynchronization(Synchronization act)
                    throws NoActivityException,
                           InvalidSynchronizationException,
                           WrongStateException,
                           SystemException

Remove the specified synchronization from the coordinator associated with the current thread.

Parameters:

act - The synchronization 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.

InvalidSynchronizationException - Thrown if the participant is invalid.

SystemException - Thrown if any other error occurs.

participantRolledback

void participantRolledback(String participantId)
                    throws NoActivityException,
                           InvalidParticipantException,
                           WrongStateException,
                           SystemException

The participant has rolled back. Mark the transaction as rolled back.

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.

participantReadOnly

void participantReadOnly(String participantId)
                  throws NoActivityException,
                         InvalidParticipantException,
                         SystemException

A participant is readonly. Remove it from the list.

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.