クラス RememberMeConfigurer<H extends HttpSecurityBuilder<H>>
java.lang.ObjectSE
org.springframework.security.config.annotation.SecurityConfigurerAdapter<DefaultSecurityFilterChain,B>
org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer < RememberMeConfigurer <H>、H>
org.springframework.security.config.annotation.web.configurers.RememberMeConfigurer<H>
- 実装されたすべてのインターフェース:
SecurityConfigurer<DefaultSecurityFilterChain,
H>
public final class RememberMeConfigurer<H extends HttpSecurityBuilder<H>>
extends AbstractHttpConfigurer<RememberMeConfigurer<H>,H>
Remember Me 認証を構成します。これには通常、ユーザーが自分のユーザー名とパスワードを入力するときに、「ユーザー名を記憶」と表示されているボックスをチェックする必要があります。
セキュリティフィルター
次のフィルターが読み込まれます作成された共有オブジェクト
次の共有オブジェクトが入力されますHttpSecurity.authenticationProvider(org.springframework.security.authentication.AuthenticationProvider)
にはRememberMeAuthenticationProvider
が実装されていますRememberMeServices
は共有オブジェクトとして入力され、AbstractConfiguredSecurityBuilder.getSharedObject(Class)
で利用可能LogoutConfigurer.addLogoutHandler(LogoutHandler)
は、ログアウトハンドラーを追加して、remember me 認証をクリーンアップするために使用されます。
使用される共有オブジェクト
次の共有オブジェクトが使用されます。AuthenticationManager
userDetailsService(UserDetailsService)
が指定されていない場合はUserDetailsService
。DefaultLoginPageGeneratingFilter
- 存在する場合、構成からの情報が入力されます
- 導入:
- 3.2
コンストラクターのサマリー
コンストラクターメソッドのサマリー
修飾子と型メソッド説明alwaysRemember
(boolean alwaysRemember) remember-me パラメーターが設定されていない場合でも、Cookie を常に作成する必要があるかどうか。authenticationSuccessHandler
(AuthenticationSuccessHandler authenticationSuccessHandler) 認証に成功したときに記憶されたユーザーが送信される宛先を制御できます。void
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。void
SecurityBuilder
を初期化します。認証を記憶するために作成されたトークンを識別するキーを設定します。rememberMeCookieDomain
(StringSE rememberMeCookieDomain) リメンバーミー Cookie が表示されるドメイン名。rememberMeCookieName
(StringSE rememberMeCookieName) 認証を記憶するためのトークンを格納する Cookie の名前。rememberMeParameter
(StringSE rememberMeParameter) ログイン時にユーザーを記憶することを示すために使用される HTTP パラメーター。rememberMeServices
(RememberMeServices rememberMeServices) 使用するRememberMeServices
を指定します。tokenRepository
(PersistentTokenRepository tokenRepository) 使用するPersistentTokenRepository
を指定します。tokenValiditySeconds
(int tokenValiditySeconds) トークンの有効期間(秒単位)を指定できますuserDetailsService
(UserDetailsService userDetailsService) Remember me トークンが有効な場合にUserDetails
を検索するために使用されるUserDetailsService
を指定します。useSecureCookie
(boolean useSecureCookie) Cookie に安全なフラグを付けるかどうか。クラス org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer から継承されたメソッド
disable, getSecurityContextHolderStrategy, withObjectPostProcessor
クラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド
addObjectPostProcessor, and, getBuilder, postProcess, setBuilder
コンストラクターの詳細
RememberMeConfigurer
public RememberMeConfigurer()新しいインスタンスを作成します
メソッドの詳細
tokenValiditySeconds
トークンの有効期間(秒単位)を指定できます- パラメーター:
tokenValiditySeconds
-- 戻り値:
- さらなるカスタマイズのための
RememberMeConfigurer
- 関連事項:
useSecureCookie
Cookie に安全なフラグを付けるかどうか。安全な Cookie は HTTPS 接続経由でのみ送信できるため、インターセプトされる可能性のある HTTP 経由で誤って送信することはできません。デフォルトでは、リクエストが安全であれば Cookie は安全です。HTTPS 経由で remember-me のみを使用する場合(推奨)、このプロパティを
true
に設定する必要があります。- パラメーター:
useSecureCookie
- 常にユーザーの安全な Cookie を使用するにはtrue
に設定し、使用を無効にするにはfalse
に設定します。- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 関連事項:
userDetailsService
覚えているトークンが有効な場合にUserDetails
を検索するために使用されるUserDetailsService
を指定します。SecurityFilterChain
Bean を使用する場合、デフォルトではUserDetailsService
Bean を検索します。または、rememberMeServices(RememberMeServices)
を設定することもできます。- パラメーター:
userDetailsService
- 構成するUserDetailsService
- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 関連事項:
tokenRepository
使用するPersistentTokenRepository
を指定します。デフォルトでは、代わりにTokenBasedRememberMeServices
を使用します。- パラメーター:
tokenRepository
- 使用するPersistentTokenRepository
- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
key
認証を記憶するために作成されたトークンを識別するキーを設定します。デフォルトは、ランダムに生成された安全なキーです。rememberMeServices(RememberMeServices)
が指定され、型がAbstractRememberMeServices
の場合、デフォルトはAbstractRememberMeServices
に設定されたキーです。- パラメーター:
key
- 認証を記憶するために作成されたトークンを識別するキー- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
rememberMeParameter
ログイン時にユーザーを記憶することを示すために使用される HTTP パラメーター。- パラメーター:
rememberMeParameter
- ユーザーを記憶することを示すために使用される HTTP パラメーター- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
rememberMeCookieName
認証を記憶するためのトークンを格納する Cookie の名前。デフォルトは "remember-me" です。- パラメーター:
rememberMeCookieName
- 認証を記憶するためのトークンを格納する Cookie の名前- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 導入:
- 4.0.1
rememberMeCookieDomain
リメンバーミー Cookie が表示されるドメイン名。- パラメーター:
rememberMeCookieDomain
- リメンバーミー Cookie が表示されるドメイン名。- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 導入:
- 4.1.0
authenticationSuccessHandler
public RememberMeConfigurer<H> authenticationSuccessHandler(AuthenticationSuccessHandler authenticationSuccessHandler) 認証に成功したときに記憶されたユーザーが送信される宛先を制御できます。デフォルトでは、フィルターは現在のリクエストの続行のみを許可しますが、AuthenticationSuccessHandler
が設定されている場合はそれが呼び出され、doFilter()
メソッドがすぐに返されるため、アプリケーションはユーザーが特定の URL にリダイレクトできるようにします。元のリクエストがあった。- パラメーター:
authenticationSuccessHandler
-doFilter()
から戻る直前に呼び出す戦略。- 戻り値:
- さらなるカスタマイズのための
RememberMeConfigurer
- 関連事項:
rememberMeServices
使用するRememberMeServices
を指定します。- パラメーター:
rememberMeServices
- 使用するRememberMeServices
- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 関連事項:
alwaysRemember
remember-me パラメーターが設定されていない場合でも、Cookie を常に作成する必要があるかどうか。デフォルトでは、これは
false
に設定されます。- パラメーター:
alwaysRemember
-true
に設定すると、remember me が常にトリガーされ、false
に設定すると、remember-me パラメーターが使用されます。- 戻り値:
- さらにカスタマイズするための
RememberMeConfigurer
- 関連事項:
init
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
を初期化します。ここでは、共有状態のみを作成および変更する必要がありますが、オブジェクトの構築に使用されるSecurityBuilder
のプロパティは作成および変更しないでください。これにより、構築時にSecurityConfigurer.configure(SecurityBuilder)
メソッドが正しい共有オブジェクトを使用するようになります。ここで設定を適用する必要があります。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,
のH extends HttpSecurityBuilder<H>> init
- オーバーライド:
- クラス
SecurityConfigurerAdapter<DefaultSecurityFilterChain,
のH extends HttpSecurityBuilder<H>> init
- 例外:
ExceptionSE
configure
インターフェースからコピーされた説明:SecurityConfigurer
SecurityBuilder
に必要なプロパティを設定して、SecurityBuilder
を構成します。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,
のH extends HttpSecurityBuilder<H>> configure
- オーバーライド:
- クラス
SecurityConfigurerAdapter<DefaultSecurityFilterChain,
のH extends HttpSecurityBuilder<H>> configure