public interface LDAPModifyDNRequest extends LDAPRequest
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.
Modifier and Type | Method and 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.
|
getQueryTimeout
LDAPModifyDNRequest clone()
clone
in interface LDAPRequest
String getDN()
LDAPModifyDNRequest setDN(String dn)
dn
- the entry distinguished name for this modify DN request. It must not
be null.String getNewRDN()
LDAPModifyDNRequest setNewRDN(String newRDN)
newRDN
- the new relative distinguished name for this modify DN request.
It must not be null.boolean isDeleteOldRDN()
LDAPModifyDNRequest setDeleteOldRDN(boolean deleteOldRDN)
deleteOldRDN
- true if the old relative distinguished name value should be
removed from the entry, or false if not.String getNewSuperiorDN()
LDAPModifyDNRequest setNewSuperiorDN(String newSuperiorDN)
newSuperiorDN
- the new superior distinguished name for this modify DN request.LDAPModifyDNRequest 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 DN request.