com.unboundid.ldap.sdk.unboundidds.extensions

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 a CollectSupportDataExtendedRequest. Once this message has been received, all processing for the associated request will be complete, and there should not be any further CollectSupportDataOutputIntermediateResponse or CollectSupportDataArchiveFragmentIntermediateResponse 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,
      ... }
 

See Also:

CollectSupportDataExtendedRequest, CollectSupportDataArchiveFragmentIntermediateResponse, CollectSupportDataOutputIntermediateResponse, Serialized Form

Field Summary

Fields

Modifier and Type	Field and 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 and Description
CollectSupportDataExtendedResult(ExtendedResult extendedResult) Creates a new collect support data extended result that is decoded from the provided generic extended result.
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.

Method Summary

Modifier and Type	Method and 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COLLECT_SUPPORT_DATA_RESULT_OID

@NotNull
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,
                                        @NotNull
                                        ResultCode resultCode,
                                        @Nullable
                                        java.lang.String diagnosticMessage,
                                        @Nullable
                                        java.lang.String matchedDN,
                                        @Nullable
                                        java.lang.String[] referralURLs,
                                        @Nullable
                                        java.lang.Integer exitCode,
                                        @Nullable
                                        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 be null.

diagnosticMessage - The diagnostic message for this extended result. It may be null if no diagnostic message should be included.

matchedDN - The matched DN for this extended result. It may be null if no matched DN should be included.

referralURLs - The set of referral URLs for this extended result. It may be null or empty if no referral URLs should be included.

exitCode - The exit code returned when the collect-support-data tool completed. This may be null 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(@NotNull
                                        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 be null.

Throws:

LDAPException - If the provided generic extended result cannot be decoded as a collect support data extended result.

Method Detail

getExitCode

@Nullable
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

@NotNull
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, then null will be returned.

Overrides:

getExtendedResultName in class ExtendedResult

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(@NotNull
                     java.lang.StringBuilder buffer)

Appends a string representation of this extended response to the provided buffer.

Specified by:

toString in interface LDAPResponse

Overrides:

toString in class ExtendedResult

Parameters:

buffer - The buffer to which a string representation of this extended response will be appended.