Package org.forgerock.opendj.ldap.requests

Interface ModifyRequest

All Superinterfaces:
ChangeRecord, Request
public interface ModifyRequest extends Request, 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);

  • Method Details

    • accept

      <R, P> R accept(ChangeRecordVisitor<R,P> v, P p)
      Description copied from interface: ChangeRecord
      Applies a ChangeRecordVisitor to this ChangeRecord.
      Specified by:
      accept in interface ChangeRecord
      Type Parameters:
      R - The return type of the visitor's methods.
      P - The type of the additional parameters to the visitor's methods.
      Parameters:
      v - The change record visitor.
      p - Optional additional visitor parameter.
      Returns:
      A result as specified by the visitor.

    • addControl

      ModifyRequest addControl(Control control)
      Description copied from interface: Request
      Adds the provided control to this request.
      Specified by:
      addControl in interface Request
      Parameters:
      control - The control to be added to this request.
      Returns:
      This request.

    • addModification

      ModifyRequest addModification(Modification modification)
      Appends the provided modification to the list of modifications included with this modify request.
      Parameters:
      modification - The modification to be performed.
      Returns:
      This modify request.
      Throws:
      UnsupportedOperationException - If this modify request does not permit modifications to be added.
      NullPointerException - If modification was null.

    • addModification

      ModifyRequest addModification(ModificationType type, String attributeDescription, Object... values)
      Appends the provided modification to the list of modifications included with this modify request.

      If the attribute value is not an instance of ByteString then it will be converted using the ByteString.valueOfObject(Object) method.

      Parameters:
      type - The type of modification to be performed.
      attributeDescription - The name of the attribute to be modified.
      values - The attribute values to be modified.
      Returns:
      This modify request.
      Throws:
      org.forgerock.i18n.LocalizedIllegalArgumentException - If attributeDescription could not be decoded using the default schema.
      UnsupportedOperationException - If this modify request does not permit modifications to be added.
      NullPointerException - If type, attributeDescription, or value was null.

    • getControl

      <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) throws DecodeException
      Description copied from interface: Request
      Decodes and returns the first control in this request having an OID corresponding to the provided control decoder.
      Specified by:
      getControl in interface Request
      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 request.
      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: Request
      Returns a List containing the controls included with this request. The returned List may be modified if permitted by this request.
      Specified by:
      getControls in interface Request
      Returns:
      A List containing the controls.

    • getModifications

      List<Modification> getModifications()
      Returns a List containing the modifications included with this modify request. The returned List may be modified if permitted by this modify request.
      Returns:
      A List containing the modifications.

    • getName

      DN getName()
      Returns the distinguished name of the entry to be modified. The server shall not perform any alias dereferencing in determining the object to be modified.
      Specified by:
      getName in interface ChangeRecord
      Returns:
      The distinguished name of the entry to be modified.

    • setName

      ModifyRequest setName(DN dn)
      Sets the distinguished name of the entry to be modified. The server shall not perform any alias dereferencing in determining the object to be modified.
      Parameters:
      dn - The the distinguished name of the entry to be modified.
      Returns:
      This modify request.
      Throws:
      UnsupportedOperationException - If this modify request does not permit the distinguished name to be set.
      NullPointerException - If dn was null.

    • setName

      ModifyRequest setName(String dn)
      Sets the distinguished name of the entry to be modified. The server shall not perform any alias dereferencing in determining the object to be modified.
      Parameters:
      dn - The the distinguished name of the entry to be modified.
      Returns:
      This modify request.
      Throws:
      org.forgerock.i18n.LocalizedIllegalArgumentException - If dn could not be decoded using the default schema.
      UnsupportedOperationException - If this modify request does not permit the distinguished name to be set.
      NullPointerException - If dn was null.