AS400JDBCPooledConnection (JTOpen 20.0.8 API)

java.lang.Object
- com.ibm.as400.access.AS400JDBCPooledConnection

All Implemented Interfaces:: PooledConnection

Direct Known Subclasses:: AS400JDBCXAConnection

public class AS400JDBCPooledConnection
extends Object
implements PooledConnection

The AS400JDBCPooledConnection class represents a connection object that provides hooks for connection pool management. This object is returned by the AS400JDBCConnectionPoolDataSource.getPooledConnection() method. The following example creates an AS400JDBCPooledConnection object that can be used to cache JDBC connections.

  // Create a data source for making the connection.
  AS400JDBCConnectionPoolDataSource dataSource = new AS400JDBCConnectionPoolDataSource("myAS400");
  datasource.setUser("Mickey Mouse");
  datasource.setPassword("IAMNORAT");

  // Get a PooledConnection and get the connection handle to the database.
  AS400JDBCPooledConnection pooledConnection = datasource.getPooledConnection();
  Connection connection = pooledConnection.getConnection();

  ... work with the connection handle.

  // Close the connection handle to make available for reuse (physical connection not closed).
  connection.close();

  // Reuse the connection somewhere else.
  Connection reusedConnection = pooledConnection.getConnection();
  ... work with the connection handle.
  reusedConnection.close();

  // Close the physical connection.
  pooledConnection.close();

AS400JDBCPooledConnection objects generate the following events:

javax.sql.ConnectionEvent - The events fired are:
- connectionClosed
- connectionErrorOccurred

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addConnectionEventListener(ConnectionEventListener listener)`	Adds a ConnectionEventListener.
`void`	`addStatementEventListener(StatementEventListener listener)`	Registers a `StatementEventListener` with this `PooledConnection` object.
`void`	`close()`	Closes the physical connection.
`void`	`closeAll()`	Closes all the Statement objects that have been opened by this PooledConnection object.
`boolean`	`equals(Object obj)`
`Connection`	`getConnection()`	Returns the connection handle to the database.
`long`	`getInactivityTime()`	Returns the elapsed time the connection has been idle waiting in the pool.
`long`	`getInUseTime()`	Returns the elapsed time the connection has been in use.
`long`	`getLifeSpan()`	Returns the elapsed time the pooled connection has been alive.
`int`	`getUseCount()`	Returns the number of times the pooled connection has been used.
`int`	`hashCode()`
`boolean`	`isInUse()`	Indicates if the pooled connection is in use.
`void`	`removeConnectionEventListener(ConnectionEventListener listener)`	Removes a ConnectionEventListener.
`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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - addConnectionEventListener
```
public void addConnectionEventListener(ConnectionEventListener listener)
```
    Adds a ConnectionEventListener.
    
    Specified by:
    
    addConnectionEventListener in interface PooledConnection
    
    Parameters:
    
    listener - The listener.
  - close
```
public void close()
           throws SQLException
```
    Closes the physical connection.
    
    Specified by:
    
    close in interface PooledConnection
    
    Throws:
    
    SQLException - If an error occurs closing the connection.
  - closeAll
```
public void closeAll()
              throws SQLException
```
    Closes all the Statement objects that have been opened by this PooledConnection object. This method is not supported.
    
    Throws:
    
    SQLException - Always thrown because this method is not supported.
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getConnection
```
public Connection getConnection()
                         throws SQLException
```
    Returns the connection handle to the database. Only one connection handle can be open at a time for any given AS400JDBCPooledConnection object.
    
    Specified by:
    
    getConnection in interface PooledConnection
    
    Returns:
    
    The connection handle.
    
    Throws:
    
    SQLException - If a database error occurs or if this PooledConnection is already in use.
  - getInactivityTime
```
public long getInactivityTime()
```
    Returns the elapsed time the connection has been idle waiting in the pool.
    
    Returns:
    
    The idle time (milliseconds).
  - getInUseTime
```
public long getInUseTime()
```
    Returns the elapsed time the connection has been in use.
    
    Returns:
    
    The elapsed time (milliseconds).
  - getLifeSpan
```
public long getLifeSpan()
```
    Returns the elapsed time the pooled connection has been alive.
    
    Returns:
    
    The elapsed time (milliseconds).
  - getUseCount
```
public int getUseCount()
```
    Returns the number of times the pooled connection has been used.
    
    Returns:
    
    The number of times used.
  - isInUse
```
public boolean isInUse()
```
    Indicates if the pooled connection is in use.
    
    Returns:
    
    true if the pooled connection is in use; false otherwise.
  - removeConnectionEventListener
```
public void removeConnectionEventListener(ConnectionEventListener listener)
```
    Removes a ConnectionEventListener.
    
    Specified by:
    
    removeConnectionEventListener in interface PooledConnection
    
    Parameters:
    
    listener - The listener to be removed.
  - addStatementEventListener
```
public void addStatementEventListener(StatementEventListener listener)
```
    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
  - removeStatementEventListener
```
public 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.
    
    Specified by:
    
    removeStatementEventListener in interface PooledConnection
    
    Parameters:
    
    listener - the component which implements the StatementEventListener interface that was previously registered with this PooledConnection object

Class AS400JDBCPooledConnection

Method Summary

Methods inherited from class java.lang.Object

Method Detail

addConnectionEventListener

close

closeAll

equals

hashCode

getConnection

getInactivityTime

getInUseTime

getLifeSpan

getUseCount

isInUse

removeConnectionEventListener

addStatementEventListener

removeStatementEventListener