org.jboss.jbossts.star.resource

Class RESTRecord

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.AbstractRecord

org.jboss.jbossts.star.resource.RESTRecord

public class RESTRecord
extends AbstractRecord

Log record for driving participants through 2PC and recovery

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jboss.logging.Logger	log

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

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Constructor and Description
RESTRecord()
RESTRecord(String txId, String coordinatorURI, String participantURI, String terminateURI)
RESTRecord(String txId, String coordinatorURI, String participantURI, String commitURI, String prepareURI, String rollbackURI, String commitOnePhaseURI)

Method Summary

Modifier and Type	Method and Description
void	alter(AbstractRecord a) Alter the current record with the one presented.
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() Forget any heuristic outcome which this implementation may have produced.
long	getAge()
String	getStatus()
void	merge(AbstractRecord a) Merge the current record with the one presented.
int	nestedAbort() A rollback of a nested transaction has occurred.
int	nestedCommit() A commit of a nested transaction has occurred.
int	nestedOnePhaseCommit() Perform a nested one phase commit.
int	nestedPrepare() A prepare for a nested transaction has occurred.
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	setFault(String name)
void	setRecoveryURI(String recoveryURI)
void	setValue(Object o)
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 a) Should we replace the record presented with the current record?
int	topLevelAbort() A rollback of a top-level transaction has occurred.
int	topLevelCommit() A commit of a top-level transaction has occurred.
int	topLevelOnePhaseCommit() For commit_one_phase we can do whatever we want since the transaction outcome is whatever we want.
int	topLevelPrepare() A prepare for a top-level transaction has occurred.
String	type() Re-implementation of abstract methods inherited from base class.
int	typeIs()
static String	typeName()
Object	value() If this abstract record caused a heuristic then it should return an object which implements HeuristicInformation

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

create, equals, getNext, getPrevious, getTypeOfObject, greaterThan, lessThan, nestedCleanup, order, print, propagateOnAbort, propagateOnCommit, 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

Field Detail

log

protected static final org.jboss.logging.Logger log

Constructor Detail

RESTRecord

public RESTRecord()

RESTRecord

public RESTRecord(String txId,
                  String coordinatorURI,
                  String participantURI,
                  String terminateURI)

RESTRecord

public RESTRecord(String txId,
                  String coordinatorURI,
                  String participantURI,
                  String commitURI,
                  String prepareURI,
                  String rollbackURI,
                  String commitOnePhaseURI)

Method Detail

typeIs

public int typeIs()

Specified by:

typeIs in class AbstractRecord

Returns:

RecordType value.

value

public Object value()

Description copied from class: AbstractRecord

If this abstract record caused a heuristic then it should return an object which implements HeuristicInformation

Specified by:

value in class AbstractRecord

Returns:

Object to be used to order.

getStatus

public String getStatus()

getAge

public long getAge()

setValue

public void setValue(Object o)

Specified by:

setValue in class AbstractRecord

nestedAbort

public int nestedAbort()

Description copied from class: AbstractRecord

A rollback of a nested transaction has occurred.

Specified by:

nestedAbort in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedCommit

public int nestedCommit()

Description copied from class: AbstractRecord

A commit of a nested transaction has occurred.

Specified by:

nestedCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedPrepare

public int nestedPrepare()

Description copied from class: AbstractRecord

A prepare for a nested transaction has occurred.

Specified by:

nestedPrepare in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

forgetHeuristic

public boolean forgetHeuristic()

Description copied from class: AbstractRecord

Forget any heuristic outcome which this implementation may have produced.

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.

topLevelPrepare

public int topLevelPrepare()

Description copied from class: AbstractRecord

A prepare for a top-level transaction has occurred.

Specified by:

topLevelPrepare in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelAbort

public int topLevelAbort()

Description copied from class: AbstractRecord

A rollback of a top-level transaction has occurred.

Specified by:

topLevelAbort in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelCommit

public int topLevelCommit()

Description copied from class: AbstractRecord

A commit of a top-level transaction has occurred.

Specified by:

topLevelCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedOnePhaseCommit

public int nestedOnePhaseCommit()

Description copied from class: AbstractRecord

Perform a nested one phase commit.

Overrides:

nestedOnePhaseCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelOnePhaseCommit

public int topLevelOnePhaseCommit()

For commit_one_phase we can do whatever we want since the transaction outcome is whatever we want. Therefore, we do not need to save any additional recoverable state, such as a reference to the transaction coordinator, since it will not have an intentions list anyway.

Overrides:

topLevelOnePhaseCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

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.

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.

type

public String type()

Description copied from class: AbstractRecord

Re-implementation of abstract methods inherited from base class.

Overrides:

type in class AbstractRecord

typeName

public static String typeName()

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 a)

Description copied from class: AbstractRecord

Should we replace the record presented with the current record?

Specified by:

shouldReplace in class AbstractRecord

Parameters:

a - The record to try to replace.

Returns:

true if the record should be replaced, false otherwise.

setRecoveryURI

public void setRecoveryURI(String recoveryURI)

setFault

public void setFault(String name)