ITokenCacheAccessContext インターフェイス
public interface ITokenCacheAccessContext
トークン キャッシュにアクセスするコンテキストを表すインターフェイス。
MSAL がトークン キャッシュにアクセスすると (前または後)、 ITokenCacheAccessAspect メソッドを介してこのインターフェイスのインスタンスがアプリケーションに提供されます。 これにより、アプリケーションは、実行されているキャッシュ アクセス操作に関する情報 (関係するクライアントやアカウント、操作によってキャッシュが変更されたかどうかなど) を取得できます。
このコンテキストは、トークン キャッシュのシリアル化と永続化戦略を実装するアプリケーションに特に役立ちます。これは、キャッシュの読み込み先または永続ストレージへの保存のタイミングを判断するのに役立ちます。
詳細については、https://aka.ms/msal4j-token-cache をご覧ください
メソッドの概要
| 修飾子と型 | メソッドと説明 |
|---|---|
| abstract IAccount |
account()
現在のキャッシュ アクセス操作に関連付けられているアカウントを取得します (存在する場合)。 |
| abstract java.lang.String |
clientId()
現在のキャッシュ アクセス操作に関連付けられているクライアント ID を取得します。 |
| abstract boolean |
hasCacheChanged()
この操作中にキャッシュが変更されたかどうかを示します。 |
|
abstract
IToken |
tokenCache()
アクセスするトークン キャッシュ インスタンスを取得します。 |
メソッドの詳細
account
public abstract IAccount account()
現在のキャッシュ アクセス操作に関連付けられているアカウントを取得します (存在する場合)。
これは、クライアント資格情報フロー トークン要求など、ユーザー アカウントに固有ではない操作の場合は null になる可能性があります。
返品:
clientId
public abstract String clientId()
現在のキャッシュ アクセス操作に関連付けられているクライアント ID を取得します。
これにより、キャッシュ アクセスを実行しているクライアント アプリケーション (Azure AD に登録) が識別されます。 マルチテナントまたはマルチクライアントのシナリオでは、アプリケーションでクライアント ID でトークン キャッシュをパーティション分割することが必要になる場合があります。
返品:
hasCacheChanged
public abstract boolean hasCacheChanged()
この操作中にキャッシュが変更されたかどうかを示します。
これは、キャッシュを永続化する必要があるかどうかを判断するために、 ITokenCacheAccessAspect#afterCacheAccess メソッドで特に役立ちます。 キャッシュに変更が加えられていた場合、アプリケーションは不要な書き込み操作を回避できます。
返品:
tokenCache
public abstract ITokenCache tokenCache()
アクセスするトークン キャッシュ インスタンスを取得します。
これは、キャッシュ アクセス操作中にキャッシュ エントリを読み取ったり変更したりするために使用できます。
返品: