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

Class AcceptAuthenticationProperties

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

  • Constructor Details

    • AcceptAuthenticationProperties

      public AcceptAuthenticationProperties()

  • Method Details

    • isEnabled

      public boolean isEnabled()
      Indicates whether the authentication strategy is enabled. The strategy may also be disabled explicitly if the users is left blank.

    • getUsers

      public String getUsers()
      Accepted users for authentication, in the syntax of uid::password.

    • getOrder

      public int getOrder()
      Order of the authentication handler in the chain.

    • getName

      public String getName()
      Name of the authentication handler.

    • getPasswordEncoder

      public PasswordEncoderProperties getPasswordEncoder()
      Password encoder settings for the authentication handler.

    • getCredentialCriteria

      public String getCredentialCriteria()
      A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
      • 1) A regular expression pattern that is tested against the credential identifier.
      • 2) A fully qualified class name of your own design that implements Predicate.
      • 3) Path to an external Groovy script that implements the same interface.

    • getPrincipalTransformation

      public PrincipalTransformationProperties getPrincipalTransformation()
      This is principal transformation properties.

    • getPasswordPolicy

      public PasswordPolicyProperties getPasswordPolicy()
      Password policy settings.

    • getState

      public AuthenticationHandlerStates getState()
      Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.

    • setEnabled

      public AcceptAuthenticationProperties setEnabled(boolean enabled)
      Indicates whether the authentication strategy is enabled. The strategy may also be disabled explicitly if the users is left blank.
      Returns:
      this.

    • setUsers

      public AcceptAuthenticationProperties setUsers(String users)
      Accepted users for authentication, in the syntax of uid::password.
      Returns:
      this.

    • setOrder

      public AcceptAuthenticationProperties setOrder(int order)
      Order of the authentication handler in the chain.
      Returns:
      this.

    • setName

      public AcceptAuthenticationProperties setName(String name)
      Name of the authentication handler.
      Returns:
      this.

    • setPasswordEncoder

      public AcceptAuthenticationProperties setPasswordEncoder(PasswordEncoderProperties passwordEncoder)
      Password encoder settings for the authentication handler.
      Returns:
      this.

    • setCredentialCriteria

      public AcceptAuthenticationProperties setCredentialCriteria(String credentialCriteria)
      A number of authentication handlers are allowed to determine whether they can operate on the provided credential and as such lend themselves to be tried and tested during the authentication handler selection phase. The credential criteria may be one of the following options:
      • 1) A regular expression pattern that is tested against the credential identifier.
      • 2) A fully qualified class name of your own design that implements Predicate.
      • 3) Path to an external Groovy script that implements the same interface.
      Returns:
      this.

    • setPrincipalTransformation

      public AcceptAuthenticationProperties setPrincipalTransformation(PrincipalTransformationProperties principalTransformation)
      This is principal transformation properties.
      Returns:
      this.

    • setPasswordPolicy

      public AcceptAuthenticationProperties setPasswordPolicy(PasswordPolicyProperties passwordPolicy)
      Password policy settings.
      Returns:
      this.

    • setState

      public AcceptAuthenticationProperties setState(AuthenticationHandlerStates state)
      Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
      Returns:
      this.