Package org.apereo.cas.configuration.model.core.authentication

Class RestPrincipalAttributesProperties

java.lang.Object

org.apereo.cas.configuration.model.BaseRestEndpointProperties

org.apereo.cas.configuration.model.RestEndpointProperties

org.apereo.cas.configuration.model.core.authentication.RestPrincipalAttributesProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-person-directory",
                automated=true)
public class RestPrincipalAttributesProperties
extends RestEndpointProperties

This is RestPrincipalAttributesProperties.

Since:

5.2.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
RestPrincipalAttributesProperties()

Method Summary

Modifier and Type	Method	Description
String	getId()	A value can be assigned to this field to uniquely identify this resolver.
int	getOrder()	The order of this attribute repository in the chain of repositories.
AttributeRepositoryStates	getState()	Whether attribute resolution based on this source is enabled.
String	getUsernameAttribute()	The attribute name that would be used to look up and determine the user id from the query map.
boolean	isCaseInsensitive()	Whether attribute repository should consider the underlying attribute names in a case-insensitive manner.
RestPrincipalAttributesProperties	setCaseInsensitive(boolean caseInsensitive)	Whether attribute repository should consider the underlying attribute names in a case-insensitive manner.
RestPrincipalAttributesProperties	setId(String id)	A value can be assigned to this field to uniquely identify this resolver.
RestPrincipalAttributesProperties	setOrder(int order)	The order of this attribute repository in the chain of repositories.
RestPrincipalAttributesProperties	setState(AttributeRepositoryStates state)	Whether attribute resolution based on this source is enabled.
RestPrincipalAttributesProperties	setUsernameAttribute(String usernameAttribute)	The attribute name that would be used to look up and determine the user id from the query map.

Methods inherited from class org.apereo.cas.configuration.model.RestEndpointProperties

getMethod, setMethod

Methods inherited from class org.apereo.cas.configuration.model.BaseRestEndpointProperties

getBasicAuthPassword, getBasicAuthUsername, getHeaders, getUrl, setBasicAuthPassword, setBasicAuthUsername, setHeaders, setUrl

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

RestPrincipalAttributesProperties

public RestPrincipalAttributesProperties()

Method Details

getOrder

public int getOrder()

The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.

isCaseInsensitive

public boolean isCaseInsensitive()

Whether attribute repository should consider the underlying attribute names in a case-insensitive manner.

getId

public String getId()

A value can be assigned to this field to uniquely identify this resolver.

getUsernameAttribute

public String getUsernameAttribute()

The attribute name that would be used to look up and determine the user id from the query map. The value linked to this attribute would be used as the username or subject by the attribute repository to pass on to the ultimate source to locate the user record.

getState

public AttributeRepositoryStates getState()

Whether attribute resolution based on this source is enabled.

setOrder

public RestPrincipalAttributesProperties setOrder(int order)

The order of this attribute repository in the chain of repositories. Can be used to explicitly position this source in chain and affects merging strategies.

Returns:

this.

setCaseInsensitive

public RestPrincipalAttributesProperties setCaseInsensitive(boolean caseInsensitive)

Whether attribute repository should consider the underlying attribute names in a case-insensitive manner.

Returns:

this.

setId

public RestPrincipalAttributesProperties setId(String id)

A value can be assigned to this field to uniquely identify this resolver.

Returns:

this.

setUsernameAttribute

public RestPrincipalAttributesProperties setUsernameAttribute(String usernameAttribute)

The attribute name that would be used to look up and determine the user id from the query map. The value linked to this attribute would be used as the username or subject by the attribute repository to pass on to the ultimate source to locate the user record.

Returns:

this.

setState

public RestPrincipalAttributesProperties setState(AttributeRepositoryStates state)

Whether attribute resolution based on this source is enabled.

Returns:

this.