Sirius.server.sql

Interface DBBackend

All Superinterfaces:

Shutdownable

All Known Implementing Classes:

DBConnection, DBConnectionPool

public interface DBBackend
extends Shutdownable

DOCUMENT ME!

Version:

$Revision$, $Date$

Author:

martin.scholl@cismet.de

Method Summary

Modifier and Type	Method and Description
Connection	getConnection() Returns a native JDBC Connection.
int	getRetriesOnError() Gets the current number of retries.
void	setRetriesOnError(int noOfRetries) Sets the number of retries the backend shall perform in case of an error during execution.
ResultSet	submitInternalQuery(String descriptor, Object... parameters) This operation shall be used to execute queries that related to the tables of the underlying cids system (cs_*).
int	submitInternalUpdate(String descriptor, Object... parameters) This operation shall be used to execute updates that related to the tables of the underlying cids system (cs_*).
ResultSet	submitQuery(int sqlID, Object... parameters) DOCUMENT ME! This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
ResultSet	submitQuery(String descriptor, Object... parameters) DOCUMENT ME! This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
int	submitUpdate(int sqlID, Object... parameters) DOCUMENT ME! This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
int	submitUpdate(String descriptor, Object... parameters) DOCUMENT ME! This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Methods inherited from interface Sirius.server.Shutdownable

isDown, shutdown

Method Detail

setRetriesOnError

void setRetriesOnError(int noOfRetries)

Sets the number of retries the backend shall perform in case of an error during execution. A negative integer will be interpreted as 0. The retry shall only take place if the underlying error indicates that the retry could be senseful (e.g. connection drop, db restart ...).

Parameters:

noOfRetries - the number of retries that shall be performed in case of an error during execution

See Also:

getRetriesOnError()

getRetriesOnError

int getRetriesOnError()

Gets the current number of retries. 0 or a negative int means that the operation will be performed exactly once, 1 means that the operation will be executed up to two times, 2 up to three times and so on. The retry shall only take place if the underlying error indicates that the retry could be senseful (e.g. connection drop, db restart ...).

Returns:

the current number of retries

getConnection

Connection getConnection()
                  throws SQLException

Returns a native JDBC Connection.

Returns:

a native JDBC Connection

Throws:

SQLException - if any error occurs while acquiring the Connection

submitInternalQuery

ResultSet submitInternalQuery(String descriptor,
                              Object... parameters)
                       throws SQLException

This operation shall be used to execute queries that related to the tables of the underlying cids system (cs_*). The available query descriptors are defined within this interface. Any other given descriptor String results in a SQLException.
The number of given parameters must match the parameter count of the statement described by the given descriptor. If the number of the parameters mismatch a SQLException is thrown.

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

descriptor - one of the descriptors defined in this interface

parameters - the parameters the underlying query will take

Returns:

the ResultSet of the executed query

Throws:

SQLException -

• if the given descriptor is invalid
• if the parameter count mismatches
• if any other error occurs during execution
• if shutdown has been called

submitInternalUpdate

int submitInternalUpdate(String descriptor,
                         Object... parameters)
                  throws SQLException

This operation shall be used to execute updates that related to the tables of the underlying cids system (cs_*). The available query descriptors are defined within this interface. Any other given descriptor String results in a SQLException.
The number of given parameters must match the parameter count of the statement described by the given descriptor. If the number of the parameters mismatch a SQLException is thrown.

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

descriptor - one of the descriptors defined in this interface

parameters - the parameters the underlying query will take

Returns:

the row count affected by the executed update

Throws:

SQLException -

• if the given descriptor is invalid
• if the parameter count mismatches
• if any other error occurs during execution
• if shutdown has been called

submitQuery

ResultSet submitQuery(String descriptor,
                      Object... parameters)
               throws SQLException

DOCUMENT ME!

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

descriptor - DOCUMENT ME!

parameters - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

SQLException - DOCUMENT ME!

submitQuery

ResultSet submitQuery(int sqlID,
                      Object... parameters)
               throws SQLException

DOCUMENT ME!

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

sqlID - DOCUMENT ME!

parameters - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

SQLException - DOCUMENT ME!

submitUpdate

int submitUpdate(String descriptor,
                 Object... parameters)
          throws SQLException

DOCUMENT ME!

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

descriptor - DOCUMENT ME!

parameters - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

SQLException - DOCUMENT ME!

submitUpdate

int submitUpdate(int sqlID,
                 Object... parameters)
          throws SQLException

DOCUMENT ME!

This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.

Parameters:

sqlID - DOCUMENT ME!

parameters - DOCUMENT ME!

Returns:

DOCUMENT ME!

Throws:

SQLException - DOCUMENT ME!