Package org.apereo.cas.configuration.model.support.ldap

Class LdapAuthorizationProperties

java.lang.Object
org.apereo.cas.configuration.model.support.ldap.LdapAuthorizationProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-support-ldap") public class LdapAuthorizationProperties extends Object implements Serializable
This is LdapAuthorizationProperties.
Since:
5.0.0
See Also:

  • Field Details

  • Constructor Details

    • LdapAuthorizationProperties

      public LdapAuthorizationProperties()

  • Method Details

    • getRoleAttribute

      public String getRoleAttribute()
      Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with rolePrefix. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute.

    • getRolePrefix

      public String getRolePrefix()
      Prefix for the role.

    • isAllowMultipleResults

      public boolean isAllowMultipleResults()
      Indicate whether the LDAP search query is allowed to return multiple entries.

    • getGroupAttribute

      public String getGroupAttribute()
      Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with groupPrefix. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group.

    • getGroupPrefix

      public String getGroupPrefix()
      A prefix that is prepended to the group attribute value to construct an authorized role.

    • getGroupFilter

      public String getGroupFilter()
      Search filter to begin looking for groups.

    • getGroupBaseDn

      public String getGroupBaseDn()
      Base DN to start the search looking for groups.

    • getBaseDn

      public String getBaseDn()
      Base DN to start the search.

    • getSearchFilter

      public String getSearchFilter()
      LDAP search filter to locate accounts.

    • setRoleAttribute

      public LdapAuthorizationProperties setRoleAttribute(String roleAttribute)
      Attribute expected to be found on the entry whose value is going to be used to construct roles. The final value is always prefixed with rolePrefix. This is useful in scenarios where you wish to grant access to a resource to all users who carry a special attribute.
      Returns:
      this.

    • setRolePrefix

      public LdapAuthorizationProperties setRolePrefix(String rolePrefix)
      Prefix for the role.
      Returns:
      this.

    • setAllowMultipleResults

      public LdapAuthorizationProperties setAllowMultipleResults(boolean allowMultipleResults)
      Indicate whether the LDAP search query is allowed to return multiple entries.
      Returns:
      this.

    • setGroupAttribute

      public LdapAuthorizationProperties setGroupAttribute(String groupAttribute)
      Attribute expected to be found on the entry resulting from the group search whose value is going to be used to construct roles. The final value is always prefixed with groupPrefix. This is useful in scenarios where you wish to grant access to a resource to all users who a member of a given group.
      Returns:
      this.

    • setGroupPrefix

      public LdapAuthorizationProperties setGroupPrefix(String groupPrefix)
      A prefix that is prepended to the group attribute value to construct an authorized role.
      Returns:
      this.

    • setGroupFilter

      public LdapAuthorizationProperties setGroupFilter(String groupFilter)
      Search filter to begin looking for groups.
      Returns:
      this.

    • setGroupBaseDn

      public LdapAuthorizationProperties setGroupBaseDn(String groupBaseDn)
      Base DN to start the search looking for groups.
      Returns:
      this.

    • setBaseDn

      public LdapAuthorizationProperties setBaseDn(String baseDn)
      Base DN to start the search.
      Returns:
      this.

    • setSearchFilter

      public LdapAuthorizationProperties setSearchFilter(String searchFilter)
      LDAP search filter to locate accounts.
      Returns:
      this.