org.springframework.security.ui.cas
Class CasProcessingFilterEntryPoint

java.lang.Object
  org.springframework.security.ui.cas.CasProcessingFilterEntryPoint

All Implemented Interfaces:

InitializingBean, AuthenticationEntryPoint

public class CasProcessingFilterEntryPoint
extends Object
implements AuthenticationEntryPoint, InitializingBean

Used by the ExceptionTranslationFilter to commence authentication via the JA-SIG Central Authentication Service (CAS).

The user's browser will be redirected to the JA-SIG CAS enterprise-wide login page. This page is specified by the loginUrl property. Once login is complete, the CAS login page will redirect to the page indicated by the service property. The service is a HTTP URL belonging to the current application. The service URL is monitored by the CasProcessingFilter, which will validate the CAS login was successful.

Version:

$Id$

Author:

Ben Alex, Scott Battaglia

Constructor Summary

CasProcessingFilterEntryPoint()

Method Summary

void	afterPropertiesSet()
void	commence(ServletRequest servletRequest, ServletResponse servletResponse, AuthenticationException authenticationException) Commences an authentication scheme.
String	getLoginUrl() The enterprise-wide CAS login URL.
ServiceProperties	getServiceProperties()
void	setEncodeServiceUrlWithSessionId(boolean encodeServiceUrlWithSessionId)
void	setLoginUrl(String loginUrl)
void	setServiceProperties(ServiceProperties serviceProperties)

Methods inherited from class java.lang.Object

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

Constructor Detail

CasProcessingFilterEntryPoint

public CasProcessingFilterEntryPoint()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

commence

public void commence(ServletRequest servletRequest,
                     ServletResponse servletResponse,
                     AuthenticationException authenticationException)
              throws IOException,
                     ServletException

Description copied from interface: AuthenticationEntryPoint

Commences an authentication scheme.

ExceptionTranslationFilter will populate the HttpSession attribute named AbstractProcessingFilter.SPRING_SECURITY_SAVED_REQUEST_KEY with the requested target URL before calling this method.

Implementations should modify the headers on the ServletResponse as necessary to commence the authentication process.

Specified by:

commence in interface AuthenticationEntryPoint

Parameters:

servletRequest - that resulted in an AuthenticationException

servletResponse - so that the user agent can begin authentication

authenticationException - that caused the invocation

Throws:

IOException

ServletException

getLoginUrl

public String getLoginUrl()

The enterprise-wide CAS login URL. Usually something like https://www.mycompany.com/cas/login.

Returns:

the enterprise-wide CAS login URL

getServiceProperties

public ServiceProperties getServiceProperties()

setLoginUrl

public void setLoginUrl(String loginUrl)

setServiceProperties

public void setServiceProperties(ServiceProperties serviceProperties)

setEncodeServiceUrlWithSessionId

public void setEncodeServiceUrlWithSessionId(boolean encodeServiceUrlWithSessionId)