org.jasig.cas.client.validation

Class Cas20ProxyReceivingTicketValidationFilter

java.lang.Object

org.jasig.cas.client.util.AbstractConfigurationFilter

org.jasig.cas.client.util.AbstractCasFilter

org.jasig.cas.client.validation.AbstractTicketValidationFilter

org.jasig.cas.client.validation.Cas20ProxyReceivingTicketValidationFilter

All Implemented Interfaces:

javax.servlet.Filter

Direct Known Subclasses:

Cas30ProxyReceivingTicketValidationFilter

public class Cas20ProxyReceivingTicketValidationFilter
extends AbstractTicketValidationFilter

Creates either a CAS20ProxyTicketValidator or a CAS20ServiceTicketValidator depending on whether any of the proxy parameters are set.

This filter can also pass additional parameters to the ticket validator. Any init parameter not included in the reserved list RESERVED_INIT_PARAMS.

Since:

3.1

Version:

$Revision$ $Date$

Author:

Scott Battaglia, Brad Cupit (brad [at] lsu {dot} edu)

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<? extends Cas20ProxyTicketValidator>	defaultProxyTicketValidatorClass
protected Class<? extends Cas20ServiceTicketValidator>	defaultServiceTicketValidatorClass

Fields inherited from class org.jasig.cas.client.util.AbstractCasFilter

CONST_CAS_ASSERTION

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

logger

Constructor Summary

Constructors

Modifier	Constructor and Description
	Cas20ProxyReceivingTicketValidationFilter()
protected	Cas20ProxyReceivingTicketValidationFilter(Protocol protocol)

Method Summary

Modifier and Type	Method and Description
void	destroy()
protected TicketValidator	getTicketValidator(javax.servlet.FilterConfig filterConfig) Constructs a Cas20ServiceTicketValidator or a Cas20ProxyTicketValidator based on supplied parameters.
void	init() Initialization method.
protected void	initInternal(javax.servlet.FilterConfig filterConfig) Controls the ordering of filter initialization and checking by defining a method that runs before the init.
protected boolean	preFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain) This processes the ProxyReceptor request before the ticket validation code executes.
void	setMillisBetweenCleanUps(int millisBetweenCleanUps)
void	setProxyGrantingTicketStorage(ProxyGrantingTicketStorage storage)
void	setProxyReceptorUrl(String proxyReceptorUrl)
void	setTimer(Timer timer)
void	setTimerTask(TimerTask timerTask)

Methods inherited from class org.jasig.cas.client.validation.AbstractTicketValidationFilter

doFilter, getHostnameVerifier, getSSLConfig, onFailedValidation, onSuccessfulValidation, setExceptionOnValidationFailure, setRedirectAfterValidation, setTicketValidator, setUseSession

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

constructServiceUrl, getProtocol, init, retrieveTicketFromRequest, setEncodeServiceUrl, setServerName, setService

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

getBoolean, getClass, getInt, getLong, getString, isIgnoreInitConfiguration, setIgnoreInitConfiguration

Methods inherited from class java.lang.Object

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

Field Detail

defaultServiceTicketValidatorClass

protected Class<? extends Cas20ServiceTicketValidator> defaultServiceTicketValidatorClass

defaultProxyTicketValidatorClass

protected Class<? extends Cas20ProxyTicketValidator> defaultProxyTicketValidatorClass

Constructor Detail

Cas20ProxyReceivingTicketValidationFilter

public Cas20ProxyReceivingTicketValidationFilter()

Cas20ProxyReceivingTicketValidationFilter

protected Cas20ProxyReceivingTicketValidationFilter(Protocol protocol)

Method Detail

initInternal

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

Description copied from class: AbstractCasFilter

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

Overrides:

initInternal in class AbstractTicketValidationFilter

Parameters:

filterConfig - the original filter configuration.

Throws:

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

init

public void init()

Description copied from class: AbstractCasFilter

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

Overrides:

init in class AbstractTicketValidationFilter

getTicketValidator

protected final TicketValidator getTicketValidator(javax.servlet.FilterConfig filterConfig)

Constructs a Cas20ServiceTicketValidator or a Cas20ProxyTicketValidator based on supplied parameters.

Overrides:

getTicketValidator in class AbstractTicketValidationFilter

Parameters:

filterConfig - the Filter Configuration object.

Returns:

a fully constructed TicketValidator.

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter

Overrides:

destroy in class AbstractCasFilter

preFilter

protected final boolean preFilter(javax.servlet.ServletRequest servletRequest,
                                  javax.servlet.ServletResponse servletResponse,
                                  javax.servlet.FilterChain filterChain)
                           throws IOException,
                                  javax.servlet.ServletException

This processes the ProxyReceptor request before the ticket validation code executes.

Overrides:

preFilter in class AbstractTicketValidationFilter

Parameters:

servletRequest - The servlet request.

servletResponse - The servlet response.

filterChain - the filter chain.

Returns:

true if processing should continue, false otherwise.

Throws:

IOException - if there is an I/O problem

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

setProxyReceptorUrl

public final void setProxyReceptorUrl(String proxyReceptorUrl)

setProxyGrantingTicketStorage

public void setProxyGrantingTicketStorage(ProxyGrantingTicketStorage storage)

setTimer

public void setTimer(Timer timer)

setTimerTask

public void setTimerTask(TimerTask timerTask)

setMillisBetweenCleanUps

public void setMillisBetweenCleanUps(int millisBetweenCleanUps)