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

Class SyncopeAuthenticationProperties

java.lang.Object
org.apereo.cas.configuration.model.support.syncope.BaseSyncopeProperties
org.apereo.cas.configuration.model.support.syncope.SyncopeAuthenticationProperties
All Implemented Interfaces:
Serializable, CasFeatureModule
@RequiresModule(name="cas-server-support-syncope-authentication") public class SyncopeAuthenticationProperties extends BaseSyncopeProperties
This is SyncopeAuthenticationProperties.
Since:
5.3.0
See Also:

  • Constructor Details

    • SyncopeAuthenticationProperties

      public SyncopeAuthenticationProperties()

  • Method Details

    • getState

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

    • getName

      public String getName()
      Name of the authentication handler.

    • getOrder

      public int getOrder()
      The order of this authentication handler in the chain.

    • 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.

    • getAttributeMappings

      public Map<String,String> getAttributeMappings()
      Map of attributes that optionally may be used to control the names of the collected attributes from Syncope. If an attribute is provided by Syncope, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention lastLoginDate->lastDate will process the Syncope attribute lastLoginDate and will internally rename that to lastDate. If no mapping is specified, CAS defaults will be used instead. In other words, this settings allows one to virtually rename and remap Syncopen attributes during the authentication event.

    • getPrincipalTransformation

      public PrincipalTransformationProperties getPrincipalTransformation()
      This is principal transformation properties.

    • getProvisioning

      public SyncopePrincipalProvisioningProperties getProvisioning()
      Handling just-in-time provisioning settings.

    • setState

      public SyncopeAuthenticationProperties 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.

    • setName

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

    • setOrder

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

    • setPasswordEncoder

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

    • setCredentialCriteria

      public SyncopeAuthenticationProperties 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.

    • setAttributeMappings

      public SyncopeAuthenticationProperties setAttributeMappings(Map<String,String> attributeMappings)
      Map of attributes that optionally may be used to control the names of the collected attributes from Syncope. If an attribute is provided by Syncope, it can be listed here as the key of the map with a value that should be the name of that attribute as collected and recorded by CAS. For example, the convention lastLoginDate->lastDate will process the Syncope attribute lastLoginDate and will internally rename that to lastDate. If no mapping is specified, CAS defaults will be used instead. In other words, this settings allows one to virtually rename and remap Syncopen attributes during the authentication event.
      Returns:
      this.

    • setPrincipalTransformation

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

    • setProvisioning

      public SyncopeAuthenticationProperties setProvisioning(SyncopePrincipalProvisioningProperties provisioning)
      Handling just-in-time provisioning settings.
      Returns:
      this.