Interface LDAPCompareRequest
-
- All Superinterfaces:
Cloneable
,LDAPRequest
public interface LDAPCompareRequest extends LDAPRequest
Represents an LDAP compare request, which can be used to perform an LDAPv3 compare operation to determine whether a specified entry contains a given attribute value.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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.-
Methods inherited from interface com.opencloud.slee.resources.ldap.objects.LDAPRequest
getQueryTimeout
-
-
-
-
Method Detail
-
clone
LDAPCompareRequest clone()
Creates and returns a copy of this compare request that may be modified without impacting this request.- Specified by:
clone
in interfaceLDAPRequest
- Returns:
- A copy of this compare request that may be modified without impacting this request.
-
getDN
String getDN()
Returns the distinguished name for this compare request.- Returns:
- the distinguished name for this compare request.
-
setDN
LDAPCompareRequest setDN(String dn)
Sets the distinguished name for this compare request.- Parameters:
dn
- the distinguished name for this compare request. It must not be null.- Returns:
- this compare request.
-
getAttributeName
String getAttributeName()
Returns the name of the attribute for this compare request.- Returns:
- the name of the attribute for this compare request.
-
setAttributeName
LDAPCompareRequest setAttributeName(String attrName)
Sets the name of the attribute for this compare request.- Parameters:
attrName
- the name of the attribute for this compare request. It must not be null.- Returns:
- this compare request.
-
getByteAssertionValue
byte[] getByteAssertionValue()
Returns the assertion value for this compare request in byte[] format.- Returns:
- the assertion value for this compare request in byte[] format.
-
getStringAssertionValue
String getStringAssertionValue()
Returns the string assertion value for this compare request.- Returns:
- the string assertion value for this compare request.
-
setAssertionValue
LDAPCompareRequest setAssertionValue(String assertionValue)
Sets the assertion value for this compare request.- Parameters:
assertionValue
- the assertion value for this compare request. It must not be null.- Returns:
- this compare request.
-
setAssertionValue
LDAPCompareRequest setAssertionValue(byte[] assertionValue)
Sets the assertion value for this compare request.- Parameters:
assertionValue
- the assertion value for this compare request. It must not be null.- Returns:
- this compare request.
-
setQueryTimeout
LDAPCompareRequest setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when processing this compare request.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.
- Specified by:
setQueryTimeout
in interfaceLDAPRequest
- Parameters:
timeout
- the maximum time, in milliseconds, to wait for a response from the server when processing this compare request.- Returns:
- this compare request.
-
-