org.treetank.api

Interface ISession

All Known Implementing Classes:

Session

public interface ISession

Each IStorage contains multiple resources. To each resource, one ISession can be bound. Transactions can then be started from this instance. There can only be one IBucketWriteTrx at the time. However, multiple IBucketReadTrx can coexist concurrently: * //Ensure, storage and resources are created final IStorage storage = Storage.openStorage(FILE); final ISession session = storage.getSession(new SessionConfiguration(RESOURCENAME, KEY)); final IBucketReadTrx pRtx = session.beginBucketRtx(REVISION); final IBucketWriteTrx pWtx = session.beginBucketWtx();

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 pRevToRepresent) 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.
void	setRunningCommit(Future<Void> pRunningCommit) Setting running commit to session.
boolean	truncate() Truncating the resource where this ISession is bound to.
void	waitForRunningCommit() Waiting and blocking for running commit.

Method Detail

deregisterBucketTrx

boolean deregisterBucketTrx(IBucketReadTrx pTrx)
                            throws TTIOException

Deregisters a registered bucket transaction.

Parameters:

pTrx - to be deregistered.

Returns:

true if successful, false otherwise

Throws:

TTIOException

getConfig

ResourceConfiguration getConfig()

Getting the resource configuration

Returns:

the config of the resource

getMostRecentVersion

long getMostRecentVersion()
                          throws TTIOException

Getting the most recent version from the storage.

Returns:

the most recent version

Throws:

TTIOException

beginBucketWtx

IBucketWriteTrx beginBucketWtx()
                               throws TTException

Begin exclusive write transaction on the bucket layer

Returns:

a IBucketReadTrx instance

Throws:

TTException

beginBucketWtx

IBucketWriteTrx beginBucketWtx(long pRevToRepresent)
                               throws TTException

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

Parameters:

pRevToRepresent -

Returns:

a IBucketReadTrx instance

Throws:

TTException

beginBucketRtx

IBucketReadTrx beginBucketRtx(long pRevKey)
                              throws TTException

Begin exclusive read transaction on the bucket layer

Parameters:

pRevKey - revision key for the revision ask

Returns:

a IBucketReadTrx instance

Throws:

TTException

close

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.

Returns:

true if successful, false otherwise

Throws:

TTException - If can't close session.

truncate

boolean truncate()
                 throws TTException

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

Returns:

true if successful, false otherwise

Throws:

TTException - if anything weird happens.

waitForRunningCommit

void waitForRunningCommit()
                          throws TTIOException

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

Throws:

TTIOException - if something goes weird

setRunningCommit

void setRunningCommit(Future<Void> pRunningCommit)

Setting running commit to session.

Parameters:

pRunningCommit - to be set