org.springframework.security.oauth2.server.authorization.web

类 OAuth2TokenEndpointFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

org.springframework.security.oauth2.server.authorization.web.OAuth2TokenEndpointFilter

所有已实现的接口:

javax.servlet.Filter, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean, org.springframework.context.EnvironmentAware, org.springframework.core.env.EnvironmentCapable, org.springframework.web.context.ServletContextAware

public final class OAuth2TokenEndpointFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter for the OAuth 2.0 Token endpoint, which handles the processing of an OAuth 2.0 Authorization Grant.

It converts the OAuth 2.0 Authorization Grant request to an Authentication, which is then authenticated by the AuthenticationManager. If the authentication succeeds, the AuthenticationManager returns an OAuth2AccessTokenAuthenticationToken, which is returned in the OAuth 2.0 Access Token response. In case of any error, an OAuth2Error is returned in the OAuth 2.0 Error response.

By default, this Filter responds to authorization grant requests at the URI /oauth2/token and HttpMethod POST.

The default endpoint URI /oauth2/token may be overridden via the constructor OAuth2TokenEndpointFilter(AuthenticationManager, String).

从以下版本开始:

0.0.1

另请参阅:

AuthenticationManager, OAuth2AuthorizationCodeAuthenticationProvider, OAuth2RefreshTokenAuthenticationProvider, OAuth2ClientCredentialsAuthenticationProvider, Section 3.2 Token Endpoint

字段概要

从类继承的字段 org.springframework.web.filter.OncePerRequestFilter

ALREADY_FILTERED_SUFFIX

从类继承的字段 org.springframework.web.filter.GenericFilterBean

logger

构造器概要

构造器

构造器和说明
OAuth2TokenEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager) Constructs an OAuth2TokenEndpointFilter using the provided parameters.
OAuth2TokenEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, java.lang.String tokenEndpointUri) Constructs an OAuth2TokenEndpointFilter using the provided parameters.

方法概要

限定符和类型	方法和说明
protected void	doFilterInternal(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.FilterChain filterChain)
void	setAuthenticationConverter(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter) Sets the AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest to an instance of OAuth2AuthorizationGrantAuthenticationToken used for authenticating the authorization grant.
void	setAuthenticationDetailsSource(org.springframework.security.authentication.AuthenticationDetailsSource<javax.servlet.http.HttpServletRequest,?> authenticationDetailsSource) Sets the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest.
void	setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.
void	setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken and returning the Access Token Response.

从类继承的方法 org.springframework.web.filter.OncePerRequestFilter

doFilter, doFilterNestedErrorDispatch, getAlreadyFilteredAttributeName, isAsyncDispatch, isAsyncStarted, shouldNotFilter, shouldNotFilterAsyncDispatch, shouldNotFilterErrorDispatch

从类继承的方法 org.springframework.web.filter.GenericFilterBean

addRequiredProperty, afterPropertiesSet, createEnvironment, destroy, getEnvironment, getFilterConfig, getFilterName, getServletContext, init, initBeanWrapper, initFilterBean, setBeanName, setEnvironment, setServletContext

从类继承的方法 java.lang.Object

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

构造器详细资料

OAuth2TokenEndpointFilter

public OAuth2TokenEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager)

Constructs an OAuth2TokenEndpointFilter using the provided parameters.

参数:

authenticationManager - the authentication manager

OAuth2TokenEndpointFilter

public OAuth2TokenEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager,
                                 java.lang.String tokenEndpointUri)

Constructs an OAuth2TokenEndpointFilter using the provided parameters.

参数:

authenticationManager - the authentication manager

tokenEndpointUri - the endpoint URI for access token requests

方法详细资料

doFilterInternal

protected void doFilterInternal(javax.servlet.http.HttpServletRequest request,
                                javax.servlet.http.HttpServletResponse response,
                                javax.servlet.FilterChain filterChain)
                         throws javax.servlet.ServletException,
                                java.io.IOException

指定者:

doFilterInternal 在类中 org.springframework.web.filter.OncePerRequestFilter

抛出:

javax.servlet.ServletException

java.io.IOException

setAuthenticationDetailsSource

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

Sets the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest.

参数:

authenticationDetailsSource - the AuthenticationDetailsSource used for building an authentication details instance from HttpServletRequest

setAuthenticationConverter

public void setAuthenticationConverter(org.springframework.security.web.authentication.AuthenticationConverter authenticationConverter)

Sets the AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest to an instance of OAuth2AuthorizationGrantAuthenticationToken used for authenticating the authorization grant.

参数:

authenticationConverter - the AuthenticationConverter used when attempting to extract an Access Token Request from HttpServletRequest

setAuthenticationSuccessHandler

public void setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler)

Sets the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken and returning the Access Token Response.

参数:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an OAuth2AccessTokenAuthenticationToken

setAuthenticationFailureHandler

public void setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler)

Sets the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException and returning the Error Response.

参数:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthenticationException