Class CollectSupportDataOutputIntermediateResponse

    • Constructor Detail

      • CollectSupportDataOutputIntermediateResponse

        public CollectSupportDataOutputIntermediateResponse​(CollectSupportDataOutputStream outputStream,
                                                            java.lang.String outputMessage,
                                                            Control... controls)
        Creates a new collect support data output intermediate response with the provided information.
        Parameters:
        outputStream - The output stream to which the message was written. It must not be null.
        outputMessage - The output message that was written by the tool. It must not be null.
        controls - The set of controls to include in this intermediate response. It may be null or empty if no controls are needed.
      • CollectSupportDataOutputIntermediateResponse

        public CollectSupportDataOutputIntermediateResponse​(IntermediateResponse intermediateResponse)
                                                     throws LDAPException
        Creates a new collect support data output intermediate response that is decoded from the provided generic intermediate response.
        Parameters:
        intermediateResponse - The generic intermediate response to be decoded as a collect support data output intermediate response. It must not be null.
        Throws:
        LDAPException - If the provided intermediate response object cannot be decoded as a collect support data output intermediate response.
    • Method Detail

      • getOutputMessage

        public java.lang.String getOutputMessage()
        Retrieves the output message that was written.
        Returns:
        The output message that was written.
      • getIntermediateResponseName

        public java.lang.String getIntermediateResponseName()
        Retrieves the user-friendly name for the intermediate response, if available. If no user-friendly name has been defined, but a response OID is available, then that will be returned. If neither a user-friendly name nor a response OID are available, then null will be returned.
        Overrides:
        getIntermediateResponseName in class IntermediateResponse
        Returns:
        The user-friendly name for this intermediate response, the response OID if a user-friendly name is not available but a response OID is, or null if neither a user-friendly name nor a response OID are available.
      • valueToString

        public java.lang.String valueToString()
        Retrieves a human-readable string representation for the contents of the value for this intermediate response, if appropriate. If one is provided, then it should be a relatively compact single-line representation of the most important elements of the value.
        Overrides:
        valueToString in class IntermediateResponse
        Returns:
        A human-readable string representation for the contents of the value for this intermediate response, or null if there is no value or no string representation is available.
      • toString

        public void toString​(java.lang.StringBuilder buffer)
        Appends a string representation of this intermediate response to the provided buffer.
        Specified by:
        toString in interface LDAPResponse
        Overrides:
        toString in class IntermediateResponse
        Parameters:
        buffer - The buffer to which the string representation should be appended.