public interface LDAPCompareRequest extends LDAPRequest
Note that LDAPCompareRequest objects should not be considered thread-safe, thus should not be used concurrently by multiple threads. Each thread wishing to process a request should have its own instance of that request.
Modifier and Type | Method and Description |
---|---|
LDAPCompareRequest |
clone()
Creates and returns a copy of this compare request that may be modified without
impacting this request.
|
String |
getAttributeName()
Returns the name of the attribute for this compare request.
|
byte[] |
getByteAssertionValue()
Returns the assertion value for this compare request in byte[] format.
|
String |
getDN()
Returns the distinguished name for this compare request.
|
String |
getStringAssertionValue()
Returns the string assertion value for this compare request.
|
LDAPCompareRequest |
setAssertionValue(byte[] assertionValue)
Sets the assertion value for this compare request.
|
LDAPCompareRequest |
setAssertionValue(String assertionValue)
Sets the assertion value for this compare request.
|
LDAPCompareRequest |
setAttributeName(String attrName)
Sets the name of the attribute for this compare request.
|
LDAPCompareRequest |
setDN(String dn)
Sets the distinguished name for this compare request.
|
LDAPCompareRequest |
setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when
processing this compare request.
|
getQueryTimeout
LDAPCompareRequest clone()
clone
in interface LDAPRequest
String getDN()
LDAPCompareRequest setDN(String dn)
dn
- the distinguished name for this compare request. It must not be null.String getAttributeName()
LDAPCompareRequest setAttributeName(String attrName)
attrName
- the name of the attribute for this compare request. It must not
be null.byte[] getByteAssertionValue()
String getStringAssertionValue()
LDAPCompareRequest setAssertionValue(String assertionValue)
assertionValue
- the assertion value for this compare request. It must not
be null.LDAPCompareRequest setAssertionValue(byte[] assertionValue)
assertionValue
- the assertion value for this compare request. It must not
be null.LDAPCompareRequest setQueryTimeout(long timeout)
A value of zero indicates that no timeout should be enforced.
A value that is less than zero indicates that the default query timeout for the underlying connection should be used.
setQueryTimeout
in interface LDAPRequest
timeout
- the maximum time, in milliseconds, to wait for a response from the
server when processing this compare request.