Package io.micronaut.security.ldap.configuration

Class LdapConfiguration

java.lang.Object

io.micronaut.security.ldap.configuration.LdapConfiguration

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

@EachProperty(value="micronaut.security.ldap",
              primary="default")
public class LdapConfiguration
extends Object
implements io.micronaut.core.util.Toggleable

Configuration for LDAP authentication.

Since:

1.0

Author:

James Kleeh

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LdapConfiguration.ContextConfiguration	The context configuration.
static class	LdapConfiguration.GroupConfiguration	The group configuration.
static class	LdapConfiguration.SearchConfiguration	The user search configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_ENABLED	The default enable value.
static final String	PREFIX

Method Summary

Modifier and Type	Method	Description
LdapConfiguration.ContextConfiguration	getContext()
LdapConfiguration.GroupConfiguration	getGroups()
ContextSettings	getManagerSettings()
String	getName()
LdapConfiguration.SearchConfiguration	getSearch()
ContextSettings	getSettings(String dn, String password)	Returns settings for creating a context for a given dn and password.
boolean	isEnabled()
void	setContext(LdapConfiguration.ContextConfiguration contextConfiguration)	Sets the context configuration.
void	setEnabled(boolean enabled)	Sets whether this configuration is enabled.
void	setGroups(LdapConfiguration.GroupConfiguration groupConfiguration)	Sets the group configuration.
void	setSearch(LdapConfiguration.SearchConfiguration searchConfiguration)	Sets the search configuration.

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

See Also:

• Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

• Constant Field Values

Method Details

getName

public String getName()

Returns:

The name of the configuration

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Sets whether this configuration is enabled. Default true.

Parameters:

enabled - The enabled setting

getContext

public LdapConfiguration.ContextConfiguration getContext()

Returns:

The context configuration

setContext

public void setContext(LdapConfiguration.ContextConfiguration contextConfiguration)

Sets the context configuration.

Parameters:

contextConfiguration - The context configuration

getSearch

public LdapConfiguration.SearchConfiguration getSearch()

Returns:

The search configuration

setSearch

public void setSearch(LdapConfiguration.SearchConfiguration searchConfiguration)

Sets the search configuration.

Parameters:

searchConfiguration - The search configuration

getGroups

public LdapConfiguration.GroupConfiguration getGroups()

Returns:

The group configuration

setGroups

public void setGroups(LdapConfiguration.GroupConfiguration groupConfiguration)

Sets the group configuration.

Parameters:

groupConfiguration - The group configuration

getSettings

public ContextSettings getSettings(String dn,
 String password)

Returns settings for creating a context for a given dn and password.

Parameters:

dn - The user dn to bind with

password - The user password to bind with

Returns:

Settings to use to create a context

getManagerSettings

public ContextSettings getManagerSettings()

Returns:

Settings for creating a context for the manager.