io.micronaut.configuration.security.ldap.context

Class DefaultLdapSearchService

java.lang.Object

io.micronaut.configuration.security.ldap.context.DefaultLdapSearchService

All Implemented Interfaces:

LdapSearchService

@Singleton
public class DefaultLdapSearchService
extends java.lang.Object
implements LdapSearchService

Default implementation of LdapSearchService.

Since:

1.0

Author:

James Kleeh

Constructor Summary

Constructors

Constructor and Description
DefaultLdapSearchService()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<LdapSearchResult>	createResults(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> results) Builds LdapSearchResult from the LDAP results.
java.util.List<LdapSearchResult>	search(javax.naming.directory.DirContext managerContext, SearchSettings settings) Searches LDAP with th e given settings and returns a list of results.
java.util.Optional<LdapSearchResult>	searchFirst(javax.naming.directory.DirContext managerContext, SearchSettings settings) Searches LDAP with the given settings and returns an optional result.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DefaultLdapSearchService

public DefaultLdapSearchService()

Method Detail

searchFirst

public java.util.Optional<LdapSearchResult> searchFirst(javax.naming.directory.DirContext managerContext,
                                                        SearchSettings settings)
                                                 throws javax.naming.NamingException

Description copied from interface: LdapSearchService

Searches LDAP with the given settings and returns an optional result.

Specified by:

searchFirst in interface LdapSearchService

Parameters:

managerContext - The context to search with

settings - The settings for searching

Returns:

An optional search result

Throws:

javax.naming.NamingException - If the search fails

search

public java.util.List<LdapSearchResult> search(javax.naming.directory.DirContext managerContext,
                                               SearchSettings settings)
                                        throws javax.naming.NamingException

Description copied from interface: LdapSearchService

Searches LDAP with th e given settings and returns a list of results.

Specified by:

search in interface LdapSearchService

Parameters:

managerContext - The context to search with

settings - The settings for searching

Returns:

A list of results, empty if none found

Throws:

javax.naming.NamingException - If the search fails

createResults

protected java.util.List<LdapSearchResult> createResults(javax.naming.NamingEnumeration<javax.naming.directory.SearchResult> results)
                                                  throws javax.naming.NamingException

Builds LdapSearchResult from the LDAP results.

Parameters:

results - The LDAP results

Returns:

The list of LdapSearchResult

Throws:

javax.naming.NamingException - If an error occurs