org.jasig.cas.client.authentication

Class AuthenticationFilter

java.lang.Object

org.jasig.cas.client.util.AbstractConfigurationFilter

org.jasig.cas.client.util.AbstractCasFilter

org.jasig.cas.client.authentication.AuthenticationFilter

All Implemented Interfaces:

javax.servlet.Filter

public class AuthenticationFilter
extends AbstractCasFilter

Filter implementation to intercept all requests and attempt to authenticate the user by redirecting them to CAS (unless the user has a ticket).

This filter allows you to specify the following parameters (at either the context-level or the filter-level):

• casServerLoginUrl - the url to log into CAS, i.e. https://cas.rutgers.edu/login
• renew - true/false on whether to use renew or not.
• gateway - true/false on whether to use gateway or not.
• method - the method used by the CAS server to send the user back to the application (redirect or post).

Please see AbstractCasFilter for additional properties.

Since:

3.0

Author:

Scott Battaglia, Misagh Moayyed

Field Summary

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
	AuthenticationFilter()
protected	AuthenticationFilter(Protocol protocol)

Method Summary

Modifier and Type	Method and Description
void	doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain)
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.
void	setCasServerLoginUrl(String casServerLoginUrl)
void	setCasServerUrlPrefix(String casServerUrlPrefix)
void	setGateway(boolean gateway)
void	setGatewayStorage(GatewayResolver gatewayStorage)
void	setIgnoreUrlPatternMatcherStrategyClass(UrlPatternMatcherStrategy ignoreUrlPatternMatcherStrategyClass)
void	setMethod(String method)
void	setRenew(boolean renew)

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

constructServiceUrl, destroy, 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

Constructor Detail

AuthenticationFilter

public AuthenticationFilter()

AuthenticationFilter

protected AuthenticationFilter(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 AbstractCasFilter

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 AbstractCasFilter

doFilter

public final void doFilter(javax.servlet.ServletRequest servletRequest,
                           javax.servlet.ServletResponse servletResponse,
                           javax.servlet.FilterChain filterChain)
                    throws IOException,
                           javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

setRenew

public final void setRenew(boolean renew)

setGateway

public final void setGateway(boolean gateway)

setMethod

public void setMethod(String method)

setCasServerUrlPrefix

public final void setCasServerUrlPrefix(String casServerUrlPrefix)

setCasServerLoginUrl

public final void setCasServerLoginUrl(String casServerLoginUrl)

setGatewayStorage

public final void setGatewayStorage(GatewayResolver gatewayStorage)

setIgnoreUrlPatternMatcherStrategyClass

public final void setIgnoreUrlPatternMatcherStrategyClass(UrlPatternMatcherStrategy ignoreUrlPatternMatcherStrategyClass)