Class ExtendedResponseProtocolOp

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static byte TYPE_RESPONSE_OID
      The BER type for the response OID element.
      static byte TYPE_RESPONSE_VALUE
      The BER type for the response value element.
    • Constructor Summary

      Constructors 
      Constructor Description
      ExtendedResponseProtocolOp​(int resultCode, java.lang.String matchedDN, java.lang.String diagnosticMessage, java.util.List<java.lang.String> referralURLs, java.lang.String responseOID, ASN1OctetString responseValue)
      Creates a new instance of this extended response protocol op with the provided information.
      ExtendedResponseProtocolOp​(LDAPResult result)
      Creates a new extended response protocol op from the provided extended result object.
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static ExtendedResponseProtocolOp decodeProtocolOp​(ASN1Element element)
      Decodes the provided ASN.1 element as an extended response protocol op.
      ASN1Element encodeProtocolOp()
      Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
      java.lang.String getDiagnosticMessage()
      Retrieves the diagnostic message for this extended response, if any.
      java.lang.String getMatchedDN()
      Retrieves the matched DN for this extended response, if any.
      byte getProtocolOpType()
      Retrieves the BER type for this protocol op.
      java.util.List<java.lang.String> getReferralURLs()
      Retrieves the list of referral URLs for this extended response.
      java.lang.String getResponseOID()
      Retrieves the OID for this extended response, if any.
      ASN1OctetString getResponseValue()
      Retrieves the value for this extended response, if any.
      int getResultCode()
      Retrieves the result code for this extended response.
      ExtendedResult toExtendedResult​(Control... controls)
      Creates a extended result from this protocol op.
      java.lang.String toString()
      Retrieves a string representation of this protocol op.
      void toString​(java.lang.StringBuilder buffer)
      Appends a string representation of this LDAP protocol op to the provided buffer.
      void writeTo​(ASN1Buffer buffer)
      Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ExtendedResponseProtocolOp

        public ExtendedResponseProtocolOp​(int resultCode,
                                          java.lang.String matchedDN,
                                          java.lang.String diagnosticMessage,
                                          java.util.List<java.lang.String> referralURLs,
                                          java.lang.String responseOID,
                                          ASN1OctetString responseValue)
        Creates a new instance of this extended response protocol op with the provided information.
        Parameters:
        resultCode - The result code for this response.
        matchedDN - The matched DN for this response, if available.
        diagnosticMessage - The diagnostic message for this response, if any.
        referralURLs - The list of referral URLs for this response, if any.
        responseOID - The response OID for this response, if any.
        responseValue - The value for this response, if any.
      • ExtendedResponseProtocolOp

        public ExtendedResponseProtocolOp​(LDAPResult result)
        Creates a new extended response protocol op from the provided extended result object.
        Parameters:
        result - The extended result object to use to create this protocol op.
    • Method Detail

      • getResultCode

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

        public java.lang.String getMatchedDN()
        Retrieves the matched DN for this extended response, if any.
        Returns:
        The matched DN for this extended response, or null if there is no matched DN.
      • getDiagnosticMessage

        public java.lang.String getDiagnosticMessage()
        Retrieves the diagnostic message for this extended response, if any.
        Returns:
        The diagnostic message for this extended response, or null if there is no diagnostic message.
      • getReferralURLs

        public java.util.List<java.lang.String> getReferralURLs()
        Retrieves the list of referral URLs for this extended response.
        Returns:
        The list of referral URLs for this extended response, or an empty list if there are no referral URLs.
      • getResponseOID

        public java.lang.String getResponseOID()
        Retrieves the OID for this extended response, if any.
        Returns:
        The OID for this extended response, or null if there is no response OID.
      • getResponseValue

        public ASN1OctetString getResponseValue()
        Retrieves the value for this extended response, if any.
        Returns:
        The value for this extended response, or null if there is no response value.
      • encodeProtocolOp

        public ASN1Element encodeProtocolOp()
        Encodes this protocol op to an ASN.1 element suitable for inclusion in an encoded LDAP message.
        Specified by:
        encodeProtocolOp in interface ProtocolOp
        Returns:
        The ASN.1 element containing the encoded protocol op.
      • decodeProtocolOp

        public static ExtendedResponseProtocolOp decodeProtocolOp​(ASN1Element element)
                                                           throws LDAPException
        Decodes the provided ASN.1 element as an extended response protocol op.
        Parameters:
        element - The ASN.1 element to be decoded.
        Returns:
        The decoded extended response protocol op.
        Throws:
        LDAPException - If the provided ASN.1 element cannot be decoded as an extended response protocol op.
      • writeTo

        public void writeTo​(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.
      • toExtendedResult

        public ExtendedResult toExtendedResult​(Control... controls)
        Creates a extended result from this protocol op.
        Parameters:
        controls - The set of controls to include in the extended result. It may be empty or null if no controls should be included.
        Returns:
        The extended result that was created.
      • toString

        public java.lang.String toString()
        Retrieves a string representation of this protocol op.
        Overrides:
        toString in class java.lang.Object
        Returns:
        A string representation of this protocol op.
      • toString

        public void toString​(java.lang.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.