Class TxnResourceApiReadUncommitted<T extends TxnReadUncommitted>

java.lang.Object

org.aksw.commons.txn.impl.TxnResourceApiReadUncommitted<T>

All Implemented Interfaces:

TxnResourceApi, TxnComponent

Direct Known Subclasses:

TxnResourceApiSerializable

public class TxnResourceApiReadUncommitted<T extends TxnReadUncommitted>
extends Object
implements TxnResourceApi

Api to a resource w.r.t. a transaction.

Author:

raven

Field Summary

Fields

Modifier and Type	Field	Description
protected FileSyncImpl	fileSync
protected Path	resFileAbsPath
protected Path	resFilePath
protected Path<String>	resKey
protected T	txn

Constructor Summary

Constructors

Constructor	Description
TxnResourceApiReadUncommitted(T txn, Path<String> resKey)

Method Summary

Modifier and Type	Method	Description
void	declareAccess()	Declare that the txn accessed the resource.
void	finalizeCommit()
FileSyncImpl	getFileSync()	A container to get/set the new content for the resource Once the transaction completes the old content will be replaced with the new one.
Instant	getLastModifiedDate()	The timestamp of the most recent modificaton to the resource
Path<String>	getResourceKey()
ReadWriteLockWithOwnership	getTxnResourceLock()
boolean	isVisible()	Whether the resource is visible to the transaction
void	preCommit()
void	putContent(Consumer<OutputStream> handler)
void	rollback()
void	undeclareAccess()	Remove access declaration from the txn to this resource.

Methods inherited from class Object

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

Methods inherited from interface TxnResourceApi

lock, unlock

Field Details

txn

protected T extends TxnReadUncommitted txn

resKey

protected Path<String> resKey

resFilePath

protected Path resFilePath

resFileAbsPath

protected Path resFileAbsPath

fileSync

protected FileSyncImpl fileSync

Constructor Details

TxnResourceApiReadUncommitted

public TxnResourceApiReadUncommitted(T txn,
 Path<String> resKey)

Method Details

getTxnResourceLock

public ReadWriteLockWithOwnership getTxnResourceLock()

Specified by:

getTxnResourceLock in interface TxnResourceApi

getLastModifiedDate

public Instant getLastModifiedDate()
                            throws IOException

Description copied from interface: TxnResourceApi

The timestamp of the most recent modificaton to the resource

Specified by:

getLastModifiedDate in interface TxnResourceApi

Throws:

IOException

getResourceKey

public Path<String> getResourceKey()

Specified by:

getResourceKey in interface TxnResourceApi

isVisible

public boolean isVisible()

Description copied from interface: TxnResourceApi

Whether the resource is visible to the transaction

Specified by:

isVisible in interface TxnResourceApi

declareAccess

public void declareAccess()

Description copied from interface: TxnResourceApi

Declare that the txn accessed the resource. Upon recovery the resource will be checked for any uncommitted changes.

Specified by:

declareAccess in interface TxnResourceApi

undeclareAccess

public void undeclareAccess()

Description copied from interface: TxnResourceApi

Remove access declaration from the txn to this resource. Recovery related to this txn will not consider the resource.

Specified by:

undeclareAccess in interface TxnResourceApi

getFileSync

public FileSyncImpl getFileSync()

Description copied from interface: TxnResourceApi

A container to get/set the new content for the resource Once the transaction completes the old content will be replaced with the new one. On rollback, the new-but-uncommitted content will by discarded

Specified by:

getFileSync in interface TxnResourceApi

putContent

public void putContent(Consumer<OutputStream> handler)
                throws IOException

Throws:

IOException

preCommit

public void preCommit()
               throws Exception

Specified by:

preCommit in interface TxnComponent

Throws:

Exception

finalizeCommit

public void finalizeCommit()
                    throws Exception

Specified by:

finalizeCommit in interface TxnComponent

Throws:

Exception

rollback

public void rollback()
              throws Exception

Specified by:

rollback in interface TxnComponent

Throws:

Exception