Top Description Fields Methods
com.mchange.v2.c3p0

public Interface UnifiedConnectionTester

extends FullQueryConnectionTester
Known Direct Implementers
com.mchange.v2.c3p0.AbstractConnectionTester
Imports
java.sql.Connection

Having expanded the once-simple ConnectionTester interface to support both user-specified queries and return of root cause Exceptions (via an out-param), this interface has grown unnecessarily complex.

If you wish to implement a custom Connection tester, here is the simple way to do it

  1. Extend com.mchange.v2.c3p0.AbstractConnectionTester
  2. Override only the two abstract methods
    • public int activeCheckConnection(Connection c, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)
    • public int statusOnException(Connection c, Throwable t, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)
  3. Take care to ensure that your methods are defined to allow preferredTestQuery and rootCauseOutParamHolder to be null.

Parameter rootCauseOutParamHolder is an optional parameter, which if supplied, will be a Throwable array whose size it at least one. If a Connection test fails because of some Exception, the Connection tester may set this Exception as the zero-th element of the array to provide information about why and how the test failed.

Field Summary

Modifier and TypeField and Description
public static final int
public static final int
public static final int

Method Summary

Modifier and TypeMethod and Description
public int
public int
activeCheckConnection(Connection c, Throwable[] rootCauseOutParamHolder)

public int
public int
activeCheckConnection(Connection c, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)

public boolean
public int
public int
public int
statusOnException(Connection c, Throwable t, Throwable[] rootCauseOutParamHolder)

public int
public int
statusOnException(Connection c, Throwable t, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)

Field Detail

CONNECTION_IS_INVALIDback to summary
public static final int CONNECTION_IS_INVALID

Hides com.mchange.v2.c3p0.ConnectionTester.CONNECTION_IS_INVALID.

CONNECTION_IS_OKAYback to summary
public static final int CONNECTION_IS_OKAY

Hides com.mchange.v2.c3p0.ConnectionTester.CONNECTION_IS_OKAY.

DATABASE_IS_INVALIDback to summary
public static final int DATABASE_IS_INVALID

Hides com.mchange.v2.c3p0.ConnectionTester.DATABASE_IS_INVALID.

Method Detail

activeCheckConnectionback to summary
public int activeCheckConnection(Connection c)

Redeclares com.mchange.v2.c3p0.ConnectionTester.activeCheckConnection.

activeCheckConnectionback to summary
public int activeCheckConnection(Connection c, Throwable[] rootCauseOutParamHolder)
activeCheckConnectionback to summary
public int activeCheckConnection(Connection c, String preferredTestQuery)

Redeclares com.mchange.v2.c3p0.QueryConnectionTester.activeCheckConnection.

activeCheckConnectionback to summary
public int activeCheckConnection(Connection c, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)
equalsback to summary
public boolean equals(Object o)
hashCodeback to summary
public int hashCode()
statusOnExceptionback to summary
public int statusOnException(Connection c, Throwable t)

Redeclares com.mchange.v2.c3p0.ConnectionTester.statusOnException.

statusOnExceptionback to summary
public int statusOnException(Connection c, Throwable t, Throwable[] rootCauseOutParamHolder)
statusOnExceptionback to summary
public int statusOnException(Connection c, Throwable t, String preferredTestQuery)

Redeclares com.mchange.v2.c3p0.FullQueryConnectionTester.statusOnException.

statusOnExceptionback to summary
public int statusOnException(Connection c, Throwable t, String preferredTestQuery, Throwable[] rootCauseOutParamHolder)