com.arjuna.ats.internal.jta.resources.arjunacore

Class CommitMarkableResourceRecord

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.AbstractRecord

com.arjuna.ats.internal.jta.resources.arjunacore.CommitMarkableResourceRecord

public class CommitMarkableResourceRecord
extends AbstractRecord

The CommitMarkableResourceRecord does not support nested transactions If the database is down forever that a CommitMarkableResourceRecord is linked to, it will have the side effect of never expiring a RecoverAtomicAction. The CommitMarkableResourceRecord assumes the following table has been created: syb: create table xids (xid varbinary(144), transactionManagerID varchar(64), actionuid varbinary(28)) ora: create table xids (xid RAW(144), transactionManagerID varchar(64), actionuid RAW(28)) psql: create table xids (xid bytea, transactionManagerID varchar(64), actionuid bytea) h2: create table xids (xid varbinary(144), transactionManagerID varchar(64), actionuid varbinary(28)) sybase notes: sp_configure "lock scheme",0,datarows

Field Summary

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

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Constructor and Description
CommitMarkableResourceRecord() For recovery
CommitMarkableResourceRecord(TransactionImple tx, org.jboss.tm.ConnectableResource xaResource, Xid xid, BasicAction basicAction)

Method Summary

Modifier and Type	Method and Description
void	alter(AbstractRecord a) Alter the current record with the one presented.
boolean	doSave() We need to save this so we know there was a ConnectableResource in the intentions list.
int	getHeuristic()
String	getJndiName()
String	getProductName()
String	getProductVersion()
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	nestedPrepare() A prepare for a nested transaction has occurred.
Uid	order() Return the Uid of this abstract record so that it can be ordered in the intentions list.
boolean	propagateOnCommit() Determine if records are discarded on action commit or must be propagated to parents.
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)
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() Perform a top-level one phase commit.
int	topLevelPrepare() This will add the required recovery data about this resource into the resources preparedConnection.
String	type() Re-implementation of abstract methods inherited from base class.
int	typeIs()
void	updateOutcome(boolean committed)
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, forgetHeuristic, getNext, getPrevious, getTypeOfObject, greaterThan, lessThan, nestedCleanup, nestedOnePhaseCommit, print, 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

CommitMarkableResourceRecord

public CommitMarkableResourceRecord()

For recovery

CommitMarkableResourceRecord

public CommitMarkableResourceRecord(TransactionImple tx,
                                    org.jboss.tm.ConnectableResource xaResource,
                                    Xid xid,
                                    BasicAction basicAction)
                             throws IllegalStateException,
                                    RollbackException,
                                    SystemException

Throws:

IllegalStateException

RollbackException

SystemException

Method Detail

getProductName

public String getProductName()

getProductVersion

public String getProductVersion()

getJndiName

public String getJndiName()

updateOutcome

public void updateOutcome(boolean committed)

doSave

public boolean doSave()

We need to save this so we know there was a ConnectableResource in the intentions list.

Overrides:

doSave in class AbstractRecord

Returns:

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

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.

topLevelPrepare

public int topLevelPrepare()

This will add the required recovery data about this resource into the resources preparedConnection. If the preparedConnection is in read only mode, we do not need to persist this information.

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

topLevelOnePhaseCommit

public int topLevelOnePhaseCommit()

Description copied from class: AbstractRecord

Perform a top-level one phase commit.

Overrides:

topLevelOnePhaseCommit in class AbstractRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

getHeuristic

public int getHeuristic()

order

public Uid order()

Description copied from class: AbstractRecord

Return the Uid of this abstract record so that it can be ordered in the intentions list. This is also the Uid that the record was saved with in the object store.

Overrides:

order in class AbstractRecord

Returns:

Uid for this instance.

See Also:

Uid

propagateOnCommit

public boolean propagateOnCommit()

Description copied from class: AbstractRecord

Determine if records are discarded on action commit or must be propagated to parents.

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

Specified by:

typeIs in class AbstractRecord

Returns:

RecordType value.

type

public String type()

Description copied from class: AbstractRecord

Re-implementation of abstract methods inherited from base class.

Overrides:

type in class AbstractRecord

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.

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

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.