Package org.forgerock.opendj.ldap.messages

Record Class AddRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.AddRequest
Record Components:
entry - the entry to be added.
controls - the List containing the controls.
All Implemented Interfaces:
ProtocolOp, Request, ChangeRecord
public record AddRequest(Entry entry, List<Control> controls) extends Record implements ChangeRecord
The Add operation allows a client to request the addition of an entry into the Directory.

The RDN attribute(s) may or may not be included in the Add request. NO-USER-MODIFICATION attributes such as the createTimestamp or creatorsName attributes must not be included, since the server maintains these automatically.

  • Constructor Details

    • AddRequest

      public AddRequest(Entry entry, List<Control> controls)
      Create new AddRequest with the entry to be added and the List containing the controls.

  • 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.

    • name

      public Dn name()
      Description copied from interface: ChangeRecord
      Returns the distinguished name of the entry being modified by this ChangeRecord.
      Specified by:
      name in interface ChangeRecord
      Returns:
      The distinguished name of the entry being modified.

    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.

    • entry

      public Entry entry()
      Returns the value of the entry record component.
      Returns:
      the value of the entry 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