org.fcrepo.kernel

Interface Transaction

public interface Transaction

Since:

Feb 18, 2014

Author:

bbpennel

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Transaction.State

Method Summary

Methods

Modifier and Type	Method and Description
void	addPathToVersion(String absPath) Adds a path at which a new version should be made upon successful completion of this transaction.
void	commit(VersionService vService) "Commit" the transaction by saving the backing-session
void	expire() End the session, and mark for reaping
Date	getCreated() Get the date this transaction was created
Date	getExpires() Get the Date when this transaction is expired and can be garbage-collected
String	getId() Get the transaction identifier
javax.jcr.Session	getSession() Get the transaction-aware session
Transaction.State	getState() Get the state of this transaction
boolean	isAssociatedWithUser(String userName) Checks if this transaction is associated with a specific user.
void	rollback() Discard all unpersisted changes and expire
void	updateExpiryDate() Roll forward the expiration date for recent activity

Method Detail

getSession

javax.jcr.Session getSession()

Get the transaction-aware session

Returns:

transaction-aware session

getCreated

Date getCreated()

Get the date this transaction was created

Returns:

creation date

getId

String getId()

Get the transaction identifier

Returns:

transaction id

getState

Transaction.State getState()
                           throws javax.jcr.RepositoryException

Get the state of this transaction

Returns:

transaction state

Throws:

javax.jcr.RepositoryException

getExpires

Date getExpires()

Get the Date when this transaction is expired and can be garbage-collected

Returns:

transaction expiration date

addPathToVersion

void addPathToVersion(String absPath)

Adds a path at which a new version should be made upon successful completion of this transaction. Subsequent calls with the same path have no effect, as the entire transaction is meant to be atomic and only one new version can result from it.

Parameters:

absPath - the object path to the resource to have a version checkpoint made

commit

void commit(VersionService vService)
            throws javax.jcr.RepositoryException

"Commit" the transaction by saving the backing-session

Parameters:

vService - a versionService

Throws:

javax.jcr.RepositoryException

expire

void expire()

End the session, and mark for reaping

isAssociatedWithUser

boolean isAssociatedWithUser(String userName)

Checks if this transaction is associated with a specific user. If username is null, it is assumed that the transaction is anonymous and thus not bound to any user.

Parameters:

userName - the user

Returns:

true if the userName is associated with this transaction

rollback

void rollback()
              throws javax.jcr.RepositoryException

Discard all unpersisted changes and expire

Throws:

javax.jcr.RepositoryException

updateExpiryDate

void updateExpiryDate()

Roll forward the expiration date for recent activity