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

Class MongoDbAuthenticationProperties

java.lang.Object

org.apereo.cas.configuration.model.support.mongo.BaseMongoDbProperties

org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties

org.apereo.cas.configuration.model.support.mongo.MongoDbAuthenticationProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-mongo")
public class MongoDbAuthenticationProperties
extends SingleCollectionMongoDbProperties

This is MongoDbAuthenticationProperties.

Since:

5.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
MongoDbAuthenticationProperties()

Method Summary

Modifier and Type	Method	Description
String	getAttributes()	Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).
String	getName()	Name of the authentication handler.
int	getOrder()	Order of authentication handler in chain.
String	getPasswordAttribute()	Attribute that holds the password.
PasswordEncoderProperties	getPasswordEncoder()	Password encoder settings for the authentication handler.
String	getPrincipalIdAttribute()	Attribute that would be used to establish the authenticated profile.
PrincipalTransformationProperties	getPrincipalTransformation()	This is principal transformation properties.
String	getUsernameAttribute()	Attributes that holds the username.
MongoDbAuthenticationProperties	setAttributes(String attributes)	Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).
MongoDbAuthenticationProperties	setName(String name)	Name of the authentication handler.
MongoDbAuthenticationProperties	setOrder(int order)	Order of authentication handler in chain.
MongoDbAuthenticationProperties	setPasswordAttribute(String passwordAttribute)	Attribute that holds the password.
MongoDbAuthenticationProperties	setPasswordEncoder(PasswordEncoderProperties passwordEncoder)	Password encoder settings for the authentication handler.
MongoDbAuthenticationProperties	setPrincipalIdAttribute(String principalIdAttribute)	Attribute that would be used to establish the authenticated profile.
MongoDbAuthenticationProperties	setPrincipalTransformation(PrincipalTransformationProperties principalTransformation)	This is principal transformation properties.
MongoDbAuthenticationProperties	setUsernameAttribute(String usernameAttribute)	Attributes that holds the username.

Methods inherited from class org.apereo.cas.configuration.model.support.mongo.SingleCollectionMongoDbProperties

getCollection, isDropCollection, setCollection, setDropCollection

Methods inherited from class org.apereo.cas.configuration.model.support.mongo.BaseMongoDbProperties

getAuthenticationDatabaseName, getClientUri, getDatabaseName, getHost, getPassword, getPool, getPort, getReadConcern, getReadPreference, getReplicaSet, getTimeout, getUserId, getWriteConcern, isRetryWrites, isSocketKeepAlive, isSslEnabled, setAuthenticationDatabaseName, setClientUri, setDatabaseName, setHost, setPassword, setPool, setPort, setReadConcern, setReadPreference, setReplicaSet, setRetryWrites, setSocketKeepAlive, setSslEnabled, setTimeout, setUserId, setWriteConcern

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

MongoDbAuthenticationProperties

public MongoDbAuthenticationProperties()

Method Details

getAttributes

public String getAttributes()

Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).

getUsernameAttribute

public String getUsernameAttribute()

Attributes that holds the username.

getPasswordAttribute

public String getPasswordAttribute()

Attribute that holds the password.

getPrincipalIdAttribute

public String getPrincipalIdAttribute()

Attribute that would be used to establish the authenticated profile.

getPasswordEncoder

public PasswordEncoderProperties getPasswordEncoder()

Password encoder settings for the authentication handler.

getPrincipalTransformation

public PrincipalTransformationProperties getPrincipalTransformation()

This is principal transformation properties.

getName

public String getName()

Name of the authentication handler.

getOrder

public int getOrder()

Order of authentication handler in chain.

setAttributes

public MongoDbAuthenticationProperties setAttributes(String attributes)

Attributes to fetch from Mongo (blank by default to force the pac4j legacy behavior).

Returns:

this.

setUsernameAttribute

public MongoDbAuthenticationProperties setUsernameAttribute(String usernameAttribute)

Attributes that holds the username.

Returns:

this.

setPasswordAttribute

public MongoDbAuthenticationProperties setPasswordAttribute(String passwordAttribute)

Attribute that holds the password.

Returns:

this.

setPrincipalIdAttribute

public MongoDbAuthenticationProperties setPrincipalIdAttribute(String principalIdAttribute)

Attribute that would be used to establish the authenticated profile.

Returns:

this.

setPasswordEncoder

public MongoDbAuthenticationProperties setPasswordEncoder(PasswordEncoderProperties passwordEncoder)

Password encoder settings for the authentication handler.

Returns:

this.

setPrincipalTransformation

public MongoDbAuthenticationProperties setPrincipalTransformation(PrincipalTransformationProperties principalTransformation)

This is principal transformation properties.

Returns:

this.

setName

public MongoDbAuthenticationProperties setName(String name)

Name of the authentication handler.

Returns:

this.

setOrder

public MongoDbAuthenticationProperties setOrder(int order)

Order of authentication handler in chain.

Returns:

this.