com.microsoft.rest.credentials

Class TokenCredentials

java.lang.Object

com.microsoft.rest.credentials.TokenCredentials

All Implemented Interfaces:

ServiceClientCredentials

public class TokenCredentials
extends Object
implements ServiceClientCredentials

Token based credentials for use with a REST Service Client.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	scheme The authentication scheme.
protected String	token The secure token.

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.
String	getScheme() Get the authentication scheme.
String	getToken() Get the secure token.
void	refreshToken() Refresh the secure token.
void	setToken(String token) Set the secure token.

Methods inherited from class java.lang.Object

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

Field Detail

scheme

protected String scheme

The authentication scheme.

token

protected String token

The secure token.

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

public String getToken()
                throws IOException

Get the secure token.

Returns:

the secure token.

Throws:

IOException - exception thrown from token acquisition operations.

refreshToken

public void refreshToken()
                  throws IOException

Refresh the secure token.

Throws:

IOException - exception thrown from token acquisition operations.

setToken

public void setToken(String token)

Set the secure token.

Parameters:

token - the token string

getScheme

public 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