Record Class ModifyDnRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.ModifyDnRequest
Record Components:
name - 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.
newRdn - 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.
newSuperior - the distinguished name of the new superior entry, or null if the entry is to remain under the same parent entry. It is 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.
deleteOldRdn - true if the old RDN attribute values are to be deleted from the entry, or false if they are to be retained.
controls - the List containing the controls.
All Implemented Interfaces:
ProtocolOp, Request, ChangeRecord
public record ModifyDnRequest(Dn name, Rdn newRdn, Dn newSuperior, boolean deleteOldRdn, List<Control> controls) extends Record implements 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.

  • Constructor Details

    • ModifyDnRequest

      public ModifyDnRequest(Dn name, Rdn newRdn, Dn newSuperior, boolean deleteOldRdn, List<Control> controls)
      Create a new ModifyDnRequest.

  • Method Details

    • accept

      public <R, P, E extends Exception> R accept(RequestVisitor<R,P,E> v, P p) throws E
      Description copied from interface: Request
      Applies a RequestVisitor to this Request.
      Specified by:
      accept in interface Request
      Type Parameters:
      R - The return type of the visitor's methods.
      P - The type of the additional parameters to the visitor's methods.
      E - The type of the exception thrown by the visitor method if it fails, or NeverThrowsException if the visitor cannot fail.
      Parameters:
      v - The request visitor.
      p - Optional additional visitor parameter.
      Returns:
      A result as specified by the visitor.
      Throws:
      E - If the visitor failed.

    • getType

      public Request.RequestType getType()
      Description copied from interface: Request
      Returns the type of this request to avoid expensive instanceof checks.
      Specified by:
      getType in interface Request
      Returns:
      the type of this request

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • name

      public Dn name()
      Returns the value of the name record component.
      Specified by:
      name in interface ChangeRecord
      Returns:
      the value of the name record component

    • newRdn

      public Rdn newRdn()
      Returns the value of the newRdn record component.
      Returns:
      the value of the newRdn record component

    • newSuperior

      public Dn newSuperior()
      Returns the value of the newSuperior record component.
      Returns:
      the value of the newSuperior record component

    • deleteOldRdn

      public boolean deleteOldRdn()
      Returns the value of the deleteOldRdn record component.
      Returns:
      the value of the deleteOldRdn record component

    • controls

      public List<Control> controls()
      Returns the value of the controls record component.
      Specified by:
      controls in interface ProtocolOp
      Returns:
      the value of the controls record component