Package org.forgerock.opendj.ldap

Interface CancelRequestListener

All Superinterfaces:
EventListener
public interface CancelRequestListener extends EventListener
An object that registers to be notified when a cancellation request has been received and processing of the request should be aborted if possible.

Requests may be cancelled as a result of an abandon request or a cancel extended request sent from the client, or by the server itself (e.g. during server shutdown).

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    handleCancelRequest(LocalizableMessage cancellationReason)
    Invoked when a cancellation request has been received and processing of the request should be aborted if possible.

  • Method Details

    • handleCancelRequest

      void handleCancelRequest(LocalizableMessage cancellationReason)
      Invoked when a cancellation request has been received and processing of the request should be aborted if possible.

      Requests may be cancelled as a result of an abandon request or a cancel extended request sent from the client, or by the server itself (e.g. during server shutdown).

      Implementations should, if possible, abort further processing of the request and return an appropriate cancellation result.

      Parameters:
      cancellationReason - A message describing the reason why the request is being cancelled.