JavaEE API 8.0.1 · javax.resource.spi.ConnectionEvent

The ConnectionEvent class provides information about the source of a connection related event.A ConnectionEvent instance contains the following information:

Type of the connection event
ManagedConnection instance that generated the connection event. A ManagedConnection instance is returned from the method ConnectionEvent.getSource.
Connection handle associated with the ManagedConnection instance; required for the CONNECTION_CLOSED event and optional for the other event types.
Optionally, an exception indicating the connection related error. Note that exception is used for CONNECTION_ERROR_OCCURRED.

This class defines following types of event notifications:

CONNECTION_CLOSED
LOCAL_TRANSACTION_STARTED
LOCAL_TRANSACTION_COMMITTED
LOCAL_TRANSACTION_ROLLEDBACK
CONNECTION_ERROR_OCCURRED

Field Summary

Modifier and Type	Field and Description
public static final int	CONNECTION_CLOSED Event notification that an application component has closed the connection
public static final int	CONNECTION_ERROR_OCCURRED Event notification that an error occurred on the connection.
private Object	connectionHandle
private Exception	exception Exception associated with the `ConnectionEvent` instance.
protected int	id Type of the event
public static final int	LOCAL_TRANSACTION_COMMITTED Event notification that a Resource Manager Local Transaction was committed on the connection
public static final int	LOCAL_TRANSACTION_ROLLEDBACK Event notification that a Resource Manager Local Transaction was rolled back on the connection
public static final int	LOCAL_TRANSACTION_STARTED Event notification that a Resource Manager Local Transaction was started on the connection

Inherited from java.util.EventObject:: source

Constructor Summary

Access	Constructor and Description
public	ConnectionEvent(ManagedConnection ManagedConnection that is the source of the event source, int type of the Connection event eid) Construct a ConnectionEvent object.
public	ConnectionEvent(ManagedConnection ManagedConnection that is the source of the event source, int type of the Connection event eid, Exception exception about to be thrown to the application exception) Construct a ConnectionEvent object.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: the connection handle. May be null getConnectionHandle() Get the connection handle associated with the Managed Connection instance.
public Exception	Returns: the exception about to be thrown. getException() Get the exception.
public int	getId() Get the type of event
public void	setConnectionHandle(Object connectionHandle) Set the connection handle.

Inherited from java.util.EventObject:: getSource toString

Field Detail

CONNECTION_CLOSED	back to summary
public static final int CONNECTION_CLOSED Event notification that an application component has closed the connection

CONNECTION_ERROR_OCCURRED	back to summary
public static final int CONNECTION_ERROR_OCCURRED Event notification that an error occurred on the connection. This event indicates that the ManagedConnection instance is now invalid and unusable.

connectionHandle	back to summary
private Object connectionHandle

exception	back to summary
private Exception exception Exception associated with the `ConnectionEvent` instance.

id	back to summary
protected int id Type of the event

LOCAL_TRANSACTION_COMMITTED	back to summary
public static final int LOCAL_TRANSACTION_COMMITTED Event notification that a Resource Manager Local Transaction was committed on the connection

LOCAL_TRANSACTION_ROLLEDBACK	back to summary
public static final int LOCAL_TRANSACTION_ROLLEDBACK Event notification that a Resource Manager Local Transaction was rolled back on the connection

LOCAL_TRANSACTION_STARTED	back to summary
public static final int LOCAL_TRANSACTION_STARTED Event notification that a Resource Manager Local Transaction was started on the connection

Constructor Detail

ConnectionEvent	back to summary
public ConnectionEvent(ManagedConnection source, int eid) Construct a ConnectionEvent object. Exception defaults to null. Parameters source:ManagedConnection ManagedConnection that is the source of the event eid:int type of the Connection event

ConnectionEvent

back to summary

public ConnectionEvent(ManagedConnection source, int eid)

Construct a ConnectionEvent object. Exception defaults to null.

Parameters

source:ManagedConnection: ManagedConnection that is the source of the event
eid:int: type of the Connection event

ConnectionEvent	back to summary
public ConnectionEvent(ManagedConnection source, int eid, Exception exception) Construct a ConnectionEvent object. Parameters source:ManagedConnection ManagedConnection that is the source of the event eid:int type of the Connection event exception:Exception exception about to be thrown to the application

ConnectionEvent

back to summary

public ConnectionEvent(ManagedConnection source, int eid, Exception exception)

Construct a ConnectionEvent object.

Parameters

source:ManagedConnection: ManagedConnection that is the source of the event
eid:int: type of the Connection event
exception:Exception: exception about to be thrown to the application

Method Detail

getConnectionHandle	back to summary
public Object getConnectionHandle() Get the connection handle associated with the Managed Connection instance. Used for CONNECTION_CLOSED event. Returns:Object the connection handle. May be null

getConnectionHandle

back to summary

public Object getConnectionHandle()

Get the connection handle associated with the Managed Connection instance. Used for CONNECTION_CLOSED event.

Returns:Object: the connection handle. May be null

getException	back to summary
public Exception getException() Get the exception. May be null. Returns:Exception the exception about to be thrown.

getException

back to summary

public Exception getException()

Get the exception. May be null.

Returns:Exception: the exception about to be thrown.

getId	back to summary
public int getId() Get the type of event

setConnectionHandle	back to summary
public void setConnectionHandle(Object connectionHandle) Set the connection handle. Used for CONNECTION_CLOSED event

public Class ConnectionEvent

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail