javax.resource.spi

Class ConnectionEvent

Contents
  • All Implemented Interfaces:
    Serializable

    public class ConnectionEvent
extends EventObject
    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
    Version:
    0.5
    Author:
    Rahul Sharma
    See Also:
    ConnectionEventListener, Serialized Form

    • Field Detail

      • CONNECTION_CLOSED

        public static final int CONNECTION_CLOSED
        Event notification that an application component has closed the connection
        See Also:
        Constant Field Values

      • LOCAL_TRANSACTION_STARTED

        public static final int LOCAL_TRANSACTION_STARTED
        Event notification that a Resource Manager Local Transaction was started on the connection
        See Also:
        Constant Field Values

      • LOCAL_TRANSACTION_COMMITTED

        public static final int LOCAL_TRANSACTION_COMMITTED
        Event notification that a Resource Manager Local Transaction was committed on the connection
        See Also:
        Constant Field Values

      • LOCAL_TRANSACTION_ROLLEDBACK

        public static final int LOCAL_TRANSACTION_ROLLEDBACK
        Event notification that a Resource Manager Local Transaction was rolled back on the connection
        See Also:
        Constant Field Values

      • CONNECTION_ERROR_OCCURRED

        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.
        See Also:
        Constant Field Values

      • id

        protected int id
        Type of the event

    • Constructor Detail

      • ConnectionEvent

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

      • ConnectionEvent

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

    • Method Detail

      • getConnectionHandle

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

      • setConnectionHandle

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

      • getException

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

      • getId

        public int getId()
        Get the type of 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/ConnectionEvent.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

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com, ConnectionEvent (Java(TM) EE 7 Specification APIs)

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.