@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CollectSupportDataOutputIntermediateResponse extends IntermediateResponse
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.
CollectSupportDataOutputIntermediateResponse ::= SEQUENCE { outputStream [0] ENUMERATED { standardOutput (0), standardError (1), ... }, outputMessage [1] OCTET STRING, ... }
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COLLECT_SUPPORT_DATA_OUTPUT_INTERMEDIATE_RESPONSE_OID
The OID (1.3.6.1.4.1.30221.2.6.65) for the collect support data output
intermediate response.
|
TYPE_INTERMEDIATE_RESPONSE_OID, TYPE_INTERMEDIATE_RESPONSE_VALUE
Constructor and Description |
---|
CollectSupportDataOutputIntermediateResponse(CollectSupportDataOutputStream outputStream,
java.lang.String outputMessage,
Control... controls)
Creates a new collect support data output intermediate response with the
provided information.
|
CollectSupportDataOutputIntermediateResponse(IntermediateResponse intermediateResponse)
Creates a new collect support data output intermediate response that is
decoded from the provided generic intermediate response.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getIntermediateResponseName()
Retrieves the user-friendly name for the intermediate response, if
available.
|
java.lang.String |
getOutputMessage()
Retrieves the output message that was written.
|
CollectSupportDataOutputStream |
getOutputStream()
Retrieves the output stream to which the output message was written.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this intermediate response to the
provided buffer.
|
java.lang.String |
valueToString()
Retrieves a human-readable string representation for the contents of the
value for this intermediate response, if appropriate.
|
getControl, getControls, getMessageID, getOID, getValue, toString
public static final java.lang.String COLLECT_SUPPORT_DATA_OUTPUT_INTERMEDIATE_RESPONSE_OID
public CollectSupportDataOutputIntermediateResponse(CollectSupportDataOutputStream outputStream, java.lang.String outputMessage, Control... controls)
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.public CollectSupportDataOutputIntermediateResponse(IntermediateResponse intermediateResponse) throws LDAPException
intermediateResponse
- The generic intermediate response to be
decoded as a collect support data output
intermediate response. It must not be
null
.LDAPException
- If the provided intermediate response object cannot
be decoded as a collect support data output
intermediate response.public CollectSupportDataOutputStream getOutputStream()
public java.lang.String getOutputMessage()
public java.lang.String getIntermediateResponseName()
null
will be returned.getIntermediateResponseName
in class IntermediateResponse
null
if neither a user-friendly name
nor a response OID are available.public java.lang.String valueToString()
valueToString
in class IntermediateResponse
null
if there is
no value or no string representation is available.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class IntermediateResponse
buffer
- The buffer to which the string representation should be
appended.