@NotMutable @ThreadSafety(level=COMPLETELY_THREADSAFE) public final class LDIFModifyDNChangeRecord extends LDIFChangeRecord
LDIFChangeRecord
class for an example demonstrating the process for
interacting with LDIF change records.Constructor and Description |
---|
LDIFModifyDNChangeRecord(ModifyDNRequest modifyDNRequest)
Creates a new LDIF modify DN change record from the provided modify DN
request.
|
LDIFModifyDNChangeRecord(java.lang.String dn,
java.lang.String newRDN,
boolean deleteOldRDN,
java.lang.String newSuperiorDN)
Creates a new LDIF modify DN change record with the provided information.
|
LDIFModifyDNChangeRecord(java.lang.String dn,
java.lang.String newRDN,
boolean deleteOldRDN,
java.lang.String newSuperiorDN,
java.util.List<Control> controls)
Creates a new LDIF modify DN change record with the provided information.
|
Modifier and Type | Method and Description |
---|---|
boolean |
deleteOldRDN()
Indicates whether to delete the current RDN value from the entry.
|
boolean |
equals(java.lang.Object o)
Indicates whether the provided object is equal to this LDIF change record.
|
ChangeType |
getChangeType()
Retrieves the type of operation represented by this LDIF change record.
|
DN |
getNewDN()
Retrieves the DN that the entry should have after the successful completion
of the operation.
|
java.lang.String |
getNewRDN()
Retrieves the new RDN value for the entry.
|
java.lang.String |
getNewSuperiorDN()
Retrieves the new superior DN for the entry, if applicable.
|
RDN |
getParsedNewRDN()
Retrieves the parsed new RDN value for the entry.
|
DN |
getParsedNewSuperiorDN()
Retrieves the parsed new superior DN for the entry, if applicable.
|
int |
hashCode()
Retrieves a hash code for this change record.
|
LDAPResult |
processChange(LDAPInterface connection,
boolean includeControls)
Apply the change represented by this LDIF change record to a directory
server using the provided connection, optionally including any change
record controls in the request.
|
void |
toLDIF(ByteStringBuffer buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided
buffer.
|
java.lang.String[] |
toLDIF(int wrapColumn)
Retrieves a string array whose lines contain an LDIF representation of this
change record.
|
void |
toLDIFString(java.lang.StringBuilder buffer,
int wrapColumn)
Appends an LDIF string representation of this change record to the provided
buffer.
|
ModifyDNRequest |
toModifyDNRequest()
Creates a modify DN request from this LDIF modify DN change record.
|
ModifyDNRequest |
toModifyDNRequest(boolean includeControls)
Creates a modify DN request from this LDIF modify DN change record,
optionally including any change record controls in the request.
|
void |
toString(java.lang.StringBuilder buffer)
Appends a single-line string representation of this change record to the
provided buffer.
|
getControls, getDN, getParsedDN, processChange, toLDIF, toLDIF, toLDIFString, toLDIFString, toLDIFString, toString
public LDIFModifyDNChangeRecord(java.lang.String dn, java.lang.String newRDN, boolean deleteOldRDN, java.lang.String newSuperiorDN)
dn
- The current DN for the entry. It must not be
null
.newRDN
- The new RDN value for the entry. It must not be
null
.deleteOldRDN
- Indicates whether to delete the currentRDN value
from the entry.newSuperiorDN
- The new superior DN for this LDIF modify DN change
record. It may be null
if the entry is not
to be moved below a new parent.public LDIFModifyDNChangeRecord(java.lang.String dn, java.lang.String newRDN, boolean deleteOldRDN, java.lang.String newSuperiorDN, java.util.List<Control> controls)
dn
- The current DN for the entry. It must not be
null
.newRDN
- The new RDN value for the entry. It must not be
null
.deleteOldRDN
- Indicates whether to delete the currentRDN value
from the entry.newSuperiorDN
- The new superior DN for this LDIF modify DN change
record. It may be null
if the entry is not
to be moved below a new parent.controls
- The set of controls for this LDIF modify DN change
record. It may be null
or empty if there
are no controls.public LDIFModifyDNChangeRecord(ModifyDNRequest modifyDNRequest)
modifyDNRequest
- The modify DN request to use to create this LDIF
modify DN change record. It must not be
null
.public java.lang.String getNewRDN()
public RDN getParsedNewRDN() throws LDAPException
LDAPException
- If a problem occurs while trying to parse the new
RDN.public boolean deleteOldRDN()
true
if the current RDN value should be removed from the
entry, or false
if not.public java.lang.String getNewSuperiorDN()
null
if the entry is
not to be moved below a new parent.public DN getParsedNewSuperiorDN() throws LDAPException
null
if the
entry is not to be moved below a new parent.LDAPException
- If a problem occurs while trying to parse the new
superior DN.public DN getNewDN() throws LDAPException
LDAPException
- If a problem occurs while trying to parse the
target DN, new RDN, or new superior DN.public ModifyDNRequest toModifyDNRequest()
public ModifyDNRequest toModifyDNRequest(boolean includeControls)
includeControls
- Indicates whether to include any controls in the
request.public ChangeType getChangeType()
getChangeType
in class LDIFChangeRecord
public LDAPResult processChange(LDAPInterface connection, boolean includeControls) throws LDAPException
processChange
in class LDIFChangeRecord
connection
- The connection to use to apply the change.includeControls
- Indicates whether to include any controls in the
request.LDAPException
- If an error occurs while processing this change
in the associated directory server.public java.lang.String[] toLDIF(int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public void toLDIF(ByteStringBuffer buffer, int wrapColumn)
toLDIF
in interface LDIFRecord
toLDIF
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public void toLDIFString(java.lang.StringBuilder buffer, int wrapColumn)
toLDIFString
in interface LDIFRecord
toLDIFString
in class LDIFChangeRecord
buffer
- The buffer to which to append an LDIF representation of
this change record.wrapColumn
- The column at which to wrap long lines. A value that
is less than or equal to two indicates that no
wrapping should be performed.public int hashCode()
hashCode
in class LDIFChangeRecord
public boolean equals(java.lang.Object o)
equals
in class LDIFChangeRecord
o
- The object for which to make the determination.true
if the provided object is equal to this LDIF change
record, or false
if not.public void toString(java.lang.StringBuilder buffer)
toString
in interface LDIFRecord
toString
in class LDIFChangeRecord
buffer
- The buffer to which the information should be written.