Class XcaConnectionEvent

java.lang.Object
org.firebirdsql.jaybird.xca.XcaConnectionEvent

public final class XcaConnectionEvent extends Object
The XcaConnectionEvent class provides information about the source of a connection related event. A XcaConnectionEvent instance contains the following information:
  • Type of the connection event
  • FBManagedConnection instance that generated the connection event. A FBManagedConnection instance is returned from the method getSource()
  • Connection handle associated with the FBManagedConnection 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
  • Constructor Details

    • XcaConnectionEvent

      public XcaConnectionEvent(FBManagedConnection source, XcaConnectionEvent.EventType eventType)
      Construct a ConnectionEvent object.
      Parameters:
      source - the source of the event
      eventType - Type of event
    • XcaConnectionEvent

      public XcaConnectionEvent(FBManagedConnection source, XcaConnectionEvent.EventType eventType, Exception exception)
      Construct a ConnectionEvent object.
      Parameters:
      source - the source of the event
      eventType - Type of event
      exception - Exception associated with the event
  • Method Details

    • getSource

      public FBManagedConnection getSource()
      Returns:
      The managed connection on which the event initially occurred.
    • getConnectionHandle

      public FirebirdConnection getConnectionHandle()
      Get the connection handle associated with the managed connection instance. Used for CONNECTION_CLOSED event.
      Returns:
      The connection handle, can be null
    • setConnectionHandle

      public void setConnectionHandle(FirebirdConnection connectionHandle)
    • getException

      public Exception getException()
      Get the exception associated with this event.
      Returns:
      Exception for this event, can be null for event type other than CONNECTION_ERROR_OCCURRED
    • getEventType

      public XcaConnectionEvent.EventType getEventType()
      Returns:
      The type of event