|
|||||||||
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.GetBackupCompatibilityDescriptorExtendedResult
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackupCompatibilityDescriptorExtendedResult
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 retrieve backup compatibility data for a Directory Server backend.
GetBackupCompatibilityDescriptorResult ::= SEQUENCE { descriptor [0] OCTET STRING, properties [1] SEQUENCE OF OCTET STRING OPTIONAL, ... }
GetBackupCompatibilityDescriptorExtendedRequest
,
IdentifyBackupCompatibilityProblemsExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
GET_BACKUP_COMPATIBILITY_DESCRIPTOR_RESULT_OID
The OID (1.3.6.1.4.1.30221.2.6.31) for the get backup compatibility descriptor extended result. |
Fields inherited from interface com.unboundid.ldap.protocol.LDAPResponse |
---|
NO_CONTROLS |
Constructor Summary | |
---|---|
GetBackupCompatibilityDescriptorExtendedResult(ExtendedResult result)
Creates a new get backup compatibility descriptor extended result from the provided generic extended result. |
|
GetBackupCompatibilityDescriptorExtendedResult(int messageID,
ResultCode resultCode,
java.lang.String diagnosticMessage,
java.lang.String matchedDN,
java.lang.String[] referralURLs,
ASN1OctetString descriptor,
java.util.Collection<java.lang.String> properties,
Control... responseControls)
Creates a new get backup compatibility descriptor extended result with the provided information. |
Method Summary | |
---|---|
static ASN1OctetString |
encodeValue(ASN1OctetString descriptor,
java.util.Collection<java.lang.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. |
ASN1OctetString |
getDescriptor()
Retrieves the backup compatibility descriptor value, if available. |
java.lang.String |
getExtendedResultName()
Retrieves the user-friendly name for the extended result, if available. |
java.util.List<java.lang.String> |
getProperties()
Retrieves a list of properties that provide information about the way the descriptor may be used. |
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 GET_BACKUP_COMPATIBILITY_DESCRIPTOR_RESULT_OID
Constructor Detail |
---|
public GetBackupCompatibilityDescriptorExtendedResult(ExtendedResult result) throws LDAPException
result
- The generic extended result to be decoded as a get backup
compatibility descriptor extended result.
LDAPException
- If the provided extended result cannot be parsed as
a valid get backup compatibility descriptor
extended result.public GetBackupCompatibilityDescriptorExtendedResult(int messageID, ResultCode resultCode, java.lang.String diagnosticMessage, java.lang.String matchedDN, java.lang.String[] referralURLs, ASN1OctetString descriptor, java.util.Collection<java.lang.String> properties, 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.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 Detail |
---|
public static ASN1OctetString encodeValue(ASN1OctetString descriptor, java.util.Collection<java.lang.String> properties)
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.
null
if a result with the provided information should
not have a value.public ASN1OctetString getDescriptor()
null
if none
was provided.public java.util.List<java.lang.String> getProperties()
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 |