com.microsoft.azure.credentials

Class AzureTokenCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

com.microsoft.azure.credentials.AzureTokenCredentials

All Implemented Interfaces:

ServiceClientCredentials

Direct Known Subclasses:

ApplicationTokenCredentials, AppServiceMSICredentials, AzureCliCredentials, DelegatedTokenCredentials, MSICredentials, UserTokenCredentials

public abstract class AzureTokenCredentials
extends TokenCredentials

AzureTokenCredentials represents a credentials object with access to Azure Resource management.

Constructor Summary

Constructors

Constructor and Description
AzureTokenCredentials(AzureEnvironment environment, String domain) Initializes a new instance of the AzureTokenCredentials.

Method Summary

Modifier and Type	Method and Description
void	applyCredentialsFilter(okhttp3.OkHttpClient.Builder clientBuilder) Apply the credentials to the HTTP client builder.
String	defaultSubscriptionId()
String	domain() Override this method to provide the domain or tenant ID the token is valid in.
AzureEnvironment	environment()
protected String	getToken(okhttp3.Request request) Get the secure token.
abstract String	getToken(String resource) Override this method to provide the mechanism to get a token.
Proxy	proxy()
AzureTokenCredentials	withDefaultSubscriptionId(String subscriptionId) Set default subscription ID.
AzureTokenCredentials	withProxy(Proxy proxy) Set the proxy used for accessing Active Directory.

Methods inherited from class com.microsoft.rest.credentials.TokenCredentials

getScheme

Methods inherited from class java.lang.Object

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

Constructor Detail

AzureTokenCredentials

public AzureTokenCredentials(AzureEnvironment environment,
                             String domain)

Initializes a new instance of the AzureTokenCredentials.

Parameters:

environment - the Azure environment to use

domain - the tenant or domain the credential is authorized to

Method Detail

getToken

protected final String getToken(okhttp3.Request request)
                         throws IOException

Description copied from class: TokenCredentials

Get the secure token. Override this method to provide a mechanism for acquiring tokens.

Overrides:

getToken in class TokenCredentials

Parameters:

request - the context of the HTTP request

Returns:

the secure token.

Throws:

IOException - exception thrown from token acquisition operations.

getToken

public abstract String getToken(String resource)
                         throws IOException

Override this method to provide the mechanism to get a token.

Parameters:

resource - the resource the access token is for

Returns:

the token to access the resource

Throws:

IOException - exceptions from IO

domain

public String domain()

Override this method to provide the domain or tenant ID the token is valid in.

Returns:

the domain or tenant ID string

environment

public AzureEnvironment environment()

Returns:

the environment details the credential has access to.

defaultSubscriptionId

public String defaultSubscriptionId()

Returns:

The default subscription ID, if any

withDefaultSubscriptionId

public AzureTokenCredentials withDefaultSubscriptionId(String subscriptionId)

Set default subscription ID.

Parameters:

subscriptionId - the default subscription ID.

Returns:

the credentials object itself.

proxy

public Proxy proxy()

Returns:

the proxy being used for accessing Active Directory.

withProxy

public AzureTokenCredentials withProxy(Proxy proxy)

Set the proxy used for accessing Active Directory.

Parameters:

proxy - the proxy to use

Returns:

the credential itself

applyCredentialsFilter

public void applyCredentialsFilter(okhttp3.OkHttpClient.Builder clientBuilder)

Description copied from interface: ServiceClientCredentials

Apply the credentials to the HTTP client builder.

Specified by:

applyCredentialsFilter in interface ServiceClientCredentials

Overrides:

applyCredentialsFilter in class TokenCredentials

Parameters:

clientBuilder - the builder for building up an OkHttpClient