PooledConnection (avaje-ebeanorm 3.3.1 API)

java.lang.Object
- com.avaje.ebeaninternal.jdbc.ConnectionDelegator
- - com.avaje.ebeaninternal.server.lib.sql.PooledConnection

All Implemented Interfaces:

AutoCloseable, Connection, Wrapper
```
public class PooledConnection
extends ConnectionDelegator
```
Is a connection that belongs to a DataSourcePool.
It is designed to be part of DataSourcePool. Closing the connection puts it back into the pool.

It defaults autoCommit and Transaction Isolation to the defaults of the DataSourcePool.

It has caching of Statements and PreparedStatements. Remembers the last statement that was executed. Keeps statistics on how long it is in use.

Field Summary
- Fields inherited from interface java.sql.Connection
  TRANSACTION_NONE, TRANSACTION_READ_COMMITTED, TRANSACTION_READ_UNCOMMITTED, TRANSACTION_REPEATABLE_READ, TRANSACTION_SERIALIZABLE

Constructor Summary

Constructors
Modifier	Constructor and Description
	`PooledConnection(DataSourcePool pool, int uniqueId, Connection connection)` Construct the connection that can refer back to the pool it belongs to.
`protected`	`PooledConnection(String name)` For testing the pool without real connections.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addError(Throwable e)` When an error occurs during use add it the connection.
`void`	`clearWarnings()`
`void`	`close()` close the connection putting it back into the connection pool.
`void`	`closeConnectionFully(boolean logErrors)` Close the connection fully NOT putting in back into the pool.
`void`	`commit()`
`Statement`	`createStatement()` Creates a wrapper ExtendedStatement so that I can get the executed sql.
`Statement`	`createStatement(int resultSetType, int resultSetConcurreny)`
`Statement`	`createStatement(int i, int x, int y)`
`boolean`	`exceedsMaxAge(long maxAgeMillis)` Return true if the connection is too old.
`protected void`	`finalize()`
`boolean`	`getAutoCommit()`
`long`	`getBusySeconds()`
`String`	`getCatalog()`
`String`	`getCreatedByMethod()` Returns the method that created the connection.
`long`	`getCreationTime()` Return the time the connection was created.
`DataSourcePool`	`getDataSourcePool()` Return the DataSourcePool that this connection belongs to.
`String`	`getDescription()`
`String`	`getFullDescription()`
`int`	`getHoldability()`
`String`	`getLastStatement()` Returns the last sql statement executed.
`long`	`getLastUsedTime()` Returns the time the connection was last used.
`DatabaseMetaData`	`getMetaData()`
`String`	`getName()` Return a string to identify the connection.
`String`	`getNameSlot()`
`PstmtCache`	`getPstmtCache()` A Least Recently used cache of PreparedStatements.
`String`	`getPstmtStatistics()`
`int`	`getSlotId()` Return the slot position in the busy buffer.
`StackTraceElement[]`	`getStackTrace()` Return the full stack trace that got the connection from the pool.
`String`	`getStackTraceAsString()` Return the stackTrace as a String for logging purposes.
`long`	`getStartUseTime()` Return the time the connection was passed to the client code.
`PooledConnectionStatistics`	`getStatistics()`
`int`	`getTransactionIsolation()`
`Map<String,Class<?>>`	`getTypeMap()`
`SQLWarning`	`getWarnings()`
`boolean`	`hadErrors()` Returns true if the connect threw any errors during use.
`boolean`	`isClosed()`
`boolean`	`isLongRunning()` Return true if the connection should be treated as long running (skip connection pool leak check).
`boolean`	`isReadOnly()`
`String`	`nativeSQL(String sql)`
`CallableStatement`	`prepareCall(String sql)`
`CallableStatement`	`prepareCall(String sql, int resultSetType, int resultSetConcurreny)`
`CallableStatement`	`prepareCall(String s, int i, int x, int y)`
`PreparedStatement`	`prepareStatement(String sql)` This will try to use a cache of PreparedStatements.
`PreparedStatement`	`prepareStatement(String sql, int returnKeysFlag)` This will try to use a cache of PreparedStatements.
`PreparedStatement`	`prepareStatement(String s, int[] i)`
`PreparedStatement`	`prepareStatement(String sql, int resultSetType, int resultSetConcurreny)`
`PreparedStatement`	`prepareStatement(String s, int i, int x, int y)`
`PreparedStatement`	`prepareStatement(String s, String[] s2)`
`void`	`releaseSavepoint(Savepoint sp)`
`protected void`	`resetForUse()` Reset the connection for returning to the client.
`protected void`	`returnPreparedStatement(ExtendedPreparedStatement pstmt)` Return a PreparedStatement back into the cache.
`void`	`rollback()`
`void`	`rollback(Savepoint sp)`
`void`	`setAutoCommit(boolean autoCommit)`
`void`	`setCatalog(String catalog)`
`void`	`setHoldability(int i)`
`protected void`	`setLastStatement(String lastStatement)` Called by ExtendedStatement to trace the sql being executed.
`void`	`setLongRunning(boolean longRunning)` Set this to true if the connection is a long running connection and should skip the 'suspected connection pool leak' checking.
`void`	`setReadOnly(boolean readOnly)` Also note the read only status needs to be reset when put back into the pool.
`Savepoint`	`setSavepoint()`
`Savepoint`	`setSavepoint(String savepointName)`
`void`	`setSlotId(int slotId)` Set the slot position in the busy buffer.
`protected void`	`setStackTrace(StackTraceElement[] stackTrace)` Set the stack trace to help find connection pool leaks.
`void`	`setTransactionIsolation(int level)` Also note the Isolation level needs to be reset when put back into the pool.
`void`	`setTypeMap(Map<String,Class<?>> map)`
`boolean`	`shouldTrim(long usedSince, long createdSince)` Return true if the connection has been idle for too long or is too old.
`boolean`	`shouldTrimOnReturn(long lastResetTime, long maxAgeMillis)`
`String`	`toString()`

Methods inherited from class com.avaje.ebeaninternal.jdbc.ConnectionDelegator
abort, createArrayOf, createBlob, createClob, createNClob, createSQLXML, createStruct, getClientInfo, getClientInfo, getNetworkTimeout, getSchema, isValid, isWrapperFor, setClientInfo, setClientInfo, setNetworkTimeout, setSchema, unwrap

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PooledConnection
```
public PooledConnection(DataSourcePool pool,
                int uniqueId,
                Connection connection)
                 throws SQLException
```
    Construct the connection that can refer back to the pool it belongs to.
    close() will return the connection back to the pool , while closeDestroy() will close() the underlining connection properly.
    
    Throws:
    
    SQLException
  - PooledConnection
```
protected PooledConnection(String name)
```
    For testing the pool without real connections.
- Method Detail
  - getSlotId
```
public int getSlotId()
```
    Return the slot position in the busy buffer.
  - setSlotId
```
public void setSlotId(int slotId)
```
    Set the slot position in the busy buffer.
  - getDataSourcePool
```
public DataSourcePool getDataSourcePool()
```
    Return the DataSourcePool that this connection belongs to.
  - getCreationTime
```
public long getCreationTime()
```
    Return the time the connection was created.
  - getName
```
public String getName()
```
    Return a string to identify the connection.
  - getNameSlot
```
public String getNameSlot()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getBusySeconds
```
public long getBusySeconds()
```
  - getDescription
```
public String getDescription()
```
  - getFullDescription
```
public String getFullDescription()
```
  - getPstmtStatistics
```
public String getPstmtStatistics()
```
  - getStatistics
```
public PooledConnectionStatistics getStatistics()
```
  - isLongRunning
```
public boolean isLongRunning()
```
    Return true if the connection should be treated as long running (skip connection pool leak check).
  - setLongRunning
```
public void setLongRunning(boolean longRunning)
```
    Set this to true if the connection is a long running connection and should skip the 'suspected connection pool leak' checking.
  - closeConnectionFully
```
public void closeConnectionFully(boolean logErrors)
```
    Close the connection fully NOT putting in back into the pool.
    The logErrors parameter exists so that expected errors are not logged such as when the database is known to be down.
    
    Parameters:
    logErrors - if false then don't log errors when closing
  - getPstmtCache
```
public PstmtCache getPstmtCache()
```
    A Least Recently used cache of PreparedStatements.
  - createStatement
```
public Statement createStatement()
                          throws SQLException
```
    Creates a wrapper ExtendedStatement so that I can get the executed sql. I want to do this so that I can get the slowest query statments etc, and log that information.
    
    Specified by:
    
    createStatement in interface Connection
    
    Overrides:
    
    createStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - createStatement
```
public Statement createStatement(int resultSetType,
                        int resultSetConcurreny)
                          throws SQLException
```
    Specified by:
    
    createStatement in interface Connection
    
    Overrides:
    
    createStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - returnPreparedStatement
```
protected void returnPreparedStatement(ExtendedPreparedStatement pstmt)
```
    Return a PreparedStatement back into the cache.
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                 int returnKeysFlag)
                                   throws SQLException
```
    This will try to use a cache of PreparedStatements.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql)
                                   throws SQLException
```
    This will try to use a cache of PreparedStatements.
    
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String sql,
                                 int resultSetType,
                                 int resultSetConcurreny)
                                   throws SQLException
```
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - resetForUse
```
protected void resetForUse()
```
    Reset the connection for returning to the client. Resets the status, startUseTime and hadErrors.
  - addError
```
public void addError(Throwable e)
```
    When an error occurs during use add it the connection.
    Any PooledConnection that has an error is checked to make sure it works before it is placed back into the connection pool.
  - hadErrors
```
public boolean hadErrors()
```
    Returns true if the connect threw any errors during use.
    Connections with errors are testing to make sure they are still good before putting them back into the pool.
  - close
```
public void close()
           throws SQLException
```
    close the connection putting it back into the connection pool.
    Note that to ensure that the next transaction starts at the correct time a commit() or rollback() should be called. If neither has occured at this time then a rollback() is used (to end the transaction).
    
    To close the connection fully use closeConnectionFully().
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Connection
    
    Overrides:
    
    close in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - exceedsMaxAge
```
public boolean exceedsMaxAge(long maxAgeMillis)
```
    Return true if the connection is too old.
  - shouldTrimOnReturn
```
public boolean shouldTrimOnReturn(long lastResetTime,
                         long maxAgeMillis)
```
  - shouldTrim
```
public boolean shouldTrim(long usedSince,
                 long createdSince)
```
    Return true if the connection has been idle for too long or is too old.
  - getStartUseTime
```
public long getStartUseTime()
```
    Return the time the connection was passed to the client code.
    Used to detect busy connections that could be leaks.
  - getLastUsedTime
```
public long getLastUsedTime()
```
    Returns the time the connection was last used.
    Used to close connections that have been idle for some time. Typically 5 minutes.
  - getLastStatement
```
public String getLastStatement()
```
    Returns the last sql statement executed.
  - setLastStatement
```
protected void setLastStatement(String lastStatement)
```
    Called by ExtendedStatement to trace the sql being executed.
    Note with addBatch() this will not really work.
  - setReadOnly
```
public void setReadOnly(boolean readOnly)
                 throws SQLException
```
    Also note the read only status needs to be reset when put back into the pool.
    
    Specified by:
    
    setReadOnly in interface Connection
    
    Overrides:
    
    setReadOnly in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setTransactionIsolation
```
public void setTransactionIsolation(int level)
                             throws SQLException
```
    Also note the Isolation level needs to be reset when put back into the pool.
    
    Specified by:
    
    setTransactionIsolation in interface Connection
    
    Overrides:
    
    setTransactionIsolation in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - clearWarnings
```
public void clearWarnings()
                   throws SQLException
```
    Specified by:
    
    clearWarnings in interface Connection
    
    Overrides:
    
    clearWarnings in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - commit
```
public void commit()
            throws SQLException
```
    Specified by:
    
    commit in interface Connection
    
    Overrides:
    
    commit in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getAutoCommit
```
public boolean getAutoCommit()
                      throws SQLException
```
    Specified by:
    
    getAutoCommit in interface Connection
    
    Overrides:
    
    getAutoCommit in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getCatalog
```
public String getCatalog()
                  throws SQLException
```
    Specified by:
    
    getCatalog in interface Connection
    
    Overrides:
    
    getCatalog in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getMetaData
```
public DatabaseMetaData getMetaData()
                             throws SQLException
```
    Specified by:
    
    getMetaData in interface Connection
    
    Overrides:
    
    getMetaData in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getTransactionIsolation
```
public int getTransactionIsolation()
                            throws SQLException
```
    Specified by:
    
    getTransactionIsolation in interface Connection
    
    Overrides:
    
    getTransactionIsolation in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getTypeMap
```
public Map<String,Class<?>> getTypeMap()
                                throws SQLException
```
    Specified by:
    
    getTypeMap in interface Connection
    
    Overrides:
    
    getTypeMap in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getWarnings
```
public SQLWarning getWarnings()
                       throws SQLException
```
    Specified by:
    
    getWarnings in interface Connection
    
    Overrides:
    
    getWarnings in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - isClosed
```
public boolean isClosed()
                 throws SQLException
```
    Specified by:
    
    isClosed in interface Connection
    
    Overrides:
    
    isClosed in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - isReadOnly
```
public boolean isReadOnly()
                   throws SQLException
```
    Specified by:
    
    isReadOnly in interface Connection
    
    Overrides:
    
    isReadOnly in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - nativeSQL
```
public String nativeSQL(String sql)
                 throws SQLException
```
    Specified by:
    
    nativeSQL in interface Connection
    
    Overrides:
    
    nativeSQL in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareCall
```
public CallableStatement prepareCall(String sql)
                              throws SQLException
```
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareCall
```
public CallableStatement prepareCall(String sql,
                            int resultSetType,
                            int resultSetConcurreny)
                              throws SQLException
```
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - rollback
```
public void rollback()
              throws SQLException
```
    Specified by:
    
    rollback in interface Connection
    
    Overrides:
    
    rollback in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setAutoCommit
```
public void setAutoCommit(boolean autoCommit)
                   throws SQLException
```
    Specified by:
    
    setAutoCommit in interface Connection
    
    Overrides:
    
    setAutoCommit in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setCatalog
```
public void setCatalog(String catalog)
                throws SQLException
```
    Specified by:
    
    setCatalog in interface Connection
    
    Overrides:
    
    setCatalog in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setTypeMap
```
public void setTypeMap(Map<String,Class<?>> map)
                throws SQLException
```
    Specified by:
    
    setTypeMap in interface Connection
    
    Overrides:
    
    setTypeMap in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setSavepoint
```
public Savepoint setSavepoint()
                       throws SQLException
```
    Specified by:
    
    setSavepoint in interface Connection
    
    Overrides:
    
    setSavepoint in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setSavepoint
```
public Savepoint setSavepoint(String savepointName)
                       throws SQLException
```
    Specified by:
    
    setSavepoint in interface Connection
    
    Overrides:
    
    setSavepoint in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - rollback
```
public void rollback(Savepoint sp)
              throws SQLException
```
    Specified by:
    
    rollback in interface Connection
    
    Overrides:
    
    rollback in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - releaseSavepoint
```
public void releaseSavepoint(Savepoint sp)
                      throws SQLException
```
    Specified by:
    
    releaseSavepoint in interface Connection
    
    Overrides:
    
    releaseSavepoint in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - setHoldability
```
public void setHoldability(int i)
                    throws SQLException
```
    Specified by:
    
    setHoldability in interface Connection
    
    Overrides:
    
    setHoldability in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getHoldability
```
public int getHoldability()
                   throws SQLException
```
    Specified by:
    
    getHoldability in interface Connection
    
    Overrides:
    
    getHoldability in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - createStatement
```
public Statement createStatement(int i,
                        int x,
                        int y)
                          throws SQLException
```
    Specified by:
    
    createStatement in interface Connection
    
    Overrides:
    
    createStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String s,
                                 int i,
                                 int x,
                                 int y)
                                   throws SQLException
```
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String s,
                                 int[] i)
                                   throws SQLException
```
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareStatement
```
public PreparedStatement prepareStatement(String s,
                                 String[] s2)
                                   throws SQLException
```
    Specified by:
    
    prepareStatement in interface Connection
    
    Overrides:
    
    prepareStatement in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - prepareCall
```
public CallableStatement prepareCall(String s,
                            int i,
                            int x,
                            int y)
                              throws SQLException
```
    Specified by:
    
    prepareCall in interface Connection
    
    Overrides:
    
    prepareCall in class ConnectionDelegator
    
    Throws:
    
    SQLException
  - getCreatedByMethod
```
public String getCreatedByMethod()
```
    Returns the method that created the connection.
    Used to help finding connection pool leaks.
  - setStackTrace
```
protected void setStackTrace(StackTraceElement[] stackTrace)
```
    Set the stack trace to help find connection pool leaks.
  - getStackTraceAsString
```
public String getStackTraceAsString()
```
    Return the stackTrace as a String for logging purposes.
  - getStackTrace
```
public StackTraceElement[] getStackTrace()
```
    Return the full stack trace that got the connection from the pool. You could use this if getCreatedByMethod() doesn't work for you.

Class PooledConnection

Field Summary

Fields inherited from interface java.sql.Connection

Constructor Summary

Method Summary

Methods inherited from class com.avaje.ebeaninternal.jdbc.ConnectionDelegator

Methods inherited from class java.lang.Object

Constructor Detail

PooledConnection

PooledConnection

Method Detail

getSlotId

setSlotId

getDataSourcePool

getCreationTime

getName

getNameSlot

toString

getBusySeconds

getDescription

getFullDescription

getPstmtStatistics

getStatistics

isLongRunning

setLongRunning

closeConnectionFully

getPstmtCache

createStatement

createStatement

returnPreparedStatement

prepareStatement

prepareStatement

prepareStatement

resetForUse

addError

hadErrors

close

finalize

exceedsMaxAge

shouldTrimOnReturn

shouldTrim

getStartUseTime

getLastUsedTime

getLastStatement

setLastStatement

setReadOnly

setTransactionIsolation

clearWarnings

commit

getAutoCommit

getCatalog

getMetaData

getTransactionIsolation

getTypeMap

getWarnings

isClosed

isReadOnly

nativeSQL

prepareCall

prepareCall

rollback

setAutoCommit

setCatalog

setTypeMap

setSavepoint

setSavepoint

rollback

releaseSavepoint

setHoldability

getHoldability

createStatement

prepareStatement

prepareStatement

prepareStatement

prepareCall

getCreatedByMethod

setStackTrace

getStackTraceAsString

getStackTrace