|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPResult
com.unboundid.ldap.sdk.ExtendedResult
com.unboundid.ldap.sdk.unboundidds.extensions.IdentifyBackupCompatibilityProblemsExtendedResult
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class IdentifyBackupCompatibilityProblemsExtendedResult
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This class provides an implementation of an extended result that can be used to identify potential incompatibility problems between two backup compatibility descriptor values.
IdentifyBackupCompatibilityProblemsResult ::= SEQUENCE { errorMessages [0] SEQUENCE OF OCTET STRING OPTIONAL, warningMessages [1] SEQUENCE OF OCTET STRING OPTIONAL, ... }
IdentifyBackupCompatibilityProblemsExtendedRequest
,
GetBackupCompatibilityDescriptorExtendedRequest
,
Serialized FormField Summary | |
---|---|
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 | |
---|---|
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. |
Method Summary | |
---|---|
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, getReferralURLs, getResponseControl, getResponseControls, getResultCode, hasResponseControl, hasResponseControl |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_RESULT_OID
Constructor Detail |
---|
public IdentifyBackupCompatibilityProblemsExtendedResult(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, 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)
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 Detail |
---|
public static ASN1OctetString encodeValue(ResultCode resultCode, java.util.Collection<java.lang.String> errorMessages, 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.public java.util.List<java.lang.String> getErrorMessages()
public java.util.List<java.lang.String> getWarningMessages()
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(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.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |