CompareRequest (UnboundID LDAP SDK for Java 2.3.6 (Standard Edition))

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.unboundid.ldap.sdk
Class CompareRequest

java.lang.Object
  com.unboundid.ldap.sdk.LDAPRequest
      com.unboundid.ldap.sdk.UpdatableLDAPRequest
          com.unboundid.ldap.sdk.CompareRequest

All Implemented Interfaces:: ProtocolOp, ReadOnlyCompareRequest, ReadOnlyLDAPRequest, java.io.Serializable

@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class CompareRequest
extends UpdatableLDAPRequest
implements ReadOnlyCompareRequest, ProtocolOp
extends UpdatableLDAPRequest
implements ReadOnlyCompareRequest, ProtocolOp

This class implements the processing necessary to perform an LDAPv3 compare operation, which may be used to determine whether a specified entry contains a given attribute value. Compare requests include the DN of the target entry, the name of the target attribute, and the value for which to make the determination. It may also include a set of controls to send to the server.

The assertion value may be specified as either a string or a byte array. If it is specified as a byte array, then it may represent either a binary or a string value. If a string value is provided as a byte array, then it should use the UTF-8 encoding for that value.

CompareRequest objects are mutable and therefore can be altered and re-used for multiple requests. Note, however, that CompareRequest objects are not threadsafe and therefore a single CompareRequest object instance should not be used to process multiple requests at the same time.

Example

The following example demonstrates the process for performing a compare operation:

 CompareRequest compareRequest =
      new CompareRequest("dc=example,dc=com", "description", "test");
 CompareResult compareResult;
 try
 {
   compareResult = connection.compare(compareRequest);

   // The compare operation didn't throw an exception, so we can try to
   // determine whether the compare matched.
   if (compareResult.compareMatched())
   {
     // The entry does have a description value of test.
   }
   else
   {
     // The entry does not have a description value of test.
   }
 }
 catch (LDAPException le)
 {
   // The compare operation failed.
   compareResult = new CompareResult(le.toLDAPResult());
   ResultCode resultCode = le.getResultCode();
   String errorMessageFromServer = le.getDiagnosticMessage();
 }

See Also:: Serialized Form

Constructor Summary
`CompareRequest(DN dn, java.lang.String attributeName, ASN1OctetString assertionValue, Control[] controls)` Creates a new compare request with the provided information.
`CompareRequest(DN dn, java.lang.String attributeName, byte[] assertionValue)` Creates a new compare request with the provided information.
`CompareRequest(DN dn, java.lang.String attributeName, byte[] assertionValue, Control[] controls)` Creates a new compare request with the provided information.
`CompareRequest(DN dn, java.lang.String attributeName, java.lang.String assertionValue)` Creates a new compare request with the provided information.
`CompareRequest(DN dn, java.lang.String attributeName, java.lang.String assertionValue, Control[] controls)` Creates a new compare request with the provided information.
`CompareRequest(java.lang.String dn, java.lang.String attributeName, byte[] assertionValue)` Creates a new compare request with the provided information.
`CompareRequest(java.lang.String dn, java.lang.String attributeName, byte[] assertionValue, Control[] controls)` Creates a new compare request with the provided information.
`CompareRequest(java.lang.String dn, java.lang.String attributeName, java.lang.String assertionValue)` Creates a new compare request with the provided information.
`CompareRequest(java.lang.String dn, java.lang.String attributeName, java.lang.String assertionValue, Control[] controls)` Creates a new compare request with the provided information.

Method Summary
`CompareRequest`	`duplicate()` Creates a new instance of this LDAP request that may be modified without impacting this request.
`CompareRequest`	`duplicate(Control[] controls)` Creates a new instance of this LDAP request that may be modified without impacting this request.
`ASN1Element`	`encodeProtocolOp()` Encodes the compare request protocol op to an ASN.1 element.
`java.lang.String`	`getAssertionValue()` Retrieves the assertion value to verify within the target entry.
`byte[]`	`getAssertionValueBytes()` Retrieves the assertion value to verify within the target entry, formatted as a byte array.
`java.lang.String`	`getAttributeName()` Retrieves the name of the attribute for which the comparison is to be performed.
`java.lang.String`	`getDN()` Retrieves the DN of the entry in which the comparison is to be performed.
`int`	`getLastMessageID()` Retrieves the message ID for the last LDAP message sent using this request.
`OperationType`	`getOperationType()` Retrieves the type of operation that is represented by this request.
`byte`	`getProtocolOpType()` Retrieves the BER type for this protocol op.
`ASN1OctetString`	`getRawAssertionValue()` Retrieves the assertion value to verify within the target entry.
`protected CompareResult`	`process(LDAPConnection connection, int depth)` Sends this delete request to the directory server over the provided connection and returns the associated response.
`void`	`responseReceived(LDAPResponse response)` Indicates that the provided LDAP response has been received by from the server.
`void`	`setAssertionValue(ASN1OctetString assertionValue)` Specifies the assertion value to specify within the target entry.
`void`	`setAssertionValue(byte[] assertionValue)` Specifies the assertion value to specify within the target entry.
`void`	`setAssertionValue(java.lang.String assertionValue)` Specifies the assertion value to specify within the target entry.
`void`	`setAttributeName(java.lang.String attributeName)` Specifies the name of the attribute for which the comparison is to be performed.
`void`	`setDN(DN dn)` Specifies the DN of the entry in which the comparison is to be performed.
`void`	`setDN(java.lang.String dn)` Specifies the DN of the entry in which the comparison is to be performed.
`void`	`toString(java.lang.StringBuilder buffer)` Appends a string representation of this request to the provided buffer.
`void`	`writeTo(ASN1Buffer buffer)` Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer.

Methods inherited from class com.unboundid.ldap.sdk.UpdatableLDAPRequest
`addControl, addControls, clearControls, removeControl, removeControl, replaceControl, replaceControl, setControls, setControls`

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`

Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest
`followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toString`

Constructor Detail