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

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.IdentifyBackupCompatibilityProblemsExtendedRequest
All Implemented Interfaces:
ProtocolOp, ReadOnlyLDAPRequest, java.io.Serializable

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public final class IdentifyBackupCompatibilityProblemsExtendedRequest
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 identify potential incompatibility problems between two backup compatibility descriptor values. This can be used to determine whether a backup from one server (or an older version of the same server) could be restored into another server (or a newer version of the same server). It may also be useful in determining whether replication initialization via binary copy may be performed between two servers.

The OID for this extended request is 1.3.6.1.4.1.30221.2.6.32. It must have a value with the following encoding:
   IdentifyBackupCompatibilityProblemsRequest ::= SEQUENCE {
        sourceDescriptor     [0] OCTET STRING,
        targetDescriptor     [1] OCTET STRING,
        ... }
 

See Also:
IdentifyBackupCompatibilityProblemsExtendedResult, GetBackupCompatibilityDescriptorExtendedRequest, Serialized Form

Field Summary
static java.lang.String IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_REQUEST_OID
          The OID (1.3.6.1.4.1.30221.2.6.32) for the identify backup compatibility problems extended request.
 
Fields inherited from class com.unboundid.ldap.sdk.ExtendedRequest
TYPE_EXTENDED_REQUEST_OID, TYPE_EXTENDED_REQUEST_VALUE
 
Constructor Summary
IdentifyBackupCompatibilityProblemsExtendedRequest(ASN1OctetString sourceDescriptor, ASN1OctetString targetDescriptor, Control... controls)
          Creates a new identify backup compatibility problems extended request with the provided information.
IdentifyBackupCompatibilityProblemsExtendedRequest(ExtendedRequest r)
          Creates a new identify backup compatibility problems extended request from the provided generic extended request.
 
Method Summary
 IdentifyBackupCompatibilityProblemsExtendedRequest duplicate()
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 IdentifyBackupCompatibilityProblemsExtendedRequest duplicate(Control[] controls)
          Creates a new instance of this LDAP request that may be modified without impacting this request.
 java.lang.String getExtendedRequestName()
          Retrieves the user-friendly name for the extended request, if available.
 ASN1OctetString getSourceDescriptor()
          Retrieves the backup compatibility descriptor obtained from the source server, or from a backup to be restored.
 ASN1OctetString getTargetDescriptor()
          Retrieves the backup compatibility descriptor obtained from the target server.
 IdentifyBackupCompatibilityProblemsExtendedResult 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

IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_REQUEST_OID

public static final java.lang.String IDENTIFY_BACKUP_COMPATIBILITY_PROBLEMS_REQUEST_OID
The OID (1.3.6.1.4.1.30221.2.6.32) for the identify backup compatibility problems extended request.

See Also:
Constant Field Values
Constructor Detail

IdentifyBackupCompatibilityProblemsExtendedRequest

public IdentifyBackupCompatibilityProblemsExtendedRequest(ASN1OctetString sourceDescriptor,
                                                          ASN1OctetString targetDescriptor,
                                                          Control... controls)
Creates a new identify backup compatibility problems extended request with the provided information.

Parameters:
sourceDescriptor - The backup compatibility descriptor obtained from the source server, or from a backup to be restored. It must not be null.
targetDescriptor - The backup compatibility descriptor obtained from the target server. It must not be null.
controls - The set of controls to include in the request. It may be null or empty if no controls should be included.

IdentifyBackupCompatibilityProblemsExtendedRequest

public IdentifyBackupCompatibilityProblemsExtendedRequest(ExtendedRequest r)
                                                   throws LDAPException
Creates a new identify backup compatibility problems extended request from the provided generic extended request.

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

getSourceDescriptor

public ASN1OctetString getSourceDescriptor()
Retrieves the backup compatibility descriptor obtained from the source server, or from a backup to be restored.

Returns:
The backup compatibility descriptor obtained from the source server, or from a backup to be restored.

getTargetDescriptor

public ASN1OctetString getTargetDescriptor()
Retrieves the backup compatibility descriptor obtained from the target server.

Returns:
The backup compatibility descriptor obtained from the target server.

process

public IdentifyBackupCompatibilityProblemsExtendedResult 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 IdentifyBackupCompatibilityProblemsExtendedRequest 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 IdentifyBackupCompatibilityProblemsExtendedRequest 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.