Package org.springframework.ldap.core

Interface LdapClient.Builder

Enclosing interface:

LdapClient

public static interface LdapClient.Builder

A mutable builder for creating an LdapClient.

Method Summary

Modifier and Type	Method	Description
LdapClient.Builder	apply(Consumer<LdapClient.Builder> builderConsumer)	Apply the given Consumer to this builder instance.
LdapClient	build()	Build the LdapClient instance.
LdapClient.Builder	clone()	Clone this LdapClient.Builder.
LdapClient.Builder	contextSource(ContextSource contextSource)	Use this ContextSource
LdapClient.Builder	defaultSearchControls(Supplier<SearchControls> searchControlsSupplier)	Use this Supplier to generate a SearchControls.
LdapClient.Builder	ignoreNameNotFoundException(boolean ignore)	Whether to ignore the NameNotFoundException.
LdapClient.Builder	ignorePartialResultException(boolean ignore)	Whether to ignore the PartialResultException.
LdapClient.Builder	ignoreSizeLimitExceededException(boolean ignore)	Whether to ignore the SizeLimitExceededException.

Method Details

contextSource

LdapClient.Builder contextSource(ContextSource contextSource)

Use this ContextSource

Returns:

the LdapClient.Builder for further customizations

defaultSearchControls

LdapClient.Builder defaultSearchControls(Supplier<SearchControls> searchControlsSupplier)

Use this Supplier to generate a SearchControls. It should generate a new SearchControls on each call.

Parameters:

searchControlsSupplier - the Supplier to use

Returns:

the LdapClient.Builder for further customizations

ignorePartialResultException

LdapClient.Builder ignorePartialResultException(boolean ignore)

Whether to ignore the PartialResultException. Defaults to true.

Parameters:

ignore - whether to ignore the PartialResultException

Returns:

the LdapClient.Builder for further customizations

ignoreNameNotFoundException

LdapClient.Builder ignoreNameNotFoundException(boolean ignore)

Whether to ignore the NameNotFoundException. Defaults to true.

Parameters:

ignore - whether to ignore the NameNotFoundException

Returns:

the LdapClient.Builder for further customizations

ignoreSizeLimitExceededException

LdapClient.Builder ignoreSizeLimitExceededException(boolean ignore)

Whether to ignore the SizeLimitExceededException. Defaults to true.

Parameters:

ignore - whether to ignore the SizeLimitExceededException

Returns:

the LdapClient.Builder for further customizations

apply

LdapClient.Builder apply(Consumer<LdapClient.Builder> builderConsumer)

Apply the given Consumer to this builder instance.

This can be useful for applying pre-packaged customizations.

Parameters:

builderConsumer - the consumer to apply

clone

LdapClient.Builder clone()

Clone this LdapClient.Builder.

build

LdapClient build()

Build the LdapClient instance.