public abstract class

AbstractAuthenticationProcessingFilter

extends GenericFilterBean
implements ApplicationEventPublisherAware MessageSourceAware
java.lang.Object
   ↳ org.springframework.web.filter.GenericFilterBean
     ↳ org.springframework.security.web.authentication.AbstractAuthenticationProcessingFilter
Known Direct Subclasses

Class Overview

Abstract processor of browser-based HTTP-based authentication requests.

Authentication Process

The filter requires that you set the authenticationManager property. An AuthenticationManager is required to process the authentication request tokens created by implementing classes.

This filter will intercept a request and attempt to perform authentication from that request if the request URL matches the value of the filterProcessesUrl property. This behaviour can modified by overriding the method requiresAuthentication.

Authentication is performed by the attemptAuthentication method, which must be implemented by subclasses.

Authentication Success

If authentication is successful, the resulting Authentication object will be placed into the SecurityContext for the current thread, which is guaranteed to have already been created by an earlier filter.

The configured AuthenticationSuccessHandler will then be called to take the redirect to the appropriate destination after a successful login. The default behaviour is implemented in a SavedRequestAwareAuthenticationSuccessHandler which will make use of any DefaultSavedRequest set by the ExceptionTranslationFilter and redirect the user to the URL contained therein. Otherwise it will redirect to the webapp root "/". You can customize this behaviour by injecting a differently configured instance of this class, or by using a different implementation.

See the successfulAuthentication method for more information.

Authentication Failure

If authentication fails, it will delegate to the configured AuthenticationFailureHandler to allow the failure information to be conveyed to the client. The default implementation is SimpleUrlAuthenticationFailureHandler, which sends a 401 error code to the client. It may also be configured with a failure URL as an alternative. Again you can inject whatever behaviour you require here.

Event Publication

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

Session Authentication

The class has an optional SessionAuthenticationStrategy which will be invoked immediately after a successful call to attemptAuthentication(). Different implementations can be injected to enable things like session-fixation attack prevention or to control the number of simultaneous sessions a principal may have.

Summary

Constants
String SPRING_SECURITY_LAST_EXCEPTION_KEY This constant is deprecated. Use the value in WebAttributes directly.
Fields
protected AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource
protected ApplicationEventPublisher eventPublisher
protected MessageSourceAccessor messages
[Expand]
Inherited Fields
From class org.springframework.web.filter.GenericFilterBean
Protected Constructors
AbstractAuthenticationProcessingFilter(String defaultFilterProcessesUrl)
Public Methods
void afterPropertiesSet()
abstract Authentication attemptAuthentication(HttpServletRequest request, HttpServletResponse response)
Performs actual authentication.
void doFilter(ServletRequest req, ServletResponse res, FilterChain chain)
Invokes the requiresAuthentication method to determine whether the request is for authentication and should be handled by this filter.
String getFilterProcessesUrl()
RememberMeServices getRememberMeServices()
void setAllowSessionCreation(boolean allowSessionCreation)
void setApplicationEventPublisher(ApplicationEventPublisher eventPublisher)
void setAuthenticationDetailsSource(AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource)
void setAuthenticationFailureHandler(AuthenticationFailureHandler failureHandler)
void setAuthenticationManager(AuthenticationManager authenticationManager)
void setAuthenticationSuccessHandler(AuthenticationSuccessHandler successHandler)
Sets the strategy used to handle a successful authentication.
void setContinueChainBeforeSuccessfulAuthentication(boolean continueChainBeforeSuccessfulAuthentication)
Indicates if the filter chain should be continued prior to delegation to successfulAuthentication(HttpServletRequest, HttpServletResponse, Authentication), which may be useful in certain environment (such as Tapestry applications).
void setFilterProcessesUrl(String filterProcessesUrl)
void setMessageSource(MessageSource messageSource)
void setRememberMeServices(RememberMeServices rememberMeServices)
void setSessionAuthenticationStrategy(SessionAuthenticationStrategy sessionStrategy)
The session handling strategy which will be invoked immediately after an authentication request is successfully processed by the AuthenticationManager.
Protected Methods
boolean getAllowSessionCreation()
AuthenticationManager getAuthenticationManager()
AuthenticationFailureHandler getFailureHandler()
AuthenticationSuccessHandler getSuccessHandler()
boolean requiresAuthentication(HttpServletRequest request, HttpServletResponse response)
Indicates whether this filter should attempt to process a login request for the current invocation.
void successfulAuthentication(HttpServletRequest request, HttpServletResponse response, FilterChain chain, Authentication authResult)
Default behaviour for successful authentication.
void successfulAuthentication(HttpServletRequest request, HttpServletResponse response, Authentication authResult)
This method is deprecated. since 3.1. Use successfulAuthentication(HttpServletRequest, HttpServletResponse, FilterChain, Authentication) instead.
void unsuccessfulAuthentication(HttpServletRequest request, HttpServletResponse response, AuthenticationException failed)
Default behaviour for unsuccessful authentication.
[Expand]
Inherited Methods
From class org.springframework.web.filter.GenericFilterBean
From class java.lang.Object
From interface javax.servlet.Filter
From interface org.springframework.beans.factory.BeanNameAware
From interface org.springframework.beans.factory.DisposableBean
From interface org.springframework.beans.factory.InitializingBean
From interface org.springframework.context.ApplicationEventPublisherAware
From interface org.springframework.context.MessageSourceAware
From interface org.springframework.web.context.ServletContextAware

Constants

public static final String SPRING_SECURITY_LAST_EXCEPTION_KEY

This constant is deprecated.
Use the value in WebAttributes directly.

Constant Value: "SPRING_SECURITY_LAST_EXCEPTION"

Fields

protected AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource

protected ApplicationEventPublisher eventPublisher

protected MessageSourceAccessor messages

Protected Constructors

protected AbstractAuthenticationProcessingFilter (String defaultFilterProcessesUrl)

Parameters
defaultFilterProcessesUrl the default value for filterProcessesUrl.

Public Methods

public void afterPropertiesSet ()

public abstract Authentication attemptAuthentication (HttpServletRequest request, HttpServletResponse response)

Performs actual authentication.

The implementation should do one of the following:

  1. Return a populated authentication token for the authenticated user, indicating successful authentication
  2. Return null, indicating that the authentication process is still in progress. Before returning, the implementation should perform any additional work required to complete the process.
  3. Throw an AuthenticationException if the authentication process fails

Parameters
request from which to extract parameters and perform the authentication
response the response, which may be needed if the implementation has to do a redirect as part of a multi-stage authentication process (such as OpenID).
Returns
  • the authenticated user token, or null if authentication is incomplete.
Throws
AuthenticationException if authentication fails.
IOException
ServletException

public void doFilter (ServletRequest req, ServletResponse res, FilterChain chain)

Invokes the requiresAuthentication method to determine whether the request is for authentication and should be handled by this filter. If it is an authentication request, the attemptAuthentication will be invoked to perform the authentication. There are then three possible outcomes:

  1. An Authentication object is returned. The configured {link SessionAuthenticationStrategy} will be invoked followed by the successfulAuthentication method
  2. An AuthenticationException occurs during authentication. The unsuccessfulAuthentication method will be invoked
  3. Null is returned, indicating that the authentication process is incomplete. The method will then return immediately, assuming that the subclass has done any necessary work (such as redirects) to continue the authentication process. The assumption is that a later request will be received by this method where the returned Authentication object is not null.

Throws
IOException
ServletException

public String getFilterProcessesUrl ()

public RememberMeServices getRememberMeServices ()

public void setAllowSessionCreation (boolean allowSessionCreation)

public void setApplicationEventPublisher (ApplicationEventPublisher eventPublisher)

public void setAuthenticationDetailsSource (AuthenticationDetailsSource<HttpServletRequest, ?> authenticationDetailsSource)

public void setAuthenticationFailureHandler (AuthenticationFailureHandler failureHandler)

public void setAuthenticationManager (AuthenticationManager authenticationManager)

public void setAuthenticationSuccessHandler (AuthenticationSuccessHandler successHandler)

Sets the strategy used to handle a successful authentication. By default a SavedRequestAwareAuthenticationSuccessHandler is used.

public void setContinueChainBeforeSuccessfulAuthentication (boolean continueChainBeforeSuccessfulAuthentication)

Indicates if the filter chain should be continued prior to delegation to successfulAuthentication(HttpServletRequest, HttpServletResponse, Authentication), which may be useful in certain environment (such as Tapestry applications). Defaults to false.

public void setFilterProcessesUrl (String filterProcessesUrl)

public void setMessageSource (MessageSource messageSource)

public void setRememberMeServices (RememberMeServices rememberMeServices)

public void setSessionAuthenticationStrategy (SessionAuthenticationStrategy sessionStrategy)

The session handling strategy which will be invoked immediately after an authentication request is successfully processed by the AuthenticationManager. Used, for example, to handle changing of the session identifier to prevent session fixation attacks.

Parameters
sessionStrategy the implementation to use. If not set a null implementation is used.

Protected Methods

protected boolean getAllowSessionCreation ()

protected AuthenticationManager getAuthenticationManager ()

protected AuthenticationFailureHandler getFailureHandler ()

protected AuthenticationSuccessHandler getSuccessHandler ()

protected boolean requiresAuthentication (HttpServletRequest request, HttpServletResponse response)

Indicates whether this filter should attempt to process a login request for the current invocation.

It strips any parameters from the "path" section of the request URL (such as the jsessionid parameter in http://host/myapp/index.html;jsessionid=blah) before matching against the filterProcessesUrl property.

Subclasses may override for special requirements, such as Tapestry integration.

Returns
  • true if the filter should attempt authentication, false otherwise.

protected void successfulAuthentication (HttpServletRequest request, HttpServletResponse response, FilterChain chain, Authentication authResult)

Default behaviour for successful authentication.

  1. Sets the successful Authentication object on the SecurityContextHolder
  2. Invokes the configured SessionAuthenticationStrategy to handle any session-related behaviour (such as creating a new session to protect against session-fixation attacks).
  3. Informs the configured RememberMeServices of the successful login
  4. Fires an InteractiveAuthenticationSuccessEvent via the configured ApplicationEventPublisher
  5. Delegates additional behaviour to the AuthenticationSuccessHandler.
Subclasses can override this method to continue the FilterChain after successful authentication.

Parameters
authResult the object returned from the attemptAuthentication method.
Throws
IOException
ServletException
IOException

protected void successfulAuthentication (HttpServletRequest request, HttpServletResponse response, Authentication authResult)

This method is deprecated.
since 3.1. Use successfulAuthentication(HttpServletRequest, HttpServletResponse, FilterChain, Authentication) instead.

Default behaviour for successful authentication.

  1. Sets the successful Authentication object on the SecurityContextHolder
  2. Invokes the configured SessionAuthenticationStrategy to handle any session-related behaviour (such as creating a new session to protect against session-fixation attacks).
  3. Informs the configured RememberMeServices of the successful login
  4. Fires an InteractiveAuthenticationSuccessEvent via the configured ApplicationEventPublisher
  5. Delegates additional behaviour to the AuthenticationSuccessHandler.

Parameters
authResult the object returned from the attemptAuthentication method.
Throws
IOException
ServletException

protected void unsuccessfulAuthentication (HttpServletRequest request, HttpServletResponse response, AuthenticationException failed)

Default behaviour for unsuccessful authentication.

  1. Clears the SecurityContextHolder
  2. Stores the exception in the session (if it exists or allowSesssionCreation is set to true)
  3. Informs the configured RememberMeServices of the failed login
  4. Delegates additional behaviour to the AuthenticationFailureHandler.

Throws
IOException
ServletException