org.springframework.security.oauth2.provider.authentication

Class OAuth2AuthenticationProcessingFilter

java.lang.Object

org.springframework.security.oauth2.provider.authentication.OAuth2AuthenticationProcessingFilter

All Implemented Interfaces:

javax.servlet.Filter, org.springframework.beans.factory.InitializingBean

public class OAuth2AuthenticationProcessingFilter
extends Object
implements javax.servlet.Filter, org.springframework.beans.factory.InitializingBean

A pre-authentication filter for OAuth2 protected resources. Extracts an OAuth2 token from the incoming request and uses it to populate the Spring Security context with an OAuth2Authentication (if used in conjunction with an OAuth2AuthenticationManager).

Author:

Dave Syer

Constructor Summary

Constructors

Constructor and Description
OAuth2AuthenticationProcessingFilter()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	destroy()
void	doFilter(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res, javax.servlet.FilterChain chain)
void	init(javax.servlet.FilterConfig filterConfig)
void	setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,?> authenticationDetailsSource)
void	setAuthenticationEntryPoint(org.springframework.security.web.AuthenticationEntryPoint authenticationEntryPoint)
void	setAuthenticationEventPublisher(org.springframework.security.authentication.AuthenticationEventPublisher eventPublisher)
void	setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)
void	setStateless(boolean stateless) Flag to say that this filter guards stateless resources (default true).
void	setTokenExtractor(TokenExtractor tokenExtractor)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2AuthenticationProcessingFilter

public OAuth2AuthenticationProcessingFilter()

Method Detail

setStateless

public void setStateless(boolean stateless)

Flag to say that this filter guards stateless resources (default true). Set this to true if the only way the resource can be accessed is with a token. If false then an incoming cookie can populate the security context and allow access to a caller that isn't an OAuth2 client.

Parameters:

stateless - the flag to set (default true)

setAuthenticationEntryPoint

public void setAuthenticationEntryPoint(org.springframework.security.web.AuthenticationEntryPoint authenticationEntryPoint)

Parameters:

authenticationEntryPoint - the authentication entry point to set

setAuthenticationManager

public void setAuthenticationManager(org.springframework.security.authentication.AuthenticationManager authenticationManager)

Parameters:

authenticationManager - the authentication manager to set (mandatory with no default)

setTokenExtractor

public void setTokenExtractor(TokenExtractor tokenExtractor)

Parameters:

tokenExtractor - the tokenExtractor to set

setAuthenticationEventPublisher

public void setAuthenticationEventPublisher(org.springframework.security.authentication.AuthenticationEventPublisher eventPublisher)

Parameters:

eventPublisher - the event publisher to set

setAuthenticationDetailsSource

public void setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,?> authenticationDetailsSource)

Parameters:

authenticationDetailsSource - The AuthenticationDetailsSource to use

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

doFilter

public void doFilter(javax.servlet.ServletRequest req,
            javax.servlet.ServletResponse res,
            javax.servlet.FilterChain chain)
              throws IOException,
                     javax.servlet.ServletException

Specified by:

doFilter in interface javax.servlet.Filter

Throws:

IOException

javax.servlet.ServletException

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Throws:

javax.servlet.ServletException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Filter