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

Class GetBackupCompatibilityDescriptorExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.GetBackupCompatibilityDescriptorExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackupCompatibilityDescriptorExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that can be used to retrieve backup compatibility data for a Directory Server backend.
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 OID for this extended result is 1.3.6.1.4.1.30221.2.6.31. If the request was processed successfully, then the response will have a value with the following encoding: 
   GetBackupCompatibilityDescriptorResult ::= SEQUENCE {
        descriptor     [0] OCTET STRING,
        properties     [1] SEQUENCE OF OCTET STRING OPTIONAL,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • GetBackupCompatibilityDescriptorExtendedResult

      public GetBackupCompatibilityDescriptorExtendedResult(@NotNull ExtendedResult result) throws LDAPException
      Creates a new get backup compatibility descriptor extended result from the provided generic extended result.
      Parameters:
      result - The generic extended result to be decoded as a get backup compatibility descriptor extended result.
      Throws:
      LDAPException - If the provided extended result cannot be parsed as a valid get backup compatibility descriptor extended result.

    • GetBackupCompatibilityDescriptorExtendedResult

      public GetBackupCompatibilityDescriptorExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable ASN1OctetString descriptor, @Nullable Collection<String> properties, @Nullable Control... responseControls)
      Creates a new get backup compatibility descriptor extended result with the provided information.
      Parameters:
      messageID - The message ID for the LDAP message that is associated with this LDAP result.
      resultCode - The result code from the response.
      diagnosticMessage - The diagnostic message from the response, if available.
      matchedDN - The matched DN from the response, if available.
      referralURLs - The set of referral URLs from the response, if available.
      descriptor - The backup compatibility descriptor value. It may be null for an unsuccessful result.
      properties - A list of properties that provide information about the way the descriptor may be used. It may be null or empty for an unsuccessful result, or if there are no properties.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • encodeValue

      @Nullable public static ASN1OctetString encodeValue(@Nullable ASN1OctetString descriptor, @Nullable Collection<String> properties)
      Creates an ASN.1 octet string containing an encoded representation of the value for a get backup compatibility descriptor extended result with the provided information.
      Parameters:
      descriptor - The backup compatibility descriptor value. It may be null for an unsuccessful result.
      properties - A list of properties that provide information about the way the descriptor may be used. It may be null or empty for an unsuccessful result, or if there are no properties.
      Returns:
      An ASN.1 octet string containing an encoded representation of the value for a get backup compatibility descriptor extended result, or null if a result with the provided information should not have a value.

    • getDescriptor

      @Nullable public ASN1OctetString getDescriptor()
      Retrieves the backup compatibility descriptor value, if available.
      Returns:
      The backup compatibility descriptor value, or null if none was provided.

    • getProperties

      @NotNull public List<String> getProperties()
      Retrieves a list of properties that provide information about the way the descriptor may be used.
      Returns:
      A list of properties that provide information about the way the descriptor may be used, or an empty list if no properties were provided.

    • 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.