クラス LogoutConfigurer<H extends HttpSecurityBuilder<H>>

メソッドの詳細

• addLogoutHandler

  public LogoutConfigurer<H> addLogoutHandler(LogoutHandler logoutHandler)

  LogoutHandler を追加します。SecurityContextLogoutHandler および LogoutSuccessEventPublishingLogoutHandler は、デフォルトで最後の LogoutHandler インスタンスとして追加されます。

  パラメーター:

  logoutHandler - 追加する LogoutHandler

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• clearAuthentication

  public LogoutConfigurer<H> clearAuthentication(boolean clearAuthentication)

  SecurityContextLogoutHandler がログアウト時に Authentication をクリアするかどうかを指定します。

  パラメーター:

  clearAuthentication - true SecurityContextLogoutHandler は Authentication（デフォルト）をクリアする必要があり、そうでない場合は false です。

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• invalidateHttpSession

  public LogoutConfigurer<H> invalidateHttpSession(boolean invalidateHttpSession)

  SecurityContextLogoutHandler を構成して、ログアウト時に HttpSession を無効にします。

  パラメーター:

  invalidateHttpSession - HttpSession を無効にする必要がある場合は true（デフォルト）、そうでない場合は false。

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• logoutUrl

  public LogoutConfigurer<H> logoutUrl(StringSE logoutUrl)

  ログアウトをトリガーする URL（デフォルトは "/logout"）。CSRF 保護が有効になっている場合（デフォルト）、リクエストも POST である必要があります。これは、デフォルトでログアウトをトリガーするために POST "/logout" が必要であることを意味します。CSRF 保護が無効になっている場合、任意の HTTP メソッドが許可されます。

  CSRF 攻撃から保護するために、状態を変更する（ログアウトする）アクションで HTTP POST を使用することをお勧めします。本当に HTTP GET を使用したい場合は、logoutRequestMatcher(PathPatternRequestMatcher.withDefaults().matcher(HttpMethod.GEt, logoutUrl)); を使用できます

  パラメーター:

  logoutUrl - ログアウトを呼び出す URL。

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

  関連事項:

  • logoutRequestMatcher(RequestMatcher)
  • HttpSecurity.csrf()

• logoutRequestMatcher

  public LogoutConfigurer<H> logoutRequestMatcher(RequestMatcher logoutRequestMatcher)

  ログアウトをトリガーする RequestMatcher。ほとんどの場合、ユーザーは logoutUrl(String) を使用します。これは、優れたプラクティスの実施に役立ちます。

  パラメーター:

  logoutRequestMatcher - ログアウトが発生するかどうかを判断するために使用される RequestMatcher

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

  関連事項:

  • logoutUrl(String)

• logoutSuccessUrl

  public LogoutConfigurer<H> logoutSuccessUrl(StringSE logoutSuccessUrl)

  ログアウトが発生した後にリダイレクトする URL。デフォルトは "/login?logout" です。これは、SimpleUrlLogoutSuccessHandler を使用して logoutSuccessHandler(LogoutSuccessHandler) を呼び出すためのショートカットです。

  パラメーター:

  logoutSuccessUrl - ログアウト後にリダイレクトする URL

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• permitAll

  public LogoutConfigurer<H> permitAll()

  true を引数として使用する permitAll(boolean) のショートカット。

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• deleteCookies

  public LogoutConfigurer<H> deleteCookies(StringSE... cookieNamesToClear)

  ログアウトの成功時に削除する Cookie の名前を指定できます。これは、addLogoutHandler(LogoutHandler) を CookieClearingLogoutHandler で簡単に呼び出すためのショートカットです。

  パラメーター:

  cookieNamesToClear - ログアウトの成功時に削除される Cookie の名前。

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• logoutSuccessHandler

  public LogoutConfigurer<H> logoutSuccessHandler(LogoutSuccessHandler logoutSuccessHandler)

  使用する LogoutSuccessHandler を設定します。これが指定されている場合、logoutSuccessUrl(String) は無視されます。

  パラメーター:

  logoutSuccessHandler - ユーザーがログアウトした後に使用する LogoutSuccessHandler

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• defaultLogoutSuccessHandlerFor

  public LogoutConfigurer<H> defaultLogoutSuccessHandlerFor(LogoutSuccessHandler handler, RequestMatcher preferredMatcher)

  指定された RequestMatcher に対して呼び出されることを優先するデフォルトの LogoutSuccessHandler を使用するように設定します。LogoutSuccessHandler が指定されていない場合、SimpleUrlLogoutSuccessHandler が使用されます。デフォルトの LogoutSuccessHandler インスタンスが構成されている場合、デフォルトで SimpleUrlLogoutSuccessHandler になる DelegatingLogoutSuccessHandler が使用されます。

  パラメーター:

  handler - 使用する LogoutSuccessHandler

  preferredMatcher - このデフォルト LogoutSuccessHandler の RequestMatcher

  戻り値:

  さらにカスタマイズするための LogoutConfigurer

• permitAll

  public LogoutConfigurer<H> permitAll(boolean permitAll)

  すべてのユーザーに logoutSuccessUrl(String) および logoutUrl(String) へのアクセスを許可します。

  パラメーター:

  permitAll - true がアクセスを許可する場合、何も実行されません

  戻り値:

  LogoutConfigurer をさらにカスタマイズします。

• getLogoutSuccessHandler

  public LogoutSuccessHandler getLogoutSuccessHandler()

  null でない場合は LogoutSuccessHandler を取得し、そうでない場合は logoutSuccessUrl(String) を使用して新しい SimpleUrlLogoutSuccessHandler を作成します。

  戻り値:

  使用する LogoutSuccessHandler

• init

  public void init(H http)

  インターフェースからコピーされた説明: SecurityConfigurer

  SecurityBuilder を初期化します。ここでは、共有状態のみを作成および変更する必要がありますが、オブジェクトの構築に使用される SecurityBuilder のプロパティは作成および変更しないでください。これにより、構築時に SecurityConfigurer.configure(SecurityBuilder) メソッドが正しい共有オブジェクトを使用するようになります。ここで設定を適用する必要があります。

  次で指定:

  インターフェース SecurityConfigurer<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>> の init 

  オーバーライド:

  クラス SecurityConfigurerAdapter<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>> の init 

• configure

  public void configure(H http) throws ExceptionSE

  インターフェースからコピーされた説明: SecurityConfigurer

  SecurityBuilder に必要なプロパティを設定して、SecurityBuilder を構成します。

  次で指定:

  インターフェース SecurityConfigurer<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>> の configure 

  オーバーライド:

  クラス SecurityConfigurerAdapter<DefaultSecurityFilterChain,H extends HttpSecurityBuilder<H>> の configure 

  例外:

  ExceptionSE

• getLogoutHandlers

  public ListSE<LogoutHandler> getLogoutHandlers()

  使用される LogoutHandler インスタンスを取得します。

  戻り値:

  LogoutHandler インスタンス。null にすることはできません。