org.objectweb.perseus.fos.api
Interface FosManager

All Superinterfaces:

FosAttributeControler, FosLoggerFactory

All Known Implementing Classes:

FosTxContextFactory

public interface FosManager

extends FosAttributeControler, FosLoggerFactory

Defines the means to manipulate FOS transaction and the FOS repository.

Author:

S. Chassande-Barrioz, P. Déchamboux

Field Summary

static java.lang.String

SPECVERSION

Fields inherited from interface org.objectweb.perseus.fos.api.FosLoggerFactory

CONNECTION, DEBUG, MANAGEDCONNECTION, TXCONTEXT, XARESOURCE

Method Summary

FosTransaction	createTxContext() Creates a new FosTransaction for managing transactional I/Os with Data Object Files.
javax.transaction.xa.Xid[]	getXidForRecovery() Gets all the Xid of distributed transaction that need to be recovered by a DTP monitor.
void	initialize() Initializes the root directory for storing files representing data objects.
void	releaseTxContext(FosTransaction txc) Releases a FosTransaction.
void	start()
void	stop()

Methods inherited from interface org.objectweb.perseus.fos.api.FosAttributeControler

getDbDir, setDbDir

Methods inherited from interface org.objectweb.perseus.fos.api.FosLoggerFactory

getLogger, setMonologFactory

Field Detail

SPECVERSION

public static final java.lang.String SPECVERSION

See Also:

Constant Field Values

Method Detail

start

public void start()
           throws FosException

Throws:

FosException

stop

public void stop()
          throws FosException

Throws:

FosException

initialize

public void initialize()
                throws FosException

Initializes the root directory for storing files representing data objects. It removes all existing data files and creates all data for managing transactions. It must be performed before starting the FOS.

Throws:

FosException

getXidForRecovery

public javax.transaction.xa.Xid[] getXidForRecovery()

Gets all the Xid of distributed transaction that need to be recovered by a DTP monitor. This method can only be called once (recoverable XID are lost upon new calls).

Returns:

The array of Xid of transactions that need to be recovered.

createTxContext

public FosTransaction createTxContext()
                               throws FosException

Creates a new FosTransaction for managing transactional I/Os with Data Object Files.

Throws:

FosException

releaseTxContext

public void releaseTxContext(FosTransaction txc)
                      throws FosException

Releases a FosTransaction. Useful if adding a transaction pool.

Parameters:

txc - The FosTransaction to be released.

Throws:

FosException