Package fr.dyade.aaa.util

Class NullTransaction

java.lang.Object

fr.dyade.aaa.util.BaseTransaction

fr.dyade.aaa.util.NullTransaction

All Implemented Interfaces:

NullTransactionMBean, Transaction, TransactionMBean

public final class NullTransaction
extends BaseTransaction
implements NullTransactionMBean

Field Summary

Fields

Modifier and Type	Field	Description
private int	commitCount	Number of commit operation since starting up.
protected int	phase
protected long	startTime

Fields inherited from class fr.dyade.aaa.util.BaseTransaction

DEBUG, logmon

Fields inherited from interface fr.dyade.aaa.util.Transaction

BACKUP, COMMIT, FINALIZE, FREE, GARBAGE, INIT, Kb, Mb, PhaseInfo, ROLLBACK, RUN

Constructor Summary

Constructors

Constructor	Description
NullTransaction()

Method Summary

Modifier and Type	Method	Description
String	backup(String path)	Backups the content of Transaction module.
void	begin()	Start a transaction validation, the validation phase needs 3 phases: begin, commit and release.
void	close()	Close the transaction module.
void	commit(boolean release)	Commit the current transaction.
boolean	containsOperations()	Indicates whether some operations have been done in this transaction.
void	create(Serializable obj, String name)	Register the state of a newly created object in the current transaction.
void	create(Serializable obj, String dirName, String name)	Register the state of a newly created object in the current transaction.
void	createByteArray(byte[] buf, String name)	Register a new byte array in the current transaction.
void	createByteArray(byte[] buf, String dirName, String name)	Register a new byte array in the current transaction.
void	delete(String name)	Deletes the specified object.
void	delete(String dirName, String name)	Deletes the specified object.
int	getCommitCount()	Returns the number of commit operation since starting up.
File	getDir()
String[]	getList(String prefix)	Returns an array of strings naming the objects in the component started by this prefix.
int	getOperationCount()	Returns the number of operations to be committed.
String	getPersistenceDir()	Returns the path of persistence directory.
int	getPhase()	Returns the transaction state.
String	getPhaseInfo()	Returns a string representation of the transaction state.
long	getStartTime()	Returns the starting time.
void	init(String path)	Initializes the atomic storage component.
boolean	isPersistent()	Tests if the Transaction component is persistent.
Object	load(String name)	Load the specified object.
Object	load(String dirName, String name)	Load the specified object.
void	loadAll(String prefix, Map map)	Fills the map with all objects of the component whose name begins with the prefix.
byte[]	loadByteArray(String name)	Load the specified byte array.
byte[]	loadByteArray(String dirName, String name)	Load the specified byte array.
void	release()	Release the mutual exclusion.
void	save(Serializable obj, String name)	Register the modified state of an object in the current transaction.
void	save(Serializable obj, String dirName, String name)	Register the modified state of an object in the current transaction.
void	save(Serializable obj, String dirName, String name, boolean first)	Register the state of an object in the current transaction.
void	saveByteArray(byte[] buf, String name)	Register a modified byte array in the current transaction.
void	saveByteArray(byte[] buf, String dirName, String name)	Register a modified byte array in the current transaction.
void	saveByteArray(byte[] buf, String dirName, String name, boolean copy, boolean first)	Register a modified byte array in the current transaction.
protected void	setPhase(int newPhase)
void	stop()	Stops the transaction module.
boolean	useLoadAll()	Returns true if this Transaction implementation implements an optimized loadAll method.

Methods inherited from class fr.dyade.aaa.util.BaseTransaction

dumpObjectList, freeze, getBoolean, getInteger, getInteger, getObject, getObjectList, getProperty, getProperty, loadProperties, saveProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface fr.dyade.aaa.util.TransactionMBean

dumpObjectList, getObject, getObjectList

Field Detail

startTime

protected long startTime

phase

protected int phase

commitCount

private int commitCount

Number of commit operation since starting up.

Constructor Detail

NullTransaction

public NullTransaction()

Method Detail

getStartTime

public long getStartTime()

Returns the starting time.

Specified by:

getStartTime in interface TransactionMBean

Returns:

The starting time.

getPhase

public final int getPhase()

Description copied from interface: TransactionMBean

Returns the transaction state.

Specified by:

getPhase in interface Transaction

Specified by:

getPhase in interface TransactionMBean

Returns:

the transaction state.

getPhaseInfo

public final String getPhaseInfo()

Description copied from interface: TransactionMBean

Returns a string representation of the transaction state.

Specified by:

getPhaseInfo in interface Transaction

Specified by:

getPhaseInfo in interface TransactionMBean

Returns:

the string representation of the transaction state.

setPhase

protected final void setPhase(int newPhase)

getCommitCount

public final int getCommitCount()

Returns the number of commit operation since starting up.

Specified by:

getCommitCount in interface Transaction

Specified by:

getCommitCount in interface TransactionMBean

Returns:

The number of commit operation.

isPersistent

public boolean isPersistent()

Tests if the Transaction component is persistent.

Specified by:

isPersistent in interface Transaction

Specified by:

isPersistent in interface TransactionMBean

Returns:

false.

init

public void init(String path)
          throws IOException

Description copied from interface: Transaction

Initializes the atomic storage component.

Specified by:

init in interface Transaction

Parameters:

path - the path of storage directory.

Throws:

IOException - an error occurs.

getDir

public File getDir()

getPersistenceDir

public String getPersistenceDir()

Returns the path of persistence directory.

Returns:

null.

begin

public final void begin()
                 throws IOException

Description copied from interface: Transaction

Start a transaction validation, the validation phase needs 3 phases: begin, commit and release. The begin ensure the mutual exclusion of the current transaction.

Specified by:

begin in interface Transaction

Throws:

IOException - an error occurs.

getList

public String[] getList(String prefix)

Description copied from interface: Transaction

Returns an array of strings naming the objects in the component started by this prefix.

Specified by:

getList in interface Transaction

Parameters:

prefix - the prefix of searched objects.

Returns:

an array of strings naming the objects in the component started by this prefix.

useLoadAll

public boolean useLoadAll()

Description copied from interface: TransactionMBean

Returns true if this Transaction implementation implements an optimized loadAll method.

Specified by:

useLoadAll in interface Transaction

Specified by:

useLoadAll in interface TransactionMBean

Returns:

true if this Transaction implementation implements an optimized loadAll method.

loadAll

public void loadAll(String prefix,
                    Map map)

Description copied from interface: Transaction

Fills the map with all objects of the component whose name begins with the prefix. Each loaded object is registered in the map with its persistent name as key.

Specified by:

loadAll in interface Transaction

Parameters:

prefix - The prefix of searched objects.

map - The map of corresponding objects.

create

public final void create(Serializable obj,
                         String name)
                  throws IOException

Description copied from interface: Transaction

Register the state of a newly created object in the current transaction.

Specified by:

create in interface Transaction

Parameters:

obj - the object to store.

name - the name of the object.

Throws:

IOException - an error occurs.

create

public final void create(Serializable obj,
                         String dirName,
                         String name)
                  throws IOException

Description copied from interface: Transaction

Register the state of a newly created object in the current transaction.

Specified by:

create in interface Transaction

Parameters:

obj - the object to store.

dirName - the directory name of the object.

name - the name of the object.

Throws:

IOException - an error occurs.

save

public final void save(Serializable obj,
                       String name)
                throws IOException

Description copied from interface: Transaction

Register the modified state of an object in the current transaction.

Specified by:

save in interface Transaction

Parameters:

obj - the object to store.

name - the name of the object.

Throws:

IOException - an error occurs.

save

public final void save(Serializable obj,
                       String dirName,
                       String name)
                throws IOException

Description copied from interface: Transaction

Register the modified state of an object in the current transaction.

Specified by:

save in interface Transaction

Parameters:

obj - the object to store.

dirName - the directory name of the object.

name - the name of the object.

Throws:

IOException - an error occurs.

save

public void save(Serializable obj,
                 String dirName,
                 String name,
                 boolean first)
          throws IOException

Description copied from interface: Transaction

Register the state of an object in the current transaction.

Specified by:

save in interface Transaction

Parameters:

obj - the object to store.

dirName - the directory name of the object.

name - the name of the object.

first - the object is a new one.

Throws:

IOException - an error occurs.

createByteArray

public final void createByteArray(byte[] buf,
                                  String name)
                           throws IOException

Description copied from interface: Transaction

Register a new byte array in the current transaction.

Specified by:

createByteArray in interface Transaction

Parameters:

buf - the byte array to store.

name - the name of the object.

Throws:

IOException - an error occurs.

createByteArray

public final void createByteArray(byte[] buf,
                                  String dirName,
                                  String name)
                           throws IOException

Description copied from interface: Transaction

Register a new byte array in the current transaction.

Specified by:

createByteArray in interface Transaction

Parameters:

buf - the byte array to store.

dirName - the directory name of the object.

name - the name of the object.

Throws:

IOException - an error occurs.

saveByteArray

public final void saveByteArray(byte[] buf,
                                String name)
                         throws IOException

Description copied from interface: Transaction

Register a modified byte array in the current transaction.

Specified by:

saveByteArray in interface Transaction

Parameters:

buf - the byte array to store.

name - the name of the object.

Throws:

IOException - an error occurs.

saveByteArray

public final void saveByteArray(byte[] buf,
                                String dirName,
                                String name)
                         throws IOException

Description copied from interface: Transaction

Register a modified byte array in the current transaction.

Specified by:

saveByteArray in interface Transaction

Parameters:

buf - the byte array to store.

dirName - the directory name of the object.

name - the name of the object.

Throws:

IOException - an error occurs.

saveByteArray

public void saveByteArray(byte[] buf,
                          String dirName,
                          String name,
                          boolean copy,
                          boolean first)
                   throws IOException

Description copied from interface: Transaction

Register a modified byte array in the current transaction.

Specified by:

saveByteArray in interface Transaction

Parameters:

buf - the byte array to store.

dirName - the directory name of the object.

name - the name of the object.

copy - the byte array can be modified, copy it.

first - the object is a new one.

Throws:

IOException - an error occurs.

load

public final Object load(String name)
                  throws IOException,
                         ClassNotFoundException

Description copied from interface: Transaction

Load the specified object.

Specified by:

load in interface Transaction

Parameters:

name - the name of the object.

Returns:

the loaded object.

Throws:

IOException - an error occurs.

ClassNotFoundException - an error occurs.

load

public final Object load(String dirName,
                         String name)
                  throws IOException,
                         ClassNotFoundException

Description copied from interface: Transaction

Load the specified object.

Specified by:

load in interface Transaction

Parameters:

dirName - the directory name of the object.

name - the name of the object.

Returns:

the loaded object.

Throws:

IOException - an error occurs.

ClassNotFoundException - an error occurs.

loadByteArray

public final byte[] loadByteArray(String name)
                           throws IOException

Description copied from interface: Transaction

Load the specified byte array.

Specified by:

loadByteArray in interface Transaction

Parameters:

name - the name of the object.

Returns:

the loaded byte array.

Throws:

IOException - an error occurs.

loadByteArray

public byte[] loadByteArray(String dirName,
                            String name)
                     throws IOException

Description copied from interface: Transaction

Load the specified byte array.

Specified by:

loadByteArray in interface Transaction

Parameters:

dirName - the directory name of the object.

name - the name of the object.

Returns:

the loaded byte array.

Throws:

IOException - an error occurs.

delete

public final void delete(String name)

Description copied from interface: Transaction

Deletes the specified object.

Specified by:

delete in interface Transaction

Parameters:

name - the name of the object.

delete

public void delete(String dirName,
                   String name)

Description copied from interface: Transaction

Deletes the specified object.

Specified by:

delete in interface Transaction

Parameters:

dirName - the directory name of the object.

name - the name of the object.

commit

public void commit(boolean release)
            throws IOException

Description copied from interface: Transaction

Commit the current transaction.

Specified by:

commit in interface Transaction

Parameters:

release - if true releases the transaction at the end of the commit.

Throws:

IOException - an error occurs.

release

public void release()
             throws IOException

Description copied from interface: Transaction

Release the mutual exclusion.

Specified by:

release in interface Transaction

Throws:

IOException - an error occurs.

stop

public final void stop()

Description copied from interface: Transaction

Stops the transaction module. It waits all transactions termination, then the module is kept in a FREE 'ready to use' state.

Specified by:

stop in interface Transaction

close

public final void close()

Description copied from interface: Transaction

Close the transaction module. It waits all transactions termination, the module will be initialized anew before reusing it.

Specified by:

close in interface Transaction

containsOperations

public boolean containsOperations()

Indicates whether some operations have been done in this transaction.

Specified by:

containsOperations in interface Transaction

Returns:

true if some operations are waiting for commit in this transaction.

getOperationCount

public int getOperationCount()

Returns the number of operations to be committed.

Specified by:

getOperationCount in interface Transaction

Returns:

the number of operations to be committed.

backup

public String backup(String path)
              throws Exception

Backups the content of Transaction module. Produces a generic Backup/Restore file containing all living objects. Currently not implemented, throws an UnsupportedOperationException.

Specified by:

backup in interface Transaction

Specified by:

backup in interface TransactionMBean

Parameters:

path - Directory path to store the backup.

Returns:

the name of created backup file.

Throws:

Exception - An error occurs during backup.