Class LdapValidatorProperties

java.lang.Object
org.apereo.cas.configuration.model.support.ldap.LdapValidatorProperties
All Implemented Interfaces:
Serializable

@RequiresModule(name="cas-server-support-ldap") public class LdapValidatorProperties extends Object implements Serializable
Since:
5.3.0
See Also:
  • Constructor Details

    • LdapValidatorProperties

      public LdapValidatorProperties()
  • Method Details

    • getType

      public String getType()
      Determine the LDAP validator type.

      The following LDAP validators can be used to test connection health status:

      • search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
      • none: No validation takes place.
      • compare: Validates a connection is healthy by performing a compare operation.
    • getBaseDn

      public String getBaseDn()
      Base DN to use for the search request of the search validator.
    • getSearchFilter

      public String getSearchFilter()
      Search filter to use for the search request of the search validator.
    • getScope

      public String getScope()
      Search scope to use for the search request of the search validator.
    • getAttributeName

      public String getAttributeName()
      Attribute name to use for the compare validator.
    • getAttributeValue

      public String getAttributeValue()
      Attribute values to use for the compare validator.
    • getDn

      public String getDn()
      DN to compare to use for the compare validator.
    • setType

      public LdapValidatorProperties setType(String type)
      Determine the LDAP validator type.

      The following LDAP validators can be used to test connection health status:

      • search: Validates a connection is healthy by performing a search operation. Validation is considered successful if the search result size is greater than zero.
      • none: No validation takes place.
      • compare: Validates a connection is healthy by performing a compare operation.
      Returns:
      this.
    • setBaseDn

      public LdapValidatorProperties setBaseDn(String baseDn)
      Base DN to use for the search request of the search validator.
      Returns:
      this.
    • setSearchFilter

      public LdapValidatorProperties setSearchFilter(String searchFilter)
      Search filter to use for the search request of the search validator.
      Returns:
      this.
    • setScope

      public LdapValidatorProperties setScope(String scope)
      Search scope to use for the search request of the search validator.
      Returns:
      this.
    • setAttributeName

      public LdapValidatorProperties setAttributeName(String attributeName)
      Attribute name to use for the compare validator.
      Returns:
      this.
    • setAttributeValue

      public LdapValidatorProperties setAttributeValue(String attributeValue)
      Attribute values to use for the compare validator.
      Returns:
      this.
    • setDn

      public LdapValidatorProperties setDn(String dn)
      DN to compare to use for the compare validator.
      Returns:
      this.