io.micronaut.security.ldap.configuration

Class LdapConfiguration.GroupConfiguration

java.lang.Object

io.micronaut.security.ldap.configuration.LdapConfiguration.GroupConfiguration

All Implemented Interfaces:

io.micronaut.core.util.Toggleable

Enclosing class:

LdapConfiguration

@ConfigurationProperties(value="groups")
public static class LdapConfiguration.GroupConfiguration
extends java.lang.Object
implements io.micronaut.core.util.Toggleable

The group configuration.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
GroupConfiguration()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAttribute()
java.lang.String	getBase()
java.lang.String	getFilter()
java.util.Optional<java.lang.String>	getFilterAttribute() The argument to pass to the search filter.
SearchSettings	getSearchSettings(java.lang.Object[] arguments)
boolean	isEnabled()
boolean	isSubtree()
void	setAttribute(java.lang.String attribute) Sets the group attribute name.
void	setBase(java.lang.String base) Sets the base DN to search from.
void	setEnabled(boolean enabled) Sets if group search is enabled.
void	setFilter(java.lang.String filter) Sets the group search filter.
void	setFilterAttribute(java.lang.String filterAttribute) Sets the name of the user attribute to bind to the group 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 Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

Constructor Detail

GroupConfiguration

public GroupConfiguration()

Method Detail

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

Parameters:

subtree - The subtree

getBase

public java.lang.String getBase()

Returns:

The base DN to search from

setBase

public void setBase(java.lang.String base)

Sets the base DN to search from.

Parameters:

base - The base DN

getFilter

public java.lang.String getFilter()

Returns:

The filter used to search for groups

setFilter

public void setFilter(java.lang.String filter)

Sets the group search filter. Default

Parameters:

filter - The filter

getAttribute

public java.lang.String getAttribute()

Returns:

Which attribute is the group name

setAttribute

public void setAttribute(java.lang.String attribute)

Sets the group attribute name. Default

Parameters:

attribute - The attribute name

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Sets if group search is enabled. Default false

Parameters:

enabled - The enabled setting

getSearchSettings

public SearchSettings getSearchSettings(java.lang.Object[] arguments)

Parameters:

arguments - The search arguments

Returns:

Settings to search ldap groups

getFilterAttribute

public java.util.Optional<java.lang.String> getFilterAttribute()

The argument to pass to the search filter.

Returns:

The name of an attribute in the user

setFilterAttribute

public void setFilterAttribute(java.lang.String filterAttribute)

Sets the name of the user attribute to bind to the group search filter. Defaults to the user's DN.

Parameters:

filterAttribute - The attribute