com.jdbwc.iface
Interface Connection

All Superinterfaces:
java.sql.Connection, java.sql.Wrapper

public interface Connection
extends java.sql.Connection

Vendor based extension.
This interface is for any extension methods we require over the standard java.sql.Connection interface to help make our driver work.

This interface and its method/s are not designed for direct public consumption.
The purpose of this interface is to expand functionality to assist the driver in doing its job internally.
Declaring any additional public methods here makes it easier to work with the actual implementation.
EG: you can easily tell whats generic to java.sql.Connection and whats an extension.

Version:
2008-05-29
Author:
Tim Gall (Oz-DevWorX)

Field Summary
 
Fields inherited from interface java.sql.Connection
TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE
 
Method Summary
 org.apache.commons.httpclient.HttpClient getClient()
           
 java.lang.String getCredentials()
          Get the database credentials required to gain access to the remote database server.
 java.lang.String getDatabase()
          Returns the name of the requested database that was used when this Connection was created.
 int getDbType()
          Returns the database's numeric type as defined in this Connections Driver class.
The numeric type is set based on the request url used to create this Connection.
 boolean getSessLimit()
           
 int getTimeOut()
           
 java.lang.String getUrl()
          Gets the remote URL this Connection is connected to.
 void setSessLimit(boolean sessLimit)
           
 void setTimeOut(int timeOut)
           
 
Methods inherited from interface java.sql.Connection
clearWarnings, close, commit, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStatement, createStatement, createStatement, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setAutoCommit, setCatalog, setClientInfo, setClientInfo, setHoldability, setReadOnly, setSavepoint, setSavepoint, setTransactionIsolation, setTypeMap
 
Methods inherited from interface java.sql.Wrapper
isWrapperFor, unwrap
 

Method Detail

getCredentials

java.lang.String getCredentials()
Get the database credentials required to gain access to the remote database server.

Returns:
A one way hash that includes this Connections database login details as supplied when this Connection was created.

getDbType

int getDbType()
Returns the database's numeric type as defined in this Connections Driver class.
The numeric type is set based on the request url used to create this Connection.

Returns:
The numeric typeName for this Connection.

getUrl

java.lang.String getUrl()
Gets the remote URL this Connection is connected to.

Returns:
The URL this Connection instance is using.

getClient

org.apache.commons.httpclient.HttpClient getClient()
Returns:
this HttpClient

getTimeOut

int getTimeOut()
Returns:
get the current timeout in ms

setTimeOut

void setTimeOut(int timeOut)
Parameters:
timeOut - the timeout period in ms

getSessLimit

boolean getSessLimit()
Returns:
current Session limit

setSessLimit

void setSessLimit(boolean sessLimit)
Parameters:
sessLimit -

getDatabase

java.lang.String getDatabase()
Returns the name of the requested database that was used when this Connection was created.

Returns:
the active database's name that this Connection Object is using.