com.microsoft.azure.credentials

Class DelegatedTokenCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

com.microsoft.azure.credentials.AzureTokenCredentials

com.microsoft.azure.credentials.DelegatedTokenCredentials

All Implemented Interfaces:

ServiceClientCredentials

@Beta(value=V1_2_0)
public class DelegatedTokenCredentials
extends AzureTokenCredentials

Token based credentials to authenticate an application on behalf of a user.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DelegatedTokenCredentials.ResponseMode Specifies the method that should be used to send the resulting token back to your app.

Constructor Summary

Constructors

Constructor and Description
DelegatedTokenCredentials(ApplicationTokenCredentials applicationCredentials, String redirectUrl) Initializes a new instance of the DelegatedTokenCredentials.
DelegatedTokenCredentials(ApplicationTokenCredentials applicationCredentials, String redirectUrl, String authorizationCode) Initializes a new instance of the DelegatedTokenCredentials, with a pre-acquired oauth2 authorization code.

Method Summary

Modifier and Type	Method and Description
String	clientId()
static DelegatedTokenCredentials	fromFile(File authFile, String redirectUrl) Creates a new instance of the DelegatedTokenCredentials from an auth file.
static DelegatedTokenCredentials	fromFile(File authFile, String redirectUrl, String authorizationCode) Creates a new instance of the DelegatedTokenCredentials from an auth file, with a pre-acquired oauth2 authorization code.
String	generateAuthenticationUrl()
String	generateAuthenticationUrl(DelegatedTokenCredentials.ResponseMode responseMode, String state) Generate the URL to authenticate through OAuth2.
String	getToken(String resource) Override this method to provide the mechanism to get a token.
void	setAuthorizationCode(String authorizationCode) Set the authorization code acquired returned to the redirect URL.

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

DelegatedTokenCredentials

public DelegatedTokenCredentials(ApplicationTokenCredentials applicationCredentials,
                                 String redirectUrl)

Initializes a new instance of the DelegatedTokenCredentials.

Parameters:

applicationCredentials - the credentials representing a service principal

redirectUrl - the URL to redirect to after authentication in Active Directory

DelegatedTokenCredentials

public DelegatedTokenCredentials(ApplicationTokenCredentials applicationCredentials,
                                 String redirectUrl,
                                 String authorizationCode)

Initializes a new instance of the DelegatedTokenCredentials, with a pre-acquired oauth2 authorization code.

Parameters:

applicationCredentials - the credentials representing a service principal

redirectUrl - the URL to redirect to after authentication in Active Directory

authorizationCode - the oauth2 authorization code

Method Detail

fromFile

public static DelegatedTokenCredentials fromFile(File authFile,
                                                 String redirectUrl)
                                          throws IOException

Creates a new instance of the DelegatedTokenCredentials from an auth file.

Parameters:

authFile - The credentials based on the file

redirectUrl - the URL to redirect to after authentication in Active Directory

Returns:

a new delegated token credentials

Throws:

IOException - exception thrown from file access errors.

fromFile

public static DelegatedTokenCredentials fromFile(File authFile,
                                                 String redirectUrl,
                                                 String authorizationCode)
                                          throws IOException

Creates a new instance of the DelegatedTokenCredentials from an auth file, with a pre-acquired oauth2 authorization code.

Parameters:

authFile - The credentials based on the file

redirectUrl - the URL to redirect to after authentication in Active Directory

authorizationCode - the oauth2 authorization code

Returns:

a new delegated token credentials

Throws:

IOException - exception thrown from file access errors.

clientId

public String clientId()

Returns:

the active directory application client id

generateAuthenticationUrl

public String generateAuthenticationUrl()

Returns:

the URL to authenticate through OAuth2

generateAuthenticationUrl

public String generateAuthenticationUrl(DelegatedTokenCredentials.ResponseMode responseMode,
                                        String state)

Generate the URL to authenticate through OAuth2.

Parameters:

responseMode - the method that should be used to send the resulting token back to your app

state - a value included in the request that is also returned in the token response

Returns:

the URL to authenticate through OAuth2

setAuthorizationCode

public void setAuthorizationCode(String authorizationCode)

Set the authorization code acquired returned to the redirect URL.

Parameters:

authorizationCode - the oauth2 authorization code

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