Package org.springframework.ldap.core

Interface LdapClient

public interface LdapClient
An LDAP Client
Since:
3.1

  • Method Details

    • list

      LdapClient.ListSpec list(String name)
      Start building a request for all children of the given name.
      Parameters:
      name - the distinguished name to find children for
      Returns:
      a spec for specifying the list parameters

    • list

      LdapClient.ListSpec list(Name name)
      Start building a request for all children of the given name.
      Parameters:
      name - the distinguished name to find children for
      Returns:
      a spec for specifying the list parameters

    • listBindings

      LdapClient.ListBindingsSpec listBindings(String name)
      Start building a request for all children of the given name. The result will include the object bound to the name.
      Parameters:
      name - the distinguished name to find children for
      Returns:
      a spec for specifying the list parameters

    • listBindings

      LdapClient.ListBindingsSpec listBindings(Name name)
      Start building a request for all children of the given name. The result will include the object bound to the name.
      Parameters:
      name - the distinguished name to find children for
      Returns:
      a spec for specifying the list parameters

    • search

      LdapClient.SearchSpec search()
      Start building a search request.
      Returns:
      a spec for specifying the search parameters

    • authenticate

      LdapClient.AuthenticateSpec authenticate()
      Start building an authentication request.
      Returns:
      a spec for specifying the authentication parameters

    • bind

      LdapClient.BindSpec bind(String name)
      Start building a bind request, using the given name as the identifier.
      Returns:
      a spec for specifying the bind parameters

    • bind

      LdapClient.BindSpec bind(Name name)
      Start building a bind or rebind request, using the given name as the identifier.
      Returns:
      a spec for specifying the bind parameters

    • modify

      LdapClient.ModifySpec modify(String name)
      Start building a request to modify name or attributes of an entry, using the given name as the identifier.

      Note that a modify(Name) is different from a rebind in that entries are changed instead of removed and recreated.

      A change in name uses LDAP's Context.rename(javax.naming.Name, javax.naming.Name) function. A change in attributes uses LDAP's DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes) function. The rename action is optimistically performed before the modify function. A rollback of the name is attempted in the event that attribute modification fails.

      Parameters:
      name - the name of the entry to modify
      Returns:
      a spec for specifying the modify parameters

    • modify

      LdapClient.ModifySpec modify(Name name)
      Start building a request to modify name or attributes of an entry, using the given name as the identifier.

      Note that a modify(Name) is different from a rebind in that entries are changed instead of removed and recreated.

      A change in name uses LDAP's Context.rename(javax.naming.Name, javax.naming.Name) function. A change in attributes uses LDAP's DirContext.modifyAttributes(javax.naming.Name, int, javax.naming.directory.Attributes) function. The rename action is optimistically performed before the modify function. A rollback of the name is attempted in the event that attribute modification fails.

      Parameters:
      name - the name of the entry to modify
      Returns:
      a spec for specifying the modify parameters

    • unbind

      LdapClient.UnbindSpec unbind(String name)
      Start building a request to remove the name entry.
      Parameters:
      name - the name of the entry to remove
      Returns:
      a spec for specifying the unbind parameters

    • unbind

      LdapClient.UnbindSpec unbind(Name name)
      Start building a request to remove the name entry.
      Parameters:
      name - the name of the entry to remove
      Returns:
      a spec for specifying the unbind parameters

    • mutate

      LdapClient.Builder mutate()
      Return a builder to create a new LdapClient whose settings are replicated from the current LdapClient.

    • create

      static LdapClient create(ContextSource contextSource)
      Create an instance of LdapClient
      Parameters:
      contextSource - the ContextSource for all requests
      See Also:

    • builder

      static LdapClient.Builder builder()
      Obtain a LdapClient builder.