com.google.auth.oauth2

Class OAuth2Credentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

Direct Known Subclasses:

GoogleCredentials

public abstract class OAuth2Credentials
extends Credentials

Base type for Credentials using OAuth2.

Constructor Summary

Constructors

Constructor and Description
OAuth2Credentials() Default constructor.
OAuth2Credentials(AccessToken accessToken) Constructor with explicit access token.

Method Summary

Modifier and Type	Method and Description
String	getAuthenticationType()
Map<String,List<String>>	getRequestMetadata(URI uri) Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.
boolean	hasRequestMetadata()
boolean	hasRequestMetadataOnly()
void	refresh() Refresh the token by discarding the cached token and metadata.
abstract AccessToken	refreshAccessToken() Abstract method to refresh the access token according to the specific type of credentials.

Methods inherited from class com.google.auth.Credentials

getRequestMetadata

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuth2Credentials

public OAuth2Credentials()

Default constructor.

OAuth2Credentials

public OAuth2Credentials(AccessToken accessToken)

Constructor with explicit access token.

Parameters:

accessToken - Initial or temporary access token.

Method Detail

getAuthenticationType

public String getAuthenticationType()

Specified by:

getAuthenticationType in class Credentials

hasRequestMetadata

public boolean hasRequestMetadata()

Specified by:

hasRequestMetadata in class Credentials

hasRequestMetadataOnly

public boolean hasRequestMetadataOnly()

Specified by:

hasRequestMetadataOnly in class Credentials

getRequestMetadata

public Map<String,List<String>> getRequestMetadata(URI uri)
                                            throws IOException

Provide the request metadata by ensuring there is a current access token and providing it as an authorization bearer token.

Specified by:

getRequestMetadata in class Credentials

Throws:

IOException

refresh

public void refresh()
             throws IOException

Refresh the token by discarding the cached token and metadata.

Specified by:

refresh in class Credentials

Throws:

IOException

refreshAccessToken

public abstract AccessToken refreshAccessToken()
                                        throws IOException

Abstract method to refresh the access token according to the specific type of credentials.

Throws:

IOException