Interface LdapClient

public interface LdapClient

An LDAP Client

Since:

3.1

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	LdapClient.AuthenticateSpec	The specifications for the authenticate() request.
static interface	LdapClient.BindSpec	The specifications for the bind(String) request.
static interface	LdapClient.Builder	A mutable builder for creating an LdapClient.
static interface	LdapClient.ListBindingsSpec	The specifications for the listBindings(String) request.
static interface	LdapClient.ListSpec	The specifications for the list(String) request.
static interface	LdapClient.MappedSearchSpec<T extends @Nullable Object>	A specification for retrieving mapped search results with various cardinality options.
static interface	LdapClient.ModifySpec	The specifications for the modify(String) request.
static interface	LdapClient.SearchSpec	The specifications for the search() request.
static interface	LdapClient.UnbindSpec	The specifications for the unbind(String) request.

Method Summary

Modifier and Type	Method	Description
LdapClient.AuthenticateSpec	authenticate()	Start building an authentication request.
LdapClient.BindSpec	bind(String name)	Start building a bind request, using the given name as the identifier.
LdapClient.BindSpec	bind(Name name)	Start building a bind or rebind request, using the given name as the identifier.
static LdapClient.Builder	builder()	Deprecated. Please provide a ContextSource using withContextSource(ContextSource)
static LdapClient	create(ContextSource contextSource)	Create an instance of LdapClient
static LdapClient	create(LdapTemplate ldap)	Create an instance of LdapClient
LdapClient.ListSpec	list(String name)	Start building a request for all children of the given name.
LdapClient.ListSpec	list(Name name)	Start building a request for all children of the given name.
LdapClient.ListBindingsSpec	listBindings(String name)	Start building a request for all children of the given name.
LdapClient.ListBindingsSpec	listBindings(Name name)	Start building a request for all children of the given name.
LdapClient.ModifySpec	modify(String name)	Start building a request to modify name or attributes of an entry, using the given name as the identifier.
LdapClient.ModifySpec	modify(Name name)	Start building a request to modify name or attributes of an entry, using the given name as the identifier.
LdapClient.Builder	mutate()	Return a builder to create a new LdapClient whose settings are replicated from the current LdapClient.
LdapClient.SearchSpec	search()	Start building a search request.
LdapClient.UnbindSpec	unbind(String name)	Start building a request to remove the name entry.
LdapClient.UnbindSpec	unbind(Name name)	Start building a request to remove the name entry.
static LdapClient.Builder	withContextSource(ContextSource contextSource)	Obtain a LdapClient builder.

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(Name, Name) function. A change in attributes uses LDAP's DirContext.modifyAttributes(Name, int, 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(Name, Name) function. A change in attributes uses LDAP's DirContext.modifyAttributes(Name, int, 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.

withContextSource

static LdapClient.Builder withContextSource(ContextSource contextSource)

Obtain a LdapClient builder.

Parameters:

contextSource - the ContextSource for all requests

Since:

4.1

create

static LdapClient create(ContextSource contextSource)

Create an instance of LdapClient

Parameters:

contextSource - the ContextSource for all requests

See Also:

• withContextSource(ContextSource)

create

static LdapClient create(LdapTemplate ldap)

Create an instance of LdapClient

Parameters:

ldap - the LdapTemplate to base this client off of

Since:

3.3

See Also:

• withContextSource(ContextSource)

builder

@Deprecated
static LdapClient.Builder builder()

Deprecated.

Please provide a ContextSource using withContextSource(ContextSource)

Obtain a LdapClient builder.