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

Class AbstractLdapSearchProperties

java.lang.Object

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

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

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

AbstractLdapAuthenticationProperties, LdapAcceptableUsagePolicyProperties, LdapConsentProperties, LdapGoogleAuthenticatorMultifactorProperties, LdapGraphicalUserAuthenticationProperties, LdapPasswordManagementProperties, LdapPasswordSynchronizationProperties, LdapPrincipalAttributesProperties, LdapServiceRegistryProperties, LdapThrottleProperties, Pac4jDelegatedAuthenticationLdapProfileSelectionProperties, PasswordlessAuthenticationLdapAccountsProperties, SpnegoLdapProperties, SurrogateLdapAuthenticationProperties, SurrogateSimpleAuthenticationProperties, WebAuthnLdapMultifactorProperties, X509LdapProperties

@RequiresModule(name="cas-server-support-ldap")
public abstract class AbstractLdapSearchProperties
extends AbstractLdapProperties

This is AbstractLdapSearchProperties.

Since:

5.3.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

Constructor Summary

Constructors

Constructor	Description
AbstractLdapSearchProperties()

Method Summary

Modifier and Type	Method	Description
String	getBaseDn()	Base DN to use.
int	getPageSize()	Request that the server return results in batches of a specific size.
List<LdapSearchEntryHandlersProperties>	getSearchEntryHandlers()	Search handlers.
String	getSearchFilter()	User filter to use for searching.
boolean	isSubtreeSearch()	Whether subtree searching is allowed.
AbstractLdapSearchProperties	setBaseDn(String baseDn)	Base DN to use.
AbstractLdapSearchProperties	setPageSize(int pageSize)	Request that the server return results in batches of a specific size.
AbstractLdapSearchProperties	setSearchEntryHandlers(List<LdapSearchEntryHandlersProperties> searchEntryHandlers)	Search handlers.
AbstractLdapSearchProperties	setSearchFilter(String searchFilter)	User filter to use for searching.
AbstractLdapSearchProperties	setSubtreeSearch(boolean subtreeSearch)	Whether subtree searching is allowed.

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

Constructor Details

AbstractLdapSearchProperties

public AbstractLdapSearchProperties()

Method Details

getSearchFilter

public String getSearchFilter()

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.

isSubtreeSearch

public boolean isSubtreeSearch()

Whether subtree searching is allowed.

getPageSize

public int getPageSize()

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

getBaseDn

public String getBaseDn()

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

getSearchEntryHandlers

public List<LdapSearchEntryHandlersProperties> getSearchEntryHandlers()

Search handlers.

setSearchFilter

public AbstractLdapSearchProperties setSearchFilter(String searchFilter)

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.

Returns:

this.

setSubtreeSearch

public AbstractLdapSearchProperties setSubtreeSearch(boolean subtreeSearch)

Whether subtree searching is allowed.

Returns:

this.

setPageSize

public AbstractLdapSearchProperties setPageSize(int pageSize)

Request that the server return results in batches of a specific size. See RFC 2696. This control is often used to work around server result size limits. A negative/zero value disables paged requests.

Returns:

this.

setBaseDn

public AbstractLdapSearchProperties setBaseDn(String baseDn)

Base DN to use. There may be scenarios where different parts of a single LDAP tree could be considered as base-dns. Rather than duplicating the LDAP configuration block for each individual base-dn, each entry can be specified and joined together using a special delimiter character. The user DN is retrieved using the combination of all base-dn and DN resolvers in the order defined. DN resolution should fail if multiple DNs are found. Otherwise the first DN found is returned. Usual syntax is: subtreeA,dc=example,dc=net|subtreeC,dc=example,dc=net.

Returns:

this.

setSearchEntryHandlers

public AbstractLdapSearchProperties setSearchEntryHandlers(List<LdapSearchEntryHandlersProperties> searchEntryHandlers)

Search handlers.

Returns:

this.