netscape.ldap.util

Class LDIFModDNContent

Implemented Interfaces:
LDIFContent, java.io.Serializable

public class LDIFModDNContent
extends LDIFBaseContent

An object of this class represents the content of an LDIF record that specifies changes to an RDN or the DN of an entry. This class implements the LDIFContent interface.

To get this object from an LDIFRecord object, use the getContent method and cast the return value as LDIFModDNContent.

Version:
1.0
See Also:
LDIFRecord.getContent(), Serialized Form

Fields inherited from interface netscape.ldap.util.LDIFContent

ADD_CONTENT, ATTRIBUTE_CONTENT, DELETE_CONTENT, MODDN_CONTENT, MODIFICATION_CONTENT

Constructor Summary

LDIFModDNContent()
Constructs an empty LDIFModDNContent object.

Method Summary

boolean
getDeleteOldRDN()
Determines if the content of the LDIF record specifies that the old RDN should be removed as an attribute in the entry.
String
getNewParent()
Returns the entry's new parent DN, if specified in the content of the LDIF record.
String
getRDN()
Returns the new RDN specified in the content of the LDIF record.
int
getType()
Returns the content type.
void
setDeleteOldRDN(boolean bool)
Sets whether or not the old RDN should be removed as an attribute in the entry.
void
setNewParent(String parent)
Sets the new parent DN that should be assigned to the entry.
void
setRDN(String rdn)
Sets the new RDN that should be assigned to the entry.
String
toString()
Returns string representation of the content of the LDIF record.

Methods inherited from class netscape.ldap.util.LDIFBaseContent

getControlString, getControls, setControls

Constructor Details

LDIFModDNContent

public LDIFModDNContent()
Constructs an empty LDIFModDNContent object. To specify the modifications to be made to the entry, use the setRDN, setNewParent, and setDeleteOldRDN methods.

Method Details

getDeleteOldRDN

public boolean getDeleteOldRDN()
Determines if the content of the LDIF record specifies that the old RDN should be removed as an attribute in the entry.
Returns:
true if the change specifies that the the attribute representing the RDN should be removed, false if the change specifies that the attribute should be left in the entry.

getNewParent

public String getNewParent()
Returns the entry's new parent DN, if specified in the content of the LDIF record.
Returns:
the new parent of the entry.

getRDN

public String getRDN()
Returns the new RDN specified in the content of the LDIF record.
Returns:
the new RDN.

getType

public int getType()
Returns the content type. You can use this with the getContent method of the LDIFRecord object to determine the type of content specified in the record.
Specified by:
getType in interface LDIFContent
Returns:
the content type (which is LDIFContent.MODDN_CONTENT).

setDeleteOldRDN

public void setDeleteOldRDN(boolean bool)
Sets whether or not the old RDN should be removed as an attribute in the entry.
Parameters:
bool - if true, remove the attribute representing the RDN. If false, leave the attribute in the entry.

setNewParent

public void setNewParent(String parent)
Sets the new parent DN that should be assigned to the entry.
Parameters:
parent - the new parent DN for the entry

setRDN

public void setRDN(String rdn)
Sets the new RDN that should be assigned to the entry.
Parameters:
rdn - the new RDN

toString

public String toString()
Returns string representation of the content of the LDIF record.
Specified by:
toString in interface LDIFContent
Returns:
the string representation of the content of the LDIF record.