org.acegisecurity.ui.rememberme
Class RememberMeProcessingFilter

java.lang.Object
  org.acegisecurity.ui.rememberme.RememberMeProcessingFilter

All Implemented Interfaces:

Filter, InitializingBean, ApplicationEventPublisherAware

public class RememberMeProcessingFilter
extends Object
implements Filter, InitializingBean, ApplicationEventPublisherAware

Detects if there is no Authentication object in the SecurityContext, and populates it with a remember-me authentication token if a RememberMeServices implementation so requests.

Concrete RememberMeServices implementations will have their RememberMeServices.autoLogin(HttpServletRequest, HttpServletResponse) method called by this filter. The Authentication or null returned by that method will be placed into the SecurityContext. The AuthenticationManager will be used, so that any concurrent session management or other authentication-specific behaviour can be achieved. This is the same pattern as with other authentication mechanisms, which call the AuthenticationManager as part of their contract.

If authentication is successful, an InteractiveAuthenticationSuccessEvent will be published to the application context. No events will be published if authentication was unsuccessful, because this would generally be recorded via an AuthenticationManager-specific application event.

Do not use this class directly. Instead configure web.xml to use the FilterToBeanProxy.

Version:

$Id: RememberMeProcessingFilter.java 1496 2006-05-23 13:38:33Z benalex $

Author:

Ben Alex

Constructor Summary

RememberMeProcessingFilter()

Method Summary

void	afterPropertiesSet()
void	destroy() Does nothing - we rely on IoC lifecycle services instead.
void	doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
RememberMeServices	getRememberMeServices()
void	init(FilterConfig ignored) Does nothing - we rely on IoC lifecycle services instead.
void	setApplicationEventPublisher(ApplicationEventPublisher eventPublisher)
void	setAuthenticationManager(AuthenticationManager authenticationManager)
void	setRememberMeServices(RememberMeServices rememberMeServices)

Methods inherited from class java.lang.Object

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

Constructor Detail

RememberMeProcessingFilter

public RememberMeProcessingFilter()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

Exception

destroy

public void destroy()

Does nothing - we rely on IoC lifecycle services instead.

Specified by:

destroy in interface Filter

doFilter

public void doFilter(ServletRequest request,
                     ServletResponse response,
                     FilterChain chain)
              throws IOException,
                     ServletException

Specified by:

doFilter in interface Filter

Throws:

IOException

ServletException

getRememberMeServices

public RememberMeServices getRememberMeServices()

init

public void init(FilterConfig ignored)
          throws ServletException

Does nothing - we rely on IoC lifecycle services instead.

Specified by:

init in interface Filter

Parameters:

ignored - not used

Throws:

ServletException - DOCUMENT ME!

setApplicationEventPublisher

public void setApplicationEventPublisher(ApplicationEventPublisher eventPublisher)

Specified by:

setApplicationEventPublisher in interface ApplicationEventPublisherAware

setAuthenticationManager

public void setAuthenticationManager(AuthenticationManager authenticationManager)

setRememberMeServices

public void setRememberMeServices(RememberMeServices rememberMeServices)