org.apache.derby.jdbc
Class ClientConnectionPoolDataSource

java.lang.Object
  org.apache.derby.jdbc.ClientBaseDataSourceRoot
      org.apache.derby.jdbc.ClientBaseDataSource
          org.apache.derby.jdbc.ClientDataSource
              org.apache.derby.jdbc.ClientConnectionPoolDataSource

All Implemented Interfaces:

java.io.Serializable, java.sql.Wrapper, javax.naming.Referenceable, javax.sql.CommonDataSource, javax.sql.ConnectionPoolDataSource, javax.sql.DataSource, ClientConnectionPoolDataSourceInterface, ClientDataSourceInterface

Direct Known Subclasses:

ClientConnectionPoolDataSource40

public class ClientConnectionPoolDataSource
extends ClientDataSource
implements ClientConnectionPoolDataSourceInterface

This datasource is suitable for a client/server use of Derby, running on full Java SE 5 or 6, corresponding to JDBC 3.0 and 4.0. If running on Java SE 7 or higher, consider a more capable data source.

ClientConnectionPoolDataSource is a factory for PooledConnection objects. An object that implements this interface will typically be registered with a naming service that is based on the Java Naming and Directory Interface (JNDI).

See Also:

Serialized Form

Field Summary

static java.lang.String	className__
private int	maxStatements Specifies the maximum number of statements that can be cached per connection by the JDBC driver.
private static MessageUtil	msgUtil Message utility used to obtain localized messages.
private static long	serialVersionUID

Fields inherited from class org.apache.derby.jdbc.ClientBaseDataSourceRoot

connectionAttributes, securityMechanism, SSL_BASIC, SSL_OFF, SSL_PEER_AUTHENTICATION, SUPPORTS_EUSRIDPWD, traceLevel

Fields inherited from interface org.apache.derby.jdbc.ClientDataSourceInterface

CLEAR_TEXT_PASSWORD_SECURITY, ENCRYPTED_PASSWORD_SECURITY, ENCRYPTED_USER_AND_PASSWORD_SECURITY, propertyDefault_portNumber, propertyDefault_retrieveMessageText, propertyDefault_securityMechanism, propertyDefault_serverName, propertyDefault_traceFileAppend, propertyDefault_traceLevel, propertyDefault_user, STRONG_PASSWORD_SUBSTITUTE_SECURITY, TRACE_ALL, TRACE_CONNECTION_CALLS, TRACE_CONNECTS, TRACE_DIAGNOSTICS, TRACE_DRIVER_CONFIGURATION, TRACE_NONE, TRACE_PARAMETER_META_DATA, TRACE_PROTOCOL_FLOWS, TRACE_RESULT_SET_CALLS, TRACE_RESULT_SET_META_DATA, TRACE_STATEMENT_CALLS, TRACE_XA_CALLS, USER_ONLY_SECURITY

Constructor Summary

ClientConnectionPoolDataSource()

Method Summary

int	getMaxStatements() Returns the maximum number of JDBC prepared statements a connection is allowed to cache.
javax.sql.PooledConnection	getPooledConnection()
javax.sql.PooledConnection	getPooledConnection(java.lang.String user, java.lang.String password)
int	maxStatementsToPool() Internally used method.
private void	readObject(java.io.ObjectInputStream inputStream) Read an object from the ObjectInputStream.
void	setMaxStatements(int maxStatements) Specifies the maximum size of the statement cache.
private void	validateState() Make sure the state of the de-serialized object is valid.

Methods inherited from class org.apache.derby.jdbc.ClientBaseDataSource

getReference

Methods inherited from class org.apache.derby.jdbc.ClientBaseDataSourceRoot

computeDncLogWriter, computeDncLogWriter, computeDncLogWriterForNewConnection, computeDncLogWriterForNewConnection, computePrintWriter, getClientSSLMode, getConnection, getConnection, getConnectionAttributes, getCreateDatabase, getDatabaseName, getDataSourceName, getDescription, getLoginTimeout, getLogWriter, getPassword, getPassword, getPooledConnectionMinion, getPooledConnectionMinion, getPortNumber, getProperties, getRetrieveMessageText, getRetrieveMessageText, getSecurityMechanism, getSecurityMechanism, getSecurityMechanism, getServerName, getShutdownDatabase, getSsl, getSSLModeFromString, getTraceDirectory, getTraceDirectory, getTraceFile, getTraceFile, getTraceFileAppend, getTraceFileAppend, getTraceLevel, getTraceLevel, getUpgradedSecurityMechanism, getUser, getUser, getXAConnectionMinion, getXAConnectionMinion, handleConnectionException, isWrapperFor, setConnectionAttributes, setCreateDatabase, setDatabaseName, setDataSourceName, setDescription, setLoginTimeout, setLogWriter, setPassword, setPortNumber, setRetrieveMessageText, setSecurityMechanism, setServerName, setShutdownDatabase, setSsl, setTraceDirectory, setTraceFile, setTraceFileAppend, setTraceLevel, setUser, tokenizeAttributes, unwrap, updateDataSourceValues

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.derby.jdbc.ClientDataSourceInterface

getConnectionAttributes, getCreateDatabase, getDatabaseName, getDataSourceName, getDescription, getPassword, getPortNumber, getRetrieveMessageText, getSecurityMechanism, getSecurityMechanism, getServerName, getShutdownDatabase, getSsl, getTraceDirectory, getTraceFile, getTraceFileAppend, getTraceLevel, getUser, setConnectionAttributes, setCreateDatabase, setDatabaseName, setDataSourceName, setDescription, setPassword, setPortNumber, setRetrieveMessageText, setSecurityMechanism, setServerName, setShutdownDatabase, setSsl, setTraceDirectory, setTraceFile, setTraceFileAppend, setTraceLevel, setUser

Methods inherited from interface javax.sql.DataSource

getConnection, getConnection

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, setLoginTimeout, setLogWriter

Methods inherited from interface java.sql.Wrapper

isWrapperFor, unwrap

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

msgUtil

private static final MessageUtil msgUtil

Message utility used to obtain localized messages.

className__

public static final java.lang.String className__

See Also:

Constant Field Values

maxStatements

private int maxStatements

Specifies the maximum number of statements that can be cached per connection by the JDBC driver.

A value of 0 disables statement caching, negative values are not allowed. The default is that caching is disabled.

Constructor Detail

ClientConnectionPoolDataSource

public ClientConnectionPoolDataSource()

Method Detail

getPooledConnection

public javax.sql.PooledConnection getPooledConnection()
                                               throws java.sql.SQLException

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Throws:

java.sql.SQLException

getPooledConnection

public javax.sql.PooledConnection getPooledConnection(java.lang.String user,
                                                      java.lang.String password)
                                               throws java.sql.SQLException

Specified by:

getPooledConnection in interface javax.sql.ConnectionPoolDataSource

Throws:

java.sql.SQLException

setMaxStatements

public void setMaxStatements(int maxStatements)

Specifies the maximum size of the statement cache.

Specified by:

setMaxStatements in interface ClientConnectionPoolDataSourceInterface

Parameters:

maxStatements - maximum number of cached statements

Throws:

java.lang.IllegalArgumentException - if maxStatements is negative

getMaxStatements

public int getMaxStatements()

Returns the maximum number of JDBC prepared statements a connection is allowed to cache.

Specified by:

getMaxStatements in interface ClientConnectionPoolDataSourceInterface

Returns:

Maximum number of statements to cache, or 0 if caching is disabled (default).

maxStatementsToPool

public int maxStatementsToPool()

Internally used method.

Overrides:

maxStatementsToPool in class ClientBaseDataSourceRoot

Returns:

Maximum number of statements to cache, or 0 if caching is disabled (default).

See Also:

ClientBaseDataSourceRoot.maxStatementsToPool()

validateState

private final void validateState()

Make sure the state of the de-serialized object is valid.

readObject

private void readObject(java.io.ObjectInputStream inputStream)
                 throws java.lang.ClassNotFoundException,
                        java.io.IOException

Read an object from the ObjectInputStream.

This implementation differs from the default one by initiating state validation of the object created.

Parameters:

inputStream - data stream to read objects from

Throws:

java.lang.ClassNotFoundException - if instantiating a class fails

java.io.IOException - if reading from the stream fails