Class TokenAuthenticationProperties
java.lang.Object
org.apereo.cas.configuration.model.support.token.TokenAuthenticationProperties
- All Implemented Interfaces:
Serializable
,CasFeatureModule
@RequiresModule(name="cas-server-support-token-webflow")
public class TokenAuthenticationProperties
extends Object
implements Serializable, CasFeatureModule
This is
TokenAuthenticationProperties
.- Since:
- 5.0.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
CasFeatureModule.FeatureCatalog
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionA 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.Crypto settings.getName()
Name of the authentication handler.int
getOrder()
Order of the authentication handler in the chain.getState()
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.The webflow configuration.boolean
When set to true, will generate a token and store it as an authentication attribute into the single sign-on session.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.Crypto settings.Name of the authentication handler.setOrder
(int order) Order of the authentication handler in the chain.setSsoTokenEnabled
(boolean ssoTokenEnabled) When set to true, will generate a token and store it as an authentication attribute into the single sign-on session.Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.The webflow configuration.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apereo.cas.configuration.features.CasFeatureModule
isDefined, isUndefined
-
Constructor Details
-
TokenAuthenticationProperties
public TokenAuthenticationProperties()
-
-
Method Details
-
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.
-
getCrypto
Crypto settings. -
getWebflow
The webflow configuration. -
getName
Name of the authentication handler. -
getState
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. -
getOrder
public int getOrder()Order of the authentication handler in the chain. -
isSsoTokenEnabled
public boolean isSsoTokenEnabled()When set to true, will generate a token and store it as an authentication attribute into the single sign-on session. This token can be used later on for token-based authentication attempts, and should allow SSO access to the server. -
setCredentialCriteria
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
.
-
setCrypto
public TokenAuthenticationProperties setCrypto(EncryptionOptionalSigningOptionalJwtCryptographyProperties crypto) Crypto settings.- Returns:
this
.
-
setWebflow
The webflow configuration.- Returns:
this
.
-
setName
Name of the authentication handler.- Returns:
this
.
-
setState
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.- Returns:
this
.
-
setOrder
Order of the authentication handler in the chain.- Returns:
this
.
-
setSsoTokenEnabled
When set to true, will generate a token and store it as an authentication attribute into the single sign-on session. This token can be used later on for token-based authentication attempts, and should allow SSO access to the server.- Returns:
this
.
-