com.microsoft.rest.credentials

Class TokenCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

All Implemented Interfaces:

ServiceClientCredentials

Direct Known Subclasses:

AzureTokenCredentials, BatchApplicationTokenCredentials, BatchUserTokenCredentials

public class TokenCredentials
extends Object
implements ServiceClientCredentials

Token based credentials for use with a REST Service Client.

Constructor Summary

Constructors

Constructor and Description
TokenCredentials(String scheme, String token) Initializes a new instance of the TokenCredentials.

Method Summary

Modifier and Type	Method and Description
void	applyCredentialsFilter(okhttp3.OkHttpClient.Builder clientBuilder) Apply the credentials to the HTTP client builder.
protected String	getScheme() Get the authentication scheme.
protected String	getToken(okhttp3.Request request) Get the secure token.

Methods inherited from class java.lang.Object

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

Constructor Detail

TokenCredentials

public TokenCredentials(String scheme,
                        String token)

Initializes a new instance of the TokenCredentials.

Parameters:

scheme - scheme to use. If null, defaults to Bearer

token - valid token

Method Detail

getToken

protected String getToken(okhttp3.Request request)
                   throws IOException

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

Parameters:

request - the context of the HTTP request

Returns:

the secure token.

Throws:

IOException - exception thrown from token acquisition operations.

getScheme

protected String getScheme()

Get the authentication scheme.

Returns:

the authentication scheme

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

Parameters:

clientBuilder - the builder for building up an OkHttpClient