com.arjuna.mwlabs.wscf.model.sagas.arjunacore

Class ParticipantRecord

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.AbstractRecord

com.arjuna.mwlabs.wscf.model.sagas.arjunacore.ParticipantRecord

public class ParticipantRecord
extends AbstractRecord

Arjuna abstract record to handle two-phase participants.

Version:

$Id: ParticipantRecord.java,v 1.6 2005/05/19 12:13:37 nmcl Exp $

Author:

Mark Little (mark.little@arjuna.com)

Field Summary

Fields inherited from class com.arjuna.ats.arjuna.StateManager

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Constructor and Description
ParticipantRecord()
ParticipantRecord(Participant theResource, Uid id) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	alter(AbstractRecord a) Alter the current record with the one presented.
boolean	complete()
void	completed() record the fact that this participant has completed
static AbstractRecord	create()
void	delist(boolean failed) record the fact that this participant has exited
boolean	doSave() Should this record be saved in the intentions list? If the record is saved, then it may be recovered later in the event of a failure.
boolean	forgetHeuristic() The record generated a heuristic and can now forget about it.
boolean	isActive() is the participant is still able to be sent a complete request
boolean	isParticipantCompletion() is this a ParticipantCompletion participant
void	merge(AbstractRecord a) Merge the current record with the one presented.
int	nestedAbort() The record is being driven through nested rollback.
int	nestedCommit() The record is being driven through nested commit.
int	nestedOnePhaseCommit() The record is being driven through nested commit and is the only resource.
int	nestedPrepare() The record is being driven through nested prepare.
void	print(PrintWriter strm) Write information about this specific instance to the specified stream.
boolean	propagateOnCommit() Override AbstractRecord.propagateOnCommit
void	remove(AbstractRecord toDelete)
boolean	restore_state(InputObjectState os, int t) During recovery, the transaction log is given to the recovery system and it will recreate a transaction instance to perform necessary recovery actions.
boolean	save_state(OutputObjectState os, int t) When the transaction is required to make the intentions list persistent, it scans the list and asks each record whether or not it requires state to be saved (by calling doSave).
void	setValue(Object o) Set the internal value.
boolean	shouldAdd(AbstractRecord a) Should we add the record presented to the intentions list?
boolean	shouldAlter(AbstractRecord a) Should we alter the current record with the one presented?
boolean	shouldMerge(AbstractRecord a) Should we merge the current record with the one presented?
boolean	shouldReplace(AbstractRecord rec) Should we replace the record presented with the current record?
int	topLevelAbort() The record is being driven through top-level rollback.
int	topLevelCommit() The record is being driven through top-level commit.
int	topLevelOnePhaseCommit() The record is being driven through top-level commit and is the only resource.
int	topLevelPrepare() The record is being driven through top-level prepare.
String	type() Re-implementation of abstract methods inherited from base class.
int	typeIs() The type of this abstract record.
Object	value() The internal value.

Methods inherited from class com.arjuna.ats.arjuna.coordinator.AbstractRecord

create, equals, getNext, getPrevious, getTypeOfObject, greaterThan, lessThan, nestedCleanup, order, propagateOnAbort, replace, setNext, setPrevious, topLevelCleanup

Methods inherited from class com.arjuna.ats.arjuna.StateManager

activate, activate, cleanup, createLists, deactivate, deactivate, deactivate, destroy, disable, forgetAction, get_uid, getMutex, getObjectModel, getStore, getStoreRoot, loadObjectState, lockMutex, modified, objectType, packHeader, persist, rememberAction, setStatus, setupStore, setupStore, setupStore, status, terminate, tryLockMutex, unlockMutex, unpackHeader

Methods inherited from class java.lang.Object

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

Constructor Detail

ParticipantRecord

public ParticipantRecord(Participant theResource,
                 Uid id)

Constructor.

Parameters:

theResource - is the proxy that allows us to call out to the object.

ParticipantRecord

public ParticipantRecord()

Method Detail

propagateOnCommit

public boolean propagateOnCommit()

Override AbstractRecord.propagateOnCommit

Overrides:

propagateOnCommit in class AbstractRecord

Returns:

true if the record should be propagated to the parent transaction if the current transaction commits, false otherwise. The default is true.

typeIs

public int typeIs()

The type of this abstract record.

Specified by:

typeIs in class AbstractRecord

Returns:

RecordType value.

value

public Object value()

The internal value.

Specified by:

value in class AbstractRecord

Returns:

Object to be used to order.

setValue

public void setValue(Object o)

Set the internal value. Not allowed for this class.

Specified by:

setValue in class AbstractRecord

nestedAbort

public int nestedAbort()

The record is being driven through nested rollback.

Specified by:

nestedAbort in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedCommit

public int nestedCommit()

The record is being driven through nested commit.

Specified by:

nestedCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedPrepare

public int nestedPrepare()

The record is being driven through nested prepare.

Specified by:

nestedPrepare in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelAbort

public int topLevelAbort()

The record is being driven through top-level rollback.

Specified by:

topLevelAbort in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelCommit

public int topLevelCommit()

The record is being driven through top-level commit.

Specified by:

topLevelCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelPrepare

public int topLevelPrepare()

The record is being driven through top-level prepare.

Specified by:

topLevelPrepare in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedOnePhaseCommit

public int nestedOnePhaseCommit()

The record is being driven through nested commit and is the only resource.

Overrides:

nestedOnePhaseCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelOnePhaseCommit

public int topLevelOnePhaseCommit()

The record is being driven through top-level commit and is the only resource.

Overrides:

topLevelOnePhaseCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

forgetHeuristic

public boolean forgetHeuristic()

The record generated a heuristic and can now forget about it.

Overrides:

forgetHeuristic in class AbstractRecord

Returns:

true by default. If false is returned then the instance must be remembered by the transaction (in the log) in order for recovery to retry later or for a system administrator to be able to determine which resources have not been successfully completed.

complete

public boolean complete()

create

public static AbstractRecord create()

remove

public void remove(AbstractRecord toDelete)

print

public void print(PrintWriter strm)

Description copied from class: AbstractRecord

Write information about this specific instance to the specified stream.

Overrides:

print in class AbstractRecord

Parameters:

strm - the stream on which to output.

restore_state

public boolean restore_state(InputObjectState os,
                    int t)

Description copied from class: AbstractRecord

During recovery, the transaction log is given to the recovery system and it will recreate a transaction instance to perform necessary recovery actions. This transaction will recreate the intentions list and give each recreated AbstractRecord the state that that was saved during transaction persistence. The base class will restore information that it needs from the log. Data items must be unpacked in the same order that they were packed.

Overrides:

restore_state in class AbstractRecord

Returns:

true if successful, false otherwise.

save_state

public boolean save_state(OutputObjectState os,
                 int t)

Description copied from class: AbstractRecord

When the transaction is required to make the intentions list persistent, it scans the list and asks each record whether or not it requires state to be saved (by calling doSave). If the answer is yes, then save_state is called and the record instance must save enough information to enable it to be restored from that state later. The basic AbstractRecord save_state will save common data that is required by the base class during recovery. If a derived class calls super.save_state then it must be called before packing any other data item.

Overrides:

save_state in class AbstractRecord

Returns:

true if successful, false otherwise.

type

public String type()

Description copied from class: AbstractRecord

Re-implementation of abstract methods inherited from base class.

Overrides:

type in class AbstractRecord

doSave

public boolean doSave()

Description copied from class: AbstractRecord

Should this record be saved in the intentions list? If the record is saved, then it may be recovered later in the event of a failure. Note, however, that the size of the intentions list on disk is critical to the performance of the system (disk I/O is a bottleneck).

Overrides:

doSave in class AbstractRecord

Returns:

true if it should be saved, false otherwise. false is the default.

merge

public void merge(AbstractRecord a)

Description copied from class: AbstractRecord

Merge the current record with the one presented.

Specified by:

merge in class AbstractRecord

Parameters:

a - the record with which to merge.

alter

public void alter(AbstractRecord a)

Description copied from class: AbstractRecord

Alter the current record with the one presented.

Specified by:

alter in class AbstractRecord

Parameters:

a - the record with which to alter.

shouldAdd

public boolean shouldAdd(AbstractRecord a)

Description copied from class: AbstractRecord

Should we add the record presented to the intentions list?

Specified by:

shouldAdd in class AbstractRecord

Parameters:

a - The record to try to add.

Returns:

true if the record should be added, false otherwise.

shouldAlter

public boolean shouldAlter(AbstractRecord a)

Description copied from class: AbstractRecord

Should we alter the current record with the one presented?

Specified by:

shouldAlter in class AbstractRecord

Parameters:

a - The record to try to alter.

Returns:

true if the record should be altered, false otherwise.

shouldMerge

public boolean shouldMerge(AbstractRecord a)

Description copied from class: AbstractRecord

Should we merge the current record with the one presented?

Specified by:

shouldMerge in class AbstractRecord

Parameters:

a - The record to try to merge.

Returns:

true if the record should be merged, false otherwise.

shouldReplace

public boolean shouldReplace(AbstractRecord rec)

Description copied from class: AbstractRecord

Should we replace the record presented with the current record?

Specified by:

shouldReplace in class AbstractRecord

Parameters:

rec - The record to try to replace.

Returns:

true if the record should be replaced, false otherwise.

delist

public final void delist(boolean failed)

record the fact that this participant has exited

Parameters:

failed - true if the exit was because of a failure i.e. the participant may be in an unclean state

completed

public final void completed()

record the fact that this participant has completed

isActive

public final boolean isActive()

is the participant is still able to be sent a complete request

Returns:

true if the participant is still able to be sent a complete request otherwise false

isParticipantCompletion

public final boolean isParticipantCompletion()

is this a ParticipantCompletion participant

Returns:

true if this is a ParticipantCompletion participant otherwise false