Package org.forgerock.opendj.io

Interface LDAPMessageHandler

All Known Implementing Classes:
AbstractLDAPMessageHandler
public interface LDAPMessageHandler
An interface for handling LDAP messages decoded using an LDAPReader.

  • Method Details

    • abandonRequest

      void abandonRequest(int messageID, AbandonRequest request) throws DecodeException, IOException
      Handles an LDAP abandon request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded abandon request.
      Throws:
      DecodeException - If this handler does not support abandon requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • addRequest

      void addRequest(int messageID, AddRequest request) throws DecodeException, IOException
      Handles an LDAP add request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded add request.
      Throws:
      DecodeException - If this handler does not support add requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • addResult

      void addResult(int messageID, Result result) throws DecodeException, IOException
      Handles an LDAP add result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded add result.
      Throws:
      DecodeException - If this handler does not support add results.
      IOException - If an unexpected IO error occurred while processing the response.

    • bindRequest

      void bindRequest(int messageID, int version, GenericBindRequest request) throws DecodeException, IOException
      Handles an LDAP bind request message.
      Parameters:
      messageID - The LDAP message ID.
      version - The requested LDAP protocol version.
      request - The decoded bind request.
      Throws:
      DecodeException - If this handler does not support bind requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • bindResult

      void bindResult(int messageID, BindResult result) throws DecodeException, IOException
      Handles an LDAP bind result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded bind result.
      Throws:
      DecodeException - If this handler does not support bind results.
      IOException - If an unexpected IO error occurred while processing the response.

    • compareRequest

      void compareRequest(int messageID, CompareRequest request) throws DecodeException, IOException
      Handles an LDAP compare request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded compare request.
      Throws:
      DecodeException - If this handler does not support compare requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • compareResult

      void compareResult(int messageID, CompareResult result) throws DecodeException, IOException
      Handles an LDAP compare result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded compare result.
      Throws:
      DecodeException - If this handler does not support compare results.
      IOException - If an unexpected IO error occurred while processing the response.

    • deleteRequest

      void deleteRequest(int messageID, DeleteRequest request) throws DecodeException, IOException
      Handles an LDAP delete request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded delete request.
      Throws:
      DecodeException - If this handler does not support delete requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • deleteResult

      void deleteResult(int messageID, Result result) throws DecodeException, IOException
      Handles an LDAP delete result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded delete result.
      Throws:
      DecodeException - If this handler does not support delete results.
      IOException - If an unexpected IO error occurred while processing the response.

    • extendedRequest

      <R extends ExtendedResult> void extendedRequest(int messageID, ExtendedRequest<R> request) throws DecodeException, IOException
      Handles an LDAP extended request message.
      Type Parameters:
      R - type of extended result
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded extended request.
      Throws:
      DecodeException - If this handler does not support extended requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • extendedResult

      void extendedResult(int messageID, ExtendedResult result) throws DecodeException, IOException
      Handles an LDAP extended result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded extended result.
      Throws:
      DecodeException - If this handler does not support extended results.
      IOException - If an unexpected IO error occurred while processing the response.

    • intermediateResponse

      void intermediateResponse(int messageID, IntermediateResponse response) throws DecodeException, IOException
      Handles an LDAP intermediate response message.
      Parameters:
      messageID - The LDAP message ID.
      response - The decoded intermediate response.
      Throws:
      DecodeException - If this handler does not support intermediate responses.
      IOException - If an unexpected IO error occurred while processing the response.

    • modifyDNRequest

      void modifyDNRequest(int messageID, ModifyDNRequest request) throws DecodeException, IOException
      Handles an LDAP modify DN request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded modify DN request.
      Throws:
      DecodeException - If this handler does not support modify DN requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • modifyDNResult

      void modifyDNResult(int messageID, Result result) throws DecodeException, IOException
      Handles an LDAP modify DN result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded modify DN result.
      Throws:
      DecodeException - If this handler does not support modify DN results.
      IOException - If an unexpected IO error occurred while processing the response.

    • modifyRequest

      void modifyRequest(int messageID, ModifyRequest request) throws DecodeException, IOException
      Handles an LDAP modify request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded modify request.
      Throws:
      DecodeException - If this handler does not support modify requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • modifyResult

      void modifyResult(int messageID, Result result) throws DecodeException, IOException
      Handles an LDAP modify result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded modify result.
      Throws:
      DecodeException - If this handler does not support modify results.
      IOException - If an unexpected IO error occurred while processing the response.

    • searchRequest

      void searchRequest(int messageID, SearchRequest request) throws DecodeException, IOException
      Handles an LDAP search request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded search request.
      Throws:
      DecodeException - If this handler does not support search requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • searchResult

      void searchResult(int messageID, Result result) throws DecodeException, IOException
      Handles an LDAP search result message.
      Parameters:
      messageID - The LDAP message ID.
      result - The decoded search result.
      Throws:
      DecodeException - If this handler does not support search results.
      IOException - If an unexpected IO error occurred while processing the response.

    • searchResultEntry

      void searchResultEntry(int messageID, SearchResultEntry entry) throws DecodeException, IOException
      Handles an LDAP search result entry message.
      Parameters:
      messageID - The LDAP message ID.
      entry - The decoded search result entry.
      Throws:
      DecodeException - If this handler does not support search result entries.
      IOException - If an unexpected IO error occurred while processing the response.

    • searchResultReference

      void searchResultReference(int messageID, SearchResultReference reference) throws DecodeException, IOException
      Handles an LDAP search result reference message.
      Parameters:
      messageID - The LDAP message ID.
      reference - The decoded search result reference.
      Throws:
      DecodeException - If this handler does not support search result references.
      IOException - If an unexpected IO error occurred while processing the response.

    • unbindRequest

      void unbindRequest(int messageID, UnbindRequest request) throws DecodeException, IOException
      Handles an LDAP unbind request message.
      Parameters:
      messageID - The LDAP message ID.
      request - The decoded unbind request.
      Throws:
      DecodeException - If this handler does not support unbind requests.
      IOException - If an unexpected IO error occurred while processing the request.

    • unrecognizedMessage

      void unrecognizedMessage(int messageID, byte messageTag, ByteString messageBytes) throws DecodeException, IOException
      Handles an unrecognized LDAP message.
      Parameters:
      messageID - The LDAP message ID.
      messageTag - The LDAP message type.
      messageBytes - The contents of the LDAP message.
      Throws:
      DecodeException - If this handler does not support the message type.
      IOException - If an unexpected IO error occurred while processing the message.