Module org.firebirdsql.jaybird
Package org.firebirdsql.jaybird.xca

# Interface XcaConnectionEventListener

public interface XcaConnectionEventListener
Listener to receives notification of events on a managed connection instance.

- ## Method Summary

  Modifier and Type
  Method
  Description
  `void`
  `connectionClosed(XcaConnectionEvent connectionEvent)`
  Notifies the close of a connection.
  `void`
  `connectionErrorOccurred(XcaConnectionEvent connectionEvent)`
  Notifies a connection related error.

- ## Method Details

  - ### connectionClosed

    void connectionClosed(XcaConnectionEvent connectionEvent)
    Notifies the close of a connection.

    A managed connection notifies its listeners by calling this method when an application component closes a connection handle. The owner of the managed connection can use this event to put the managed connection instance back in to the connection pool, or close the physical connection.

    Parameters:
      `connectionEvent` - Connection event

  - ### connectionErrorOccurred

    void connectionErrorOccurred(XcaConnectionEvent connectionEvent)
    Notifies a connection related error.

    The managed connection instance calls this method to notify its listeners of the occurrence of a physical connection-related error. The event notification happens just before it throws an exception to the application component using the connection handle.

    This method indicates that the associated managed connection instance is now invalid and unusable. The owner of the managed connection handles the connection error event notification by initiating owner-specific cleanup (for example, removing the managed connection instance from the connection pool) and then calling the destroy method to destroy the physical connection.

    Parameters:
      `connectionEvent` - Connection event