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 ITokenCache tokenCache()

取得正在存取的憑證快取實例。

方法詳細資料

account

public abstract IAccount account()

取得與目前快取存取操作相關的帳號(如果有的話)。

對於非特定使用者帳號的操作,例如用戶端憑證流程令牌請求,這可能是空的。

傳回:

該 IAccount 實例與此快取存取相關,若操作非特定帳號則為空值。

clientId

public abstract String clientId()

取得與目前快取存取操作相關的客戶端 ID。

這會識別哪個用戶端應用程式(註冊於 Azure AD)正在執行快取存取。 在多租戶或多用戶端情境中,應用程式可能希望依客戶端 ID 分割其憑證快取。

傳回:

客戶端 ID(應用程式 ID)已在 Azure 入口網站註冊。

hasCacheChanged

public abstract boolean hasCacheChanged()

顯示快取在此操作中是否被修改。

這在 ITokenCacheAccessAspect#afterCacheAccess 判斷快取是否應該被持久化時特別有用。 若快取未做任何變更,應用程式可避免不必要的寫入操作。

傳回:

若快取在此操作中被修改,則為 true;否則為 false。

tokenCache

public abstract ITokenCache tokenCache()

取得正在存取的憑證快取實例。

這可用於快取存取操作時讀取或修改快取項目。

傳回:

ITokenCache正在存取的實例。

適用於