Package org.forgerock.opendj.ldap.messages

Interface DeleteRequest

  • All Superinterfaces:
    ChangeRecord, ProtocolOp, Request
    public interface DeleteRequest
extends Request, ChangeRecord
    The Delete operation allows a client to request the removal of an entry from the Directory.

    Only leaf entries (those with no subordinate entries) can be deleted with this operation. However, addition of the SubtreeDeleteControl permits whole sub-trees to be deleted using a single Delete request. 

     Connection connection = ...;
 String baseDN = ...;

 DeleteRequest request =
         Requests.newDeleteRequest(baseDN)
             .addControl(SubtreeDeleteRequestControl.newControl(true));
 connection.delete(request);

    • Method Detail

      • getControl

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

      • getName

        Dn getName()
        Returns the distinguished name of the entry to be deleted. The server shall not dereference any aliases in locating the entry to be deleted.
        Specified by:
        getName in interface ChangeRecord
        Returns:
        The distinguished name of the entry.

      • setName

        DeleteRequest setName​(Dn dn)
        Sets the distinguished name of the entry to be deleted. The server shall not dereference any aliases in locating the entry to be deleted.
        Specified by:
        setName in interface ChangeRecord
        Parameters:
        dn - The distinguished name of the entry to be deleted.
        Returns:
        This delete request.
        Throws:
        UnsupportedOperationException - If this delete request does not permit the distinguished name to be set.
        NullPointerException - If dn was null.