Package com.unboundid.ldap.sdk
Interface ReadOnlyModifyDNRequest
-
- All Superinterfaces:
ReadOnlyLDAPRequest
,java.io.Serializable
- All Known Implementing Classes:
ModifyDNRequest
@NotExtensible @ThreadSafety(level=INTERFACE_NOT_THREADSAFE) public interface ReadOnlyModifyDNRequest extends ReadOnlyLDAPRequest
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 thanModifyDNRequest
.
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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description 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, getControls, getReferralConnector, getResponseTimeoutMillis, hasControl, hasControl, toCode, toString, toString
-
-
-
-
Method Detail
-
getDN
java.lang.String getDN()
Retrieves the current DN of the entry to move/rename.- Returns:
- The current DN of the entry to move/rename.
-
getNewRDN
java.lang.String getNewRDN()
Retrieves the new RDN for the entry.- Returns:
- The new RDN for the entry.
-
deleteOldRDN
boolean deleteOldRDN()
Indicates whether the current RDN value should be removed from the entry.- Returns:
true
if the current RDN value should be removed from the entry, orfalse
if not.
-
getNewSuperiorDN
java.lang.String getNewSuperiorDN()
Retrieves the new superior DN for the entry.- Returns:
- The new superior DN for the entry, or
null
if the entry is not to be moved below a new parent.
-
duplicate
ModifyDNRequest duplicate()
Creates a new instance of this LDAP request that may be modified without impacting this request.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
duplicate
ModifyDNRequest duplicate(Control[] controls)
Creates a new instance of this LDAP request that may be modified without impacting this request. The provided controls will be used for the new request instead of duplicating the controls from this request.- Specified by:
duplicate
in interfaceReadOnlyLDAPRequest
- Parameters:
controls
- The set of controls to include in the duplicate request.- Returns:
- A new instance of this LDAP request that may be modified without impacting this request.
-
toLDIFChangeRecord
LDIFModifyDNChangeRecord toLDIFChangeRecord()
Retrieves an LDIF modify DN change record with the contents of this modify DN request.- Returns:
- An LDIF modify DN change record with the contents of this modify DN request.
-
toLDIF
java.lang.String[] toLDIF()
Retrieves a string array whose lines contain an LDIF representation of the corresponding modify DN change record.- Returns:
- A string array whose lines contain an LDIF representation of the corresponding modify DN change record.
-
toLDIFString
java.lang.String toLDIFString()
Retrieves an LDIF string representation of this modify DN request.- Returns:
- An LDIF string representation of this modify DN request.
-
-