Package com.unboundid.ldap.sdk

Interface ReadOnlyCompareRequest

All Superinterfaces:
ReadOnlyLDAPRequest, Serializable
All Known Implementing Classes:
CompareRequest
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlyCompareRequest extends ReadOnlyLDAPRequest
This interface defines a set of methods that may be safely called in an LDAP compare request without altering its contents. This interface must not be implemented by any class other than CompareRequest.

This interface does not inherently provide the assurance of thread safety for the methods that it exposes, because it is still possible for a thread referencing the object which implements this interface to alter the request using methods not included in this interface. However, if it can be guaranteed that no thread will alter the underlying object, then the methods exposed by this interface can be safely invoked concurrently by any number of threads.

  • Method Details

    • getDN

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

    • getAttributeName

      @NotNull String getAttributeName()
      Retrieves the name of the attribute for which the comparison is to be performed.
      Returns:
      The name of the attribute for which the comparison is to be performed.

    • getAssertionValue

      @NotNull String getAssertionValue()
      Retrieves the assertion value to verify within the target entry.
      Returns:
      The assertion value to verify within the target entry.

    • getAssertionValueBytes

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

    • getRawAssertionValue

      @NotNull ASN1OctetString getRawAssertionValue()
      Retrieves the assertion value to verify within the target entry.
      Returns:
      The assertion value to verify within the target entry.

    • duplicate

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

    • duplicate

      @NotNull 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 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.