パッケージ org.springframework.security.web.authentication.logout

クラス LogoutFilter

java.lang.ObjectSE
org.springframework.web.filter.GenericFilterBean
org.springframework.security.web.authentication.logout.LogoutFilter
実装されたすべてのインターフェース:
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 LogoutFilter extends org.springframework.web.filter.GenericFilterBean
プリンシパルをログアウトします。

一連の LogoutHandler をポーリングします。ハンドラーは、必要な順序で指定する必要があります。通常は、ログアウトハンドラー TokenBasedRememberMeServices および SecurityContextLogoutHandler を（この順序で）呼び出す必要があります。

ログアウト後、使用されたコンストラクターに応じて、構成された LogoutSuccessHandler または logoutSuccessUrl によって決定された URL にリダイレクトされます。

  • フィールドサマリー

    クラス org.springframework.web.filter.GenericFilterBean から継承されたフィールド

    logger

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    LogoutFilter(StringSE logoutSuccessUrl, LogoutHandler... handlers)
    LogoutFilter(LogoutSuccessHandler logoutSuccessHandler, LogoutHandler... handlers)
    LogoutSuccessHandler インスタンスを取得して、ログアウト後にターゲットの宛先を決定するコンストラクター。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
    protected boolean
    requiresLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    ログアウトが発生するタイミングをサブクラスが変更できるようにします。
    void
    setFilterProcessesUrl(StringSE filterProcessesUrl)
    void
    setLogoutRequestMatcher(RequestMatcher logoutRequestMatcher)
    void
    setSecurityContextHolderStrategy(SecurityContextHolderStrategy securityContextHolderStrategy)
    使用する SecurityContextHolderStrategy を設定します。

    クラス org.springframework.web.filter.GenericFilterBean から継承されたメソッド

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

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

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

    • LogoutFilter

      public LogoutFilter(LogoutSuccessHandler logoutSuccessHandler, LogoutHandler... handlers)
      LogoutSuccessHandler インスタンスを取得して、ログアウト後にターゲットの宛先を決定するコンストラクター。 LogoutHandler のリストは、実際のログアウト機能（セキュリティコンテキストのクリア、セッションの無効化など）を実行することを目的としています。

    • LogoutFilter

      public LogoutFilter(StringSE logoutSuccessUrl, LogoutHandler... handlers)

  • メソッドの詳細

    • doFilter

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

    • requiresLogout

      protected boolean requiresLogout(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      ログアウトが発生するタイミングをサブクラスが変更できるようにします。
      パラメーター:
      request - リクエスト
      response - レスポンス
      戻り値:
      ログアウトが必要な場合は true、それ以外の場合は false 

    • setSecurityContextHolderStrategy

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

    • setLogoutRequestMatcher

      public void setLogoutRequestMatcher(RequestMatcher logoutRequestMatcher)

    • setFilterProcessesUrl

      public void setFilterProcessesUrl(StringSE filterProcessesUrl)