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

Class LdapMonitorProperties

java.lang.Object

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

org.apereo.cas.configuration.model.core.monitor.LdapMonitorProperties

All Implemented Interfaces:

Serializable, CasFeatureModule

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

This is LdapMonitorProperties.

Since:

6.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
LdapMonitorProperties()	Initialize minPoolSize for the monitor to zero.

Method Summary

Modifier and Type	Method	Description
String	getMaxWait()	When monitoring the LDAP connection pool, indicates the amount of time the operation must wait before it times outs and considers the pool in bad shape.
ConnectionPoolingProperties	getPool()	Options that define the thread pool that will ping on the ldap pool.
boolean	isEnabled()	Whether LDAP monitoring should be enabled.
LdapMonitorProperties	setEnabled(boolean enabled)	Whether LDAP monitoring should be enabled.
LdapMonitorProperties	setMaxWait(String maxWait)	When monitoring the LDAP connection pool, indicates the amount of time the operation must wait before it times outs and considers the pool in bad shape.
LdapMonitorProperties	setPool(ConnectionPoolingProperties pool)	Options that define the thread pool that will ping on the ldap pool.

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

LdapMonitorProperties

public LdapMonitorProperties()

Initialize minPoolSize for the monitor to zero. This prevents a bad ldap connection from causing server to fail startup. User can override this default via configuration.

Method Details

getMaxWait

public String getMaxWait()

When monitoring the LDAP connection pool, indicates the amount of time the operation must wait before it times outs and considers the pool in bad shape.

isEnabled

public boolean isEnabled()

Whether LDAP monitoring should be enabled.

getPool

public ConnectionPoolingProperties getPool()

Options that define the thread pool that will ping on the ldap pool.

setMaxWait

public LdapMonitorProperties setMaxWait(String maxWait)

When monitoring the LDAP connection pool, indicates the amount of time the operation must wait before it times outs and considers the pool in bad shape.

Returns:

this.

setEnabled

public LdapMonitorProperties setEnabled(boolean enabled)

Whether LDAP monitoring should be enabled.

Returns:

this.

setPool

public LdapMonitorProperties setPool(ConnectionPoolingProperties pool)

Options that define the thread pool that will ping on the ldap pool.

Returns:

this.