Package org.apache.directory.api.ldap.model.message

Interface ModifyDnRequest

  • All Superinterfaces:
    AbandonableRequest, Message, Request, ResultResponseRequest, SingleReplyRequest
    All Known Implementing Classes:
    ModifyDNRequestDsml, ModifyDnRequestImpl
    public interface ModifyDnRequest
extends SingleReplyRequest, AbandonableRequest
    Modify Dn request protocol message used to rename or move an existing entry in the directory. Here's what RFC 2251 has to say about it: 
      4.9. Modify Dn Operation
 
   The Modify Dn Operation allows a client to change the leftmost (least
   significant) component of the name of an entry in the directory, or
   to move a subtree of entries to a new location in the directory.  The
   Modify Dn Request is defined as follows:
 
        ModifyDNRequest ::= [APPLICATION 12] SEQUENCE {
                entry           LDAPDN,
                newrdn          RelativeLDAPDN,
                deleteoldrdn    BOOLEAN,
                newSuperior     [0] LDAPDN OPTIONAL }
 
   Parameters of the Modify Dn Request are:
 
   - entry: the Distinguished Name of the entry to be changed.  This
     entry may or may not have subordinate entries.
 
   - newrdn: the Rdn that will form the leftmost component of the new
     name of the entry.
 
   - deleteoldrdn: a boolean parameter that controls whether the old Rdn
     attribute values are to be retained as attributes of the entry, or
     deleted from the entry.
 
   - newSuperior: if present, this is the Distinguished Name of the entry
     which becomes the immediate superior of the existing entry.
    Note that this operation can move an entry and change its Rdn at the same time in fact it might have no choice to comply with name forms.
    Author:
    Apache Directory Project

    • Method Detail

      • getName

        Dn getName()
        Gets the entry's distinguished name representing the entry PDU field.
        Returns:
        the distinguished name of the entry.

      • setName

        ModifyDnRequest setName​(Dn name)
        Sets the entry's distinguished name representing the entry PDU field.
        Parameters:
        name - the distinguished name of the entry.
        Returns:
        The ModifyDnRequest instance

      • getNewRdn

        Rdn getNewRdn()
        Gets the new relative distinguished name for the entry which represents the PDU's newrdn field.
        Returns:
        the relative dn with one component

      • setNewRdn

        ModifyDnRequest setNewRdn​(Rdn newRdn)
        Sets the new relative distinguished name for the entry which represents the PDU's newrdn field.
        Parameters:
        newRdn - the relative dn with one component
        Returns:
        The ModifyDnRequest instance

      • getDeleteOldRdn

        boolean getDeleteOldRdn()
        Gets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead. This property corresponds to the deleteoldrdn.
        Returns:
        true if the old rdn is to be deleted, false if it is not

      • setDeleteOldRdn

        ModifyDnRequest setDeleteOldRdn​(boolean deleteOldRdn)
        Sets the flag which determines if the old Rdn attribute is to be removed from the entry when the new Rdn is used in its stead. This property corresponds to the deleteoldrdn.
        Parameters:
        deleteOldRdn - true if the old rdn is to be deleted, false if it is not
        Returns:
        The ModifyDnRequest instance

      • getNewSuperior

        Dn getNewSuperior()
        Gets the optional distinguished name of the new superior entry where the candidate entry is to be moved. This property corresponds to the PDU's newSuperior field. May be null representing a simple Rdn change rather than a move operation.
        Returns:
        the dn of the superior entry the candidate entry is moved under.

      • setNewSuperior

        ModifyDnRequest setNewSuperior​(Dn newSuperior)
        Sets the optional distinguished name of the new superior entry where the candidate entry is to be moved. This property corresponds to the PDU's newSuperior field. May be null representing a simple Rdn change rather than a move operation. Setting this property to a non-null value toggles the move flag obtained via the isMove method.
        Parameters:
        newSuperior - the dn of the superior entry the candidate entry for Dn modification is moved under.
        Returns:
        The ModifyDnRequest instance

      • isMove

        boolean isMove()
        Gets whether or not this request is a Dn change resulting in a move operation. Setting the newSuperior property to a non-null name, toggles this flag.
        Returns:
        true if the newSuperior property is NOT null, false otherwise.

      • setMessageId

        ModifyDnRequest setMessageId​(int messageId)
        Sets the Message ID for this request
        Specified by:
        setMessageId in interface Message
        Parameters:
        messageId - The message Id
        Returns:
        A Message reference

      • addControl

        ModifyDnRequest addControl​(Control control)
        Adds a control to this Message.
        Specified by:
        addControl in interface Message
        Parameters:
        control - the control to add.
        Returns:
        A Message reference

      • addAllControls

        ModifyDnRequest addAllControls​(Control[] controls)
        Adds an array of controls to this Message.
        Specified by:
        addAllControls in interface Message
        Parameters:
        controls - the controls to add.
        Returns:
        A Message reference

      • removeControl

        ModifyDnRequest removeControl​(Control control)
        Deletes a control removing it from this Message.
        Specified by:
        removeControl in interface Message
        Parameters:
        control - the control to remove.
        Returns:
        A Message reference