org.jasig.cas.client.configuration
Interface ConfigurationStrategy

All Known Implementing Classes:

BaseConfigurationStrategy, JndiConfigurationStrategyImpl, LegacyConfigurationStrategyImpl, PropertiesConfigurationStrategyImpl, SystemPropertiesConfigurationStrategyImpl, WebXmlConfigurationStrategyImpl

public interface ConfigurationStrategy

Abstraction to allow for pluggable methods for retrieving filter configuration.

Since:

3.4.0

Author:

Scott Battaglia

Method Summary

boolean	getBoolean(ConfigurationKey<Boolean> configurationKey) Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.
<T> Class<? extends T>	getClass(ConfigurationKey<Class<? extends T>> configurationKey) Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.
int	getInt(ConfigurationKey<Integer> configurationKey) Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.
long	getLong(ConfigurationKey<Long> configurationKey) Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.
String	getString(ConfigurationKey<String> configurationKey) Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.
void	init(javax.servlet.FilterConfig filterConfig, Class<? extends javax.servlet.Filter> filterClazz) Initializes the strategy.

Method Detail

getBoolean

boolean getBoolean(ConfigurationKey<Boolean> configurationKey)

Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.

Parameters:

configurationKey - the configuration key. MUST NOT BE NULL.

Returns:

the configured value, or the default value.

getString

String getString(ConfigurationKey<String> configurationKey)

Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.

Parameters:

configurationKey - the configuration key. MUST NOT BE NULL.

Returns:

the configured value, or the default value.

getLong

long getLong(ConfigurationKey<Long> configurationKey)

Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.

Parameters:

configurationKey - the configuration key. MUST NOT BE NULL.

Returns:

the configured value, or the default value.

getInt

int getInt(ConfigurationKey<Integer> configurationKey)

Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.

Parameters:

configurationKey - the configuration key. MUST NOT BE NULL.

Returns:

the configured value, or the default value.

getClass

<T> Class<? extends T> getClass(ConfigurationKey<Class<? extends T>> configurationKey)

Retrieves the value for the provided , falling back to the 's ConfigurationKey.getDefaultValue() if nothing can be found.

Parameters:

configurationKey - the configuration key. MUST NOT BE NULL.

Returns:

the configured value, or the default value.

init

void init(javax.servlet.FilterConfig filterConfig,
          Class<? extends javax.servlet.Filter> filterClazz)

Initializes the strategy. This must be called before calling any of the "get" methods.

Parameters:

filterConfig - the filter configuration object.

filterClazz - the filter