|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.unboundid.ldap.sdk.LDAPRequest
com.unboundid.ldap.sdk.ExtendedRequest
com.unboundid.ldap.sdk.unboundidds.extensions.GetBackupCompatibilityDescriptorExtendedRequest
@ThreadSafety(level=COMPLETELY_THREADSAFE) public final class GetBackupCompatibilityDescriptorExtendedRequest
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 request that can be used to retrieve backup compatibility data for a Directory Server backend. This includes both a token that can be used to compare compatibility data with other servers (or potentially the same server at a later date, for example to check compatibility after upgrading to a new version), and a set of capability strings that may provide additional context about how the backup descriptor may be used.
GetBackupCompatibilityDescriptorRequest ::= SEQUENCE { baseDN [0] OCTET STRING, ... }
GetBackupCompatibilityDescriptorExtendedResult
,
IdentifyBackupCompatibilityProblemsExtendedRequest
,
Serialized FormField Summary | |
---|---|
static java.lang.String |
GET_BACKUP_COMPATIBILITY_DESCRIPTOR_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.30) for the get backup compatibility descriptor extended request. |
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE |
Constructor Summary | |
---|---|
GetBackupCompatibilityDescriptorExtendedRequest(ExtendedRequest r)
Creates a new get backup compatibility descriptor extended request from the provided generic extended request. |
|
GetBackupCompatibilityDescriptorExtendedRequest(java.lang.String baseDN,
Control... controls)
Creates a new get backup compatibility descriptor extended request with the provided base DN. |
Method Summary | |
---|---|
GetBackupCompatibilityDescriptorExtendedRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
GetBackupCompatibilityDescriptorExtendedRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getBaseDN()
Retrieves the base DN for the backend for which to obtain the backup compatibility descriptor. |
java.lang.String |
getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. |
GetBackupCompatibilityDescriptorExtendedResult |
process(LDAPConnection connection,
int depth)
Sends this extended request to the directory server over the provided connection and returns the associated response. |
void |
toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer. |
Methods inherited from class com.unboundid.ldap.sdk.ExtendedRequest |
---|
encodeProtocolOp, getLastMessageID, getOID, getOperationType, getProtocolOpType, getValue, hasValue, responseReceived, writeTo |
Methods inherited from class com.unboundid.ldap.sdk.LDAPRequest |
---|
followReferrals, getControl, getControlList, getControls, getIntermediateResponseListener, getResponseTimeoutMillis, hasControl, hasControl, setFollowReferrals, setIntermediateResponseListener, setResponseTimeoutMillis, toString |
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_REQUEST_OID
Constructor Detail |
---|
public GetBackupCompatibilityDescriptorExtendedRequest(java.lang.String baseDN, Control... controls)
baseDN
- The base DN for the backend for which to obtain the
backup compatibility descriptor. It must not be
null
, and should be the base DN of a backend
defined in the server.controls
- The set of controls to include in the request. It may be
null
or empty if no controls should be included.public GetBackupCompatibilityDescriptorExtendedRequest(ExtendedRequest r) throws LDAPException
r
- The generic extended request to decode as a get backup
compatibility descriptor extended request.
LDAPException
- If the provided request cannot be decoded as a get
backup compatibility descriptor extended request.Method Detail |
---|
public java.lang.String getBaseDN()
public GetBackupCompatibilityDescriptorExtendedResult process(LDAPConnection connection, int depth) throws LDAPException
process
in class ExtendedRequest
connection
- The connection to use to communicate with the directory
server.depth
- The current referral depth for this request. It should
always be one for the initial request, and should only
be incremented when following referrals.
LDAPException
- If a problem occurs while sending the request or
reading the response.public GetBackupCompatibilityDescriptorExtendedRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
public GetBackupCompatibilityDescriptorExtendedRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
duplicate
in class ExtendedRequest
controls
- The set of controls to include in the duplicate request.
public java.lang.String getExtendedRequestName()
getExtendedRequestName
in class ExtendedRequest
public void toString(java.lang.StringBuilder buffer)
toString
in interface ProtocolOp
toString
in interface ReadOnlyLDAPRequest
toString
in class ExtendedRequest
buffer
- The buffer to which to append a string representation of
this request.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |