c3p0 0.10.1 · com.mchange.v2.c3p0.AbstractConnectionTester

public abstract Class AbstractConnectionTester

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

Extend com.mchange.v2.c3p0.AbstractConnectionTester
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)
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.

Constructor Summary

Access	Constructor and Description
public	AbstractConnectionTester()

Modifier and Type	Method and Description
public abstract int	activeCheckConnection(Connection c, String preferredTestQuery, Throwable[] rootCauseOutParamHolder) Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection. Override, but remember that `preferredTestQuery` and `rootCauseOutParamHolder` can be null.
public int	activeCheckConnection(Connection c) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.
public int	activeCheckConnection(Connection c, Throwable[] rootCauseOutParamHolder) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.
public int	activeCheckConnection(Connection c, String preferredTestQuery) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Implements com.mchange.v2.c3p0.UnifiedConnectionTester.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Implements com.mchange.v2.c3p0.UnifiedConnectionTester.hashCode. Returns a hash code value for this object.
public abstract int	statusOnException(Connection c, Throwable t, String preferredTestQuery, Throwable[] rootCauseOutParamHolder) Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException. Override, but remember that `preferredTestQuery` and `rootCauseOutParamHolder` can be null.
public int	statusOnException(Connection c, Throwable t) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.
public int	statusOnException(Connection c, Throwable t, Throwable[] rootCauseOutParamHolder) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.
public int	statusOnException(Connection c, Throwable t, String preferredTestQuery) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

Modifier and Type

Method and Description

public abstract int

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

Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

Override, but remember that preferredTestQuery and rootCauseOutParamHolder can be null.

public int

activeCheckConnection(Connection c)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

public int

activeCheckConnection(Connection c, Throwable[] rootCauseOutParamHolder)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

public int

activeCheckConnection(Connection c, String preferredTestQuery)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

public boolean

equals(Object

the reference object with which to compare.

Overrides java.lang.Object.equals.

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.equals.

Indicates whether some other object is "equal to" this one.

public int

hashCode()

Overrides java.lang.Object.hashCode.

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.hashCode.

Returns a hash code value for this object.

public abstract int

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

Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

Override, but remember that preferredTestQuery and rootCauseOutParamHolder can be null.

public int

statusOnException(Connection c, Throwable t)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

public int

statusOnException(Connection c, Throwable t, Throwable[] rootCauseOutParamHolder)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

public int

statusOnException(Connection c, Throwable t, String preferredTestQuery)

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

Constructor Detail

AbstractConnectionTester	back to summary
public AbstractConnectionTester()

Method Detail

activeCheckConnection back to summary

activeCheckConnection	back to summary
public abstract int activeCheckConnection(Connection c, String preferredTestQuery, Throwable[] rootCauseOutParamHolder) Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection. Override, but remember that `preferredTestQuery` and `rootCauseOutParamHolder` can be null.

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

Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

Override, but remember that preferredTestQuery and rootCauseOutParamHolder can be null.

activeCheckConnection	back to summary
public int activeCheckConnection(Connection c) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

activeCheckConnection	back to summary
public int activeCheckConnection(Connection c, Throwable[] rootCauseOutParamHolder) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

activeCheckConnection	back to summary
public int activeCheckConnection(Connection c, String preferredTestQuery) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.activeCheckConnection.

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides java.lang.Object.equals. Implements com.mchange.v2.c3p0.UnifiedConnectionTester.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean `true` if this object is the same as the obj argument; `false` otherwise.

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides java.lang.Object.hashCode. Implements com.mchange.v2.c3p0.UnifiedConnectionTester.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int a hash code value for this object

public int hashCode()

Overrides java.lang.Object.hashCode.

Implements com.mchange.v2.c3p0.UnifiedConnectionTester.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int: a hash code value for this object

statusOnException back to summary

statusOnException	back to summary
public abstract int statusOnException(Connection c, Throwable t, String preferredTestQuery, Throwable[] rootCauseOutParamHolder) Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException. Override, but remember that `preferredTestQuery` and `rootCauseOutParamHolder` can be null.

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

Redeclares com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

Override, but remember that preferredTestQuery and rootCauseOutParamHolder can be null.

statusOnException	back to summary
public int statusOnException(Connection c, Throwable t) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

statusOnException	back to summary
public int statusOnException(Connection c, Throwable t, Throwable[] rootCauseOutParamHolder) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

statusOnException	back to summary
public int statusOnException(Connection c, Throwable t, String preferredTestQuery) Implements com.mchange.v2.c3p0.UnifiedConnectionTester.statusOnException.

public abstract Class AbstractConnectionTester

Constructor Summary

Method Summary

Constructor Detail

Method Detail