CookieCsrfTokenRepository (spring-security-docs-manual 5.3.2.RELEASE API)

java.lang.Object
- org.springframework.security.web.csrf.CookieCsrfTokenRepository

実装済みのインターフェース一覧:
CsrfTokenRepository
```
public final class CookieCsrfTokenRepository
extends java.lang.Object
implements CsrfTokenRepository
```
CSRF トークンを "XSRF-TOKEN" という名前の Cookie に永続化し、AngularJS の規則に従ってヘッダー "X-XSRF-TOKEN" から読み取る CsrfTokenRepository。AngularJS で使用する場合は、必ず withHttpOnlyFalse() を使用してください。
導入:
4.1

コンストラクター概要
コンストラクター
コンストラクターと説明
CookieCsrfTokenRepository()

コンストラクター
コンストラクターと説明
`CookieCsrfTokenRepository()`

方法の概要

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`CsrfToken`	`generateToken(javax.servlet.http.HttpServletRequest request)` `CsrfToken` を生成します
`java.lang.String`	`getCookiePath()` CSRF Cookie が設定されるパスを取得します。
`CsrfToken`	`loadToken(javax.servlet.http.HttpServletRequest request)` `HttpServletRequest` から予想される `CsrfToken` をロードします
`void`	`saveToken(CsrfToken token, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` `HttpServletRequest` および `HttpServletResponse` を使用して `CsrfToken` を保存します。
`void`	`setCookieDomain(java.lang.String cookieDomain)` 予期される CSRF トークンが保存され、そこから読み取られる Cookie のドメインを設定します。
`void`	`setCookieHttpOnly(boolean cookieHttpOnly)` CSRF トークンを含む Cookie に HttpOnly 属性を設定します。
`void`	`setCookieName(java.lang.String cookieName)` 予期される CSRF トークンが保存され、読み取られる Cookie の名前を設定します。
`void`	`setCookiePath(java.lang.String path)` Cookie の作成に使用するパスを設定します。
`void`	`setHeaderName(java.lang.String headerName)` トークンの提供に使用する HTTP ヘッダーの名前を設定します。
`void`	`setParameterName(java.lang.String parameterName)` トークンを提供するために使用する必要がある HTTP リクエストパラメーターの名前を設定します。
`static CookieCsrfTokenRepository`	`withHttpOnlyFalse()` `setCookieHttpOnly(boolean)` を false に設定したインスタンスを簡単に作成するためのファクトリメソッド。

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクターの詳細
  - CookieCsrfTokenRepository
```
public CookieCsrfTokenRepository()
```
- メソッドの詳細
  - generateToken
```
public CsrfToken generateToken(javax.servlet.http.HttpServletRequest request)
```
    インターフェースからコピーされた説明: CsrfTokenRepository
    CsrfToken を生成します
    次で指定:
    インターフェース CsrfTokenRepository 内の generateToken
    パラメーター:
    request - 使用する HttpServletRequest
    戻り値:
    生成された CsrfToken。null にはできません。
  - saveToken
```
public void saveToken(CsrfToken token,
                      javax.servlet.http.HttpServletRequest request,
                      javax.servlet.http.HttpServletResponse response)
```
    インターフェースからコピーされた説明: CsrfTokenRepository
    HttpServletRequest および HttpServletResponse を使用して CsrfToken を保存します。CsrfToken が null の場合、削除と同じです。
    次で指定:
    インターフェース CsrfTokenRepository 内の saveToken
    パラメーター:
    token - 保存する CsrfToken または削除する null
    request - 使用する HttpServletRequest
    response - 使用する HttpServletResponse
  - loadToken
```
public CsrfToken loadToken(javax.servlet.http.HttpServletRequest request)
```
    インターフェースからコピーされた説明: CsrfTokenRepository
    HttpServletRequest から予想される CsrfToken をロードします
    次で指定:
    インターフェース CsrfTokenRepository 内の loadToken
    パラメーター:
    request - 使用する HttpServletRequest
    戻り値:
    CsrfToken または存在しない場合は null
  - setParameterName
```
public void setParameterName(java.lang.String parameterName)
```
    トークンを提供するために使用する必要がある HTTP リクエストパラメーターの名前を設定します。
    パラメーター:
    parameterName - トークンを提供するために使用する必要がある HTTP リクエストパラメーターの名前
  - setHeaderName
```
public void setHeaderName(java.lang.String headerName)
```
    トークンの提供に使用する HTTP ヘッダーの名前を設定します。
    パラメーター:
    headerName - トークンを提供するために使用される HTTP ヘッダーの名前
  - setCookieName
```
public void setCookieName(java.lang.String cookieName)
```
    予期される CSRF トークンが保存され、読み取られる Cookie の名前を設定します。
    パラメーター:
    cookieName - 予期される CSRF トークンが保存され、そこから読み取られる Cookie の名前
  - setCookieHttpOnly
```
public void setCookieHttpOnly(boolean cookieHttpOnly)
```
    CSRF トークンを含む Cookie に HttpOnly 属性を設定します。デフォルトは true です。
    パラメーター:
    cookieHttpOnly - true は HttpOnly 属性を設定しますが、false はそれを設定しません
  - withHttpOnlyFalse
```
public static CookieCsrfTokenRepository withHttpOnlyFalse()
```
    setCookieHttpOnly(boolean) を false に設定したインスタンスを簡単に作成するためのファクトリメソッド。
    戻り値:
    setCookieHttpOnly(boolean) が false に設定された CookieCsrfTokenRepository のインスタンス
  - setCookiePath
```
public void setCookiePath(java.lang.String path)
```
    Cookie の作成に使用するパスを設定します。これにより、リクエストコンテキストをパスとして使用するデフォルトの機能が上書きされます。
    パラメーター:
    path - 使用するパス
  - getCookiePath
```
public java.lang.String getCookiePath()
```
    CSRF Cookie が設定されるパスを取得します。
    戻り値:
    使用するパス。
  - setCookieDomain
```
public void setCookieDomain(java.lang.String cookieDomain)
```
    予期される CSRF トークンが保存され、そこから読み取られる Cookie のドメインを設定します。
    パラメーター:
    cookieDomain - 予期される CSRF トークンが保存され、そこから読み取られる Cookie のドメイン
    導入:
    5.2

クラス CookieCsrfTokenRepository

コンストラクター概要

方法の概要

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

コンストラクターの詳細

CookieCsrfTokenRepository

メソッドの詳細

generateToken

saveToken

loadToken

setParameterName

setHeaderName

setCookieName

setCookieHttpOnly

withHttpOnlyFalse

setCookiePath

getCookiePath

setCookieDomain