ITokenCacheAccessContext Interface

Pacote:

com.microsoft.aad.msal4j

Artefato Maven:

com.microsoft.azure:msal4j:1.26.0

public interface ITokenCacheAccessContext

Interface que representa o contexto no qual o cache de token é acessado.

Quando a MSAL acessa o cache de token (antes ou depois), ela fornece uma instância dessa interface para o aplicativo por meio ITokenCacheAccessAspect de métodos. Isso permite que o aplicativo obtenha informações sobre a operação de acesso ao cache que está sendo executada, como qual cliente e conta estão envolvidos, e se a operação modificou o cache.

Esse contexto é particularmente útil para aplicativos que implementam estratégias de serialização e persistência de cache de token, pois ajuda a determinar quando o cache deve ser carregado ou salvo no armazenamento persistente.

Para obter mais detalhes, confira https://aka.ms/msal4j-token-cache

Resumo do método

Modificador e tipo	Método e descrição
abstract IAccount	account() Obtém a conta associada à operação de acesso ao cache atual, se houver.
abstract java.lang.String	clientId() Obtém a ID do cliente associada à operação de acesso ao cache atual.
abstract boolean	hasCacheChanged() Indica se o cache foi modificado durante essa operação.
abstract ITokenCache	tokenCache() Obtém a instância de cache de token que está sendo acessada.

Detalhes do método

account

public abstract IAccount account()

Obtém a conta associada à operação de acesso ao cache atual, se houver.

Isso pode ser nulo para operações que não são específicas a uma conta de usuário, como solicitações de token de fluxo de credencial do cliente.

Retornos:

A IAccount instância relacionada a esse acesso de cache ou nula se a operação não for específica da conta.

clientId

public abstract String clientId()

Obtém a ID do cliente associada à operação de acesso ao cache atual.

Isso identifica qual aplicativo cliente (registrado no Azure AD) está executando o acesso ao cache. Em cenários multilocatários ou de vários clientes, os aplicativos podem querer particionar o cache de token por ID do cliente.

Retornos:

A ID do cliente (ID do aplicativo) conforme registrado no portal do Azure.

hasCacheChanged

public abstract boolean hasCacheChanged()

Indica se o cache foi modificado durante essa operação.

Isso é particularmente útil no ITokenCacheAccessAspect#afterCacheAccess método para determinar se o cache deve ser mantido. Se nenhuma alteração tiver sido feita no cache, os aplicativos poderão evitar operações de gravação desnecessárias.

Retornos:

true se o cache foi modificado durante esta operação, caso contrário, false.

tokenCache

public abstract ITokenCache tokenCache()

Obtém a instância de cache de token que está sendo acessada.

Isso pode ser usado para ler ou modificar as entradas de cache durante uma operação de acesso ao cache.

Retornos:

A ITokenCache instância que está sendo acessada.