com.arjuna.mwlabs.wst.at.participants

Class DurableTwoPhaseCommitParticipant

java.lang.Object

com.arjuna.mwlabs.wst.at.participants.DurableTwoPhaseCommitParticipant

All Implemented Interfaces:

Participant

public class DurableTwoPhaseCommitParticipant
extends Object
implements Participant

Since:

1.0.

Version:

$Id: DurableTwoPhaseCommitParticipant.java,v 1.1.2.2 2004/08/09 12:34:24 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Constructor Summary

Constructors

Constructor and Description
DurableTwoPhaseCommitParticipant()
DurableTwoPhaseCommitParticipant(Durable2PCParticipant resource, String identifier)

Method Summary

Modifier and Type	Method and Description
void	cancel() attempt to cancel the participant
void	confirm() attempt to commit the participant
void	confirmOnePhase() Confirm the participant in a single phase.
void	forget() Inform the participant that is can forget the heuristic result.
String	id()
Vote	prepare() tell the participant to prepare
boolean	restore_state(com.arjuna.ats.arjuna.state.InputObjectState os)
boolean	save_state(com.arjuna.ats.arjuna.state.OutputObjectState os)
void	unknown()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DurableTwoPhaseCommitParticipant

public DurableTwoPhaseCommitParticipant()

DurableTwoPhaseCommitParticipant

public DurableTwoPhaseCommitParticipant(Durable2PCParticipant resource,
                                        String identifier)

Method Detail

prepare

public Vote prepare()
             throws InvalidParticipantException,
                    WrongStateException,
                    HeuristicHazardException,
                    HeuristicMixedException,
                    SystemException

tell the participant to prepare

Specified by:

prepare in interface Participant

Returns:

the participant's vote or a cancel vote the participant is null

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot prepare.

HeuristicHazardException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean it cannot determine what the result of issuing prepare to them has been.

HeuristicMixedException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean some of them cancelled and some of them confirmed.

SystemException - Thrown if some other error occurred.

confirm

public void confirm()
             throws InvalidParticipantException,
                    WrongStateException,
                    HeuristicHazardException,
                    HeuristicMixedException,
                    HeuristicCancelException,
                    SystemException

attempt to commit the participant

Specified by:

confirm in interface Participant

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot confirm.

HeuristicHazardException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean it cannot determine what the result of issuing confirm to them has been.

HeuristicMixedException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean some of them cancelled and some of them confirmed.

HeuristicCancelException - Thrown if the participant rolls back rather than commits.

SystemException - Thrown if some other error occurred.

cancel

public void cancel()
            throws InvalidParticipantException,
                   WrongStateException,
                   HeuristicHazardException,
                   HeuristicMixedException,
                   HeuristicConfirmException,
                   SystemException

attempt to cancel the participant

Specified by:

cancel in interface Participant

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot cancel.

HeuristicHazardException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean it cannot determine what the result of issuing cancel to them has been.

HeuristicMixedException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean some of them cancelled and some of them confirmed.

HeuristicConfirmException - Thrown if the participant commits rather than rolls back.

SystemException - Thrown if some other error occurred.

confirmOnePhase

public void confirmOnePhase()
                     throws InvalidParticipantException,
                            WrongStateException,
                            HeuristicHazardException,
                            HeuristicMixedException,
                            HeuristicCancelException,
                            SystemException

Description copied from interface: Participant

Confirm the participant in a single phase.

Specified by:

confirmOnePhase in interface Participant

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid (e.g., refers to an unknown participant.)

WrongStateException - Thrown if the state of the participant is such that it cannot cancel.

HeuristicHazardException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean it cannot determine what the result of issuing cancel to them has been.

HeuristicMixedException - Thrown if upon preparing, the participant finds that some of its enlisted participants have return statuses which mean some of them cancelled and some of them confirmed.

HeuristicCancelException - Thrown if the participant rolls back rather than commit.

SystemException - Thrown if some other error occurred.

forget

public void forget()
            throws InvalidParticipantException,
                   WrongStateException,
                   SystemException

Description copied from interface: Participant

Inform the participant that is can forget the heuristic result.

Specified by:

forget in interface Participant

Throws:

InvalidParticipantException - Thrown if the participant identity is invalid.

WrongStateException - Thrown if the participant is in an invalid state.

SystemException - Thrown in the event of a general fault.

unknown

public void unknown()
             throws SystemException

Throws:

SystemException

id

public String id()
          throws SystemException

Specified by:

id in interface Participant

Throws:

SystemException

save_state

public boolean save_state(com.arjuna.ats.arjuna.state.OutputObjectState os)

Specified by:

save_state in interface Participant

restore_state

public boolean restore_state(com.arjuna.ats.arjuna.state.InputObjectState os)

Specified by:

restore_state in interface Participant