org.objectweb.jotm.core.transaction
Class PrepareEvent

java.lang.Object
  |
  +--org.objectweb.jotm.core.transaction.PrepareEvent

All Implemented Interfaces:

Event, TransactionalEvent, TwoPhaseCommitEvent

public class PrepareEvent

extends java.lang.Object

implements TwoPhaseCommitEvent

Prepare event. This class provides a simple helper implementation of the prepare transactional event. I.e., it corresponds to the TwoPhaseCommitEvent.TYPE_PREPARE event type. It allows an event listener to set the event vote which can be later determined by the event source.

Field Summary

static int	VOTE_ABORT
static int	VOTE_COMMIT
static int	VOTE_READ_ONLY

Fields inherited from interface org.objectweb.jotm.core.transaction.TwoPhaseCommitEvent

TYPE_AFTER_ONE_PHASE_COMMIT, TYPE_AFTER_PREPARE, TYPE_BEFORE_ONE_PHASE_COMMIT, TYPE_BEFORE_PREPARE, TYPE_ONE_PHASE_COMMIT, TYPE_PREPARE, TYPE_SYNCHRONIZATION, TYPE_TWO_PHASE_COMMIT

Fields inherited from interface org.objectweb.jotm.core.transaction.TransactionalEvent

TYPE_ABORT, TYPE_AFTER_ABORT, TYPE_AFTER_COMMIT, TYPE_AFTER_COMPLETION, TYPE_BEFORE_ABORT, TYPE_BEFORE_COMMIT, TYPE_BEFORE_COMPLETION, TYPE_COMMIT

Constructor Summary

PrepareEvent(BasicTransaction iTx)

Method Summary

BasicTransaction	getTransaction() Get corresponding transaction.
int	getType() Get transactional event type.
int	getVote() Get prepare vote.
void	setVote(int iVote) Set preapre vote.

Methods inherited from class java.lang.Object

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

Field Detail

VOTE_COMMIT

public static final int VOTE_COMMIT

See Also:

Constant Field Values

VOTE_ABORT

public static final int VOTE_ABORT

See Also:

Constant Field Values

VOTE_READ_ONLY

public static final int VOTE_READ_ONLY

See Also:

Constant Field Values

Constructor Detail

PrepareEvent

public PrepareEvent(BasicTransaction iTx)

Method Detail

getType

public int getType()

Description copied from interface: TransactionalEvent

Get transactional event type. The value is one of the constants defined in TransactionalEvent.

Specified by:

getType in interface TransactionalEvent

Returns:

type of this event

getTransaction

public BasicTransaction getTransaction()

Description copied from interface: TransactionalEvent

Get corresponding transaction. A transaction is the event source of TransactionalEvent.

Specified by:

getTransaction in interface TransactionalEvent

Returns:

transaction that is the source of this transactional event

setVote

public void setVote(int iVote)
             throws InvalidVoteException

Set preapre vote. The method allows the event listener to set the preapre vote that can be later determined by the event source transaction. The default value is VOTE_COMMIT, i.e., if the value is not set, the listener implicitly votes by this value.

Parameters:

iVote - prepare vote

Throws:

InvalidVoteException - vote value is invalid

getVote

public int getVote()

Get prepare vote.

Returns:

prepare vote value