com.microsoft.aad.msal4j

Enum CacheRefreshReason

java.lang.Object

java.lang.Enum<CacheRefreshReason>

com.microsoft.aad.msal4j.CacheRefreshReason

All Implemented Interfaces:

Serializable, Comparable<CacheRefreshReason>

public enum CacheRefreshReason
extends Enum<CacheRefreshReason>

Specifies the reason for fetching the access token from the identity provider when using AbstractClientApplicationBase.acquireTokenSilently(SilentParameters)

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLAIMS Silent call was made with claims set
EXPIRED Cached access token was expired and successfully refreshed
FORCE_REFRESH Silent call was made with the force refresh option
NO_CACHED_ACCESS_TOKEN Access token was missing from the cache, but a valid refresh token was used to retrieve a new access token
NOT_APPLICABLE Token did not need to be refreshed, or was retrieved in a non-silent call
PROACTIVE_REFRESH Cached access token was not expired but was after the 'refresh_in' value, and was proactively refreshed before the expiration date

Method Summary

Modifier and Type	Method and Description
static CacheRefreshReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static CacheRefreshReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NOT_APPLICABLE

public static final CacheRefreshReason NOT_APPLICABLE

Token did not need to be refreshed, or was retrieved in a non-silent call

FORCE_REFRESH

public static final CacheRefreshReason FORCE_REFRESH

Silent call was made with the force refresh option

CLAIMS

public static final CacheRefreshReason CLAIMS

Silent call was made with claims set

NO_CACHED_ACCESS_TOKEN

public static final CacheRefreshReason NO_CACHED_ACCESS_TOKEN

Access token was missing from the cache, but a valid refresh token was used to retrieve a new access token

EXPIRED

public static final CacheRefreshReason EXPIRED

Cached access token was expired and successfully refreshed

PROACTIVE_REFRESH

public static final CacheRefreshReason PROACTIVE_REFRESH

Cached access token was not expired but was after the 'refresh_in' value, and was proactively refreshed before the expiration date

Method Detail

values

public static CacheRefreshReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (CacheRefreshReason c : CacheRefreshReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CacheRefreshReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null