public interface LDAPModifyRequest extends LDAPRequest
Note that LDAPModifyRequest 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 |
---|---|
LDAPModifyRequest |
addModification(LDAPModification modification)
Adds the specified modification to this modify request.
|
LDAPModifyRequest |
clone()
Creates and returns a copy of this modify request that may be modified without
impacting this request.
|
String |
getDN()
Returns the distinguished name for this modify request.
|
Iterator<LDAPModification> |
modificationsIterator()
Returns an iterator over the set of modifications from this modify request.
|
boolean |
removeModification(LDAPModification modification)
Removes the provided modification from the set of modifications from this modify
request.
|
LDAPModifyRequest |
setDN(String dn)
Sets the distinguished name for this modify request.
|
LDAPModifyRequest |
setModifications(LDAPModification... modifications)
Replaces the existing set of modifications from this modify request with the
provided modifications.
|
LDAPModifyRequest |
setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when
processing this modify request.
|
getQueryTimeout
LDAPModifyRequest clone()
clone
in interface LDAPRequest
String getDN()
LDAPModifyRequest setDN(String dn)
dn
- the distinguished name for this modify request. It must not be null.LDAPModifyRequest addModification(LDAPModification modification)
modification
- the modification to add. It must not be null.Iterator<LDAPModification> modificationsIterator()
boolean removeModification(LDAPModification modification)
modification
- the modification to remove. It must not be null.LDAPModifyRequest setModifications(LDAPModification... modifications)
modifications
- the set of modifications to use for this modify request.
It must not be null.LDAPModifyRequest 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 modify request.