Package io.micronaut.security.ldap.configuration

Class LdapConfiguration.SearchConfiguration

java.lang.Object

io.micronaut.security.ldap.configuration.LdapConfiguration.SearchConfiguration

Enclosing class:

LdapConfiguration

@ConfigurationProperties("search")
public static class LdapConfiguration.SearchConfiguration
extends Object

The user search configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PREFIX	The configuration prefix.

Constructor Summary

Constructors

Constructor	Description
SearchConfiguration()

Method Summary

Modifier and Type	Method	Description
String[]	getAttributes()
String	getBase()
String	getFilter()
SearchSettings	getSettings(Object[] arguments)
boolean	isSubtree()
void	setAttributes(String[] attributes)	Sets the attributes to return.
void	setBase(String base)	Sets the base DN to search.
void	setFilter(String filter)	Sets the search filter.
void	setSubtree(boolean subtree)	Sets if the subtree should be searched.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

The configuration prefix.

See Also:

• Constant Field Values

Constructor Details

SearchConfiguration

public SearchConfiguration()

Method Details

isSubtree

public boolean isSubtree()

Returns:

True if the subtree should be searched

setSubtree

public void setSubtree(boolean subtree)

Sets if the subtree should be searched. Default true

Parameters:

subtree - The subtree

getBase

public String getBase()

Returns:

The base DN to search from

setBase

public void setBase(String base)

Sets the base DN to search.

Parameters:

base - The base DN

getFilter

public String getFilter()

Returns:

The search filter

setFilter

public void setFilter(String filter)

Sets the search filter. Default "(uid={0})"

Parameters:

filter - The search filter

getAttributes

public String[] getAttributes()

Returns:

The attributes to return. Null if all

setAttributes

public void setAttributes(String[] attributes)

Sets the attributes to return. Default all

Parameters:

attributes - The attributes

getSettings

public SearchSettings getSettings(Object[] arguments)

Parameters:

arguments - The search arguments

Returns:

The settings to search for a user