Package 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, Serializable
@Mutable @ThreadSafety(level=NOT_THREADSAFE) public final class CompareRequest 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:

  • Constructor Details

    • CompareRequest

      public CompareRequest(@NotNull String dn, @NotNull String attributeName, @NotNull String assertionValue)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.

    • CompareRequest

      public CompareRequest(@NotNull String dn, @NotNull String attributeName, @NotNull byte[] assertionValue)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.

    • CompareRequest

      public CompareRequest(@NotNull DN dn, @NotNull String attributeName, @NotNull String assertionValue)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.

    • CompareRequest

      public CompareRequest(@NotNull DN dn, @NotNull String attributeName, @NotNull byte[] assertionValue)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.

    • CompareRequest

      public CompareRequest(@NotNull String dn, @NotNull String attributeName, @NotNull String assertionValue, @Nullable Control[] controls)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.
      controls - The set of controls for this compare request.

    • CompareRequest

      public CompareRequest(@NotNull String dn, @NotNull String attributeName, @NotNull byte[] assertionValue, @Nullable Control[] controls)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.
      controls - The set of controls for this compare request.

    • CompareRequest

      public CompareRequest(@NotNull DN dn, @NotNull String attributeName, @NotNull String assertionValue, @Nullable Control[] controls)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.
      controls - The set of controls for this compare request.

    • CompareRequest

      public CompareRequest(@NotNull DN dn, @NotNull String attributeName, @NotNull ASN1OctetString assertionValue, @Nullable Control[] controls)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.
      controls - The set of controls for this compare request.

    • CompareRequest

      public CompareRequest(@NotNull DN dn, @NotNull String attributeName, @NotNull byte[] assertionValue, @Nullable Control[] controls)
      Creates a new compare request with the provided information.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.
      attributeName - The name of the target attribute for which the comparison is to be performed. It must not be null.
      assertionValue - The assertion value to verify within the entry. It must not be null.
      controls - The set of controls for this compare request.

  • Method Details

    • getDN

      @NotNull public String getDN()
      Retrieves the DN of the entry in which the comparison is to be performed.
      Specified by:
      getDN in interface ReadOnlyCompareRequest
      Returns:
      The DN of the entry in which the comparison is to be performed.

    • setDN

      public void setDN(@NotNull String dn)
      Specifies the DN of the entry in which the comparison is to be performed.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.

    • setDN

      public void setDN(@NotNull DN dn)
      Specifies the DN of the entry in which the comparison is to be performed.
      Parameters:
      dn - The DN of the entry in which the comparison is to be performed. It must not be null.

    • getAttributeName

      @NotNull public String getAttributeName()
      Retrieves the name of the attribute for which the comparison is to be performed.
      Specified by:
      getAttributeName in interface ReadOnlyCompareRequest
      Returns:
      The name of the attribute for which the comparison is to be performed.

    • setAttributeName

      public void setAttributeName(@NotNull String attributeName)
      Specifies the name of the attribute for which the comparison is to be performed.
      Parameters:
      attributeName - The name of the attribute for which the comparison is to be performed. It must not be null.

    • getAssertionValue

      @NotNull public String getAssertionValue()
      Retrieves the assertion value to verify within the target entry.
      Specified by:
      getAssertionValue in interface ReadOnlyCompareRequest
      Returns:
      The assertion value to verify within the target entry.

    • getAssertionValueBytes

      @NotNull public byte[] getAssertionValueBytes()
      Retrieves the assertion value to verify within the target entry, formatted as a byte array.
      Specified by:
      getAssertionValueBytes in interface ReadOnlyCompareRequest
      Returns:
      The assertion value to verify within the target entry, formatted as a byte array.

    • getRawAssertionValue

      @NotNull public ASN1OctetString getRawAssertionValue()
      Retrieves the assertion value to verify within the target entry.
      Specified by:
      getRawAssertionValue in interface ReadOnlyCompareRequest
      Returns:
      The assertion value to verify within the target entry.

    • setAssertionValue

      public void setAssertionValue(@NotNull String assertionValue)
      Specifies the assertion value to specify within the target entry.
      Parameters:
      assertionValue - The assertion value to specify within the target entry. It must not be null.

    • setAssertionValue

      public void setAssertionValue(@NotNull byte[] assertionValue)
      Specifies the assertion value to specify within the target entry.
      Parameters:
      assertionValue - The assertion value to specify within the target entry. It must not be null.

    • setAssertionValue

      public void setAssertionValue(@NotNull ASN1OctetString assertionValue)
      Specifies the assertion value to specify within the target entry.
      Parameters:
      assertionValue - The assertion value to specify within the target entry. It must not be null.

    • getProtocolOpType

      public byte getProtocolOpType()
      Retrieves the BER type for this protocol op.
      Specified by:
      getProtocolOpType in interface ProtocolOp
      Returns:
      The BER type for this protocol op.

    • writeTo

      public void writeTo(@NotNull ASN1Buffer buffer)
      Writes an ASN.1-encoded representation of this LDAP protocol op to the provided ASN.1 buffer. This method is intended for internal use only and should not be used by third-party code.
      Specified by:
      writeTo in interface ProtocolOp
      Parameters:
      buffer - The ASN.1 buffer to which the encoded representation should be written.

    • encodeProtocolOp

      @NotNull public ASN1Element encodeProtocolOp()
      Encodes the compare request protocol op to an ASN.1 element.
      Specified by:
      encodeProtocolOp in interface ProtocolOp
      Returns:
      The ASN.1 element with the encoded compare request protocol op.

    • process

      @NotNull protected CompareResult process(@NotNull LDAPConnection connection, int depth) throws LDAPException
      Sends this delete request to the directory server over the provided connection and returns the associated response.
      Specified by:
      process in class LDAPRequest
      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 delete processing.
      Throws:
      LDAPException - If a problem occurs while sending the request or reading the response.

    • responseReceived

      @InternalUseOnly public void responseReceived(@NotNull LDAPResponse response) throws LDAPException
      Throws:
      LDAPException

    • getLastMessageID

      public int getLastMessageID()
      Retrieves the message ID for the last LDAP message sent using this request.
      Specified by:
      getLastMessageID in class LDAPRequest
      Returns:
      The message ID for the last LDAP message sent using this request, or -1 if it no LDAP messages have yet been sent using this request.

    • getOperationType

      @NotNull public OperationType getOperationType()
      Retrieves the type of operation that is represented by this request.
      Specified by:
      getOperationType in class LDAPRequest
      Returns:
      The type of operation that is represented by this request.

    • duplicate

      @NotNull public CompareRequest duplicate()
      Creates a new instance of this LDAP request that may be modified without impacting this request.
      Specified by:
      duplicate in interface ReadOnlyCompareRequest
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      Returns:
      A new instance of this LDAP request that may be modified without impacting this request.

    • duplicate

      @NotNull public CompareRequest duplicate(@Nullable 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.
      Specified by:
      duplicate in interface ReadOnlyCompareRequest
      Specified by:
      duplicate in interface ReadOnlyLDAPRequest
      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.

    • toString

      public void toString(@NotNull 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
      Specified by:
      toString in class LDAPRequest
      Parameters:
      buffer - The buffer to which to append a string representation of this request.

    • toCode

      public void toCode(@NotNull List<String> lineList, @NotNull String requestID, int indentSpaces, boolean includeProcessing)
      Appends a number of lines comprising the Java source code that can be used to recreate this request to the given list.
      Specified by:
      toCode in interface ReadOnlyLDAPRequest
      Parameters:
      lineList - The list to which the source code lines should be added.
      requestID - The name that should be used as an identifier for the request. If this is null or empty, then a generic ID will be used.
      indentSpaces - The number of spaces that should be used to indent the generated code. It must not be negative.
      includeProcessing - Indicates whether the generated code should include code required to actually process the request and handle the result (if true), or just to generate the request (if false).