Class ConnectionEvent

java.lang.Object

java.util.EventObject

javax.sql.ConnectionEvent

All Implemented Interfaces:

Serializable

public class ConnectionEvent
extends EventObject

An Event object that provides information about the source of a connection-related event. ConnectionEvent objects are generated when an application closes a pooled connection and when an error occurs. The ConnectionEvent object contains two kinds of information:

• The pooled connection closed by the application
• In the case of an error event, the SQLException about to be thrown to the application

Since:

1.4

See Also:

• Serialized Form

Field Summary

Fields declared in class EventObject

source

Modifier and Type	Field	Description
protected Object	source	The object on which the Event initially occurred.

Constructor Summary

Constructors

Constructor	Description
ConnectionEvent(PooledConnection con)	Constructs a ConnectionEvent object initialized with the given PooledConnection object.
ConnectionEvent(PooledConnection con, SQLException ex)	Constructs a ConnectionEvent object initialized with the given PooledConnection object and SQLException object.

Method Summary

Modifier and Type	Method	Description
SQLException	getSQLException()	Retrieves the SQLException for this ConnectionEvent object.

Methods declared in class EventObject

getSource, toString

Modifier and Type	Method	Description
Object	getSource()	The object on which the Event initially occurred.
String	toString()	Returns a String representation of this EventObject.

Methods declared in class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
boolean	equals(Object o)	Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
int	hashCode()	Answers an integer hash code for the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Constructor Details

ConnectionEvent

public ConnectionEvent(PooledConnection con)

Constructs a ConnectionEvent object initialized with the given PooledConnection object. SQLException defaults to null.

Parameters:

con - the pooled connection that is the source of the event

Throws:

IllegalArgumentException - if con is null.

ConnectionEvent

public ConnectionEvent(PooledConnection con,
 SQLException ex)

Constructs a ConnectionEvent object initialized with the given PooledConnection object and SQLException object.

Parameters:

con - the pooled connection that is the source of the event

ex - the SQLException about to be thrown to the application

Throws:

IllegalArgumentException - if con is null.

Method Details

getSQLException

public SQLException getSQLException()

Retrieves the SQLException for this ConnectionEvent object. May be null.

Returns:

the SQLException about to be thrown or null