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

获取与当前缓存访问操作关联的帐户(如果有)。

对于不特定于用户帐户的操作(例如客户端凭据流令牌请求),这可能为 null。

返回:

与此 IAccount 缓存访问相关的实例;如果操作不特定于帐户,则为 null。

clientId

public abstract String clientId()

获取与当前缓存访问操作关联的客户端 ID。

这标识了哪个客户端应用程序(在 Azure AD 中注册)正在执行缓存访问。 在多租户或多客户端方案中,应用程序可能需要按客户端 ID 对其令牌缓存进行分区。

返回:

Azure门户中注册的客户端 ID(应用程序 ID)。

hasCacheChanged

public abstract boolean hasCacheChanged()

指示是否在此操作期间修改了缓存。

此方法在 ITokenCacheAccessAspect#afterCacheAccess 确定缓存是否应持久保存时特别有用。 如果未对缓存进行更改,则应用程序可以避免不必要的写入操作。

返回:

如果在此操作期间修改了缓存,则为 true,否则为 false。

tokenCache

public abstract ITokenCache tokenCache()

获取要访问的令牌缓存实例。

这可用于在缓存访问操作期间读取或修改缓存条目。

返回:

ITokenCache正在访问的实例。

适用于