Interface LDAPDeleteRequest

  • All Superinterfaces:
    Cloneable, LDAPRequest

    public interface LDAPDeleteRequest
    extends LDAPRequest
    Represents an LDAP delete request, which can be used to perform an LDAPv3 delete operation to remove an entry from the directory.

    Note that LDAPDeleteRequest objects should not be considered thread-safe, thus should not be used concurrently by multiple threads. Each thread wishing to process a request should have its own instance of that request.

    • Method Detail

      • clone

        LDAPDeleteRequest clone()
        Creates and returns a copy of this delete request that may be modified without impacting this request.
        Specified by:
        clone in interface LDAPRequest
        Returns:
        A copy of this delete request that may be modified without impacting this request.
      • getDN

        String getDN()
        Returns the distinguished name for this delete request.
        Returns:
        the distinguished name for this delete request.
      • setDN

        LDAPDeleteRequest setDN​(String dn)
        Sets the distinguished name for this delete request.
        Parameters:
        dn - the distinguished name for this delete request. It must not be null.
        Returns:
        this delete request.
      • setQueryTimeout

        LDAPDeleteRequest setQueryTimeout​(long timeout)
        Sets the maximum time, in milliseconds, to wait for a response from the server when processing this delete request.

        A value of zero indicates that no timeout should be enforced.

        A value that is less than zero indicates that the default query timeout for the underlying connection should be used.

        Specified by:
        setQueryTimeout in interface LDAPRequest
        Parameters:
        timeout - the maximum time, in milliseconds, to wait for a response from the server when processing this delete request.
        Returns:
        this delete request.