|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlyModifyDNRequest
This interface defines a set of methods that may be safely called in an LDAP
modify DN request without altering its contents. This interface must not be
implemented by any class other than ModifyDNRequest
.
This interface does not inherently provide the assurance of thread safety for
the methods that it exposes, because it is still possible for a thread
referencing the object which implements this interface to alter the request
using methods not included in this interface. However, if it can be
guaranteed that no thread will alter the underlying object, then the methods
exposed by this interface can be safely invoked concurrently by any number of
threads.
Method Summary | |
---|---|
boolean |
deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry. |
ModifyDNRequest |
duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request. |
ModifyDNRequest |
duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. |
java.lang.String |
getDN()
Retrieves the current DN of the entry to move/rename. |
java.lang.String |
getNewRDN()
Retrieves the new RDN for the entry. |
java.lang.String |
getNewSuperiorDN()
Retrieves the new superior DN for the entry. |
java.lang.String[] |
toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding modify DN change record. |
LDIFModifyDNChangeRecord |
toLDIFChangeRecord()
Retrieves an LDIF modify DN change record with the contents of this modify DN request. |
java.lang.String |
toLDIFString()
Retrieves an LDIF string representation of this modify DN request. |
Methods inherited from interface com.unboundid.ldap.sdk.ReadOnlyLDAPRequest |
---|
followReferrals, getControl, getControlList, getResponseTimeoutMillis, hasControl, hasControl, toString, toString |
Method Detail |
---|
java.lang.String getDN()
java.lang.String getNewRDN()
boolean deleteOldRDN()
true
if the current RDN value should be removed from the
entry, or false
if not.java.lang.String getNewSuperiorDN()
null
if the entry is
not to be moved below a new parent.ModifyDNRequest duplicate()
duplicate
in interface ReadOnlyLDAPRequest
ModifyDNRequest duplicate(Control[] controls)
duplicate
in interface ReadOnlyLDAPRequest
controls
- The set of controls to include in the duplicate request.
LDIFModifyDNChangeRecord toLDIFChangeRecord()
java.lang.String[] toLDIF()
java.lang.String toLDIFString()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |