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

Class LdapPrincipalAttributesProperties

java.lang.Object

org.apereo.cas.configuration.model.support.ldap.AbstractLdapProperties

org.apereo.cas.configuration.model.support.ldap.AbstractLdapSearchProperties

org.apereo.cas.configuration.model.support.ldap.LdapPrincipalAttributesProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

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

This is LdapPrincipalAttributesProperties.

Since:

5.2.0

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.apereo.cas.configuration.model.support.ldap.AbstractLdapProperties

AbstractLdapProperties.LdapConnectionPoolPassivator, AbstractLdapProperties.LdapConnectionStrategy, AbstractLdapProperties.LdapHostnameVerifierOptions, AbstractLdapProperties.LdapTrustManagerOptions, AbstractLdapProperties.LdapType

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

CasFeatureModule.FeatureCatalog

Constructor Summary

Constructors

Constructor	Description
LdapPrincipalAttributesProperties()

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getAttributes()	Map of attributes to fetch from the source.
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.
Map<String,String>	getQueryAttributes()	Define a Map of query attribute names to data-layer attribute names to use when building the query.
AttributeRepositoryStates	getState()	Whether attribute resolution based on this source is enabled.
boolean	isUseAllQueryAttributes()	Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.
LdapPrincipalAttributesProperties	setAttributes(Map<String,String> attributes)	Map of attributes to fetch from the source.
LdapPrincipalAttributesProperties	setId(String id)	A value can be assigned to this field to uniquely identify this resolver.
LdapPrincipalAttributesProperties	setOrder(int order)	The order of this attribute repository in the chain of repositories.
LdapPrincipalAttributesProperties	setQueryAttributes(Map<String,String> queryAttributes)	Define a Map of query attribute names to data-layer attribute names to use when building the query.
LdapPrincipalAttributesProperties	setState(AttributeRepositoryStates state)	Whether attribute resolution based on this source is enabled.
LdapPrincipalAttributesProperties	setUseAllQueryAttributes(boolean useAllQueryAttributes)	Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.

Methods inherited from class org.apereo.cas.configuration.model.support.ldap.AbstractLdapSearchProperties

getBaseDn, getPageSize, getSearchEntryHandlers, getSearchFilter, isSubtreeSearch, setBaseDn, setPageSize, setSearchEntryHandlers, setSearchFilter, setSubtreeSearch

Methods inherited from class org.apereo.cas.configuration.model.support.ldap.AbstractLdapProperties

getBinaryAttributes, getBindCredential, getBindDn, getBlockWaitTime, getConnectionStrategy, getConnectTimeout, getHostnameVerifier, getIdleTime, getKeystore, getKeystorePassword, getKeystoreType, getLdapUrl, getMaxPoolSize, getMinPoolSize, getName, getPoolPassivator, getPrunePeriod, getResponseTimeout, getSaslAuthorizationId, getSaslMechanism, getSaslMutualAuth, getSaslQualityOfProtection, getSaslRealm, getSaslSecurityStrength, getTrustCertificates, getTrustManager, getTrustStore, getTrustStorePassword, getTrustStoreType, getValidatePeriod, getValidateTimeout, getValidator, isAllowMultipleDns, isAllowMultipleEntries, isDisablePooling, isFailFast, isFollowReferrals, isUseStartTls, isValidateOnCheckout, isValidatePeriodically, setAllowMultipleDns, setAllowMultipleEntries, setBinaryAttributes, setBindCredential, setBindDn, setBlockWaitTime, setConnectionStrategy, setConnectTimeout, setDisablePooling, setFailFast, setFollowReferrals, setHostnameVerifier, setIdleTime, setKeystore, setKeystorePassword, setKeystoreType, setLdapUrl, setMaxPoolSize, setMinPoolSize, setName, setPoolPassivator, setPrunePeriod, setResponseTimeout, setSaslAuthorizationId, setSaslMechanism, setSaslMutualAuth, setSaslQualityOfProtection, setSaslRealm, setSaslSecurityStrength, setTrustCertificates, setTrustManager, setTrustStore, setTrustStorePassword, setTrustStoreType, setUseStartTls, setValidateOnCheckout, setValidatePeriod, setValidatePeriodically, setValidateTimeout, setValidator

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

LdapPrincipalAttributesProperties

public LdapPrincipalAttributesProperties()

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.

getAttributes

public Map<String,String> getAttributes()

Map of attributes to fetch from the source. 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 data source and the value is the attribute name CAS should use for virtual renames.

Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute.

To fetch and resolve attributes that carry tags/options, such as homePostalAddress;lang-jp consider tagging the mapped attribute as such: affiliation=affiliation;.

Values may be separated by a comma, which allows you to rename the source attribute into multiple CAS attributes. For example mail=mail,email would fetch the mail attribute from the data source and virtually rename it into two CAS attributes: mail and email.

getId

public String getId()

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

getState

public AttributeRepositoryStates getState()

Whether attribute resolution based on this source is enabled.

isUseAllQueryAttributes

public boolean isUseAllQueryAttributes()

Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.

getQueryAttributes

public Map<String,String> getQueryAttributes()

Define a Map of query attribute names to data-layer attribute names to use when building the query. The key is always the name of the query attribute that is defined by CAS and passed internally, and the value is the column/field that should map.

setOrder

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

setAttributes

public LdapPrincipalAttributesProperties setAttributes(Map<String,String> attributes)

Map of attributes to fetch from the source. 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 data source and the value is the attribute name CAS should use for virtual renames.

Attributes may be allowed to be virtually renamed and remapped. The key in the attribute map is the original attribute, and the value should be the virtually-renamed attribute.

To fetch and resolve attributes that carry tags/options, such as homePostalAddress;lang-jp consider tagging the mapped attribute as such: affiliation=affiliation;.

Values may be separated by a comma, which allows you to rename the source attribute into multiple CAS attributes. For example mail=mail,email would fetch the mail attribute from the data source and virtually rename it into two CAS attributes: mail and email.

Returns:

this.

setId

public LdapPrincipalAttributesProperties setId(String id)

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

Returns:

this.

setState

public LdapPrincipalAttributesProperties setState(AttributeRepositoryStates state)

Whether attribute resolution based on this source is enabled.

Returns:

this.

setUseAllQueryAttributes

public LdapPrincipalAttributesProperties setUseAllQueryAttributes(boolean useAllQueryAttributes)

Whether all existing attributes should be passed down to the query builder map and be used in the construction of the filter.

Returns:

this.

setQueryAttributes

public LdapPrincipalAttributesProperties setQueryAttributes(Map<String,String> queryAttributes)

Define a Map of query attribute names to data-layer attribute names to use when building the query. The key is always the name of the query attribute that is defined by CAS and passed internally, and the value is the column/field that should map.

Returns:

this.