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
,java.io.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, ... }
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.33) for the identify backup compatibility problems extended request.-
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse
NO_CONTROLS
-
-
Constructor Summary
Constructors Constructor Description IdentifyBackupCompatibilityProblemsExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, java.util.Collection<java.lang.String> errorMessages, java.util.Collection<java.lang.String> warningMessages, Control... responseControls)
Creates a new identify backup compatibility problems extended result with the provided information.IdentifyBackupCompatibilityProblemsExtendedResult(ExtendedResult result)
Creates a new identify backup compatibility problems extended result from the provided generic extended result.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ASN1OctetString
encodeValue(ResultCode resultCode, java.util.Collection<java.lang.String> errorMessages, java.util.Collection<java.lang.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.java.util.List<java.lang.String>
getErrorMessages()
Retrieves a list of messages for any compatibility errors that have been identified.java.lang.String
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available.java.util.List<java.lang.String>
getWarningMessages()
Retrieves a list of messages for any compatibility warnings that have been identified.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
-
IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_RESULT_OID
@NotNull public static final java.lang.String IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.33) for the identify backup compatibility problems extended request.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
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 java.lang.String diagnosticMessage, @Nullable java.lang.String matchedDN, @Nullable java.lang.String[] referralURLs, @Nullable java.util.Collection<java.lang.String> errorMessages, @Nullable java.util.Collection<java.lang.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 benull
or empty if no error messages should be included.warningMessages
- The set of warning messages to include in the result. It may benull
or empty if no warning messages should be included.responseControls
- The set of controls from the response, if available.
-
-
Method Detail
-
encodeValue
@Nullable public static ASN1OctetString encodeValue(@NotNull ResultCode resultCode, @Nullable java.util.Collection<java.lang.String> errorMessages, @Nullable java.util.Collection<java.lang.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 benull
or empty if no error messages should be included.warningMessages
- The set of warning messages to include in the result. It may benull
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 java.util.List<java.lang.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 java.util.List<java.lang.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 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(@NotNull 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.
-
-