-
- All Superinterfaces:
- EventListener
public interface ConnectionEventListener extends EventListener
TheConnectionEventListener
interface provides an event callback mechanism to enable an application server to receive notifications from aManagedConnection
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 aManagedConnection
instance by usingManagedConnection.addConnectionEventListener
method.- Version:
- 0.5
- Author:
- Rahul Sharma
- See Also:
ConnectionEvent
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method and Description void
connectionClosed(ConnectionEvent event)
Notifies that an application component has closed the connection.void
connectionErrorOccurred(ConnectionEvent event)
Notifies a connection related error.void
localTransactionCommitted(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was committed on the ManagedConnection instance.void
localTransactionRolledback(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was rolled back on the ManagedConnection instance.void
localTransactionStarted(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was started on the ManagedConnection instance.
-
-
-
Method Detail
-
connectionClosed
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
- event object describing the source of the event
-
localTransactionStarted
void localTransactionStarted(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was started on the ManagedConnection instance.- Parameters:
event
- event object describing the source of the event
-
localTransactionCommitted
void localTransactionCommitted(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was committed on the ManagedConnection instance.- Parameters:
event
- event object describing the source of the event
-
localTransactionRolledback
void localTransactionRolledback(ConnectionEvent event)
Notifies that a Resource Manager Local Transaction was rolled back on the ManagedConnection instance.- Parameters:
event
- event object describing the source of the event
-
connectionErrorOccurred
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
- event object describing the source of the event
-
-
Document created the 11/06/2005, last modified the 18/08/2025
Source of the printed document:https://www.gaudry.be/en/java-api-javaee-rf-javax/resource/spi/ConnectionEventListener.html
The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.
References
These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author of this site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.