クラス JdbcOneTimeTokenService
java.lang.ObjectSE
org.springframework.security.authentication.ott.JdbcOneTimeTokenService
- 実装されているすべてのインターフェース:
org.springframework.beans.factory.DisposableBean、org.springframework.beans.factory.InitializingBean、OneTimeTokenService
public final class JdbcOneTimeTokenService
extends ObjectSE
implements OneTimeTokenService, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean
OneTimeToken 永続性のために JdbcOperations を使用する OneTimeTokenService の JDBC 実装。 注意 : この JdbcOneTimeTokenService は、"classpath:org/springframework/security/core/ott/jdbc/one-time-tokens-schema.sql" に記述されているテーブル定義に依存するため、データベーススキーマで定義する必要があります。
- 導入:
- 6.4
コンストラクターの概要
コンストラクターコンストラクター説明JdbcOneTimeTokenService(org.springframework.jdbc.core.JdbcOperations jdbcOperations) 提供されたパラメーターを使用してJdbcOneTimeTokenServiceを構築します。方法の概要
修飾子と型メソッド説明voidvoid@Nullable OneTimeTokenconsume(OneTimeTokenAuthenticationToken authenticationToken) 提供された認証トークンに基づいてワンタイムトークンを消費します。voiddestroy()generate(GenerateOneTimeTokenRequest request) 提供された生成リクエストに基づいてワンタイムトークンを生成します。voidsetCleanupCron(StringSE cleanupCron) 期限切れのトークンをクリーンアップするために使用される chron 式を設定します。voidワンタイムトークンの生成時およびトークンの有効期限の確認時に使用するClockSE を設定します。
コンストラクターの詳細
JdbcOneTimeTokenService
public JdbcOneTimeTokenService(org.springframework.jdbc.core.JdbcOperations jdbcOperations) 提供されたパラメーターを使用してJdbcOneTimeTokenServiceを構築します。- パラメーター:
jdbcOperations- JDBC オペレーション
メソッドの詳細
setCleanupCron
期限切れのトークンをクリーンアップするために使用される chron 式を設定します。デフォルトでは、1 時間ごとに実行されます。より高度なユースケースでは、cleanupCron を null に設定して、組み込みのクリーンアップを無効にすることができます。その後、ユーザーはカスタムロジックを使用してcleanupExpiredTokens()を呼び出すことができます。- パラメーター:
cleanupCron- クリーンアップを実行する頻度を決定するために使用される、CronTriggerに渡される chron 式。デフォルトは "@hourly" です。- 関連事項:
CronTriggercleanupExpiredTokens()
generate
インターフェースからコピーされた説明:OneTimeTokenService提供された生成リクエストに基づいてワンタイムトークンを生成します。- 次で指定:
- インターフェース
OneTimeTokenServiceのgenerate - パラメーター:
request- トークンを生成するために必要な情報を含む生成リクエスト- 戻り値:
- 生成された
OneTimeTokenであり、nullではありません。
consume
インターフェースからコピーされた説明:OneTimeTokenService提供された認証トークンに基づいてワンタイムトークンを消費します。- 次で指定:
- インターフェース
OneTimeTokenServiceのconsume - パラメーター:
authenticationToken- 消費されるワンタイムトークン値を含む認証トークン- 戻り値:
- トークンが無効な場合は消費された
OneTimeTokenまたはnull
cleanupExpiredTokens
public void cleanupExpiredTokens()afterPropertiesSet
- 次で指定:
- インターフェース
org.springframework.beans.factory.InitializingBeanのafterPropertiesSet - 例外:
ExceptionSE
destroy
- 次で指定:
- インターフェース
org.springframework.beans.factory.DisposableBeanのdestroy - 例外:
ExceptionSE
setClock
ワンタイムトークンの生成時およびトークンの有効期限の確認時に使用するClockSE を設定します。- パラメーター:
clock- 監視