インターフェース CsrfTokenRepository

すべての既知の実装クラス:
CookieCsrfTokenRepository, HttpSessionCsrfTokenRepository
public interface CsrfTokenRepository
予想される CsrfToken が HttpServletRequest に関連付けられているメソッドを変更できるようにする API。例: HttpSession に保存される場合があります。
導入:
3.2
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    CsrfToken
    generateToken(jakarta.servlet.http.HttpServletRequest request)
    CsrfToken を生成します
    default DeferredCsrfToken
    loadDeferredToken(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    アプリケーションで必要になるまで、HttpServletRequest および HttpServletResponse を使用した CsrfToken のロードを延期します。
    @Nullable CsrfToken
    loadToken(jakarta.servlet.http.HttpServletRequest request)
    HttpServletRequest から予想される CsrfToken をロードします
    void
    saveToken(@Nullable CsrfToken token, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    HttpServletRequest および HttpServletResponse を使用して CsrfToken を保存します。

  • メソッドの詳細

    • generateToken

      CsrfToken generateToken(jakarta.servlet.http.HttpServletRequest request)
      CsrfToken を生成します
      パラメーター:
      request - 使用する HttpServletRequest 
      戻り値:
      生成された CsrfToken。null にはできません。

    • saveToken

      void saveToken(@Nullable CsrfToken token, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      HttpServletRequest および HttpServletResponse を使用して CsrfToken を保存します。CsrfToken が null の場合、削除と同じです。
      パラメーター:
      token - 保存する CsrfToken または削除する null
      request - 使用する HttpServletRequest 
      response - 使用する HttpServletResponse 

    • loadToken

      @Nullable CsrfToken loadToken(jakarta.servlet.http.HttpServletRequest request)
      HttpServletRequest から予想される CsrfToken をロードします
      パラメーター:
      request - 使用する HttpServletRequest 
      戻り値:
      CsrfToken または存在しない場合は null

    • loadDeferredToken

      default DeferredCsrfToken loadDeferredToken(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      アプリケーションで必要になるまで、HttpServletRequest および HttpServletResponse を使用した CsrfToken のロードを延期します。

      返された DeferredCsrfToken はキャッシュされ、その後の DeferredCsrfToken.get() への呼び出しで同じ CsrfToken を返すことができます。トークンを再度ロードまたは生成する必要はありません。

      パラメーター:
      request - 使用する HttpServletRequest 
      response - 使用する HttpServletResponse 
      戻り値:
      CsrfToken をロードする DeferredCsrfToken
      導入:
      5.8