Package org.apereo.cas.configuration.model.core.authentication

Class PrincipalTransformationProperties

java.lang.Object
org.apereo.cas.configuration.model.core.authentication.PrincipalTransformationProperties
All Implemented Interfaces:
Serializable
@RequiresModule(name="cas-server-core-authentication", automated=true) public class PrincipalTransformationProperties extends Object implements Serializable
This is PrincipalTransformationProperties. Transform the user id prior to executing the authentication sequence. Each authentication strategy in CAS provides settings to properly transform the principal. Refer to the relevant settings for the authentication strategy at hand to learn more.
Since:
5.0.0
See Also:

  • Constructor Details

    • PrincipalTransformationProperties

      public PrincipalTransformationProperties()

  • Method Details

    • getPrefix

      public String getPrefix()
      Prefix to add to the principal id prior to authentication.

    • getSuffix

      public String getSuffix()
      Suffix to add to the principal id prior to authentication.

    • getPattern

      public String getPattern()
      A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.

    • getBlockingPattern

      public String getBlockingPattern()
      A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.

    • getGroovy

      public GroovyPrincipalTransformationProperties getGroovy()
      Transform usernames using a Groovy resource.

    • getCaseConversion

      public PrincipalTransformationProperties.CaseConversion getCaseConversion()
      Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc.

    • setPrefix

      public PrincipalTransformationProperties setPrefix(String prefix)
      Prefix to add to the principal id prior to authentication.
      Returns:
      this.

    • setSuffix

      public PrincipalTransformationProperties setSuffix(String suffix)
      Suffix to add to the principal id prior to authentication.
      Returns:
      this.

    • setPattern

      public PrincipalTransformationProperties setPattern(String pattern)
      A regular expression that will be used against the provided username for username extractions. On a successful match, the first matched group in the pattern will be used as the extracted username.
      Returns:
      this.

    • setBlockingPattern

      public PrincipalTransformationProperties setBlockingPattern(String blockingPattern)
      A regular expression that will be used against the username to match for blocking/forbidden values. If a match is found, an exception will be thrown and principal transformation will fail.
      Returns:
      this.

    • setGroovy

      public PrincipalTransformationProperties setGroovy(GroovyPrincipalTransformationProperties groovy)
      Transform usernames using a Groovy resource.
      Returns:
      this.

    • setCaseConversion

      public PrincipalTransformationProperties setCaseConversion(PrincipalTransformationProperties.CaseConversion caseConversion)
      Indicate whether the principal identifier should be transformed into upper-case, lower-case, etc.
      Returns:
      this.