Package 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, 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:

  • Field Details

  • Constructor Details

    • CollectSupportDataExtendedResult

      public CollectSupportDataExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable 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 Details

    • getExitCode

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