com.microsoft.aad.msal4j

Class TokenCacheAccessContext

java.lang.Object

com.microsoft.aad.msal4j.TokenCacheAccessContext

All Implemented Interfaces:

ITokenCacheAccessContext

public class TokenCacheAccessContext
extends Object
implements ITokenCacheAccessContext

Context in which the token cache is accessed

For more details, see https://aka.ms/msal4j-token-cache

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TokenCacheAccessContext.TokenCacheAccessContextBuilder

Method Summary

Modifier and Type	Method and Description
IAccount	account() Gets the account associated with the current cache access operation, if any.
static TokenCacheAccessContext.TokenCacheAccessContextBuilder	builder()
String	clientId() Gets the client ID associated with the current cache access operation.
boolean	hasCacheChanged() Indicates whether the cache was modified during this operation.
ITokenCache	tokenCache() Gets the token cache instance being accessed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static TokenCacheAccessContext.TokenCacheAccessContextBuilder builder()

tokenCache

public ITokenCache tokenCache()

Description copied from interface: ITokenCacheAccessContext

Gets the token cache instance being accessed.

This can be used to read or modify the cache entries during a cache access operation.

Specified by:

tokenCache in interface ITokenCacheAccessContext

Returns:

The ITokenCache instance that is being accessed.

clientId

public String clientId()

Description copied from interface: ITokenCacheAccessContext

Gets the client ID associated with the current cache access operation.

This identifies which client application (registered in Azure AD) is performing the cache access. In multi-tenant or multi-client scenarios, applications may want to partition their token cache by client ID.

Specified by:

clientId in interface ITokenCacheAccessContext

Returns:

The client ID (application ID) as registered in the Azure portal.

account

public IAccount account()

Description copied from interface: ITokenCacheAccessContext

Gets the account associated with the current cache access operation, if any.

This may be null for operations that are not specific to a user account, such as client credential flow token requests.

Specified by:

account in interface ITokenCacheAccessContext

Returns:

The IAccount instance related to this cache access, or null if the operation is not account-specific.

hasCacheChanged

public boolean hasCacheChanged()

Description copied from interface: ITokenCacheAccessContext

Indicates whether the cache was modified during this operation.

This is particularly useful in the ITokenCacheAccessAspect.afterCacheAccess(com.microsoft.aad.msal4j.ITokenCacheAccessContext) method to determine whether the cache should be persisted. If no changes were made to the cache, applications can avoid unnecessary write operations.

Specified by:

hasCacheChanged in interface ITokenCacheAccessContext

Returns:

true if the cache was modified during this operation, false otherwise.