Interface LdapClient.SearchSpec

Enclosing interface:

LdapClient

public static interface LdapClient.SearchSpec

The specifications for the LdapClient.search() request.

Since:

3.1

Method Summary

Modifier and Type	Method	Description
default <O extends LdapDataEntry> List<O>	list()	Retrieve the result as a pre-resolved list of mapped objects, retaining the order from the original database result.
default <T> LdapClient.MappedSearchSpec<T>	map(AttributesMapper<T> mapper)	Map each search result to an object using the given AttributesMapper strategy.
default <T> LdapClient.MappedSearchSpec<T>	map(ContextMapper<T> mapper)	Map each search result to an object using the given ContextMapper strategy.
LdapClient.SearchSpec	name(String name)	The name to search for.
LdapClient.SearchSpec	name(Name name)	The name to search for.
default <O extends LdapDataEntry> Optional<O>	optional()	Retrieve a single search result, if available, as an Optional handle.
LdapClient.SearchSpec	query(Consumer<LdapQueryBuilder> consumer)	The no-filter query to execute.
LdapClient.SearchSpec	query(LdapQuery query)	The query to execute.
default <O extends LdapDataEntry> O	single()	Retrieve a single search result as a required LdapDataEntry instance.
default <O extends LdapDataEntry> Stream<O>	stream()	Retrieve the result as a lazily resolved stream of mapped objects, retaining the order from the original database result.
default <O extends LdapDataEntry> @Nullable O	toEntry()	Deprecated.
default <O extends LdapDataEntry> List<O>	toEntryList()	Deprecated.
default <O extends LdapDataEntry> Stream<O>	toEntryStream()	Deprecated.
<O> List<O>	toList(AttributesMapper<O> mapper)	Deprecated. use map(AttributesMapper) with LdapClient.MappedSearchSpec.list()
<O> List<O>	toList(ContextMapper<O> mapper)	Deprecated. use map(ContextMapper) with LdapClient.MappedSearchSpec.list()
<O> @Nullable O	toObject(AttributesMapper<O> mapper)	Deprecated. use map(AttributesMapper) with LdapClient.MappedSearchSpec.optional()
<O> @Nullable O	toObject(ContextMapper<O> mapper)	Deprecated. use map(ContextMapper) with LdapClient.MappedSearchSpec.optional()
<O> Stream<O>	toStream(AttributesMapper<O> mapper)	Deprecated. use map(AttributesMapper) with LdapClient.MappedSearchSpec.stream()
<O> Stream<O>	toStream(ContextMapper<O> mapper)	Deprecated. use map(ContextMapper) with LdapClient.MappedSearchSpec.stream()

Method Details

name

LdapClient.SearchSpec name(String name)

The name to search for. This is a convenience method for creating an LdapQuery based only on the name.

Parameters:

name - the name to search for

Returns:

the LdapClient.SearchSpec for further configuration

name

LdapClient.SearchSpec name(Name name)

The name to search for. This is a convenience method for creating an LdapQuery based only on the name.

Parameters:

name - the name to search for

Returns:

the LdapClient.SearchSpec for further configuration

query

LdapClient.SearchSpec query(Consumer<LdapQueryBuilder> consumer)

The no-filter query to execute. Or, that is, the filter is (objectclass=*).

This is helpful when searching by name and needing to customize the SearchControls or the returned attribute set.

Parameters:

consumer - the consumer to alter a default query

Returns:

the LdapClient.SearchSpec for further configuration

query

LdapClient.SearchSpec query(LdapQuery query)

The query to execute.

Parameters:

query - the query to execute

Returns:

the LdapClient.SearchSpec for further configuration

single

default <O extends LdapDataEntry> O single()

Retrieve a single search result as a required LdapDataEntry instance.

Returns:

the single result object (never null)

Since:

4.1

optional

default <O extends LdapDataEntry> Optional<O> optional()

Retrieve a single search result, if available, as an Optional handle.

Returns:

an Optional handle with a single LdapDataEntry result or none

Since:

4.1

list

default <O extends LdapDataEntry> List<O> list()

Retrieve the result as a pre-resolved list of mapped objects, retaining the order from the original database result.

Returns:

the result as a detached List, containing mapped objects

Since:

4.1

stream

default <O extends LdapDataEntry> Stream<O> stream()

Retrieve the result as a lazily resolved stream of mapped objects, retaining the order from the original database result.

Returns:

the result Stream, containing mapped objects, needing to be closed once fully processed (for example, through a try-with-resources clause)

Since:

4.1

map

default <T> LdapClient.MappedSearchSpec<T> map(ContextMapper<T> mapper)

Map each search result to an object using the given ContextMapper strategy.

Parameters:

mapper - the ContextMapper strategy to use to map each result

Returns:

a LdapClient.MappedSearchSpec for specifying the result cardinality

Since:

4.1

map

default <T> LdapClient.MappedSearchSpec<T> map(AttributesMapper<T> mapper)

Map each search result to an object using the given AttributesMapper strategy.

Parameters:

mapper - the AttributesMapper strategy to use to map each result

Returns:

a LdapClient.MappedSearchSpec for specifying the result cardinality

Since:

4.1

toEntry

@Deprecated(since="4.1.0")
default <O extends LdapDataEntry> @Nullable O toEntry()

Deprecated.

toObject

@Deprecated(since="4.1.0")
<O> @Nullable O toObject(ContextMapper<O> mapper)

Deprecated.

use map(ContextMapper) with LdapClient.MappedSearchSpec.optional()

Expect at most one search result, mapped by the given strategy.

Returns null if no result is found.

Parameters:

mapper - the ContextMapper strategy to use to map the result

Returns:

the single search result, or null if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result

toObject

@Deprecated(since="4.1.0")
<O> @Nullable O toObject(AttributesMapper<O> mapper)

Deprecated.

use map(AttributesMapper) with LdapClient.MappedSearchSpec.optional()

Expect at most one search result, mapped by the given strategy.

Parameters:

mapper - the AttributesMapper strategy to use to map the result

Returns:

the single search result, or null if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result

toEntryList

@Deprecated(since="4.1.0")
default <O extends LdapDataEntry> List<O> toEntryList()

Deprecated.

toList

@Deprecated(since="4.1.0")
<O> List<O> toList(ContextMapper<O> mapper)

Deprecated.

use map(ContextMapper) with LdapClient.MappedSearchSpec.list()

Return a list of search results, each mapped by the given strategy.

Parameters:

mapper - the ContextMapper strategy to use to map the result

Returns:

the single search result, or empty list if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result

toList

@Deprecated(since="4.1.0")
<O> List<O> toList(AttributesMapper<O> mapper)

Deprecated.

use map(AttributesMapper) with LdapClient.MappedSearchSpec.list()

Return a list of search results, each mapped by the given strategy.

Parameters:

mapper - the AttributesMapper strategy to use to map the result

Returns:

the single search result, or empty list if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result

toEntryStream

@Deprecated(since="4.1.0")
default <O extends LdapDataEntry> Stream<O> toEntryStream()

Deprecated.

toStream

@Deprecated(since="4.1.0")
<O> Stream<O> toStream(ContextMapper<O> mapper)

Deprecated.

use map(ContextMapper) with LdapClient.MappedSearchSpec.stream()

Return a stream of search results, each mapped by the given strategy.

Parameters:

mapper - the ContextMapper strategy to use to map the result

Returns:

the single search result, or empty stream if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result

toStream

@Deprecated(since="4.1.0")
<O> Stream<O> toStream(AttributesMapper<O> mapper)

Deprecated.

use map(AttributesMapper) with LdapClient.MappedSearchSpec.stream()

Return a stream of search results, each mapped by the given strategy.

Parameters:

mapper - the AttributesMapper strategy to use to map the result

Returns:

the single search result, or empty stream if none was found

Throws:

org.springframework.dao.IncorrectResultSizeDataAccessException - if the result set contains more than one result