Class BaseJdbcAuthenticationProperties
java.lang.Object
org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties
org.apereo.cas.configuration.model.support.jdbc.authn.BaseJdbcAuthenticationProperties
- All Implemented Interfaces:
Serializable
,CasFeatureModule
- Direct Known Subclasses:
BindJdbcAuthenticationProperties
,QueryEncodeJdbcAuthenticationProperties
,QueryJdbcAuthenticationProperties
,SearchJdbcAuthenticationProperties
@RequiresModule(name="cas-server-support-jdbc-authentication")
public abstract class BaseJdbcAuthenticationProperties
extends AbstractJpaProperties
This is
BaseJdbcAuthenticationProperties
.- Since:
- 6.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.getName()
Name of the authentication handler.int
getOrder()
Order of the authentication handler in the chain.Password encoding strategies for this authentication.List of column names to fetch as user attributes.Principal transformation settings for this authentication.getState()
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.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.Name of the authentication handler.setOrder
(int order) Order of the authentication handler in the chain.setPasswordEncoder
(PasswordEncoderProperties passwordEncoder) Password encoding strategies for this authentication.setPrincipalAttributeList
(List<String> principalAttributeList) List of column names to fetch as user attributes.setPrincipalTransformation
(PrincipalTransformationProperties principalTransformation) Principal transformation settings for this authentication.Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.Methods inherited from class org.apereo.cas.configuration.model.support.jpa.AbstractJpaProperties
getBatchSize, getDataSourceName, getDdlAuto, getDefaultCatalog, getDefaultSchema, getDialect, getDriverClass, getFailFastTimeout, getFetchSize, getHealthQuery, getIdleTimeout, getIsolationLevelName, getLeakThreshold, getPassword, getPhysicalNamingStrategyClassName, getPool, getPropagationBehaviorName, getProperties, getUrl, getUser, isAutocommit, isGenerateStatistics, isIsolateInternalQueries, isReadOnly, setAutocommit, setBatchSize, setDataSourceName, setDdlAuto, setDefaultCatalog, setDefaultSchema, setDialect, setDriverClass, setFailFastTimeout, setFetchSize, setGenerateStatistics, setHealthQuery, setIdleTimeout, setIsolateInternalQueries, setIsolationLevelName, setLeakThreshold, setPassword, setPhysicalNamingStrategyClassName, setPool, setPropagationBehaviorName, setProperties, setReadOnly, setUrl, setUser
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
-
BaseJdbcAuthenticationProperties
public BaseJdbcAuthenticationProperties()
-
-
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.
-
getPrincipalTransformation
Principal transformation settings for this authentication. -
getPasswordEncoder
Password encoding strategies for this authentication. -
getName
Name of the authentication handler. -
getOrder
public 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. -
getPrincipalAttributeList
List of column names to fetch as user attributes. This is only effective in scenarios where the JDBC authentication method is able to execute a SQL query against a database table and return results. Authentication methods that merely check for the user account's existence or verify the user with just a simple bind are not able to fetch attributes.Attributes name are separated by a comma and may use a "directed list" syntax where the allowed syntax would be
column-name->cas-attribute
. -
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
.
-
setPrincipalTransformation
public BaseJdbcAuthenticationProperties setPrincipalTransformation(PrincipalTransformationProperties principalTransformation) Principal transformation settings for this authentication.- Returns:
this
.
-
setPasswordEncoder
public BaseJdbcAuthenticationProperties setPasswordEncoder(PasswordEncoderProperties passwordEncoder) Password encoding strategies for this authentication.- Returns:
this
.
-
setName
Name of the authentication handler.- Returns:
this
.
-
setOrder
Order of the authentication handler in the chain.- 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
.
-
setPrincipalAttributeList
public BaseJdbcAuthenticationProperties setPrincipalAttributeList(List<String> principalAttributeList) List of column names to fetch as user attributes. This is only effective in scenarios where the JDBC authentication method is able to execute a SQL query against a database table and return results. Authentication methods that merely check for the user account's existence or verify the user with just a simple bind are not able to fetch attributes.Attributes name are separated by a comma and may use a "directed list" syntax where the allowed syntax would be
column-name->cas-attribute
.- Returns:
this
.
-