Package 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("groups") public static class LdapConfiguration.GroupConfiguration extends Object implements io.micronaut.core.util.Toggleable
The group configuration.

  • Field Details

  • Constructor Details

    • GroupConfiguration

      public GroupConfiguration()

  • 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 from.
      Parameters:
      base - The base DN

    • getFilter

      public String getFilter()
      Returns:
      The filter used to search for groups

    • setFilter

      public void setFilter(String filter)
      Sets the group search filter. Default "uniquemember={0}"
      Parameters:
      filter - The filter

    • getAttribute

      public String getAttribute()
      Returns:
      Which attribute is the group name

    • setAttribute

      public void setAttribute(String attribute)
      Sets the group attribute name. Default "cn"
      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(Object[] arguments)
      Parameters:
      arguments - The search arguments
      Returns:
      Settings to search ldap groups

    • getFilterAttribute

      public Optional<String> getFilterAttribute()
      The argument to pass to the search filter.
      Returns:
      The name of an attribute in the user

    • setFilterAttribute

      public void setFilterAttribute(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