com.microsoft.azure.credentials

Class ApplicationTokenCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

com.microsoft.azure.credentials.AzureTokenCredentials

com.microsoft.azure.credentials.ApplicationTokenCredentials

All Implemented Interfaces:

ServiceClientCredentials

public class ApplicationTokenCredentials
extends AzureTokenCredentials

Token based credentials for use with a REST Service Client.

Constructor Summary

Constructors

Constructor and Description
ApplicationTokenCredentials(String clientId, String domain, byte[] certificate, String password, AzureEnvironment environment) Initializes a new instance of the ApplicationTokenCredentials.
ApplicationTokenCredentials(String clientId, String domain, String secret, AzureEnvironment environment) Initializes a new instance of the ApplicationTokenCredentials.

Method Summary

Modifier and Type	Method and Description
String	clientId() Gets the active directory application client id.
static ApplicationTokenCredentials	fromFile(File credentialsFile) Initializes the credentials based on the provided credentials file.
String	getToken(String resource) Override this method to provide the mechanism to get a token.

Methods inherited from class com.microsoft.azure.credentials.AzureTokenCredentials

applyCredentialsFilter, defaultSubscriptionId, domain, environment, getToken, proxy, withDefaultSubscriptionId, withProxy

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

ApplicationTokenCredentials

public ApplicationTokenCredentials(String clientId,
                                   String domain,
                                   String secret,
                                   AzureEnvironment environment)

Initializes a new instance of the ApplicationTokenCredentials.

Parameters:

clientId - the active directory application client id. Also known as Application Id which Identifies the application that is using the token.

domain - the domain or tenant id containing this application.

secret - the authentication secret for the application.

environment - the Azure environment to authenticate with. If null is provided, AzureEnvironment.AZURE will be used.

ApplicationTokenCredentials

public ApplicationTokenCredentials(String clientId,
                                   String domain,
                                   byte[] certificate,
                                   String password,
                                   AzureEnvironment environment)

Initializes a new instance of the ApplicationTokenCredentials.

Parameters:

clientId - the active directory application client id. Also known as Application Id which Identifies the application that is using the token.

domain - the domain or tenant id containing this application.

certificate - the PKCS12 certificate file content

password - the password to the certificate file

environment - the Azure environment to authenticate with. If null is provided, AzureEnvironment.AZURE will be used.

Method Detail

fromFile

public static ApplicationTokenCredentials fromFile(File credentialsFile)
                                            throws IOException

Initializes the credentials based on the provided credentials file.

Parameters:

credentialsFile - A file with credentials, using the standard Java properties format. and the following keys: subscription=<subscription-id> tenant=<tenant-id> client=<client-id> key=<client-key> managementURI=<management-URI> baseURL=<base-URL> authURL=<authentication-URL> or a JSON format and the following keys { "clientId": "<client-id>", "clientSecret": "<client-key>", "subscriptionId": "<subscription-id>", "tenantId": "<tenant-id>", } and any custom endpoints listed in AzureEnvironment.

Returns:

The credentials based on the file.

Throws:

IOException - exception thrown from file access errors.

clientId

public String clientId()

Gets the active directory application client id. Also known as Application Id which Identifies the application that is using the token.

Returns:

the active directory application client id.

getToken

public String getToken(String resource)
                throws IOException

Description copied from class: AzureTokenCredentials

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

Specified by:

getToken in class AzureTokenCredentials

Parameters:

resource - the resource the access token is for

Returns:

the token to access the resource

Throws:

IOException - exceptions from IO