Interface LDAPModifyRequest
-
- All Superinterfaces:
Cloneable
,LDAPRequest
public interface LDAPModifyRequest extends LDAPRequest
Represents an LDAP modify request, which can be used to perform an LDAPv3 modify operation to update an entry in the directory server.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.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method 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.-
Methods inherited from interface com.opencloud.slee.resources.ldap.objects.LDAPRequest
getQueryTimeout
-
-
-
-
Method Detail
-
clone
LDAPModifyRequest clone()
Creates and returns a copy of this modify request that may be modified without impacting this request.- Specified by:
clone
in interfaceLDAPRequest
- Returns:
- A copy of this modify request that may be modified without impacting this request.
-
getDN
String getDN()
Returns the distinguished name for this modify request.- Returns:
- the distinguished name for this modify request.
-
setDN
LDAPModifyRequest setDN(String dn)
Sets the distinguished name for this modify request.- Parameters:
dn
- the distinguished name for this modify request. It must not be null.- Returns:
- this modify request.
-
addModification
LDAPModifyRequest addModification(LDAPModification modification)
Adds the specified modification to this modify request.- Parameters:
modification
- the modification to add. It must not be null.- Returns:
- this modify request.
-
modificationsIterator
Iterator<LDAPModification> modificationsIterator()
Returns an iterator over the set of modifications from this modify request.- Returns:
- an iterator over the set of modifications from this modify request.
-
removeModification
boolean removeModification(LDAPModification modification)
Removes the provided modification from the set of modifications from this modify request.- Parameters:
modification
- the modification to remove. It must not be null.- Returns:
- true if the specified modification was found and removed, or false if no modification in the modify request matches the specified modification.
-
setModifications
LDAPModifyRequest setModifications(LDAPModification... modifications)
Replaces the existing set of modifications from this modify request with the provided modifications.- Parameters:
modifications
- the set of modifications to use for this modify request. It must not be null.- Returns:
- this modify request.
-
setQueryTimeout
LDAPModifyRequest setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when processing this modify 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 modify request.- Returns:
- this modify request.
-
-