org.jasig.cas.client.util
Class AbstractConfigurationFilter

java.lang.Object
  org.jasig.cas.client.util.AbstractConfigurationFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

AbstractCasFilter, HttpServletRequestWrapperFilter, SingleSignOutFilter

public abstract class AbstractConfigurationFilter
extends java.lang.Object
implements javax.servlet.Filter

Abstracts out the ability to configure the filters from the initial properties provided.

Since:

3.1

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

protected org.apache.commons.logging.Log

log

Constructor Summary

AbstractConfigurationFilter()

Method Summary

protected java.lang.String	getPropertyFromInitParams(javax.servlet.FilterConfig filterConfig, java.lang.String propertyName, java.lang.String defaultValue) Retrieves the property from the FilterConfig.
protected boolean	isIgnoreInitConfiguration()
protected java.lang.String	loadFromContext(javax.naming.InitialContext context, java.lang.String path)
protected boolean	parseBoolean(java.lang.String value)
void	setIgnoreInitConfiguration(boolean ignoreInitConfiguration)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.Filter

destroy, doFilter, init

Field Detail

log

protected final org.apache.commons.logging.Log log

Constructor Detail

AbstractConfigurationFilter

public AbstractConfigurationFilter()

Method Detail

getPropertyFromInitParams

protected final java.lang.String getPropertyFromInitParams(javax.servlet.FilterConfig filterConfig,
                                                           java.lang.String propertyName,
                                                           java.lang.String defaultValue)

Retrieves the property from the FilterConfig. First it checks the FilterConfig's initParameters to see if it has a value. If it does, it returns that, otherwise it retrieves the ServletContext's initParameters and returns that value if any.

Finally, it will check JNDI if all other methods fail. All the JNDI properties should be stored under java:comp/env/cas/{propertyName}

Parameters:

filterConfig - the Filter Configuration.

propertyName - the property to retrieve.

defaultValue - the default value if the property is not found.

Returns:

the property value, following the above conventions. It will always return the more specific value (i.e. filter vs. context).

parseBoolean

protected final boolean parseBoolean(java.lang.String value)

loadFromContext

protected final java.lang.String loadFromContext(javax.naming.InitialContext context,
                                                 java.lang.String path)

setIgnoreInitConfiguration

public final void setIgnoreInitConfiguration(boolean ignoreInitConfiguration)

isIgnoreInitConfiguration

protected final boolean isIgnoreInitConfiguration()