Package com.unboundid.ldap.protocol

Class GenericResponseProtocolOp

java.lang.Object
com.unboundid.ldap.protocol.GenericResponseProtocolOp
All Implemented Interfaces:
ProtocolOp, Serializable
Direct Known Subclasses:
AddResponseProtocolOp, CompareResponseProtocolOp, DeleteResponseProtocolOp, ModifyDNResponseProtocolOp, ModifyResponseProtocolOp, SearchResultDoneProtocolOp
@InternalUseOnly @NotExtensible @ThreadSafety(level=COMPLETELY_THREADSAFE) public abstract class GenericResponseProtocolOp extends Object implements ProtocolOp
This class provides an implementation of a generic response protocol op. It must be subclassed by classes providing implementations for each operation type.
See Also:

  • Field Details

  • Constructor Details

    • GenericResponseProtocolOp

      protected GenericResponseProtocolOp(byte type, int resultCode, @Nullable String matchedDN, @Nullable String diagnosticMessage, @Nullable List<String> referralURLs)
      Creates a new instance of this response with the provided information.
      Parameters:
      type - The BER type for this response.
      resultCode - The result code for this response.
      matchedDN - The matched DN for this result, if available.
      diagnosticMessage - The diagnostic message for this response, if available.
      referralURLs - The list of referral URLs for this response, if available.

    • GenericResponseProtocolOp

      protected GenericResponseProtocolOp(@NotNull ASN1StreamReader reader) throws LDAPException
      Creates a new response read from the provided ASN.1 stream reader.
      Parameters:
      reader - The ASN.1 stream reader from which to read the response.
      Throws:
      LDAPException - If a problem occurs while reading or parsing the response.

  • Method Details

    • getResultCode

      public final int getResultCode()
      Retrieves the result code for this response.
      Returns:
      The result code for this response.

    • getMatchedDN

      @Nullable public final String getMatchedDN()
      Retrieves the matched DN for this response, if any.
      Returns:
      The matched DN for this response, or null if there is no matched DN.

    • getDiagnosticMessage

      @Nullable public final String getDiagnosticMessage()
      Retrieves the diagnostic message for this response, if any.
      Returns:
      The diagnostic message for this response, or null if there is no diagnostic message.

    • getReferralURLs

      @NotNull public final List<String> getReferralURLs()
      Retrieves the list of referral URLs for this response.
      Returns:
      The list of referral URLs for this response, or an empty list if there are no referral URLs.

    • getProtocolOpType

      public byte getProtocolOpType()
      Retrieves the BER type for this protocol op.
      Specified by:
      getProtocolOpType in interface ProtocolOp
      Returns:
      The BER type for this protocol op.

    • writeTo

      public final void writeTo(@NotNull ASN1Buffer buffer)
      Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.
      Specified by:
      writeTo in interface ProtocolOp
      Parameters:
      buffer - The ASN.1 buffer to which the encoded representation should be written.

    • toLDAPResult

      @NotNull public LDAPResult toLDAPResult(@Nullable Control... controls)
      Creates a new LDAP result object from this response protocol op.
      Parameters:
      controls - The set of controls to include in the LDAP result. It may be empty or null if no controls should be included.
      Returns:
      The LDAP result that was created.

    • toString

      @NotNull public final String toString()
      Retrieves a string representation of this protocol op.
      Overrides:
      toString in class Object
      Returns:
      A string representation of this protocol op.

    • toString

      public final void toString(@NotNull StringBuilder buffer)
      Appends a string representation of this LDAP protocol op to the provided buffer.
      Specified by:
      toString in interface ProtocolOp
      Parameters:
      buffer - The buffer to which the string representation should be appended.