Top Description Methods
javax.resource.spi

public Interface ConnectionEventListener

extends EventListener
Imports
java.util.EventListener, javax.resource.ResourceException

The ConnectionEventListener interface provides an event callback mechanism to enable an application server to receive notifications from a ManagedConnection instance.

An application server uses these event notifications to manage its connection pool, to clean up any invalid or terminated connections and to manage local transactions.

An application server implements the ConnectionEventListener interface. It registers a connection listener with a ManagedConnection instance by using ManagedConnection.addConnectionEventListener method.

Author
Rahul Sharma
Version
0.5
See Also
javax.resource.spi.ConnectionEvent

Method Summary

Modifier and TypeMethod and Description
public void
connectionClosed(ConnectionEvent
event object describing the source of the event
event
)

Notifies that an application component has closed the connection.

public void
connectionErrorOccurred(ConnectionEvent
event object describing the source of the event
event
)

Notifies a connection related error.

public void
localTransactionCommitted(ConnectionEvent
event object describing the source of the event
event
)

Notifies that a Resource Manager Local Transaction was committed on the ManagedConnection instance.

public void
localTransactionRolledback(ConnectionEvent
event object describing the source of the event
event
)

Notifies that a Resource Manager Local Transaction was rolled back on the ManagedConnection instance.

public void
localTransactionStarted(ConnectionEvent
event object describing the source of the event
event
)

Notifies that a Resource Manager Local Transaction was started on the ManagedConnection instance.

Method Detail

connectionClosedback to summary
public void connectionClosed(ConnectionEvent event)

Notifies that an application component has closed the connection.

A ManagedConnection instance notifies its registered set of listeners by calling ConnectionEventListener.connectionClosed method when an application component closes a connection handle. The application server uses this connection close event to put the ManagedConnection instance back in to the connection pool.

Parameters
event:ConnectionEvent

event object describing the source of the event

connectionErrorOccurredback to summary
public void connectionErrorOccurred(ConnectionEvent event)

Notifies a connection related error. The ManagedConnection instance calls the method ConnectionEventListener.connectionErrorOccurred to notify its registered listeners of the occurrence of a physical connection-related error. The event notification happens just before a resource adapter throws an exception to the application component using the connection handle. The connectionErrorOccurred method indicates that the associated ManagedConnection instance is now invalid and unusable. The application server handles the connection error event notification by initiating application server-specific cleanup (for example, removing ManagedConnection instance from the connection pool) and then calling ManagedConnection.destroy method to destroy the physical connection.

Parameters
event:ConnectionEvent

event object describing the source of the event

localTransactionCommittedback to summary
public void localTransactionCommitted(ConnectionEvent event)

Notifies that a Resource Manager Local Transaction was committed on the ManagedConnection instance.

Parameters
event:ConnectionEvent

event object describing the source of the event

localTransactionRolledbackback to summary
public void localTransactionRolledback(ConnectionEvent event)

Notifies that a Resource Manager Local Transaction was rolled back on the ManagedConnection instance.

Parameters
event:ConnectionEvent

event object describing the source of the event

localTransactionStartedback to summary
public void localTransactionStarted(ConnectionEvent event)

Notifies that a Resource Manager Local Transaction was started on the ManagedConnection instance.

Parameters
event:ConnectionEvent

event object describing the source of the event