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

类 OAuth2AuthorizationEndpointFilter

java.lang.Object

org.springframework.web.filter.GenericFilterBean

org.springframework.web.filter.OncePerRequestFilter

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

所有已实现的接口:

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 OAuth2AuthorizationEndpointFilter
extends org.springframework.web.filter.OncePerRequestFilter

A Filter for the OAuth 2.0 Authorization Code Grant, which handles the processing of the OAuth 2.0 Authorization Request (and Consent).

从以下版本开始:

0.0.1

另请参阅:

AuthenticationManager, OAuth2AuthorizationCodeRequestAuthenticationProvider, Section 4.1 Authorization Code Grant, Section 4.1.1 Authorization Request, Section 4.1.2 Authorization Response

字段概要

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

ALREADY_FILTERED_SUFFIX

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

logger

构造器概要

构造器

构造器和说明
OAuth2AuthorizationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager) Constructs an OAuth2AuthorizationEndpointFilter using the provided parameters.
OAuth2AuthorizationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager, java.lang.String authorizationEndpointUri) Constructs an OAuth2AuthorizationEndpointFilter 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 Authorization Request (or Consent) from HttpServletRequest to an instance of OAuth2AuthorizationCodeRequestAuthenticationToken used for authenticating the request.
void	setAuthenticationFailureHandler(org.springframework.security.web.authentication.AuthenticationFailureHandler authenticationFailureHandler) Sets the AuthenticationFailureHandler used for handling an OAuth2AuthorizationCodeRequestAuthenticationException and returning the Error Response.
void	setAuthenticationSuccessHandler(org.springframework.security.web.authentication.AuthenticationSuccessHandler authenticationSuccessHandler) Sets the AuthenticationSuccessHandler used for handling an OAuth2AuthorizationCodeRequestAuthenticationToken and returning the Authorization Response.
void	setConsentPage(java.lang.String consentPage) Specify the URI to redirect Resource Owners to if consent is required.

从类继承的方法 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

构造器详细资料

OAuth2AuthorizationEndpointFilter

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

Constructs an OAuth2AuthorizationEndpointFilter using the provided parameters.

参数:

authenticationManager - the authentication manager

OAuth2AuthorizationEndpointFilter

public OAuth2AuthorizationEndpointFilter(org.springframework.security.authentication.AuthenticationManager authenticationManager,
                                         java.lang.String authorizationEndpointUri)

Constructs an OAuth2AuthorizationEndpointFilter using the provided parameters.

参数:

authenticationManager - the authentication manager

authorizationEndpointUri - the endpoint URI for authorization 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

setAuthenticationConverter

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

Sets the AuthenticationConverter used when attempting to extract an Authorization Request (or Consent) from HttpServletRequest to an instance of OAuth2AuthorizationCodeRequestAuthenticationToken used for authenticating the request.

参数:

authenticationConverter - the AuthenticationConverter used when attempting to extract an Authorization Request (or Consent) from HttpServletRequest

setAuthenticationSuccessHandler

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

Sets the AuthenticationSuccessHandler used for handling an OAuth2AuthorizationCodeRequestAuthenticationToken and returning the Authorization Response.

参数:

authenticationSuccessHandler - the AuthenticationSuccessHandler used for handling an OAuth2AuthorizationCodeRequestAuthenticationToken

setAuthenticationFailureHandler

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

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

参数:

authenticationFailureHandler - the AuthenticationFailureHandler used for handling an OAuth2AuthorizationCodeRequestAuthenticationException

setConsentPage

public void setConsentPage(java.lang.String consentPage)

Specify the URI to redirect Resource Owners to if consent is required. A default consent page will be generated when this attribute is not specified.

参数:

consentPage - the URI of the custom consent page to redirect to if consent is required (e.g. "/oauth2/consent")