Class AmazonCognitoAuthenticationProperties
java.lang.Object
org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties
org.apereo.cas.configuration.model.support.cognito.AmazonCognitoAuthenticationProperties
- All Implemented Interfaces:
Serializable
,CasFeatureModule
@RequiresModule(name="cas-server-support-aws-cognito-authentication")
public class AmazonCognitoAuthenticationProperties
extends BaseAmazonWebServicesProperties
- 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 TypeMethodDescriptionThe application client id, created in Cognito without a secret key.Map of attributes to rename after fetching from the user pool.getName()
The name of the authentication handler.int
getOrder()
The order of this authentication handler in the chain.Password encoding properties.Principal transformation properties.getState()
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.The user pool identifiers where accounts may be located.setClientId
(String clientId) The application client id, created in Cognito without a secret key.setMappedAttributes
(Map<String, String> mappedAttributes) Map of attributes to rename after fetching from the user pool.The name of the authentication handler.setOrder
(int order) The order of this authentication handler in the chain.setPasswordEncoder
(PasswordEncoderProperties passwordEncoder) Password encoding properties.setPrincipalTransformation
(PrincipalTransformationProperties principalTransformation) Principal transformation properties.Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.setUserPoolId
(String userPoolId) The user pool identifiers where accounts may be located.Methods inherited from class org.apereo.cas.configuration.model.support.aws.BaseAmazonWebServicesProperties
getClientExecutionTimeout, getConnectionTimeout, getCredentialAccessKey, getCredentialSecretKey, getEndpoint, getLocalAddress, getMaxConnections, getProfileName, getProfilePath, getProxyHost, getProxyPassword, getProxyUsername, getRegion, getRetryMode, getSocketTimeout, isUseReaper, setClientExecutionTimeout, setConnectionTimeout, setCredentialAccessKey, setCredentialSecretKey, setEndpoint, setLocalAddress, setMaxConnections, setProfileName, setProfilePath, setProxyHost, setProxyPassword, setProxyUsername, setRegion, setRetryMode, setSocketTimeout, setUseReaper
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
-
AmazonCognitoAuthenticationProperties
public AmazonCognitoAuthenticationProperties()
-
-
Method Details
-
getName
The name of the authentication handler. -
getOrder
public int getOrder()The order of this authentication handler in the chain. -
getPasswordEncoder
Password encoding properties. -
getPrincipalTransformation
Principal transformation properties. -
getClientId
The application client id, created in Cognito without a secret key. -
getUserPoolId
The user pool identifiers where accounts may be located. -
getMappedAttributes
Map of attributes to rename after fetching from the user pool. Mapped attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the user pool and the value is the attribute name CAS should use for virtual renames. -
getState
Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated. -
setName
The name of the authentication handler.- Returns:
this
.
-
setOrder
The order of this authentication handler in the chain.- Returns:
this
.
-
setPasswordEncoder
public AmazonCognitoAuthenticationProperties setPasswordEncoder(PasswordEncoderProperties passwordEncoder) Password encoding properties.- Returns:
this
.
-
setPrincipalTransformation
public AmazonCognitoAuthenticationProperties setPrincipalTransformation(PrincipalTransformationProperties principalTransformation) Principal transformation properties.- Returns:
this
.
-
setClientId
The application client id, created in Cognito without a secret key.- Returns:
this
.
-
setUserPoolId
The user pool identifiers where accounts may be located.- Returns:
this
.
-
setMappedAttributes
public AmazonCognitoAuthenticationProperties setMappedAttributes(Map<String, String> mappedAttributes) Map of attributes to rename after fetching from the user pool. Mapped attributes are defined using a key-value structure where CAS allows the attribute name/key to be renamed virtually to a different attribute. The key is the attribute fetched from the user pool and the value is the attribute name CAS should use for virtual renames.- 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
.
-