org.postgresql.ds

Class PGConnectionPoolDataSource

java.lang.Object

org.postgresql.ds.common.BaseDataSource

org.postgresql.ds.PGConnectionPoolDataSource

All Implemented Interfaces:

Serializable, Referenceable, CommonDataSource, ConnectionPoolDataSource

Direct Known Subclasses:

ConnectionPool, Jdbc3ConnectionPool

public class PGConnectionPoolDataSource
extends BaseDataSource
implements ConnectionPoolDataSource, Serializable

PostgreSQL implementation of ConnectionPoolDataSource. The app server or middleware vendor should provide a DataSource implementation that takes advantage of this ConnectionPoolDataSource. If not, you can use the PostgreSQL implementation known as PoolingDataSource, but that should only be used if your server or middleware vendor does not provide their own. Why? The server may want to reuse the same Connection across all EJBs requesting a Connection within the same Transaction, or provide other similar advanced features.

In any case, in order to use this ConnectionPoolDataSource, you must set the property databaseName. The settings for serverName, portNumber, user, and password are optional. Note: these properties are declared in the superclass.

This implementation supports JDK 1.3 and higher.

Author:

Aaron Mulder ([email protected])

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PGConnectionPoolDataSource()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets a description of this DataSource.
PooledConnection	getPooledConnection() Gets a connection which may be pooled by the app server or middleware implementation of DataSource.
PooledConnection	getPooledConnection(String user, String password) Gets a connection which may be pooled by the app server or middleware implementation of DataSource.
boolean	isDefaultAutoCommit() Gets whether connections supplied by this pool will have autoCommit turned on by default.
void	setDefaultAutoCommit(boolean defaultAutoCommit) Sets whether connections supplied by this pool will have autoCommit turned on by default.

Methods inherited from class org.postgresql.ds.common.BaseDataSource

createReference, getAllowEncodingChanges, getApplicationName, getAssumeMinServerVersion, getAutosave, getBinaryTransfer, getBinaryTransferDisable, getBinaryTransferEnable, getCancelSignalTimeout, getCleanupSavepoints, getConnection, getConnection, getConnectTimeout, getCurrentSchema, getDatabaseMetadataCacheFields, getDatabaseMetadataCacheFieldsMiB, getDatabaseName, getDefaultRowFetchSize, getDisableColumnSanitiser, getEscapeSyntaxCallMode, getGssLib, getHideUnprivilegedObjects, getHostRecheckSeconds, getJaasApplicationName, getJaasLogin, getKerberosServerName, getLoadBalanceHosts, getLoggerFile, getLoggerLevel, getLoginTimeout, getLogServerErrorDetail, getLogUnclosedConnections, getLogWriter, getOptions, getParentLogger, getPassword, getPortNumber, getPortNumbers, getPreferQueryMode, getPreparedStatementCacheQueries, getPreparedStatementCacheSizeMiB, getPrepareThreshold, getProperty, getProperty, getProtocolVersion, getReadOnly, getReadOnlyMode, getReceiveBufferSize, getRecvBufferSize, getReference, getReplication, getReWriteBatchedInserts, getSendBufferSize, getServerName, getServerNames, getSocketFactory, getSocketFactoryArg, getSocketTimeout, getSsl, getSslcert, getSslCert, getSslfactory, getSslfactoryarg, getSslFactoryArg, getSslhostnameverifier, getSslHostnameVerifier, getSslkey, getSslKey, getSslmode, getSslMode, getSslpassword, getSslPassword, getSslpasswordcallback, getSslPasswordCallback, getSslrootcert, getSslRootCert, getSspiServiceClass, getStringType, getTargetServerType, getTcpKeepAlive, getUnknownLength, getUrl, getURL, getUser, getUseSpNego, initializeFrom, isAllowEncodingChanges, isCleanupSavePoints, isColumnSanitiserDisabled, isDisableColumnSanitiser, isLoadBalanceHosts, isLogUnclosedConnections, isReadOnly, isReWriteBatchedInserts, isSsl, isTcpKeepAlive, readBaseObject, setAllowEncodingChanges, setApplicationName, setAssumeMinServerVersion, setAutosave, setBinaryTransfer, setBinaryTransferDisable, setBinaryTransferEnable, setCancelSignalTimeout, setCleanupSavepoints, setCleanupSavePoints, setConnectTimeout, setCurrentSchema, setDatabaseMetadataCacheFields, setDatabaseMetadataCacheFieldsMiB, setDatabaseName, setDefaultRowFetchSize, setDisableColumnSanitiser, setEscapeSyntaxCallMode, setFromReference, setGssLib, setHideUnprivilegedObjects, setHostRecheckSeconds, setJaasApplicationName, setJaasLogin, setKerberosServerName, setLoadBalanceHosts, setLoggerFile, setLoggerLevel, setLoginTimeout, setLogServerErrorDetail, setLogUnclosedConnections, setLogWriter, setOptions, setPassword, setPortNumber, setPortNumbers, setPreferQueryMode, setPreparedStatementCacheQueries, setPreparedStatementCacheSizeMiB, setPrepareThreshold, setProperty, setProperty, setProtocolVersion, setReadOnly, setReadOnlyMode, setReceiveBufferSize, setRecvBufferSize, setReplication, setReWriteBatchedInserts, setSendBufferSize, setServerName, setServerNames, setSocketFactory, setSocketFactoryArg, setSocketTimeout, setSsl, setSslcert, setSslCert, setSslfactory, setSslfactoryarg, setSslFactoryArg, setSslhostnameverifier, setSslHostnameVerifier, setSslkey, setSslKey, setSslmode, setSslMode, setSslpassword, setSslPassword, setSslpasswordcallback, setSslPasswordCallback, setSslrootcert, setSslRootCert, setSspiServiceClass, setStringType, setTargetServerType, setTcpKeepAlive, setUnknownLength, setUrl, setURL, setUser, setUseSpNego, writeBaseObject

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.sql.CommonDataSource

getLoginTimeout, getLogWriter, getParentLogger, setLoginTimeout, setLogWriter

Constructor Detail

PGConnectionPoolDataSource

public PGConnectionPoolDataSource()

Method Detail

getDescription

public String getDescription()

Gets a description of this DataSource.

Specified by:

getDescription in class BaseDataSource

Returns:

description of this DataSource-ish thing

getPooledConnection

public PooledConnection getPooledConnection()
                                     throws SQLException

Gets a connection which may be pooled by the app server or middleware implementation of DataSource.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Returns:

a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents

Throws:

SQLException - Occurs when the physical database connection cannot be established.

SQLFeatureNotSupportedException - if the JDBC driver does not support this method

getPooledConnection

public PooledConnection getPooledConnection(String user,
                                            String password)
                                     throws SQLException

Gets a connection which may be pooled by the app server or middleware implementation of DataSource.

Specified by:

getPooledConnection in interface ConnectionPoolDataSource

Parameters:

user - the database user on whose behalf the connection is being made

password - the user's password

Returns:

a PooledConnection object that is a physical connection to the database that this ConnectionPoolDataSource object represents

Throws:

SQLException - Occurs when the physical database connection cannot be established.

SQLFeatureNotSupportedException - if the JDBC driver does not support this method

isDefaultAutoCommit

public boolean isDefaultAutoCommit()

Gets whether connections supplied by this pool will have autoCommit turned on by default. The default value is true, so that autoCommit will be turned on by default.

Returns:

true if connections supplied by this pool will have autoCommit

setDefaultAutoCommit

public void setDefaultAutoCommit(boolean defaultAutoCommit)

Sets whether connections supplied by this pool will have autoCommit turned on by default. The default value is true, so that autoCommit will be turned on by default.

Parameters:

defaultAutoCommit - whether connections supplied by this pool will have autoCommit