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

Class LdapServiceRegistryProperties

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.serviceregistry.LdapServiceRegistryProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

@RequiresModule(name="cas-server-support-ldap-service-registry")
public class LdapServiceRegistryProperties
extends AbstractLdapSearchProperties

This is LdapServiceRegistryProperties.

Since:

5.0.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
LdapServiceRegistryProperties()

Method Summary

Modifier and Type	Method	Description
String	getIdAttribute()	ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier.
String	getLoadFilter()
String	getObjectClass()	Object class used for the registered service entry in LDAP.
String	getSearchFilter()	User filter to use for searching.
String	getServiceDefinitionAttribute()	Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body.
LdapServiceRegistryProperties	setIdAttribute(String idAttribute)	ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier.
LdapServiceRegistryProperties	setLoadFilter(String loadFilter)	The load filter used to load entries by the objectClass.
LdapServiceRegistryProperties	setObjectClass(String objectClass)	Object class used for the registered service entry in LDAP.
LdapServiceRegistryProperties	setServiceDefinitionAttribute(String serviceDefinitionAttribute)	Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body.

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

getBaseDn, getPageSize, getSearchEntryHandlers, 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

LdapServiceRegistryProperties

public LdapServiceRegistryProperties()

Method Details

getSearchFilter

public String getSearchFilter()

Description copied from class: AbstractLdapSearchProperties

User filter to use for searching. Syntax is cn={user} or cn={0}.

You may also provide an external groovy script in the syntax of file:/path/to/GroovyScript.groovy to fully build the final filter template dynamically.

Overrides:

getSearchFilter in class AbstractLdapSearchProperties

getLoadFilter

public String getLoadFilter()

getObjectClass

public String getObjectClass()

Object class used for the registered service entry in LDAP.

getIdAttribute

public String getIdAttribute()

ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier.

getServiceDefinitionAttribute

public String getServiceDefinitionAttribute()

Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body.

setObjectClass

public LdapServiceRegistryProperties setObjectClass(String objectClass)

Object class used for the registered service entry in LDAP.

Returns:

this.

setIdAttribute

public LdapServiceRegistryProperties setIdAttribute(String idAttribute)

ID attribute used for the registered service entry in LDAP to keep track of the service numeric identifier.

Returns:

this.

setServiceDefinitionAttribute

public LdapServiceRegistryProperties setServiceDefinitionAttribute(String serviceDefinitionAttribute)

Service definition attribute used for the registered service entry in LDAP to keep a representation of the service body.

Returns:

this.

setLoadFilter

public LdapServiceRegistryProperties setLoadFilter(String loadFilter)

The load filter used to load entries by the objectClass. This is typically used to load all definitions that might be mapped to a service definition. The search filter used to load entries by the idAttribute. This is typically used to load a specific service definition by its id during search operations.

Returns:

this.