com.unboundid.ldap.sdk
Interface ReadOnlyCompareRequest

All Superinterfaces:
ReadOnlyLDAPRequest, java.io.Serializable
All Known Implementing Classes:
CompareRequest

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 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.
 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.
 ASN1OctetString getRawAssertionValue()
          Retrieves the assertion value to verify within the target entry.
 
Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest
followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toCode, toString, toString
 

Method Detail

getDN

java.lang.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

java.lang.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

java.lang.String getAssertionValue()
Retrieves the assertion value to verify within the target entry.

Returns:
The assertion value to verify within the target entry.

getAssertionValueBytes

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

ASN1OctetString getRawAssertionValue()
Retrieves the assertion value to verify within the target entry.

Returns:
The assertion value to verify within the target entry.

duplicate

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

CompareRequest 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.

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.