Class TxnSerializable

java.lang.Object

org.aksw.commons.txn.impl.TxnReadUncommitted

org.aksw.commons.txn.impl.TxnSerializable

All Implemented Interfaces:

Txn

public class TxnSerializable
extends TxnReadUncommitted

Field Summary

Fields

Modifier and Type	Field	Description
protected Path	commitFile
protected String	commitFilename
protected Path	finalizeFile
protected String	finalizeFilename
protected LockFromFile	mgmtLock
protected Path	mgmtLockFile
protected String	mgmtLockFilename
protected Duration	mgmtLockTtl
protected Path	ownerFile
protected String	ownerFilename
protected Path	rollbackFile
protected String	rollbackFilename
protected Path	txnFolder
protected String	txnId
protected TxnMgrImpl	txnMgr

Fields inherited from class TxnReadUncommitted

containerCache

Constructor Summary

Constructors

Constructor	Description
TxnSerializable(TxnMgrImpl txnMgr, String txnId, Path txnFolder)

Method Summary

Modifier and Type	Method	Description
void	addCommit()
void	addFinalize()
void	addRollback()
boolean	claim()	Instruct this TxnMgr to try to claim (i.e.
void	cleanUpTxn()	Declare that the resource was accessed by the transaction Upon recovery the resource's state must be checked for whether any actions need to be taken.
protected TxnResourceApi	createResourceApi(Path<String> key)
Instant	getActivityDate()
Instant	getCreationDate()
TemporalAmount	getDurationToNextHeartbeat()
String	getId()	Get the id of this transaction
Instant	getMostRecentHeartbeat()
String	getOwner()
Path<String>	getRelPathForJournalEntry(Path txnPath)
TxnResourceApi	getResourceApi(String resourceName)
TxnResourceApi	getResourceApi(Path<String> resRelPath)	Get access to a resource as seen from this txn
boolean	isCommit()
boolean	isFinalize()
boolean	isRollback()
boolean	isStale()	A stale transaction was idle for longer than the heartbeat time.
boolean	isWrite()
protected <T> T	runWithMgmtLock(Callable<T> action)
protected <T> T	runWithVerifiedOwner(Callable<T> action)	Acquires the txn's management lock, validates ownership and runs an action while the lock is held.
void	setActivityDate(Instant instant)	Update the transaction's most recent activity timestamp to given timestamp; Used to prevent other processes from considering the transaction stale.
Stream<Path>	streamAccessedEntries()	Stream the resources to which access has been declared The returned stream must be closed!
Stream<Path<String>>	streamAccessedResourcePaths()
void	updateHeartbeat()
protected void	updateHeartbeatInternal()
void	writeOwner()

Methods inherited from class TxnReadUncommitted

getTxnMgr, listVisibleFiles, promote

Methods inherited from class Object

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

Methods inherited from interface Txn

updateActivityDate

Field Details

mgmtLockTtl

protected Duration mgmtLockTtl

txnMgr

protected TxnMgrImpl txnMgr

txnId

protected String txnId

txnFolder

protected Path txnFolder

commitFilename

protected String commitFilename

finalizeFilename

protected String finalizeFilename

rollbackFilename

protected String rollbackFilename

commitFile

protected transient Path commitFile

finalizeFile

protected transient Path finalizeFile

rollbackFile

protected transient Path rollbackFile

ownerFilename

protected String ownerFilename

ownerFile

protected transient Path ownerFile

mgmtLockFilename

protected String mgmtLockFilename

mgmtLockFile

protected transient Path mgmtLockFile

mgmtLock

protected transient LockFromFile mgmtLock

Constructor Details

TxnSerializable

public TxnSerializable(TxnMgrImpl txnMgr,
 String txnId,
 Path txnFolder)

Method Details

getId

public String getId()

Description copied from interface: Txn

Get the id of this transaction

Specified by:

getId in interface Txn

Overrides:

getId in class TxnReadUncommitted

createResourceApi

protected TxnResourceApi createResourceApi(Path<String> key)

Overrides:

createResourceApi in class TxnReadUncommitted

getCreationDate

public Instant getCreationDate()

Specified by:

getCreationDate in interface Txn

Overrides:

getCreationDate in class TxnReadUncommitted

getResourceApi

public TxnResourceApi getResourceApi(String resourceName)

getResourceApi

public TxnResourceApi getResourceApi(Path<String> resRelPath)

Description copied from interface: Txn

Get access to a resource as seen from this txn

Specified by:

getResourceApi in interface Txn

Overrides:

getResourceApi in class TxnReadUncommitted

isWrite

public boolean isWrite()

Specified by:

isWrite in interface Txn

Overrides:

isWrite in class TxnReadUncommitted

cleanUpTxn

public void cleanUpTxn()
                throws IOException

Declare that the resource was accessed by the transaction Upon recovery the resource's state must be checked for whether any actions need to be taken. Note, that declaration of access to a resource does not lock it

Specified by:

cleanUpTxn in interface Txn

Overrides:

cleanUpTxn in class TxnReadUncommitted

Parameters:

resourceName -

Throws:

IOException

addCommit

public void addCommit()
               throws IOException

Specified by:

addCommit in interface Txn

Overrides:

addCommit in class TxnReadUncommitted

Throws:

IOException

addFinalize

public void addFinalize()
                 throws IOException

Specified by:

addFinalize in interface Txn

Overrides:

addFinalize in class TxnReadUncommitted

Throws:

IOException

addRollback

public void addRollback()
                 throws IOException

Specified by:

addRollback in interface Txn

Overrides:

addRollback in class TxnReadUncommitted

Throws:

IOException

isFinalize

public boolean isFinalize()
                   throws IOException

Specified by:

isFinalize in interface Txn

Overrides:

isFinalize in class TxnReadUncommitted

Throws:

IOException

isCommit

public boolean isCommit()
                 throws IOException

Specified by:

isCommit in interface Txn

Overrides:

isCommit in class TxnReadUncommitted

Throws:

IOException

isRollback

public boolean isRollback()
                   throws IOException

Specified by:

isRollback in interface Txn

Overrides:

isRollback in class TxnReadUncommitted

Throws:

IOException

streamAccessedEntries

public Stream<Path> streamAccessedEntries()
                                   throws IOException

Stream the resources to which access has been declared The returned stream must be closed!

Throws:

IOException

getRelPathForJournalEntry

public Path<String> getRelPathForJournalEntry(Path txnPath)

streamAccessedResourcePaths

public Stream<Path<String>> streamAccessedResourcePaths()
                                                 throws IOException

Specified by:

streamAccessedResourcePaths in interface Txn

Overrides:

streamAccessedResourcePaths in class TxnReadUncommitted

Throws:

IOException

getActivityDate

public Instant getActivityDate()
                        throws IOException

Specified by:

getActivityDate in interface Txn

Overrides:

getActivityDate in class TxnReadUncommitted

Throws:

IOException

setActivityDate

public void setActivityDate(Instant instant)
                     throws IOException

Description copied from interface: Txn

Update the transaction's most recent activity timestamp to given timestamp; Used to prevent other processes from considering the transaction stale.

Specified by:

setActivityDate in interface Txn

Overrides:

setActivityDate in class TxnReadUncommitted

Throws:

IOException

isStale

public boolean isStale()
                throws IOException

A stale transaction was idle for longer than the heartbeat time. If the owner file (used for heartbeat checks) does not (yet) exist then the txn is also considered stale.

Specified by:

isStale in interface Txn

Overrides:

isStale in class TxnReadUncommitted

Throws:

IOException

getOwner

public String getOwner()
                throws IOException

Throws:

IOException

writeOwner

public void writeOwner()
                throws IOException

Throws:

IOException

claim

public boolean claim()

Description copied from interface: Txn

Instruct this TxnMgr to try to claim (i.e. take ownership) of this txn. Should only be used on stale transactions. A claim fails - indicated by a return value of false - if the txn's heartbeat timeout has not been reached. This condition also occurs if another thread won the competition for claiming a txn.

Specified by:

claim in interface Txn

Overrides:

claim in class TxnReadUncommitted

updateHeartbeatInternal

protected void updateHeartbeatInternal()
                                throws IOException

Throws:

IOException

updateHeartbeat

public void updateHeartbeat()
                     throws IOException

Specified by:

updateHeartbeat in interface Txn

Overrides:

updateHeartbeat in class TxnReadUncommitted

Throws:

IOException

getMostRecentHeartbeat

public Instant getMostRecentHeartbeat()
                               throws IOException

Specified by:

getMostRecentHeartbeat in interface Txn

Overrides:

getMostRecentHeartbeat in class TxnReadUncommitted

Throws:

IOException

getDurationToNextHeartbeat

public TemporalAmount getDurationToNextHeartbeat()
                                          throws IOException

Specified by:

getDurationToNextHeartbeat in interface Txn

Overrides:

getDurationToNextHeartbeat in class TxnReadUncommitted

Throws:

IOException

runWithMgmtLock

protected <T> T runWithMgmtLock(Callable<T> action)

runWithVerifiedOwner

protected <T> T runWithVerifiedOwner(Callable<T> action)

Acquires the txn's management lock, validates ownership and runs an action while the lock is held.

Type Parameters:

T -

Parameters:

action -

Returns: