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

Class IdentifyBackupCompatibilityProblemsExtendedResult

java.lang.Object
com.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.IdentifyBackupCompatibilityProblemsExtendedResult
All Implemented Interfaces:
LDAPResponse, Serializable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IdentifyBackupCompatibilityProblemsExtendedResult extends ExtendedResult
This class provides an implementation of an extended result that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.
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.33. If the request was processed successfully, then the response will have a value with the following encoding: 
   IdentifyBackupCompatibilityProblemsResult ::= SEQUENCE {
        errorMessages       [0] SEQUENCE OF OCTET STRING OPTIONAL,
        warningMessages     [1] SEQUENCE OF OCTET STRING OPTIONAL,
        ... }
See Also:

  • Field Details

  • Constructor Details

    • IdentifyBackupCompatibilityProblemsExtendedResult

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

    • IdentifyBackupCompatibilityProblemsExtendedResult

      public IdentifyBackupCompatibilityProblemsExtendedResult(int messageID, @NotNull ResultCode resultCode, @Nullable String diagnosticMessage, @Nullable String matchedDN, @Nullable String[] referralURLs, @Nullable Collection<String> errorMessages, @Nullable Collection<String> warningMessages, @Nullable Control... responseControls)
      Creates a new identify backup compatibility problems 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.
      errorMessages - The set of error messages to include in the result. It may be null or empty if no error messages should be included.
      warningMessages - The set of warning messages to include in the result. It may be null or empty if no warning messages should be included.
      responseControls - The set of controls from the response, if available.

  • Method Details

    • encodeValue

      @Nullable public static ASN1OctetString encodeValue(@NotNull ResultCode resultCode, @Nullable Collection<String> errorMessages, @Nullable Collection<String> warningMessages)
      Creates an ASN.1 octet string containing an encoded representation of the value for an identify backup compatibility problems extended result with the provided information.
      Parameters:
      resultCode - The result code from the response.
      errorMessages - The set of error messages to include in the result. It may be null or empty if no error messages should be included.
      warningMessages - The set of warning messages to include in the result. It may be null or empty if no warning messages should be included.
      Returns:
      An ASN.1 octet string containing an encoded representation of the value for an identify backup compatibility problems extended result, or null if a result with the provided information should not have a value.

    • getErrorMessages

      @NotNull public List<String> getErrorMessages()
      Retrieves a list of messages for any compatibility errors that have been identified. If there are any errors, a backup from the source cannot be restored into the target.
      Returns:
      A list of messages for any compatibility errors that have been identified, or an empty list if there are no compatibility errors.

    • getWarningMessages

      @NotNull public List<String> getWarningMessages()
      Retrieves a list of messages for any compatibility warnings that have been identified. If there are any warnings, it may still be possible to restore a backup from the source into the target.
      Returns:
      A list of messages for any compatibility warnings that have been identified, or an empty list if there are no compatibility warnings.

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