org.postgresql.ds

Class PGPooledConnection

java.lang.Object

org.postgresql.ds.PGPooledConnection

All Implemented Interfaces:

PooledConnection

Direct Known Subclasses:

PGXAConnection

public class PGPooledConnection
extends Object
implements PooledConnection

PostgreSQL implementation of the PooledConnection interface. This shouldn't be used directly, as the pooling client should just interact with the ConnectionPool instead.

Author:

Aaron Mulder (ammulder@chariotsolutions.com), Csaba Nagy (ncsaba@yahoo.com)

See Also:

PGConnectionPoolDataSource

Constructor Summary

Constructors

Constructor and Description
PGPooledConnection(Connection con, boolean autoCommit)
PGPooledConnection(Connection con, boolean autoCommit, boolean isXA) Creates a new PooledConnection representing the specified physical connection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addConnectionEventListener(ConnectionEventListener connectionEventListener) Adds a listener for close or fatal error events on the connection handed out to a client.
void	addStatementEventListener(StatementEventListener listener) Registers a StatementEventListener with this PooledConnection object.
void	close() Closes the physical database connection represented by this PooledConnection.
protected ConnectionEvent	createConnectionEvent(SQLException e)
Connection	getConnection() Gets a handle for a client to use.
void	removeConnectionEventListener(ConnectionEventListener connectionEventListener) Removes a listener for close or fatal error events on the connection handed out to a client.
void	removeStatementEventListener(StatementEventListener listener) Removes the specified StatementEventListener from the list of components that will be notified when the driver detects that a PreparedStatement has been closed or is invalid.

Methods inherited from class java.lang.Object

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

Constructor Detail

PGPooledConnection

public PGPooledConnection(Connection con,
                  boolean autoCommit,
                  boolean isXA)

Creates a new PooledConnection representing the specified physical connection.

Parameters:

con - connection

autoCommit - whether to autocommit

isXA - whether connection is a XA connection

PGPooledConnection

public PGPooledConnection(Connection con,
                  boolean autoCommit)

Method Detail

addConnectionEventListener

public void addConnectionEventListener(ConnectionEventListener connectionEventListener)

Adds a listener for close or fatal error events on the connection handed out to a client.

Specified by:

addConnectionEventListener in interface PooledConnection

Parameters:

connectionEventListener - a component, usually the connection pool manager, that has implemented the ConnectionEventListener interface and wants to be notified when the connection is closed or has an error

See Also:

PooledConnection.removeConnectionEventListener(javax.sql.ConnectionEventListener)

removeConnectionEventListener

public void removeConnectionEventListener(ConnectionEventListener connectionEventListener)

Removes a listener for close or fatal error events on the connection handed out to a client.

Specified by:

removeConnectionEventListener in interface PooledConnection

Parameters:

connectionEventListener - a component, usually the connection pool manager, that has implemented the ConnectionEventListener interface and been registered with this PooledConnection object as a listener

See Also:

PooledConnection.addConnectionEventListener(javax.sql.ConnectionEventListener)

close

public void close()
           throws SQLException

Closes the physical database connection represented by this PooledConnection. If any client has a connection based on this PooledConnection, it is forcibly closed as well.

Specified by:

close in interface PooledConnection

Throws:

SQLException - if a database access error occurs

getConnection

public Connection getConnection()
                         throws SQLException

Gets a handle for a client to use. This is a wrapper around the physical connection, so the client can call close and it will just return the connection to the pool without really closing the pgysical connection.

According to the JDBC 2.0 Optional Package spec (6.2.3), only one client may have an active handle to the connection at a time, so if there is a previous handle active when this is called, the previous one is forcibly closed and its work rolled back.

Specified by:

getConnection in interface PooledConnection

Returns:

a Connection object that is a handle to this PooledConnection object

Throws:

SQLException - if a database access error occurs

createConnectionEvent

protected ConnectionEvent createConnectionEvent(SQLException e)

removeStatementEventListener

public void removeStatementEventListener(StatementEventListener listener)

Description copied from interface: javax.sql.PooledConnection

Removes the specified StatementEventListener from the list of components that will be notified when the driver detects that a PreparedStatement has been closed or is invalid.

Specified by:

removeStatementEventListener in interface PooledConnection

Parameters:

listener - the component which implements the StatementEventListener interface that was previously registered with this PooledConnection object

addStatementEventListener

public void addStatementEventListener(StatementEventListener listener)

Description copied from interface: javax.sql.PooledConnection

Registers a StatementEventListener with this PooledConnection object. Components that wish to be notified when PreparedStatements created by the connection are closed or are detected to be invalid may use this method to register a StatementEventListener with this PooledConnection object.

Specified by:

addStatementEventListener in interface PooledConnection

Parameters:

listener - an component which implements the StatementEventListener interface that is to be registered with this PooledConnection object