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

java.lang.Object
- org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices
- - org.springframework.security.web.authentication.rememberme.PersistentTokenBasedRememberMeServices

実装済みのインターフェース一覧:
org.springframework.beans.factory.InitializingBean, LogoutHandler, RememberMeServices
```
public class PersistentTokenBasedRememberMeServices
extends AbstractRememberMeServices
```
Barry Jaspan の永続的ログイン Cookie のベストプラクティスの改善に基づく RememberMeServices 実装。ユーザー名は Cookie の一部として保存されず、PersistentTokenRepository の実装を介して永続ストアから取得されるという点で、前述のアプローチに若干の変更があります。後者はシリーズ識別子に一意の制約を課す必要があるため、同じ識別子を 2 人の異なるユーザーに割り当てることはできません。
パスワードの変更、ユーザーの削除、ユーザーステータスの設定などのユーザー管理は、ユーザーの永続的なトークンのメンテナンスと組み合わせる必要があります。
このクラスはトークンの作成日を使用して、提示された Cookie が設定された tokenValiditySeconds プロパティより古いかどうかを確認し、この場合は認証を拒否しますが、これらのトークンをストレージから削除しないことに注意してください。期限切れのトークンをデータベースから削除するには、適切なバッチプロセスを定期的に実行する必要があります。
導入:
2.0

フィールド概要
フィールド
修飾子と型フィールドと説明
static int DEFAULT_SERIES_LENGTH
static int DEFAULT_TOKEN_LENGTH
- クラス org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices から継承されたフィールド
  DEFAULT_PARAMETER, logger, messages, SPRING_SECURITY_REMEMBER_ME_COOKIE_KEY, TWO_WEEKS_S

フィールド
修飾子と型	フィールドと説明
`static int`	`DEFAULT_SERIES_LENGTH`
`static int`	`DEFAULT_TOKEN_LENGTH`

コンストラクター概要

コンストラクター
コンストラクターと説明
`PersistentTokenBasedRememberMeServices(java.lang.String key, UserDetailsService userDetailsService, PersistentTokenRepository tokenRepository)`

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`protected java.lang.String`	`generateSeriesData()`
`protected java.lang.String`	`generateTokenData()`
`void`	`logout(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication authentication)` `LogoutHandler` の実装。
`protected void`	`onLoginSuccess(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Authentication successfulAuthentication)` 新しいシリーズ番号で新しい永続的ログイントークンを作成し、データを永久トークンリポジトリに保存し、対応する Cookie をレスポンスに追加します。
`protected UserDetails`	`processAutoLoginCookie(java.lang.String[] cookieTokens, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` シリーズ ID を使用して、提示された Cookie データをトークンリポジトリで検索します。
`void`	`setSeriesLength(int seriesLength)`
`void`	`setTokenLength(int tokenLength)`
`void`	`setTokenValiditySeconds(int tokenValiditySeconds)`

クラス org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices から継承されたメソッド
afterPropertiesSet, autoLogin, cancelCookie, createSuccessfulAuthentication, decodeCookie, encodeCookie, extractRememberMeCookie, getAuthenticationDetailsSource, getCookieName, getKey, getParameter, getTokenValiditySeconds, getUserDetailsService, loginFail, loginSuccess, onLoginFail, rememberMeRequested, setAlwaysRemember, setAuthenticationDetailsSource, setAuthoritiesMapper, setCookie, setCookieDomain, setCookieName, setParameter, setUserDetailsChecker, setUseSecureCookie

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

- フィールドの詳細
  - DEFAULT_SERIES_LENGTH
```
public static final int DEFAULT_SERIES_LENGTH
```
    関連事項:
    定数フィールド値
  - DEFAULT_TOKEN_LENGTH
```
public static final int DEFAULT_TOKEN_LENGTH
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - PersistentTokenBasedRememberMeServices
```
public PersistentTokenBasedRememberMeServices(java.lang.String key,
                                              UserDetailsService userDetailsService,
                                              PersistentTokenRepository tokenRepository)
```
- メソッドの詳細
  - processAutoLoginCookie
```
protected UserDetails processAutoLoginCookie(java.lang.String[] cookieTokens,
                                             javax.servlet.http.HttpServletRequest request,
                                             javax.servlet.http.HttpServletResponse response)
```
    シリーズ ID を使用して、提示された Cookie データをトークンリポジトリで検索します。データが永続ストアのデータと正常に比較されると、新しいトークンが生成され、同じシリーズで保存されます。対応する Cookie 値がレスポンスに設定されます。
    次で指定:
    クラス AbstractRememberMeServices の processAutoLoginCookie
    パラメーター:
    cookieTokens - シリーズとトークンの値
    request - リクエスト
    response - 必要に応じて Cookie を変更できるようにするレスポンス。
    戻り値:
    Cookie が正常に検証された場合、対応するユーザーアカウントの UserDetails。
    例外:
    RememberMeAuthenticationException - 送信された Cookie に対応するトークンが保存されていない場合、または永続ストアのトークンの有効期限が切れている場合。
    InvalidCookieException - Cookie に期待どおりの 2 つのトークンがない場合。
    CookieTheftException - 提示されたシリーズ値が見つかったが、格納されたトークンが提示されたものと異なる場合。
  - onLoginSuccess
```
protected void onLoginSuccess(javax.servlet.http.HttpServletRequest request,
                              javax.servlet.http.HttpServletResponse response,
                              Authentication successfulAuthentication)
```
    新しいシリーズ番号で新しい永続的ログイントークンを作成し、データを永久トークンリポジトリに保存し、対応する Cookie をレスポンスに追加します。
    次で指定:
    クラス AbstractRememberMeServices の onLoginSuccess
  - logout
```
public void logout(javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Authentication authentication)
```
    クラスからコピーされた説明: AbstractRememberMeServices
    LogoutHandler の実装。デフォルトの動作は cancelCookie() を呼び出すことです。
    次で指定:
    インターフェース LogoutHandler 内の logout
    オーバーライド:
    クラス AbstractRememberMeServices の logout
    パラメーター:
    request - HTTP リクエスト
    response - HTTP レスポンス
    authentication - 現在のプリンシパルの詳細
  - generateSeriesData
```
protected java.lang.String generateSeriesData()
```
  - generateTokenData
```
protected java.lang.String generateTokenData()
```
  - setSeriesLength
```
public void setSeriesLength(int seriesLength)
```
  - setTokenLength
```
public void setTokenLength(int tokenLength)
```
  - setTokenValiditySeconds
```
public void setTokenValiditySeconds(int tokenValiditySeconds)
```
    オーバーライド:
    クラス AbstractRememberMeServices の setTokenValiditySeconds

クラス PersistentTokenBasedRememberMeServices

フィールド概要

クラス org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices から継承されたフィールド

コンストラクター概要

方法の概要

クラス org.springframework.security.web.authentication.rememberme.AbstractRememberMeServices から継承されたメソッド

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

フィールドの詳細

DEFAULT_SERIES_LENGTH

DEFAULT_TOKEN_LENGTH

コンストラクターの詳細

PersistentTokenBasedRememberMeServices

メソッドの詳細

processAutoLoginCookie

onLoginSuccess

logout

generateSeriesData

generateTokenData

setSeriesLength

setTokenLength

setTokenValiditySeconds