MultiConnectionImplementation (MMBase 1.9-SNAPSHOT

java.lang.Object
- org.mmbase.module.database.ConnectionWrapper
- - org.mmbase.module.database.MultiConnectionImplementation

All Implemented Interfaces:

MultiConnection
```
public class MultiConnectionImplementation
extends ConnectionWrapper
implements MultiConnection
```
MultiConnection is a replacement class for Connection it provides you a multiplexed and reusable connections from the connection pool. The main function of this class is to 'log' (keep) the last sql statement passed to it. Another function is to keep state (i.e. notifying that it is busy), and to make itself available again to the connection pool once it is finished (closed).

Since:

MMBase-1.9 (as 'MultiConnection' in < 1.9)

Version:

$Id$

Author:

vpro, Pierre van Rooden

Sql:

It would possibly be better to pass the logging of the sql query to the code that calls the connection, rather than place it in the connection itself, as it's implementation leads to conflicts between various JDBC versions. This also goes for freeing the connection once it is 'closed'.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CON_BUSY`
`static int`	`CON_FAILED`
`static int`	`CON_FINISHED`
`static int`	`CON_UNUSED`
`(package private) String`	`lastSql`
`(package private) MultiPool`	`parent`
`static long`	`queries`
`(package private) Exception`	`stackTrace`
`int`	`state`

Fields inherited from class org.mmbase.module.database.ConnectionWrapper
con

Constructor Summary

Constructors
Constructor and Description

MultiConnectionImplementation(MultiPool parent, Connection con)

Constructors
Constructor and Description
`MultiConnectionImplementation(MultiPool parent, Connection con)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`checkAfterException()` Tries to fix the this connection, if it proves to be broken.
`boolean`	`checkSQLError(Exception e)`
`void`	`claim()`
`void`	`close()` Close connections
`Statement`	`createStatement()` createStatement returns an SQL Statement object
`Statement`	`createStatement(int resultSetType, int resultSetConcurrency)` createStatement returns an SQL Statement object
`Statement`	`createStatement(int type, int concurrency, int holdability)`
`String`	`getLastSQL()`
`MultiPool`	`getParent()`
`Connection`	`getRealConnection()` Deprecated. Use `ConnectionWrapper.unwrap(Class)` (a java 1.6 method from 'Wrapper')
`Exception`	`getStackTrace()`
`int`	`getStartTime()` Returns the moment on which the last SQL statement was started in seconds after 1970.
`long`	`getStartTimeMillis()` Returns the moment on which the last SQL statement was started in milliseconds after 1970.
`String`	`getStateString()`
`int`	`getUsage()`
`void`	`realclose()` Close connections
`void`	`release()`
`void`	`resetUsage()`
`void`	`setAutoCommit(boolean enableAutoCommit)` If "autoCommit" is true, then all subsequent SQL statements will be executed and committed as individual transactions.
`void`	`setLastSQL(String sql)` Called just before every prepare statement.
`String`	`toString()`
`void`	`wrap(Connection con)`

Methods inherited from class org.mmbase.module.database.ConnectionWrapper
clearWarnings, commit, createArrayOf, createStruct, getAutoCommit, getCatalog, getClientInfo, getClientInfo, getHoldability, getMetaData, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, isValid, isWrapperFor, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setCatalog, setHoldability, setReadOnly, setSavepoint, setSavepoint, setTransactionIsolation, setTypeMap, unwrap

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

Methods inherited from interface org.mmbase.module.database.MultiConnection
clearWarnings, commit, getAutoCommit, getCatalog, getHoldability, getMetaData, getTransactionIsolation, getTypeMap, getWarnings, isClosed, isReadOnly, nativeSQL, prepareCall, prepareCall, prepareCall, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, prepareStatement, releaseSavepoint, rollback, rollback, setCatalog, setHoldability, setReadOnly, setSavepoint, setSavepoint, setTransactionIsolation, setTypeMap, unwrap

- Field Detail
  - CON_UNUSED
```
public static final int CON_UNUSED
```
    See Also:
    
    Constant Field Values
  - CON_BUSY
```
public static final int CON_BUSY
```
    See Also:
    
    Constant Field Values
  - CON_FINISHED
```
public static final int CON_FINISHED
```
    See Also:
    
    Constant Field Values
  - CON_FAILED
```
public static final int CON_FAILED
```
    See Also:
    
    Constant Field Values
  - queries
```
public static long queries
```
  - parent
```
MultiPool parent
```
    Javadoc:
  - lastSql
```
String lastSql
```
    Javadoc:
  - stackTrace
```
Exception stackTrace
```
  - state
```
public int state
```
- Constructor Detail
  - MultiConnectionImplementation
```
public MultiConnectionImplementation(MultiPool parent,
                                     Connection con)
```
    Since:
    
    MMBase-1.7
    
    To Do:
    
    in 1.7 this method was made public,document why?
    
    Javadoc:
- Method Detail
  - getParent
```
public MultiPool getParent()
```
    Specified by:
    
    getParent in interface MultiConnection
  - getStateString
```
public String getStateString()
```
    Specified by:
    
    getStateString in interface MultiConnection
    
    Javadoc:
  - setLastSQL
```
public void setLastSQL(String sql)
```
    Description copied from class: ConnectionWrapper
    
    Called just before every prepare statement. Can be overridden, because this default implementation is empty.
    
    Specified by:
    
    setLastSQL in interface MultiConnection
    
    Overrides:
    
    setLastSQL in class ConnectionWrapper
    
    Javadoc:
  - getLastSQL
```
public String getLastSQL()
```
    Specified by:
    
    getLastSQL in interface MultiConnection
    
    Javadoc:
  - getStackTrace
```
public Exception getStackTrace()
```
    Specified by:
    
    getStackTrace in interface MultiConnection
  - createStatement
```
public Statement createStatement()
                          throws SQLException
```
    createStatement returns an SQL Statement object
    
    Specified by:
    
    createStatement in interface MultiConnection
    
    Overrides:
    
    createStatement in class ConnectionWrapper
    
    Throws:
    
    SQLException
    
    See Also:
    
    Connection.createStatement()
  - checkAfterException
```
public boolean checkAfterException()
                            throws SQLException
```
    Tries to fix the this connection, if it proves to be broken. It is supposed to be broken if the query "SELECT 1 FROM
    " does yield an exception. This method is meant to be called in the catch after trying to use the connection.
    
    Specified by:
    
    checkAfterException in interface MultiConnection
    
    Returns:
    
    true if connection was broken and successfully repaired. false if connection was not broken.
    
    Throws:
    
    SQLException - If connection is broken and no new one could be obtained.
    
    Since:
    
    MMBase-1.7.1
    
    setAutoCommit
    
    public void setAutoCommit(boolean enableAutoCommit) throws SQLException
    
    If "autoCommit" is true, then all subsequent SQL statements will be executed and committed as individual transactions. Otherwise (if "autoCommit" is false) then subsequent SQL statements will all be part of the same transaction , which must be explicitly committed with either a "commit" or "rollback" call. By default new connections are initialized with autoCommit "true".
    
    Specified by:
    
    setAutoCommit in interface MultiConnection
    
    Overrides:
    
    setAutoCommit in class ConnectionWrapper
    
    Throws:
    
    SQLException
    
    See Also:
    
    Connection.setAutoCommit(boolean)
    
    close
    
    public void close() throws SQLException
    
    Close connections
    
    Specified by:
    
    close in interface MultiConnection
    
    Overrides:
    
    close in class ConnectionWrapper
    
    Throws:
    
    SQLException
    
    See Also:
    
    Connection.close()
    
    realclose
    
    public void realclose() throws SQLException
    
    Close connections
    
    Specified by:
    
    realclose in interface MultiConnection
    
    Throws:
    
    SQLException
    
    checkSQLError
    
    public boolean checkSQLError(Exception e)
    
    Javadoc:
    
    claim
    
    public void claim()
    
    Specified by:
    
    claim in interface MultiConnection
    
    Javadoc:
    
    release
    
    public void release()
    
    Specified by:
    
    release in interface MultiConnection
    
    Javadoc:
    
    getUsage
    
    public int getUsage()
    
    Specified by:
    
    getUsage in interface MultiConnection
    
    Javadoc:
    
    resetUsage
    
    public void resetUsage()
    
    Specified by:
    
    resetUsage in interface MultiConnection
    
    Since:
    
    MMBase-1.8
    
    getStartTime
    
    public int getStartTime()
    
    Returns the moment on which the last SQL statement was started in seconds after 1970.
    
    Specified by:
    
    getStartTime in interface MultiConnection
    
    getStartTimeMillis
    
    public long getStartTimeMillis()
    
    Returns the moment on which the last SQL statement was started in milliseconds after 1970.
    
    Specified by:
    
    getStartTimeMillis in interface MultiConnection
    
    toString
    
    public String toString()
    
    Overrides:
    
    toString in class Object
    
    Javadoc:
    
    createStatement
    
    public Statement createStatement(int resultSetType, int resultSetConcurrency) throws SQLException
    
    createStatement returns an SQL Statement object
    
    Specified by:
    
    createStatement in interface MultiConnection
    
    Overrides:
    
    createStatement in class ConnectionWrapper
    
    Throws:
    
    SQLException
    
    See Also:
    
    Connection.createStatement(int, int)
    
    createStatement
    
    public Statement createStatement(int type, int concurrency, int holdability) throws SQLException
    
    Specified by:
    
    createStatement in interface MultiConnection
    
    Overrides:
    
    createStatement in class ConnectionWrapper
    
    Throws:
    
    SQLException
    
    Since:
    
    MMBase 1.5, JDBC 1.4
    
    See Also:
    
    Connection.createStatement(int, int, int)
    
    getRealConnection
    
    public Connection getRealConnection()
    
    Deprecated. Use ConnectionWrapper.unwrap(Class) (a java 1.6 method from 'Wrapper')
    
    Return the underlying real connection. NOTE: use with extreme caution! MMBase is supposed to look after it's own connections. This method is public only for the reason that specific database implementations need access to this connection in order to safely clear them before they can be put back in the connection pool.
    
    wrap
    
    public void wrap(Connection con)
    
    Specified by:
    
    wrap in interface MultiConnection
    
    Skip navigation links
    
    Overview
    
    Package
    
    Class
    
    Use
    
    Tree
    
    Deprecated
    
    Index
    
    Help
    
    Prev Class
    
    Next Class
    
    Frames
    
    No Frames
    
    All Classes
    
    Summary:
    
    Nested |
    
    Field |
    
    Constr |
    
    Method
    
    Detail:
    
    Field |
    
    Constr |
    
    Method
    
    MMBase 1.9-SNAPSHOT - ${javadoctimestamp}

Class MultiConnectionImplementation

Field Summary

Fields inherited from class org.mmbase.module.database.ConnectionWrapper

Constructor Summary

Method Summary

Methods inherited from class org.mmbase.module.database.ConnectionWrapper

Methods inherited from class java.lang.Object

Methods inherited from interface org.mmbase.module.database.MultiConnection

Field Detail

CON_UNUSED

CON_BUSY

CON_FINISHED

CON_FAILED

queries

parent

lastSql

stackTrace

state

Constructor Detail

MultiConnectionImplementation

Method Detail

getParent

getStateString

setLastSQL

getLastSQL

getStackTrace

createStatement

checkAfterException

setAutoCommit

close

realclose

checkSQLError

claim

release

getUsage

resetUsage

getStartTime

getStartTimeMillis

toString

createStatement

createStatement

getRealConnection

wrap