Package com.unboundid.ldap.sdk.unboundidds.extensions

Class CollectSupportDataOutputIntermediateResponse

java.lang.Object
com.unboundid.ldap.sdk.IntermediateResponse
com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataOutputIntermediateResponse
All Implemented Interfaces:
LDAPResponse, Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CollectSupportDataOutputIntermediateResponse extends IntermediateResponse
This class provides an implementation of an intermediate response that can provide the client with output from the collect-support-data tool in response to a CollectSupportDataExtendedRequest.
NOTE: This class, and other classes within the com.unboundid.ldap.sdk.unboundidds package structure, are only supported for use against Ping Identity, UnboundID, and Nokia/Alcatel-Lucent 8661 server products. These classes provide support for proprietary functionality or for external specifications that are not considered stable or mature enough to be guaranteed to work in an interoperable way with other types of LDAP servers.

The collect support data output intermediate response has an OID of 1.3.6.1.4.1.30221.2.6.65 and a value with the following encoding: 
   CollectSupportDataOutputIntermediateResponse ::= SEQUENCE {
      outputStream      [0] ENUMERATED {
           standardOutput     (0),
           standardError      (1),
           ... },
      outputMessage     [1] OCTET STRING,
      ... }
See Also:

  • Field Details

  • Constructor Details

    • CollectSupportDataOutputIntermediateResponse

      public CollectSupportDataOutputIntermediateResponse(@NotNull CollectSupportDataOutputStream outputStream, @NotNull String outputMessage, @Nullable 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(@NotNull 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 Details

    • getOutputStream

      @NotNull public CollectSupportDataOutputStream getOutputStream()
      Retrieves the output stream to which the output message was written.
      Returns:
      The output stream to which the output was written.

    • getOutputMessage

      @NotNull public String getOutputMessage()
      Retrieves the output message that was written.
      Returns:
      The output message that was written.

    • getIntermediateResponseName

      @NotNull public 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

      @NotNull public 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(@NotNull 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.