Package org.forgerock.opendj.ldap.messages

Interface ModifyDnRequest

  • All Superinterfaces:
    ChangeRecord, ProtocolOp, Request
    public interface ModifyDnRequest
extends Request, ChangeRecord
    The Modify DN operation allows a client to change the Relative Distinguished Name (RDN) of an entry in the Directory and/or to move a subtree of entries to a new location in the Directory.

    • Method Detail

      • getControl

        <C extends Control> C getControl​(ControlDecoder<C> decoder,
                                 DecodeOptions options)
                          throws DecodeException
        Description copied from interface: ProtocolOp
        Decodes and returns the first control in this protocol-op having an OID corresponding to the provided control decoder.
        Specified by:
        getControl in interface ProtocolOp
        Type Parameters:
        C - The type of control to be decoded and returned.
        Parameters:
        decoder - The control decoder.
        options - The set of decode options which should be used when decoding the control.
        Returns:
        The decoded control, or null if the control is not included with this protocol-op.
        Throws:
        DecodeException - If the control could not be decoded because it was malformed in some way (e.g. the control value was missing, or its content could not be decoded).

      • getControls

        List<Control> getControls()
        Description copied from interface: ProtocolOp
        Returns a List containing the controls included with this protocol-op. The returned List may be modified if permitted by this protocol-op.
        Specified by:
        getControls in interface ProtocolOp
        Returns:
        A List containing the controls.

      • getName

        Dn getName()
        Returns the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries. The server shall not dereference any aliases in locating the entry to be renamed.
        Specified by:
        getName in interface ChangeRecord
        Returns:
        The distinguished name of the entry.

      • getNewRdn

        Rdn getNewRdn()
        Returns the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.
        Returns:
        The new RDN of the entry.

      • getNewSuperior

        Dn getNewSuperior()
        Returns the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. The server shall not dereference any aliases in locating the new superior entry. The default value is null, indicating that the entry is to remain under the same parent entry.
        Returns:
        The distinguished name of the new superior entry, or null if the entry is to remain under the same parent entry.

      • isDeleteOldRdn

        boolean isDeleteOldRdn()
        Indicates whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry. The default value is false.
        Returns:
        true if the old RDN attribute values are to be deleted from the entry, or false if they are to be retained.

      • setDeleteOldRdn

        ModifyDnRequest setDeleteOldRdn​(boolean deleteOldRdn)
        Specifies whether the old RDN attribute values are to be retained as attributes of the entry or deleted from the entry. The default value is false.
        Parameters:
        deleteOldRdn - true if the old RDN attribute values are to be deleted from the entry, or false if they are to be retained.
        Returns:
        This modify DN request.
        Throws:
        UnsupportedOperationException - If this modify DN request does not permit the delete old RDN parameter to be set.

      • setName

        ModifyDnRequest setName​(Dn dn)
        Sets the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries. The server shall not dereference any aliases in locating the entry to be renamed.
        Specified by:
        setName in interface ChangeRecord
        Parameters:
        dn - The distinguished name of the entry to be renamed.
        Returns:
        This modify DN request.
        Throws:
        UnsupportedOperationException - If this modify DN request does not permit the distinguished name to be set.
        NullPointerException - If dn was null.

      • setName

        ModifyDnRequest setName​(String dn)
        Sets the distinguished name of the entry to be renamed. This entry may or may not have subordinate entries. The server shall not dereference any aliases in locating the entry to be renamed.
        Specified by:
        setName in interface ChangeRecord
        Parameters:
        dn - The distinguished name of the entry to be renamed.
        Returns:
        This modify DN request.
        Throws:
        LocalizedIllegalArgumentException - If dn could not be decoded using the default schema.
        UnsupportedOperationException - If this modify DN request does not permit the distinguished name to be set.
        NullPointerException - If dn was null.

      • setNewRdn

        ModifyDnRequest setNewRdn​(Rdn rdn)
        Sets the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.
        Parameters:
        rdn - The new RDN of the entry to be renamed.
        Returns:
        This modify DN request.
        Throws:
        UnsupportedOperationException - If this modify DN request does not permit the new RDN to be set.
        NullPointerException - If rdn was null.

      • setNewRdn

        ModifyDnRequest setNewRdn​(String rdn)
        Sets the new RDN of the entry to be renamed. The value of the old RDN is supplied when moving the entry to a new superior without changing its RDN. Attribute values of the new RDN not matching any attribute value of the entry are added to the entry, and an appropriate error is returned if this fails.
        Parameters:
        rdn - The new RDN of the entry to be renamed.
        Returns:
        This modify DN request.
        Throws:
        LocalizedIllegalArgumentException - If rdn could not be decoded using the default schema.
        UnsupportedOperationException - If this modify DN request does not permit the new RDN to be set.
        NullPointerException - If rdn was null.

      • setNewSuperior

        ModifyDnRequest setNewSuperior​(Dn dn)
        Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. The server shall not dereference any aliases in locating the new superior entry. The default value is null, indicating that the entry is to remain under the same parent entry.
        Parameters:
        dn - The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null.
        Returns:
        This modify DN request.
        Throws:
        UnsupportedOperationException - If this modify DN request does not permit the new superior to be set.

      • setNewSuperior

        ModifyDnRequest setNewSuperior​(String dn)
        Sets the distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed. The server shall not dereference any aliases in locating the new superior entry. The default value is null, indicating that the entry is to remain under the same parent entry.
        Parameters:
        dn - The distinguished name of an existing entry that will become the immediate superior (parent) of the entry to be renamed, may be null.
        Returns:
        This modify DN request.
        Throws:
        LocalizedIllegalArgumentException - If dn could not be decoded using the default schema.
        UnsupportedOperationException - If this modify DN request does not permit the new superior to be set.