org.jasig.cas.client.util
Class AbstractCasFilter

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

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

AbstractTicketValidationFilter, AuthenticationFilter

public abstract class AbstractCasFilter
extends AbstractConfigurationFilter

Abstract filter that contains code that is common to all CAS filters.

The following filter options can be configured (either at the context-level or filter-level).

• serverName - the name of the CAS client server, in the format: localhost:8080 or localhost:8443 or localhost or https://localhost:8443
• service - the completely qualified service url, i.e. https://localhost/cas-client/app

Please note that one of the two above parameters must be set.

Since:

3.1

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

static java.lang.String	CONST_CAS_ASSERTION Represents the constant for where the assertion will be located in memory.
protected org.apache.commons.logging.Log	log Instance of commons logging for logging purposes.

Constructor Summary

AbstractCasFilter()

Method Summary

protected java.lang.String	constructServiceUrl(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	destroy()
java.lang.String	getArtifactParameterName()
java.lang.String	getServiceParameterName()
void	init() Initialization method.
void	init(javax.servlet.FilterConfig filterConfig)
protected void	initInternal(javax.servlet.FilterConfig filterConfig) Controls the ordering of filter initialization and checking by defining a method that runs before the init.
void	setArtifactParameterName(java.lang.String artifactParameterName)
void	setEncodeServiceUrl(boolean encodeServiceUrl)
void	setServerName(java.lang.String serverName)
void	setService(java.lang.String service)
void	setServiceParameterName(java.lang.String serviceParameterName)

Methods inherited from class org.jasig.cas.client.util.AbstractConfigurationFilter

getPropertyFromInitParams, isIgnoreInitConfiguration, loadFromContext, parseBoolean, setIgnoreInitConfiguration

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

doFilter

Field Detail

CONST_CAS_ASSERTION

public static final java.lang.String CONST_CAS_ASSERTION

Represents the constant for where the assertion will be located in memory.

See Also:

Constant Field Values

log

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

Instance of commons logging for logging purposes.

Constructor Detail

AbstractCasFilter

public AbstractCasFilter()

Method Detail

init

public final void init(javax.servlet.FilterConfig filterConfig)
                throws javax.servlet.ServletException

Throws:

javax.servlet.ServletException

initInternal

protected void initInternal(javax.servlet.FilterConfig filterConfig)
                     throws javax.servlet.ServletException

Controls the ordering of filter initialization and checking by defining a method that runs before the init.

Parameters:

filterConfig - the original filter configuration.

Throws:

javax.servlet.ServletException - if there is a problem.

init

public void init()

Initialization method. Called by Filter's init method or by Spring. Similar in concept to the InitializingBean interface's afterPropertiesSet();

destroy

public void destroy()

constructServiceUrl

protected final java.lang.String constructServiceUrl(javax.servlet.http.HttpServletRequest request,
                                                     javax.servlet.http.HttpServletResponse response)

setServerName

public final void setServerName(java.lang.String serverName)

setService

public final void setService(java.lang.String service)

setArtifactParameterName

public final void setArtifactParameterName(java.lang.String artifactParameterName)

setServiceParameterName

public final void setServiceParameterName(java.lang.String serviceParameterName)

setEncodeServiceUrl

public final void setEncodeServiceUrl(boolean encodeServiceUrl)

getArtifactParameterName

public final java.lang.String getArtifactParameterName()

getServiceParameterName

public final java.lang.String getServiceParameterName()