クラス BearerTokenAuthenticationFilter
java.lang.ObjectSE
org.springframework.web.filter.GenericFilterBean
org.springframework.web.filter.OncePerRequestFilter
org.springframework.security.oauth2.server.resource.web.authentication.BearerTokenAuthenticationFilter
- 実装されたすべてのインターフェース:
jakarta.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
- 既知の直属サブクラス
BearerTokenAuthenticationFilter
public class BearerTokenAuthenticationFilter
extends org.springframework.web.filter.OncePerRequestFilter
OAuth 2.0 ベアラートークンを含むリクエストを認証します。このフィルターは、
BearerTokenAuthenticationToken
を認証できる AuthenticationManager
と接続する必要があります。フィールドサマリー
クラス org.springframework.web.filter.OncePerRequestFilter から継承されたフィールド
ALREADY_FILTERED_SUFFIX
クラス org.springframework.web.filter.GenericFilterBean から継承されたフィールド
logger
コンストラクターのサマリー
コンストラクター説明BearerTokenAuthenticationFilter
(AuthenticationManager authenticationManager) 提供されたパラメーターを使用してBearerTokenAuthenticationFilter
を構築しますBearerTokenAuthenticationFilter
(AuthenticationManagerResolver<jakarta.servlet.http.HttpServletRequest> authenticationManagerResolver) 提供されたパラメーターを使用してBearerTokenAuthenticationFilter
を構築しますメソッドのサマリー
修飾子と型メソッド説明protected void
doFilterInternal
(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain) リクエストからベアラートークンを抽出し、認証を試みます。void
setAuthenticationDetailsSource
(AuthenticationDetailsSource<jakarta.servlet.http.HttpServletRequest, ?> authenticationDetailsSource) 使用するAuthenticationDetailsSource
を設定します。void
setAuthenticationEntryPoint
(AuthenticationEntryPoint authenticationEntryPoint) 使用するAuthenticationEntryPoint
を設定します。void
setAuthenticationFailureHandler
(AuthenticationFailureHandler authenticationFailureHandler) 使用するAuthenticationFailureHandler
を設定します。void
setBearerTokenResolver
(BearerTokenResolver bearerTokenResolver) 使用するBearerTokenResolver
を設定します。void
setSecurityContextHolderStrategy
(SecurityContextHolderStrategy securityContextHolderStrategy) 使用するSecurityContextHolderStrategy
を設定します。void
setSecurityContextRepository
(SecurityContextRepository securityContextRepository) 認証が成功したときにSecurityContext
を保存するようにSecurityContextRepository
を設定します。クラス 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
コンストラクターの詳細
BearerTokenAuthenticationFilter
public BearerTokenAuthenticationFilter(AuthenticationManagerResolver<jakarta.servlet.http.HttpServletRequest> authenticationManagerResolver) 提供されたパラメーターを使用してBearerTokenAuthenticationFilter
を構築します- パラメーター:
authenticationManagerResolver
-
BearerTokenAuthenticationFilter
提供されたパラメーターを使用してBearerTokenAuthenticationFilter
を構築します- パラメーター:
authenticationManager
-
メソッドの詳細
doFilterInternal
protected void doFilterInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, jakarta.servlet.FilterChain filterChain) throws jakarta.servlet.ServletException, IOExceptionSE リクエストからベアラートークンを抽出し、認証を試みます。- 次で指定:
- クラス
org.springframework.web.filter.OncePerRequestFilter
のdoFilterInternal
- パラメーター:
request
-response
-filterChain
-- 例外:
jakarta.servlet.ServletException
IOExceptionSE
setSecurityContextHolderStrategy
public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy) 使用するSecurityContextHolderStrategy
を設定します。デフォルトのアクションは、SecurityContextHolder
に格納されているSecurityContextHolderStrategy
を使用することです。- 導入:
- 5.8
setSecurityContextRepository
認証が成功したときにSecurityContext
を保存するようにSecurityContextRepository
を設定します。デフォルトのアクションは、SecurityContext
を保存しないことです。- パラメーター:
securityContextRepository
- 使用するSecurityContextRepository
。null にはできません。
setBearerTokenResolver
使用するBearerTokenResolver
を設定します。デフォルトはDefaultBearerTokenResolver
です。- パラメーター:
bearerTokenResolver
- 使用するBearerTokenResolver
setAuthenticationEntryPoint
使用するAuthenticationEntryPoint
を設定します。デフォルトはBearerTokenAuthenticationEntryPoint
です。- パラメーター:
authenticationEntryPoint
- 使用するAuthenticationEntryPoint
setAuthenticationFailureHandler
public void setAuthenticationFailureHandler(AuthenticationFailureHandler authenticationFailureHandler) 使用するAuthenticationFailureHandler
を設定します。デフォルトの実装はAuthenticationEntryPoint
を呼び出します。- パラメーター:
authenticationFailureHandler
- 使用するAuthenticationFailureHandler
- 導入:
- 5.2
setAuthenticationDetailsSource
public void setAuthenticationDetailsSource(AuthenticationDetailsSource<jakarta.servlet.http.HttpServletRequest, ?> authenticationDetailsSource) 使用するAuthenticationDetailsSource
を設定します。デフォルトはWebAuthenticationDetailsSource
です。- パラメーター:
authenticationDetailsSource
- 使用するAuthenticationConverter
- 導入:
- 5.5