Interface LDAPModifyDNRequest
-
- All Superinterfaces:
Cloneable
,LDAPRequest
public interface LDAPModifyDNRequest extends LDAPRequest
Represents an LDAP modify DN request, which can be used to perform an LDAPv3 modify DN operation to rename and/or move an entry or subtree in the directory.Note that LDAPModifyDNRequest 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 LDAPModifyDNRequest
clone()
Creates and returns a copy of this modify DN request that may be modified without impacting this request.String
getDN()
Returns the entry distinguished name for this modify DN request.String
getNewRDN()
Returns the new relative distinguished name for this modify DN request.String
getNewSuperiorDN()
Returns the new superior distinguished name for this modify DN request.boolean
isDeleteOldRDN()
Returns whether the old relative distinguished name value should be removed from the entry.LDAPModifyDNRequest
setDeleteOldRDN(boolean deleteOldRDN)
Sets whether the old relative distinguished name value should be removed from the entry.LDAPModifyDNRequest
setDN(String dn)
Sets the entry distinguished name for this modify DN request.LDAPModifyDNRequest
setNewRDN(String newRDN)
Sets the new relative distinguished name for this modify DN request.LDAPModifyDNRequest
setNewSuperiorDN(String newSuperiorDN)
Sets the new superior distinguished name for this modify DN request.LDAPModifyDNRequest
setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when processing this modify DN request.-
Methods inherited from interface com.opencloud.slee.resources.ldap.objects.LDAPRequest
getQueryTimeout
-
-
-
-
Method Detail
-
clone
LDAPModifyDNRequest clone()
Creates and returns a copy of this modify DN request that may be modified without impacting this request.- Specified by:
clone
in interfaceLDAPRequest
- Returns:
- A copy of this modify DN request that may be modified without impacting this request.
-
getDN
String getDN()
Returns the entry distinguished name for this modify DN request.- Returns:
- the entry distinguished name for this modify DN request.
-
setDN
LDAPModifyDNRequest setDN(String dn)
Sets the entry distinguished name for this modify DN request.- Parameters:
dn
- the entry distinguished name for this modify DN request. It must not be null.- Returns:
- this modify DN request.
-
getNewRDN
String getNewRDN()
Returns the new relative distinguished name for this modify DN request.- Returns:
- the new relative distinguished name for this modify DN request.
-
setNewRDN
LDAPModifyDNRequest setNewRDN(String newRDN)
Sets the new relative distinguished name for this modify DN request.- Parameters:
newRDN
- the new relative distinguished name for this modify DN request. It must not be null.- Returns:
- this modify DN request.
-
isDeleteOldRDN
boolean isDeleteOldRDN()
Returns whether the old relative distinguished name value should be removed from the entry.- Returns:
- true if the old relative distinguished name value should be removed from the entry, or false if not.
-
setDeleteOldRDN
LDAPModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN)
Sets whether the old relative distinguished name value should be removed from the entry.- Parameters:
deleteOldRDN
- true if the old relative distinguished name value should be removed from the entry, or false if not.- Returns:
- this modify DN request.
-
getNewSuperiorDN
String getNewSuperiorDN()
Returns the new superior distinguished name for this modify DN request.- Returns:
- the new superior distinguished name for this modify DN request.
-
setNewSuperiorDN
LDAPModifyDNRequest setNewSuperiorDN(String newSuperiorDN)
Sets the new superior distinguished name for this modify DN request.- Parameters:
newSuperiorDN
- the new superior distinguished name for this modify DN request.- Returns:
- this modify DN request.
-
setQueryTimeout
LDAPModifyDNRequest setQueryTimeout(long timeout)
Sets the maximum time, in milliseconds, to wait for a response from the server when processing this modify DN 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 DN request.- Returns:
- this modify DN request.
-
-