Package org.forgerock.opendj.ldap

Interface ServerConnection<C>

Type Parameters:
C - The type of request context.
All Superinterfaces:
RequestHandler<C>
@Deprecated public interface ServerConnection<C> extends RequestHandler<C>
Deprecated.
will be removed as part of OPENDJ-3467. It has been replaced by ReactiveHandler<>
A handler interface for interacting with client connections. A ServerConnection is associated with a client connection when the handleAccept method is invoked against a ServerConnectionFactory.

Implementations are responsible for handling connection life-cycle as well as request life-cycle. In particular, a ServerConnection is responsible for processing abandon and unbind requests, as well as extended operations such as StartTLS and Cancel operations.

See Also:

  • Method Details

    • handleAbandon

      void handleAbandon(C requestContext, AbandonRequest request)
      Deprecated.
      Invoked when an abandon request is received from a client.
      Parameters:
      requestContext - The request context.
      request - The abandon request.
      Throws:
      UnsupportedOperationException - If this server connection does not handle abandon requests.

    • handleConnectionClosed

      void handleConnectionClosed(C requestContext, UnbindRequest request)
      Deprecated.
      Invoked when the client closes the connection, possibly using an unbind request.
      Parameters:
      requestContext - The request context which should be ignored if there was no associated unbind request.
      request - The unbind request, which may be null if one was not sent before the connection was closed.

    • handleConnectionDisconnected

      void handleConnectionDisconnected(ResultCode resultCode, String message)
      Deprecated.
      Invoked when the server disconnects the client connection, possibly using a disconnect notification.
      Parameters:
      resultCode - The result code which was included with the disconnect notification, or null if no disconnect notification was sent.
      message - The diagnostic message, which may be empty or null indicating that none was provided.

    • handleConnectionError

      void handleConnectionError(Throwable error)
      Deprecated.
      Invoked when an error occurs on the connection and it is no longer usable.
      Parameters:
      error - The exception describing the problem that occurred.