@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IdentifyBackupCompatibilityProblemsExtendedResult extends ExtendedResult
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.
IdentifyBackupCompatibilityProblemsResult ::= SEQUENCE { errorMessages [0] SEQUENCE OF OCTET STRING OPTIONAL, warningMessages [1] SEQUENCE OF OCTET STRING OPTIONAL, ... }
Modifier and Type | Field and 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.
|
NO_CONTROLS
Constructor and Description |
---|
IdentifyBackupCompatibilityProblemsExtendedResult(ExtendedResult result)
Creates a new identify backup compatibility problems extended result from
the provided generic extended result.
|
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.
|
Modifier and Type | Method and 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.
|
getOID, getValue, hasValue, toString
getDiagnosticMessage, getMatchedDN, getMessageID, getOperationType, getReferralURLs, getResponseControl, getResponseControls, getResultCode, getResultString, hasResponseControl, hasResponseControl
@NotNull public static final java.lang.String IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_RESULT_OID
public IdentifyBackupCompatibilityProblemsExtendedResult(@NotNull ExtendedResult result) throws LDAPException
result
- The generic extended result to be decoded as an identify
backup compatibility problems extended result.LDAPException
- If the provided extended result cannot be parsed as
a valid identify backup compatibility problems
extended result.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)
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.@Nullable public static ASN1OctetString encodeValue(@NotNull ResultCode resultCode, @Nullable java.util.Collection<java.lang.String> errorMessages, @Nullable java.util.Collection<java.lang.String> warningMessages)
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.null
if a result with the provided information
should not have a value.@NotNull public java.util.List<java.lang.String> getErrorMessages()
@NotNull public java.util.List<java.lang.String> getWarningMessages()
@NotNull public java.lang.String getExtendedResultName()
null
will be returned.getExtendedResultName
in class ExtendedResult
null
if neither a user-friendly name nor a response OID
are available.public void toString(@NotNull java.lang.StringBuilder buffer)
toString
in interface LDAPResponse
toString
in class ExtendedResult
buffer
- The buffer to which a string representation of this
extended response will be appended.