Package org.forgerock.opendj.ldif

Interface ChangeRecord

All Superinterfaces:
ProtocolOp, Request
All Known Implementing Classes:
AddRequest, DeleteRequest, ModifyDnRequest, ModifyRequest
public interface ChangeRecord extends Request
A request to modify the content of the Directory in some way. A change record represents one of the following operations:
  • An Add operation.
  • A Delete operation.
  • A Modify operation.
  • A ModifyDN operation.

  • Method Details

    • getName

      Dn getName()
      Returns the distinguished name of the entry being modified by this ChangeRecord.
      Returns:
      The distinguished name of the entry being modified.

    • setName

      ChangeRecord setName(Dn dn)
      Sets the distinguished name of the entry to be updated. The server shall not perform any alias dereferencing in determining the object to be updated.
      Parameters:
      dn - The distinguished name of the entry to be updated.
      Returns:
      This change record.
      Throws:
      UnsupportedOperationException - If this change record does not permit the distinguished name to be set.
      NullPointerException - If dn was null.

    • setName

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

    • addControl

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

    • addControls

      ChangeRecord addControls(Iterable<? extends Control> controls)
      Description copied from interface: ProtocolOp
      Adds the provided controls to this protocol-op.
      Specified by:
      addControls in interface ProtocolOp
      Specified by:
      addControls in interface Request
      Parameters:
      controls - The controls to be added to this protocol-op.
      Returns:
      This protocol-op.