com.microsoft.azure.sdk.iot.provisioning.service.auth

Class TokenCredentialCache

java.lang.Object

com.microsoft.azure.sdk.iot.provisioning.service.auth.TokenCredentialCache

public class TokenCredentialCache
extends Object

This class generates AAD authentication tokens from a TokenCredential but caches previous tokens when they aren't near expiry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEARER_TOKEN_PREFIX
static String[]	PROVISIONING_PUBLIC_SCOPE

Constructor Summary

Constructors

Constructor and Description
TokenCredentialCache(com.azure.core.credential.TokenCredential tokenCredential) Construct a new TokenCredentialCache instance.

Method Summary

Modifier and Type	Method and Description
com.azure.core.credential.AccessToken	getAccessToken() Get a valid AAD authentication token.
com.azure.core.credential.TokenCredential	getTokenCredential()
String	getTokenString() Get the access token string, including the Bearer prefix.

Methods inherited from class java.lang.Object

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

Field Detail

PROVISIONING_PUBLIC_SCOPE

public static final String[] PROVISIONING_PUBLIC_SCOPE

BEARER_TOKEN_PREFIX

public static final String BEARER_TOKEN_PREFIX

See Also:

Constant Field Values

Constructor Detail

TokenCredentialCache

public TokenCredentialCache(com.azure.core.credential.TokenCredential tokenCredential)

Construct a new TokenCredentialCache instance.

Parameters:

tokenCredential - The tokenCredential instance that this cache will use to generate new tokens.

Method Detail

getAccessToken

public com.azure.core.credential.AccessToken getAccessToken()

Get a valid AAD authentication token. This may be the same as a previously returned token if it is not near expiration time yet. If a token is less than or equal to 9 minutes away from expiring or is expired already, the token will be renewed. Otherwise, a cached token will be returned.

Returns:

a valid AAD authentication token.

getTokenString

public String getTokenString()

Get the access token string, including the Bearer prefix.

Returns:

the access token string, including the Bearer prefix.

getTokenCredential

public com.azure.core.credential.TokenCredential getTokenCredential()

Returns:

the TokenCredential instance that was set in the constructor.