com.unboundid.ldap.sdk.unboundidds.extensions
Class GetBackupCompatibilityDescriptorExtendedRequest

java.lang.Object
  extended by com.unboundid.ldap.sdk.LDAPRequest
      extended by com.unboundid.ldap.sdk.ExtendedRequest
          extended by com.unboundid.ldap.sdk.unboundidds.extensions.GetBackupCompatibilityDescriptorExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class GetBackupCompatibilityDescriptorExtendedRequest
extends ExtendedRequest

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.

The OID for this extended request is 1.3.6.1.4.1.30221.2.6.30. It must have a value with the following encoding:
   GetBackupCompatibilityDescriptorRequest ::= SEQUENCE {
        baseDN     [0] OCTET STRING,
        ... }
 

See Also:
GetBackupCompatibilityDescriptorExtendedResult, IdentifyBackupCompatibilityProblemsExtendedRequest, Serialized Form

Field 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

GET_BACKUP_COMPATIBILITY_DESCRIPTOR_REQUEST_OID

public static final 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.

See Also:
Constant Field Values
Constructor Detail

GetBackupCompatibilityDescriptorExtendedRequest

public GetBackupCompatibilityDescriptorExtendedRequest(java.lang.String baseDN,
                                                       Control... controls)
Creates a new get backup compatibility descriptor extended request with the provided base DN.

Parameters:
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.

GetBackupCompatibilityDescriptorExtendedRequest

public GetBackupCompatibilityDescriptorExtendedRequest(ExtendedRequest r)
                                                throws LDAPException
Creates a new get backup compatibility descriptor extended request from the provided generic extended request.

Parameters:
r - The generic extended request to decode as a get backup compatibility descriptor extended request.
Throws:
LDAPException - If the provided request cannot be decoded as a get backup compatibility descriptor extended request.
Method Detail

getBaseDN

public java.lang.String getBaseDN()
Retrieves the base DN for the backend for which to obtain the backup compatibility descriptor.

Returns:
The base DN for the backend for which to obtain the backup compatibility descriptor.

process

public GetBackupCompatibilityDescriptorExtendedResult process(LDAPConnection connection,
                                                              int depth)
                                                       throws LDAPException
Sends this extended request to the directory server over the provided connection and returns the associated response.

Overrides:
process in class ExtendedRequest
Parameters:
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.
Returns:
An LDAP result object that provides information about the result of the extended operation processing.
Throws:
LDAPException - If a problem occurs while sending the request or reading the response.

duplicate

public GetBackupCompatibilityDescriptorExtendedRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

duplicate

public GetBackupCompatibilityDescriptorExtendedRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.. Subclasses should override this method to return a duplicate of the appropriate type.

Specified by:
duplicate in interface ReadOnlyLDAPRequest
Overrides:
duplicate in class ExtendedRequest
Parameters:
controls - The set of controls to include in the duplicate request.
Returns:
A new instance of this LDAP request that may be modified without impacting this request.

getExtendedRequestName

public java.lang.String getExtendedRequestName()
Retrieves the user-friendly name for the extended request, if available. If no user-friendly name has been defined, then the OID will be returned.

Overrides:
getExtendedRequestName in class ExtendedRequest
Returns:
The user-friendly name for this extended request, or the OID if no user-friendly name is available.

toString

public void toString(java.lang.StringBuilder buffer)
Appends a string representation of this request to the provided buffer.

Specified by:
toString in interface ProtocolOp
Specified by:
toString in interface ReadOnlyLDAPRequest
Overrides:
toString in class ExtendedRequest
Parameters:
buffer - The buffer to which to append a string representation of this request.