Class CollectSupportDataExtendedResult
- java.lang.Object
-
- com.unboundid.ldap.sdk.LDAPResult
-
- com.unboundid.ldap.sdk.ExtendedResult
-
- com.unboundid.ldap.sdk.unboundidds.extensions.CollectSupportDataExtendedResult
-
- All Implemented Interfaces:
LDAPResponse
,java.io.Serializable
@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class CollectSupportDataExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that provides information about the result of processing aCollectSupportDataExtendedRequest
. Once this message has been received, all processing for the associated request will be complete, and there should not be any furtherCollectSupportDataOutputIntermediateResponse
orCollectSupportDataArchiveFragmentIntermediateResponse
messages.
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.
If the extended operation processing failed for some reason before the server could invoke the collect-support-data tool, then this response may not include an OID or value. However, if the collect-support-data tool has been invoked (regardless of its success or failure), then the extended result should have an OID of1.3.6.1.4.1.30221.2.6.67 and a value with the following encoding:
CollectSupportDataResponse ::= SEQUENCE { exitCode [0] INTEGER, ... }
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
COLLECT_SUPPORT_DATA_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.67) for the collect support data extended result.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description CollectSupportDataExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.Integer exitCode, Control... controls)
Creates a new collect support data extended result with the provided information.CollectSupportDataExtendedResult(ExtendedResult extendedResult)
Creates a new collect support data extended result that is decoded from the provided generic extended result.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.Integer
getExitCode()
Retrieves the exit code returned when the collect-support-data tool completed.java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.void
toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer.-
Methods inherited from class com.unboundid.ldap.sdk.ExtendedResult
getOID, getValue, hasValue, toString
-
Methods inherited from class com.unboundid.ldap.sdk.LDAPResult
getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
-
-
-
-
Field Detail
-
COLLECT_SUPPORT_DATA_RESULT_OID
public static final java.lang.String COLLECT_SUPPORT_DATA_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.67) for the collect support data extended result.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
CollectSupportDataExtendedResult
public CollectSupportDataExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.lang.Integer exitCode, Control... controls)
Creates a new collect support data extended result with the provided information.- Parameters:
messageID
- The LDAP message ID for this extended result.resultCode
- The result code for this extended result. It must not benull
.diagnosticMessage
- The diagnostic message for this extended result. It may benull
if no diagnostic message should be included.matchedDN
- The matched DN for this extended result. It may benull
if no matched DN should be included.referralURLs
- The set of referral URLs for this extended result. It may benull
or empty if no referral URLs should be included.exitCode
- The exit code returned when the collect-support-data tool completed. This may benull
if extended operation processing failed before the collect-support-data tool could complete.controls
- The set of controls to include in the extended result. It may be [@code null} or empty if no controls should be included.
-
CollectSupportDataExtendedResult
public CollectSupportDataExtendedResult(ExtendedResult extendedResult) throws LDAPException
Creates a new collect support data extended result that is decoded from the provided generic extended result.- Parameters:
extendedResult
- The generic extended result to be decoded as a collect support data extended result. It must not benull
.- Throws:
LDAPException
- If the provided generic extended result cannot be decoded as a collect support data extended result.
-
-
Method Detail
-
getExitCode
public java.lang.Integer getExitCode()
Retrieves the exit code returned when the collect-support-data tool completed.- Returns:
- The exit code returned when the collect-support-data tool
completed, or
null
if extended operation processing failed before the collect-support-data tool could complete.
-
getExtendedResultName
public java.lang.String getExtendedResultName()
Retrieves the user-friendly name for the extended result, 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, thennull
will be returned.- Overrides:
getExtendedResultName
in classExtendedResult
- Returns:
- The user-friendly name for this extended request, 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.
-
toString
public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this extended response to the provided buffer.- Specified by:
toString
in interfaceLDAPResponse
- Overrides:
toString
in classExtendedResult
- Parameters:
buffer
- The buffer to which a string representation of this extended response will be appended.
-
-