DBConnection (cids Server [9.3-SNAPSHOT] 9.3-SNAPSHOT API)

java.lang.Object
- Sirius.server.sql.DBConnection

All Implemented Interfaces:

Shutdownable, DBBackend
```
public final class DBConnection
extends Object
implements DBBackend
```
:-) DOCUMENT ME!

Version:

1.1 refactored on 2011/01/13

Author:

Sascha Schlobinski, mscholl, helllth

Field Summary

Fields
Modifier and Type	Field and Description
`protected DBClassifier`	`dbc`
`static String`	`DESC_CHANGE_USER_PASSWORD`
`static String`	`DESC_DELETE_CACHEENTRY` parameters to put in: class id, object id,
`static String`	`DESC_FETCH_CONFIG_ATTR_DOMAIN_VALUE`
`static String`	`DESC_FETCH_CONFIG_ATTR_EXEMPT_VALUE`
`static String`	`DESC_FETCH_CONFIG_ATTR_KEY_ID`
`static String`	`DESC_FETCH_CONFIG_ATTR_UG_VALUE`
`static String`	`DESC_FETCH_CONFIG_ATTR_USER_VALUE`
`static String`	`DESC_FETCH_DOMAIN_ID_FROM_DOMAIN_STRING`
`static String`	`DESC_FETCH_HISTORY`
`static String`	`DESC_FETCH_HISTORY_LIMIT`
`static String`	`DESC_GET_ALL_CLASS_ATTRIBUTES`
`static String`	`DESC_GET_ALL_CLASS_PERMS`
`static String`	`DESC_GET_ALL_CLASSES`
`static String`	`DESC_GET_ALL_IMAGES`
`static String`	`DESC_GET_ALL_MEMBERSHIPS`
`static String`	`DESC_GET_ALL_METHOD_PERMS`
`static String`	`DESC_GET_ALL_METHODS`
`static String`	`DESC_GET_ALL_USERGROUPS`
`static String`	`DESC_GET_ALL_USERS`
`static String`	`DESC_GET_ATTRIBUTE_INFO`
`static String`	`DESC_HAS_HISTORY`
`static String`	`DESC_INSERT_CACHEENTRY` parameters to put in: primary key field, object id, class id
`static String`	`DESC_INSERT_HISTORY_ENTRY`
`static String`	`DESC_SUPPORTS_SCHEDULED_SERVER_ACTIONS`
`static String`	`DESC_TABLE_HAS_COLUMN`
`static String`	`DESC_UPDATE_CACHEENTRY` parameters to put in: primary key field, object id, object id, class id
`static String`	`DESC_VERIFY_USER_PW`
`static String`	`GET_ALL_CS_CONFIG_ATTR`
`static String`	`GET_ALL_CS_CONFIG_ATTR_EXEMPT`
`static String`	`INSERT_CS_CHANGED_CLASS_ENTRY`
`static String`	`INSERT_CS_CHANGED_OBJECT_ENTRY`
`static String`	`IS_USER_DEACTIVATED`
`static String`	`SQL_CODE_ALREADY_CLOSED`
`static String`	`SQL_CODE_INVALID_DESC`
`static String`	`UPDATE_CS_CHANGED_CLASS_ENTRY`
`static String`	`UPDATE_CS_CHANGED_OBJECT_ENTRY`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`DBConnection(DBClassifier dbc, DBConnectionPool.CheckConnection connectionChecker)` Creates a new DBConnection object.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`charToBool(char bool)` DOCUMENT ME!
`void`	`close()` DOCUMENT ME!
`static void`	`closeConnections(Connection... cons)` Closes all given `Connection`s and logs a warning message if an error occurs while closing.
`static void`	`closeResultSets(ResultSet... sets)` Closes all given `ResultSet`s and logs a warning message if an error occurs while closing.
`static void`	`closeStatements(Statement... stmts)` Closes all given `Statement`s and logs a warning message if an error occurs while closing.
`Connection`	`getConnection()` The `Connection` used by this `DBConnection.`
`DBConnectionPool.CheckConnection`	`getConnectionChecker()` DOCUMENT ME!
`String`	`getDriver()` The driver class of the jdbc driver.
`String`	`getPassword()` The password of the currently logged-in db user.
`long`	`getPoolLeftTime()` DOCUMENT ME!
`int`	`getRetriesOnError()` Always returns `0` as retries are not supported.
`StatementCache`	`getStatementCache()` DOCUMENT ME!
`String`	`getURL()` The URL of the jdbc driver connection.
`String`	`getUser()` The currently logged-in db username.
`boolean`	`isClosed()` Returns the current closed state of the connection.
`boolean`	`isDown()` Simply calls `isClosed()`.
`boolean`	`isValid()` Returns the current closed state of the connection.
`void`	`setConnectionChecker(DBConnectionPool.CheckConnection connectionChecker)` DOCUMENT ME!
`void`	`setPoolLeftTime(long poolLeftTime)` DOCUMENT ME!
`void`	`setRetriesOnError(int noOfRetries)` Calls to this operation will to nothing since retries are not supported.
`void`	`shutdown()` Simply calls `close()`.
`static boolean`	`stringToBool(String bool)` DOCUMENT ME!
`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 class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SQL_CODE_ALREADY_CLOSED
```
public static final String SQL_CODE_ALREADY_CLOSED
```
    See Also:
    
    Constant Field Values
  - SQL_CODE_INVALID_DESC
```
public static final String SQL_CODE_INVALID_DESC
```
    See Also:
    
    Constant Field Values
  - DESC_VERIFY_USER_PW
```
public static final String DESC_VERIFY_USER_PW
```
    See Also:
    
    Constant Field Values
  - IS_USER_DEACTIVATED
```
public static final String IS_USER_DEACTIVATED
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_DOMAIN_ID_FROM_DOMAIN_STRING
```
public static final String DESC_FETCH_DOMAIN_ID_FROM_DOMAIN_STRING
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_CONFIG_ATTR_KEY_ID
```
public static final String DESC_FETCH_CONFIG_ATTR_KEY_ID
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_CONFIG_ATTR_USER_VALUE
```
public static final String DESC_FETCH_CONFIG_ATTR_USER_VALUE
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_CONFIG_ATTR_UG_VALUE
```
public static final String DESC_FETCH_CONFIG_ATTR_UG_VALUE
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_CONFIG_ATTR_DOMAIN_VALUE
```
public static final String DESC_FETCH_CONFIG_ATTR_DOMAIN_VALUE
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_CONFIG_ATTR_EXEMPT_VALUE
```
public static final String DESC_FETCH_CONFIG_ATTR_EXEMPT_VALUE
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_HISTORY
```
public static final String DESC_FETCH_HISTORY
```
    See Also:
    
    Constant Field Values
  - DESC_FETCH_HISTORY_LIMIT
```
public static final String DESC_FETCH_HISTORY_LIMIT
```
    See Also:
    
    Constant Field Values
  - DESC_INSERT_HISTORY_ENTRY
```
public static final String DESC_INSERT_HISTORY_ENTRY
```
    See Also:
    
    Constant Field Values
  - DESC_HAS_HISTORY
```
public static final String DESC_HAS_HISTORY
```
    See Also:
    
    Constant Field Values
  - DESC_TABLE_HAS_COLUMN
```
public static final String DESC_TABLE_HAS_COLUMN
```
    See Also:
    
    Constant Field Values
  - DESC_DELETE_CACHEENTRY
```
public static final String DESC_DELETE_CACHEENTRY
```
    parameters to put in: class id, object id,
    
    See Also:
    
    Constant Field Values
  - DESC_INSERT_CACHEENTRY
```
public static final String DESC_INSERT_CACHEENTRY
```
    parameters to put in: primary key field, object id, class id
    
    See Also:
    
    Constant Field Values
  - DESC_UPDATE_CACHEENTRY
```
public static final String DESC_UPDATE_CACHEENTRY
```
    parameters to put in: primary key field, object id, object id, class id
    
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_USERGROUPS
```
public static final String DESC_GET_ALL_USERGROUPS
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_CLASSES
```
public static final String DESC_GET_ALL_CLASSES
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_CLASS_ATTRIBUTES
```
public static final String DESC_GET_ALL_CLASS_ATTRIBUTES
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_METHODS
```
public static final String DESC_GET_ALL_METHODS
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_IMAGES
```
public static final String DESC_GET_ALL_IMAGES
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_USERS
```
public static final String DESC_GET_ALL_USERS
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_MEMBERSHIPS
```
public static final String DESC_GET_ALL_MEMBERSHIPS
```
    See Also:
    
    Constant Field Values
  - DESC_CHANGE_USER_PASSWORD
```
public static final String DESC_CHANGE_USER_PASSWORD
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_CLASS_PERMS
```
public static final String DESC_GET_ALL_CLASS_PERMS
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ALL_METHOD_PERMS
```
public static final String DESC_GET_ALL_METHOD_PERMS
```
    See Also:
    
    Constant Field Values
  - DESC_GET_ATTRIBUTE_INFO
```
public static final String DESC_GET_ATTRIBUTE_INFO
```
    See Also:
    
    Constant Field Values
  - DESC_SUPPORTS_SCHEDULED_SERVER_ACTIONS
```
public static final String DESC_SUPPORTS_SCHEDULED_SERVER_ACTIONS
```
    See Also:
    
    Constant Field Values
  - UPDATE_CS_CHANGED_OBJECT_ENTRY
```
public static final String UPDATE_CS_CHANGED_OBJECT_ENTRY
```
    See Also:
    
    Constant Field Values
  - UPDATE_CS_CHANGED_CLASS_ENTRY
```
public static final String UPDATE_CS_CHANGED_CLASS_ENTRY
```
    See Also:
    
    Constant Field Values
  - INSERT_CS_CHANGED_OBJECT_ENTRY
```
public static final String INSERT_CS_CHANGED_OBJECT_ENTRY
```
    See Also:
    
    Constant Field Values
  - INSERT_CS_CHANGED_CLASS_ENTRY
```
public static final String INSERT_CS_CHANGED_CLASS_ENTRY
```
    See Also:
    
    Constant Field Values
  - GET_ALL_CS_CONFIG_ATTR
```
public static final String GET_ALL_CS_CONFIG_ATTR
```
    See Also:
    
    Constant Field Values
  - GET_ALL_CS_CONFIG_ATTR_EXEMPT
```
public static final String GET_ALL_CS_CONFIG_ATTR_EXEMPT
```
    See Also:
    
    Constant Field Values
  - dbc
```
protected final DBClassifier dbc
```
- Constructor Detail
  - DBConnection
```
protected DBConnection(DBClassifier dbc,
                       DBConnectionPool.CheckConnection connectionChecker)
                throws ServerExitError
```
    Creates a new DBConnection object.
    
    Parameters:
    
    dbc - DOCUMENT ME!
    
    connectionChecker - DOCUMENT ME!
    
    Throws:
    
    ServerExitError - DOCUMENT ME!
- Method Detail
  - getPoolLeftTime
```
public long getPoolLeftTime()
```
    DOCUMENT ME!
    
    Returns:
    
    the poolLeftTime
  - setPoolLeftTime
```
public void setPoolLeftTime(long poolLeftTime)
```
    DOCUMENT ME!
    
    Parameters:
    
    poolLeftTime - the poolLeftTime to set
  - setConnectionChecker
```
public void setConnectionChecker(DBConnectionPool.CheckConnection connectionChecker)
```
    DOCUMENT ME!
    
    Parameters:
    
    connectionChecker - the connectionChecker to set
  - getConnectionChecker
```
public DBConnectionPool.CheckConnection getConnectionChecker()
```
    DOCUMENT ME!
    
    Returns:
    
    the connectionChecker
  - charToBool
```
public static boolean charToBool(char bool)
```
    DOCUMENT ME!
    
    Parameters:
    
    bool - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - stringToBool
```
public static boolean stringToBool(String bool)
```
    DOCUMENT ME!
    
    Parameters:
    
    bool - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - getUser
```
public String getUser()
```
    The currently logged-in db username.
    
    Returns:
    
    DB username
  - getPassword
```
public String getPassword()
```
    The password of the currently logged-in db user.
    
    Returns:
    
    DB user password
  - getURL
```
public String getURL()
```
    The URL of the jdbc driver connection.
    
    Returns:
    
    DB jdbc connection url
  - getDriver
```
public String getDriver()
```
    The driver class of the jdbc driver.
    
    Returns:
    
    driver class of jdbc driver
  - getConnection
```
public Connection getConnection()
```
    The Connection used by this DBConnection.
    
    Specified by:
    
    getConnection in interface DBBackend
    
    Returns:
    
    the Connection used by this DBConnection
  - close
```
public void close()
```
    DOCUMENT ME!
  - submitInternalQuery
```
public ResultSet submitInternalQuery(String descriptor,
                                     Object... parameters)
                              throws SQLException
```
    Description copied from interface: DBBackend
    
    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.
    Specified by:
    
    submitInternalQuery in interface DBBackend
    
    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
```
public int submitInternalUpdate(String descriptor,
                                Object... parameters)
                         throws SQLException
```
    Description copied from interface: DBBackend
    
    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.
    Specified by:
    
    submitInternalUpdate in interface DBBackend
    
    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
```
public ResultSet submitQuery(String descriptor,
                             Object... parameters)
                      throws SQLException
```
    Description copied from interface: DBBackend
    
    DOCUMENT ME!
    
    This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
    
    Specified by:
    
    submitQuery in interface DBBackend
    
    Parameters:
    
    descriptor - DOCUMENT ME!
    
    parameters - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    SQLException - DOCUMENT ME!
  - submitQuery
```
public ResultSet submitQuery(int sqlID,
                             Object... parameters)
                      throws SQLException
```
    Description copied from interface: DBBackend
    
    DOCUMENT ME!
    
    This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
    
    Specified by:
    
    submitQuery in interface DBBackend
    
    Parameters:
    
    sqlID - DOCUMENT ME!
    
    parameters - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    SQLException - DOCUMENT ME!
  - submitUpdate
```
public int submitUpdate(String descriptor,
                        Object... parameters)
                 throws SQLException
```
    Description copied from interface: DBBackend
    
    DOCUMENT ME!
    
    This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
    
    Specified by:
    
    submitUpdate in interface DBBackend
    
    Parameters:
    
    descriptor - DOCUMENT ME!
    
    parameters - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    SQLException - DOCUMENT ME!
  - submitUpdate
```
public int submitUpdate(int sqlID,
                        Object... parameters)
                 throws SQLException
```
    Description copied from interface: DBBackend
    
    DOCUMENT ME!
    
    This operation shall throw a SQLException if the Shutdownable.shutdown() has already been called.
    
    Specified by:
    
    submitUpdate in interface DBBackend
    
    Parameters:
    
    sqlID - DOCUMENT ME!
    
    parameters - DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
    
    Throws:
    
    SQLException - DOCUMENT ME!
  - getStatementCache
```
public StatementCache getStatementCache()
```
    DOCUMENT ME!
    
    Returns:
    
    DOCUMENT ME!
  - closeConnections
```
public static void closeConnections(Connection... cons)
```
    Closes all given Connections and logs a warning message if an error occurs while closing. null objects are ignored.
    
    Parameters:
    
    cons - sets the statements to close
  - closeResultSets
```
public static void closeResultSets(ResultSet... sets)
```
    Closes all given ResultSets and logs a warning message if an error occurs while closing. null objects are ignored.
    
    Parameters:
    
    sets - the statements to close
  - closeStatements
```
public static void closeStatements(Statement... stmts)
```
    Closes all given Statements and logs a warning message if an error occurs while closing. null objects are ignored.
    
    Parameters:
    
    stmts - the statements to close
  - setRetriesOnError
```
public void setRetriesOnError(int noOfRetries)
```
    Calls to this operation will to nothing since retries are not supported.
    
    Specified by:
    
    setRetriesOnError in interface DBBackend
    
    Parameters:
    
    noOfRetries - DOCUMENT ME!
    
    See Also:
    
    DBBackend.getRetriesOnError()
  - getRetriesOnError
```
public int getRetriesOnError()
```
    Always returns 0 as retries are not supported.
    
    Specified by:
    
    getRetriesOnError in interface DBBackend
    
    Returns:
    
    always 0
  - shutdown
```
public void shutdown()
              throws ServerExitError
```
    Simply calls close().
    
    Specified by:
    
    shutdown in interface Shutdownable
    
    Throws:
    
    ServerExitError - never
  - isClosed
```
public boolean isClosed()
```
    Returns the current closed state of the connection.
    
    Returns:
    
    true if the connection is closed, false otherwise
  - isValid
```
public boolean isValid()
```
    Returns the current closed state of the connection.
    
    Returns:
    
    true if the connection is closed, false otherwise
  - isDown
```
public boolean isDown()
```
    Simply calls isClosed().
    
    Specified by:
    
    isDown in interface Shutdownable
    
    Returns:
    
    true if the connection is closed, false otherwise
    
    See Also:
    
    isClosed()

Class DBConnection

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SQL_CODE_ALREADY_CLOSED

SQL_CODE_INVALID_DESC

DESC_VERIFY_USER_PW

IS_USER_DEACTIVATED

DESC_FETCH_DOMAIN_ID_FROM_DOMAIN_STRING

DESC_FETCH_CONFIG_ATTR_KEY_ID

DESC_FETCH_CONFIG_ATTR_USER_VALUE

DESC_FETCH_CONFIG_ATTR_UG_VALUE

DESC_FETCH_CONFIG_ATTR_DOMAIN_VALUE

DESC_FETCH_CONFIG_ATTR_EXEMPT_VALUE

DESC_FETCH_HISTORY

DESC_FETCH_HISTORY_LIMIT

DESC_INSERT_HISTORY_ENTRY

DESC_HAS_HISTORY

DESC_TABLE_HAS_COLUMN

DESC_DELETE_CACHEENTRY

DESC_INSERT_CACHEENTRY

DESC_UPDATE_CACHEENTRY

DESC_GET_ALL_USERGROUPS

DESC_GET_ALL_CLASSES

DESC_GET_ALL_CLASS_ATTRIBUTES

DESC_GET_ALL_METHODS

DESC_GET_ALL_IMAGES

DESC_GET_ALL_USERS

DESC_GET_ALL_MEMBERSHIPS

DESC_CHANGE_USER_PASSWORD

DESC_GET_ALL_CLASS_PERMS

DESC_GET_ALL_METHOD_PERMS

DESC_GET_ATTRIBUTE_INFO

DESC_SUPPORTS_SCHEDULED_SERVER_ACTIONS

UPDATE_CS_CHANGED_OBJECT_ENTRY

UPDATE_CS_CHANGED_CLASS_ENTRY

INSERT_CS_CHANGED_OBJECT_ENTRY

INSERT_CS_CHANGED_CLASS_ENTRY

GET_ALL_CS_CONFIG_ATTR

GET_ALL_CS_CONFIG_ATTR_EXEMPT

dbc

Constructor Detail

DBConnection

Method Detail

getPoolLeftTime

setPoolLeftTime

setConnectionChecker

getConnectionChecker

charToBool

stringToBool

getUser

getPassword

getURL

getDriver

getConnection

close

submitInternalQuery

submitInternalUpdate

submitQuery

submitQuery

submitUpdate

submitUpdate

getStatementCache

closeConnections

closeResultSets

closeStatements

setRetriesOnError

getRetriesOnError

shutdown

isClosed

isValid

isDown