com.arjuna.ats.internal.arjuna.abstractrecords

Class CadaverRecord

java.lang.Object

com.arjuna.ats.arjuna.StateManager

com.arjuna.ats.arjuna.coordinator.AbstractRecord

com.arjuna.ats.internal.arjuna.abstractrecords.RecoveryRecord

com.arjuna.ats.internal.arjuna.abstractrecords.PersistenceRecord

com.arjuna.ats.internal.arjuna.abstractrecords.CadaverRecord

Direct Known Subclasses:

DisposeRecord

public class CadaverRecord
extends PersistenceRecord

Cadaver records are created whenever a persistent object is deleted while still in the scope of an atomic action. This ensures that if the action commits the state of the persistent objects gets properly reflected back in the object participantStore. For objects that are only recoverable such work is unnecessary. Cadaver records replace PersistenceRecords in the record list of an atomic action so they must be merged with such records to enable both commits and aborts to occur.

Since:

JTS 1.0.

Version:

$Id: CadaverRecord.java 2342 2006-03-30 13:06:17Z $

Author:

Mark Little (mark@arjuna.com)

Field Summary

Fields inherited from class com.arjuna.ats.internal.arjuna.abstractrecords.PersistenceRecord

classicPrepare, MAX_OBJECT_SIZE, shadowMade, targetParticipantStore, topLevelState

Fields inherited from class com.arjuna.ats.internal.arjuna.abstractrecords.RecoveryRecord

objectAddr, state

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

modifyingActions, objectModel, objectUid, usingActions

Constructor Summary

Constructors

Constructor and Description
CadaverRecord() Create a new instance using default values.
CadaverRecord(OutputObjectState os, ParticipantStore participantStore, StateManager sm) Create a new instance, passing in the object that is being managed.

Method Summary

Modifier and Type	Method and Description
boolean	doSave() Override the AbstractRecord.doSave.
void	merge(AbstractRecord mergewith) merge takes the information from the incoming PersistenceRecord and uses it to initialise the oldState information.
int	nestedAbort() The nested transaction has aborted.
int	nestedPrepare() The nested transaction is preparing.
void	print(PrintWriter strm) Override AbstractRecord.print to write specific information to the specified stream.
boolean	propagateOnAbort() Override default AbstractRecord method.
boolean	shouldMerge(AbstractRecord ar) Overrides AbstractRecord.shouldMerge
boolean	shouldReplace(AbstractRecord ar) Overrides AbstractRecord.shouldReplace
int	topLevelAbort() The nested transaction has aborted.
int	topLevelCommit() At topLevelCommit we commit the uncommitted version already saved into object participantStore.
int	topLevelPrepare() At topLevelPrepare write uncommitted version into object participantStore.
String	type() The type of the class - may be used to save information in an hierarchical manner in the object participantStore.
int	typeIs() The type of the record.

Methods inherited from class com.arjuna.ats.internal.arjuna.abstractrecords.PersistenceRecord

restore_state, save_state, shadowForced, topLevelCleanup

Methods inherited from class com.arjuna.ats.internal.arjuna.abstractrecords.RecoveryRecord

alter, finalize, forgetAction, nestedCommit, setValue, shouldAdd, shouldAlter, value

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

create, equals, forgetHeuristic, getNext, getPrevious, getTypeOfObject, greaterThan, lessThan, nestedCleanup, nestedOnePhaseCommit, order, propagateOnCommit, replace, setNext, setPrevious, topLevelOnePhaseCommit

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, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CadaverRecord

public CadaverRecord(OutputObjectState os,
                     ParticipantStore participantStore,
                     StateManager sm)

Create a new instance, passing in the object that is being managed.

Parameters:

os - the state of the object that is being removed.

participantStore - the object participantStore instance used to manipulate the persistent state.

sm - the object being removed.

CadaverRecord

public CadaverRecord()

Create a new instance using default values. Typically used during failure recovery.

Method Detail

propagateOnAbort

public boolean propagateOnAbort()

Override default AbstractRecord method. CadaverRecords are propagated regardless of the termination condition.

Overrides:

propagateOnAbort in class AbstractRecord

Returns:

true

typeIs

public int typeIs()

The type of the record.

Overrides:

typeIs in class PersistenceRecord

Returns:

RecordType.PERSISTENT

See Also:

RecordType

nestedAbort

public int nestedAbort()

The nested transaction has aborted. The record will invalidate any new state.

Overrides:

nestedAbort in class RecoveryRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

nestedPrepare

public int nestedPrepare()

The nested transaction is preparing. If there is any new state for the object being removed, and that state is valid, then this record will call nestedPrepare on the object being removed. If we have no new state then we cannot commit and must force an abort. Do this by failing the prepare phase.

Overrides:

nestedPrepare in class RecoveryRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelAbort

public int topLevelAbort()

The nested transaction has aborted. Invalidate any new state.

Overrides:

topLevelAbort in class PersistenceRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelCommit

public int topLevelCommit()

At topLevelCommit we commit the uncommitted version already saved into object participantStore. Cannot use inherited version since that assumes object is alive instead talk directly to the object participantStore itself.

Overrides:

topLevelCommit in class PersistenceRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

topLevelPrepare

public int topLevelPrepare()

At topLevelPrepare write uncommitted version into object participantStore. Cannot use inherited version since that assumes object is alive instead talk directly to the object participantStore itself.

Overrides:

topLevelPrepare in class PersistenceRecord

Returns:

TwoPhaseOutcome to indicate success/failure.

See Also:

TwoPhaseOutcome

print

public void print(PrintWriter strm)

Override AbstractRecord.print to write specific information to the specified stream.

Overrides:

print in class PersistenceRecord

Parameters:

strm - the stream to use.

type

public String type()

The type of the class - may be used to save information in an hierarchical manner in the object participantStore.

Overrides:

type in class PersistenceRecord

doSave

public boolean doSave()

Override the AbstractRecord.doSave.

Overrides:

doSave in class PersistenceRecord

Returns:

true if the object being removed is a persistent object (RecordType.PERSISTENT). false otherwise.

See Also:

RecordType

merge

public void merge(AbstractRecord mergewith)

merge takes the information from the incoming PersistenceRecord and uses it to initialise the oldState information. This is required for processing of action aborts since CadaverRecords maintain the final state of an object normally - which is required if the action commits.

Overrides:

merge in class RecoveryRecord

Parameters:

mergewith - The record to merge with.

shouldMerge

public boolean shouldMerge(AbstractRecord ar)

Overrides AbstractRecord.shouldMerge

Overrides:

shouldMerge in class RecoveryRecord

Parameters:

ar - the record to potentially merge with.

Returns:

true if this instance and the parameter have the same id (order()) and the parameter is either persistent or recoverable. false otherwise.

See Also:

RecordType

shouldReplace

public boolean shouldReplace(AbstractRecord ar)

Overrides AbstractRecord.shouldReplace

Overrides:

shouldReplace in class RecoveryRecord

Parameters:

ar - the record to potentially replace this instance.

Returns:

true if this instance and the parameter have the same id (order()) and the parameter is either persistent or recoverable. false otherwise.

See Also:

RecordType