com.dpslink.base.jdbc

Class JDBCConnectionInfo

java.lang.Object

com.dpslink.base.jdbc.JDBCConnectionInfo

All Implemented Interfaces:

java.io.Serializable

public class JDBCConnectionInfo
extends java.lang.Object
implements java.io.Serializable

Defines a JDBC connection information object.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.sql.Connection	ivConnection The JDBC connection.
private java.util.Hashtable<java.lang.String,JDBCObjectController<? extends JDBCObject<?>>>	ivControllers A cache of JDBC object controllers associated with this connection.
private JDBCConnectionPool	ivPool The connection pool this object belongs to.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
JDBCConnectionInfo(JDBCConnectionPool pool, java.sql.Connection conn) Constructs a new JDBCConnectionInfo object.

Method Summary

Modifier and Type	Method and Description
void	freeConnection() Returns this JDBC connection info object back to its pool.
java.sql.Connection	getConnection() Returns the information object's JDBC connection.
JDBCConnectionPool	getConnectionPool() Returns the information object's JDBC connection pool.
<DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR	getController(java.lang.Class<DBOBJCTLR> ctlrcls) Returns the JDBC object controller for the given controller class.
<DBOBJ extends JDBCObject<?>> DBOBJ	getObject(java.lang.Class<DBOBJ> objcls) Returns the JDBC object for the given object class.
java.lang.String	getRevisedSQL(java.lang.String sqlstmt) Returns the given sql statement with revisions based on the current rules for revising sql statements (sql collection name, etc.).
boolean	isDB2e() Answers if this connection uses an IBM DB2 Everyplace database.
boolean	isDB2i() Answers if this connection uses an IBM DB2 System i (AS/400) database.
boolean	isDB2iNative() Answers if this connection uses an IBM DB2 System i (AS/400) database in native mode (i.e.
boolean	isDB2w() Answers if this connection uses an IBM DB2 Windows database.
boolean	isDerby() Answers if this connection uses an Apache Derby (IBM Cloudscape) database.
void	setConnection(java.sql.Connection conn) Sets the information object's JDBC connection.
<DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> void	setController(DBOBJCTLR objctlr) Caches the given JDBC object controller instance.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivPool

private JDBCConnectionPool ivPool

The connection pool this object belongs to.

ivConnection

private java.sql.Connection ivConnection

The JDBC connection.

ivControllers

private java.util.Hashtable<java.lang.String,JDBCObjectController<? extends JDBCObject<?>>> ivControllers

A cache of JDBC object controllers associated with this connection.

Constructor Detail

JDBCConnectionInfo

public JDBCConnectionInfo(JDBCConnectionPool pool,
                          java.sql.Connection conn)

Constructs a new JDBCConnectionInfo object.

Parameters:

pool - (JDBCConnectionPool) The connection pool that this connection information object belongs to.

conn - (Connection) A JDBC connection.

Method Detail

getConnection

public java.sql.Connection getConnection()

Returns the information object's JDBC connection.

Returns:

Connection - The JDBC connection.

setConnection

public void setConnection(java.sql.Connection conn)

Sets the information object's JDBC connection.

Parameters:

conn - (Connection) The JDBC connection.

freeConnection

public void freeConnection()

Returns this JDBC connection info object back to its pool.

getConnectionPool

public JDBCConnectionPool getConnectionPool()

Returns the information object's JDBC connection pool.

Returns:

JDBCConnectionPool - The JDBC connection pool.

getController

public <DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> DBOBJCTLR getController(java.lang.Class<DBOBJCTLR> ctlrcls)

Returns the JDBC object controller for the given controller class. Returns a cached instance of the controller if a cached instance exists; otherwise creates a new instance, adds the new instance to the cache and then returns the new instance.

Parameters:

ctlrcls - (Class) The class for the desired controller.

Returns:

JDBCObjectController - The JDBC object controller.

setController

public <DBOBJCTLR extends JDBCObjectController<? extends JDBCObject<?>>> void setController(DBOBJCTLR objctlr)

Caches the given JDBC object controller instance.

Parameters:

objctlr - (JDBCObjectController) The controller to cache.

getObject

public <DBOBJ extends JDBCObject<?>> DBOBJ getObject(java.lang.Class<DBOBJ> objcls)

Returns the JDBC object for the given object class. Unlike controllers, JDBC objects are not directly associated with a JDBC connection and are therefore not cached. A new instance of the requested object is created for each invocation of this method.

Parameters:

objcls - (Class) The class for the desired object.

Returns:

JDBCObject - The JDBC object.

getRevisedSQL

public java.lang.String getRevisedSQL(java.lang.String sqlstmt)

Returns the given sql statement with revisions based on the current rules for revising sql statements (sql collection name, etc.).

Parameters:

sqlstmt - (String) The sql statement that is to be revised.

Returns:

String - The revised sql statement string.

isDB2e

public boolean isDB2e()

Answers if this connection uses an IBM DB2 Everyplace database.

Returns:

boolean - true if this is a DB2 Everyplace database, otherwise false.

isDB2i

public boolean isDB2i()

Answers if this connection uses an IBM DB2 System i (AS/400) database.

Returns:

boolean - true if this is a DB2 System i database, otherwise false.

isDB2iNative

public boolean isDB2iNative()

Answers if this connection uses an IBM DB2 System i (AS/400) database in native mode (i.e. uses the native JDBC driver).

Returns:

boolean - true if this is a DB2 System i native database, otherwise false.

isDB2w

public boolean isDB2w()

Answers if this connection uses an IBM DB2 Windows database.

Returns:

boolean - true if this is a DB2 Windows database, otherwise false.

isDerby

public boolean isDerby()

Answers if this connection uses an Apache Derby (IBM Cloudscape) database.

Returns:

boolean - true if this is an Apache Derby database, otherwise false.