org.waarp.common.database

Class DbSession

java.lang.Object

org.waarp.common.database.DbSession

public class DbSession
extends Object

Class to handle session with the SGBD

Author:

Frederic Bregier

Constructor Summary

Constructors

Constructor and Description
DbSession(DbAdmin admin, boolean isReadOnly) Create a session and connect the current object to the server using the DbAdmin object.
DbSession(DbAdmin admin, boolean isReadOnly, boolean autoCommit) Create a session and connect the current object to the server using the DbAdmin object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLongTermPreparedStatement(DbPreparedStatement longterm) Add a Long Term PreparedStatement
void	checkConnection() Check the connection to the Database and try to reopen it if possible
boolean	checkConnectionNoException()
void	commit() Commit everything
void	disconnect() Close the connection
void	endUseConnection() To be called when a client will stop to use this DbSession (once by client)
void	enUseConnectionNoDisconnect() To be called when a client will stop to use this DbSession (once by client).
boolean	equals(Object o)
static void	error(SQLException ex) Print the error from SQLException
void	forceDisconnect() Force the close of the connection
DbAdmin	getAdmin()
Connection	getConn()
UUID	getInternalId()
int	hashCode()
boolean	isAutoCommit()
boolean	isDisActive()
boolean	isReadOnly()
void	recreateLongTermPreparedStatements() Due to a reconnection, recreate all associated long term PreparedStatements
void	releaseSavepoint(Savepoint savepoint) Release the savepoint
void	removeLongTermPreparedStatements() Remove all Long Term PreparedStatements (closing connection)
void	removeLongTermPreparedStatements(DbPreparedStatement longterm) Remove one Long Term PreparedStatement
void	rollback(Savepoint savepoint) Rollback from the savepoint or the last set if null
Savepoint	savepoint() Make a savepoint
protected void	setAdmin(DbAdmin admin)
void	setAutoCommit(boolean autoCommit) Change the autocommit feature
void	setConn(Connection conn)
void	setDisActive(boolean isDisActive)
void	setReadOnly(boolean isReadOnly)
void	useConnection() To be called when a client will start to use this DbSession (once by client)

Methods inherited from class java.lang.Object

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

Constructor Detail

DbSession

public DbSession(DbAdmin admin,
         boolean isReadOnly)
          throws WaarpDatabaseNoConnectionException

Create a session and connect the current object to the server using the DbAdmin object. The database access use auto commit. If the initialize is not call before, call it with the default value.

Parameters:

admin -

isReadOnly -

Throws:

WaarpDatabaseSqlException

WaarpDatabaseNoConnectionException

DbSession

public DbSession(DbAdmin admin,
         boolean isReadOnly,
         boolean autoCommit)
          throws WaarpDatabaseNoConnectionException

Create a session and connect the current object to the server using the DbAdmin object. If the initialize is not call before, call it with the default value.

Parameters:

admin -

isReadOnly -

autoCommit -

Throws:

WaarpDatabaseSqlException

WaarpDatabaseNoConnectionException

Method Detail

setAutoCommit

public void setAutoCommit(boolean autoCommit)
                   throws WaarpDatabaseNoConnectionException

Change the autocommit feature

Parameters:

autoCommit -

Throws:

WaarpDatabaseNoConnectionException

getAdmin

public DbAdmin getAdmin()

Returns:

the admin

setAdmin

protected void setAdmin(DbAdmin admin)

Parameters:

admin - the admin to set

error

public static void error(SQLException ex)

Print the error from SQLException

Parameters:

ex -

useConnection

public void useConnection()

To be called when a client will start to use this DbSession (once by client)

endUseConnection

public void endUseConnection()

To be called when a client will stop to use this DbSession (once by client)

enUseConnectionNoDisconnect

public void enUseConnectionNoDisconnect()

To be called when a client will stop to use this DbSession (once by client). This version is not blocking.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

forceDisconnect

public void forceDisconnect()

Force the close of the connection

disconnect

public void disconnect()

Close the connection

checkConnection

public void checkConnection()
                     throws WaarpDatabaseNoConnectionException

Check the connection to the Database and try to reopen it if possible

Throws:

WaarpDatabaseNoConnectionException

checkConnectionNoException

public boolean checkConnectionNoException()

Returns:

True if the connection was successfully reconnected

addLongTermPreparedStatement

public void addLongTermPreparedStatement(DbPreparedStatement longterm)

Add a Long Term PreparedStatement

Parameters:

longterm -

recreateLongTermPreparedStatements

public void recreateLongTermPreparedStatements()
                                        throws WaarpDatabaseNoConnectionException,
                                               WaarpDatabaseSqlException

Due to a reconnection, recreate all associated long term PreparedStatements

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

removeLongTermPreparedStatements

public void removeLongTermPreparedStatements()

Remove all Long Term PreparedStatements (closing connection)

removeLongTermPreparedStatements

public void removeLongTermPreparedStatements(DbPreparedStatement longterm)

Remove one Long Term PreparedStatement

Parameters:

longterm -

commit

public void commit()
            throws WaarpDatabaseSqlException,
                   WaarpDatabaseNoConnectionException

Commit everything

Throws:

WaarpDatabaseSqlException

WaarpDatabaseNoConnectionException

rollback

public void rollback(Savepoint savepoint)
              throws WaarpDatabaseNoConnectionException,
                     WaarpDatabaseSqlException

Rollback from the savepoint or the last set if null

Parameters:

savepoint -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

savepoint

public Savepoint savepoint()
                    throws WaarpDatabaseNoConnectionException,
                           WaarpDatabaseSqlException

Make a savepoint

Returns:

the new savepoint

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

releaseSavepoint

public void releaseSavepoint(Savepoint savepoint)
                      throws WaarpDatabaseNoConnectionException,
                             WaarpDatabaseSqlException

Release the savepoint

Parameters:

savepoint -

Throws:

WaarpDatabaseNoConnectionException

WaarpDatabaseSqlException

isReadOnly

public boolean isReadOnly()

Returns:

the isReadOnly

setReadOnly

public void setReadOnly(boolean isReadOnly)

Parameters:

isReadOnly - the isReadOnly to set

isAutoCommit

public boolean isAutoCommit()

Returns:

the autoCommit

getConn

public Connection getConn()

Returns:

the conn

setConn

public void setConn(Connection conn)

Parameters:

conn - the conn to set

getInternalId

public UUID getInternalId()

Returns:

the internalId

isDisActive

public boolean isDisActive()

Returns:

the isDisActive

setDisActive

public void setDisActive(boolean isDisActive)

Parameters:

isDisActive - the isDisActive to set