Package org.forgerock.opendj.ldap.messages

Record Class ModifyRequest

java.lang.Object
java.lang.Record
org.forgerock.opendj.ldap.messages.ModifyRequest
Record Components:
name - the distinguished name of the entry to be modified. The server shall not perform any alias dereferencing in determining the object to be modified.
modifications - the List containing the modifications included with this modify request. The returned List may be modified if permitted by this modify request.
controls - the List containing the controls.
All Implemented Interfaces:
ProtocolOp, Request, ChangeRecord
public record ModifyRequest(Dn name, List<Modification> modifications, List<Control> controls) extends Record implements ChangeRecord
The Modify operation allows a client to request that a modification of an entry be performed on its behalf by a server.

The following example adds a member to a static group entry. 

 Connection connection = ...;
 String groupDN = ...;
 String memberDN = ...;

 ModifyRequest addMember = Requests.newModifyRequest(groupDN)
         .addModification(ModificationType.ADD, "member", memberDN);
 connection.modify(addMember);

  • Constructor Details

    • ModifyRequest

      public ModifyRequest(Dn name, List<Modification> modifications, List<Control> controls)
      Create new ModifyRequest 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.

    • 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

    • with

      public ModifyRequest with(Modification modification)
      Adds the provided modification to this modify request.
      Parameters:
      modification - The modification.
      Returns:
      This modify request.
      Throws:
      UnsupportedOperationException - If the this request is immutable.

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

    • 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

    • modifications

      public List<Modification> modifications()
      Returns the value of the modifications record component.
      Returns:
      the value of the modifications 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