パッケージ org.springframework.security.web.servletapi

クラス SecurityContextHolderAwareRequestFilter

java.lang.ObjectSE
org.springframework.web.filter.GenericFilterBean
org.springframework.security.web.servletapi.SecurityContextHolderAwareRequestFilter
実装されたすべてのインターフェース:
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
public class SecurityContextHolderAwareRequestFilter extends org.springframework.web.filter.GenericFilterBean
ServletRequest に、サーブレット API セキュリティメソッドを実装するリクエストラッパーを設定する Filter。

SecurityContextHolderAwareRequestWrapper は、以下の追加メソッドを提供するように拡張されています。

  • コンストラクターの詳細

    • SecurityContextHolderAwareRequestFilter

      public SecurityContextHolderAwareRequestFilter()

  • メソッドの詳細

    • setSecurityContextRepository

      public void setSecurityContextRepository(SecurityContextRepository securityContextRepository)
      使用する SecurityContextRepository を設定します。デフォルトでは HttpSessionSecurityContextRepository を使用します。
      パラメーター:
      securityContextRepository - 使用する SecurityContextRepository。
      導入:
      6.0

    • setSecurityContextHolderStrategy

      public void setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)
      使用する SecurityContextHolderStrategy を設定します。デフォルトのアクションは、SecurityContextHolder に格納されている SecurityContextHolderStrategy を使用することです。
      導入:
      5.8

    • setRolePrefix

      public void setRolePrefix(StringSE rolePrefix)

    • setAuthenticationEntryPoint

      public void setAuthenticationEntryPoint(AuthenticationEntryPoint authenticationEntryPoint)

      HttpServletRequest を Servlet 3 API と統合するときに使用する AuthenticationEntryPoint を設定します。具体的には、HttpServletRequest.authenticate(HttpServletResponse) が呼び出され、ユーザーが認証されていない場合に使用されます。

      値が null（デフォルト）の場合、HttpServletRequest.authenticate(HttpServletResponse) を呼び出してもデフォルトのコンテナーの動作が保持されます。

      パラメーター:
      authenticationEntryPoint - ユーザーが認証されていない場合に HttpServletRequest.authenticate(HttpServletResponse) を呼び出すときに使用する AuthenticationEntryPoint

    • setAuthenticationManager

      public void setAuthenticationManager(AuthenticationManager authenticationManager)

      HttpServletRequest を Servlet 3 API と統合するときに使用する AuthenticationManager を設定します。具体的には、HttpServletRequest.login(String, String) が呼び出されてユーザーが認証されているかどうかを判別するときに使用されます。

      値が null（デフォルト）の場合、HttpServletRequest.login(String, String) を呼び出したときのデフォルトのコンテナー動作が保持されます。

      パラメーター:
      authenticationManager - HttpServletRequest.login(String, String) を呼び出すときに使用する AuthenticationManager

    • setLogoutHandlers

      public void setLogoutHandlers(ListSE<LogoutHandler> logoutHandlers)

      HttpServletRequest を Servlet 3 API と統合するときに使用する LogoutHandler を設定します。具体的には、ユーザーをログアウトさせるために HttpServletRequest.logout() が呼び出されたときに使用されます。LogoutHandler が HttpServletResponse （予想）をコミットしない限り、ユーザーはレスポンスの処理を担当します。

      値が null（デフォルト）の場合、HttpServletRequest.logout() を呼び出したときのデフォルトのコンテナー動作が保持されます。

      パラメーター:
      logoutHandlers - HttpServletRequest.logout() を呼び出すときの List&lt;LogoutHandler&gt;

    • doFilter

      public void doFilter(jakarta.servlet.ServletRequest req, jakarta.servlet.ServletResponse res, jakarta.servlet.FilterChain chain) throws IOExceptionSE, jakarta.servlet.ServletException
      例外:
      IOExceptionSE
      jakarta.servlet.ServletException

    • afterPropertiesSet

      public void afterPropertiesSet() throws jakarta.servlet.ServletException
      次で指定:
      インターフェース org.springframework.beans.factory.InitializingBean の afterPropertiesSet 
      オーバーライド:
      クラス org.springframework.web.filter.GenericFilterBean の afterPropertiesSet 
      例外:
      jakarta.servlet.ServletException

    • setTrustResolver

      public void setTrustResolver(AuthenticationTrustResolver trustResolver)
      使用する AuthenticationTrustResolver を設定します。デフォルトは AuthenticationTrustResolverImpl です。
      パラメーター:
      trustResolver - 使用する AuthenticationTrustResolver。null にはできません。