org.treetank.access

Class Session

java.lang.Object

org.treetank.access.Session

All Implemented Interfaces:

ISession

public final class Session
extends Object
implements ISession

Session

Makes sure that there only is a single session instance bound to a TreeTank file.

Field Summary

Fields

Modifier and Type	Field and Description
protected SessionConfiguration	mSessionConfig Session configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Session(Storage pStorage, ResourceConfiguration pResourceConf, SessionConfiguration pSessionConf, UberBucket pBucket) Hidden constructor, only visible for the Storage-Class for instantiation.

Method Summary

Methods

Modifier and Type	Method and Description
IBucketReadTrx	beginBucketRtx(long pRevKey) Begin exclusive read transaction on the bucket layer
IBucketWriteTrx	beginBucketWtx() Begin exclusive write transaction on the bucket layer
IBucketWriteTrx	beginBucketWtx(long mRepresentRevision) Begin exclusive write transaction on the bucket layer with fixed revisions.
boolean	close() Safely close session and immediately release all resources.
boolean	deregisterBucketTrx(IBucketReadTrx pTrx) Deregisters a registered bucket transaction.
ResourceConfiguration	getConfig() Getting the resource configuration
long	getMostRecentVersion() Getting the most recent version from the storage.
protected void	setLastCommittedUberBucket(UberBucket pBucket)
void	setRunningCommit(Future<Void> pRunningCommit) Setting running commit to session.
String	toString()
boolean	truncate() Truncating the resource where this ISession is bound to.
void	waitForRunningCommit() Waiting and blocking for running commit.

Methods inherited from class java.lang.Object

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

Field Detail

mSessionConfig

protected final SessionConfiguration mSessionConfig

Session configuration.

Constructor Detail

Session

protected Session(Storage pStorage,
       ResourceConfiguration pResourceConf,
       SessionConfiguration pSessionConf,
       UberBucket pBucket)
           throws TTException

Hidden constructor, only visible for the Storage-Class for instantiation.

Parameters:

pStorage - Storage for centralized operations on related sessions.

pSessionConf - StorageConfiguration for general setting about the storage

pResourceConf - ResourceConfiguration for handling this specific session

pBucket - to be set.

Throws:

TTException

Method Detail

beginBucketRtx

public IBucketReadTrx beginBucketRtx(long pRevKey)
                              throws TTException

Description copied from interface: ISession

Begin exclusive read transaction on the bucket layer

Specified by:

beginBucketRtx in interface ISession

Parameters:

pRevKey - revision key for the revision ask

Returns:

a IBucketReadTrx instance

Throws:

TTException

beginBucketWtx

public IBucketWriteTrx beginBucketWtx()
                               throws TTException

Description copied from interface: ISession

Begin exclusive write transaction on the bucket layer

Specified by:

beginBucketWtx in interface ISession

Returns:

a IBucketReadTrx instance

Throws:

TTException

beginBucketWtx

public IBucketWriteTrx beginBucketWtx(long mRepresentRevision)
                               throws TTException

Description copied from interface: ISession

Begin exclusive write transaction on the bucket layer with fixed revisions.

Specified by:

beginBucketWtx in interface ISession

Returns:

a IBucketReadTrx instance

Throws:

TTException

close

public boolean close()
              throws TTException

Safely close session and immediately release all resources. If there are running transactions, they will automatically be closed. This is an idempotent operation and does nothing if the session is already closed.

Specified by:

close in interface ISession

Returns:

true if successful, false otherwise

Throws:

TTException - If can't close session.

truncate

public boolean truncate()
                 throws TTException

Truncating the resource where this ISession is bound to. Note that the session must be closed first.

Specified by:

truncate in interface ISession

Returns:

true if successful, false otherwise

Throws:

TTException - if anything weird happens.

setLastCommittedUberBucket

protected void setLastCommittedUberBucket(UberBucket pBucket)

getMostRecentVersion

public long getMostRecentVersion()
                          throws TTIOException

Getting the most recent version from the storage.

Specified by:

getMostRecentVersion in interface ISession

Returns:

the most recent version

Throws:

TTIOException

getConfig

public ResourceConfiguration getConfig()

Getting the resource configuration

Specified by:

getConfig in interface ISession

Returns:

the config of the resource

deregisterBucketTrx

public boolean deregisterBucketTrx(IBucketReadTrx pTrx)
                            throws TTIOException

Deregisters a registered bucket transaction.

Specified by:

deregisterBucketTrx in interface ISession

Parameters:

pTrx - to be deregistered.

Returns:

true if successful, false otherwise

Throws:

TTIOException

toString

public String toString()

Overrides:

toString in class Object

waitForRunningCommit

public void waitForRunningCommit()
                          throws TTIOException

Waiting and blocking for running commit. Necessary before new commits are triggered or new transactions are started.

Specified by:

waitForRunningCommit in interface ISession

Throws:

TTIOException - if something goes weird

setRunningCommit

public void setRunningCommit(Future<Void> pRunningCommit)

Setting running commit to session.

Specified by:

setRunningCommit in interface ISession

Parameters:

pRunningCommit - to be set