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

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

This is AmazonCognitoAuthenticationProperties.

Since:

6.0.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.apereo.cas.configuration.features.CasFeatureModule

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
AmazonCognitoAuthenticationProperties()

Method Summary

Modifier and Type	Method	Description
String	getClientId()	The application client id, created in Cognito without a secret key.
Map<String,String>	getMappedAttributes()	Map of attributes to rename after fetching from the user pool.
String	getName()	The name of the authentication handler.
int	getOrder()	The order of this authentication handler in the chain.
PasswordEncoderProperties	getPasswordEncoder()	Password encoding properties.
PrincipalTransformationProperties	getPrincipalTransformation()	Principal transformation properties.
AuthenticationHandlerStates	getState()	Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
String	getUserPoolId()	The user pool identifiers where accounts may be located.
AmazonCognitoAuthenticationProperties	setClientId(String clientId)	The application client id, created in Cognito without a secret key.
AmazonCognitoAuthenticationProperties	setMappedAttributes(Map<String,String> mappedAttributes)	Map of attributes to rename after fetching from the user pool.
AmazonCognitoAuthenticationProperties	setName(String name)	The name of the authentication handler.
AmazonCognitoAuthenticationProperties	setOrder(int order)	The order of this authentication handler in the chain.
AmazonCognitoAuthenticationProperties	setPasswordEncoder(PasswordEncoderProperties passwordEncoder)	Password encoding properties.
AmazonCognitoAuthenticationProperties	setPrincipalTransformation(PrincipalTransformationProperties principalTransformation)	Principal transformation properties.
AmazonCognitoAuthenticationProperties	setState(AuthenticationHandlerStates state)	Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.
AmazonCognitoAuthenticationProperties	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

public String getName()

The name of the authentication handler.

getOrder

public int getOrder()

The order of this authentication handler in the chain.

getPasswordEncoder

public PasswordEncoderProperties getPasswordEncoder()

Password encoding properties.

getPrincipalTransformation

public PrincipalTransformationProperties getPrincipalTransformation()

Principal transformation properties.

getClientId

public String getClientId()

The application client id, created in Cognito without a secret key.

getUserPoolId

public String getUserPoolId()

The user pool identifiers where accounts may be located.

getMappedAttributes

public Map<String,String> 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

public AuthenticationHandlerStates getState()

Define the scope and state of this authentication handler and the lifecycle in which it can be invoked or activated.

setName

public AmazonCognitoAuthenticationProperties setName(String name)

The name of the authentication handler.

Returns:

this.

setOrder

public AmazonCognitoAuthenticationProperties setOrder(int order)

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

public AmazonCognitoAuthenticationProperties setClientId(String clientId)

The application client id, created in Cognito without a secret key.

Returns:

this.

setUserPoolId

public AmazonCognitoAuthenticationProperties setUserPoolId(String userPoolId)

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

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