com.google.auth.oauth2

Class OAuth2Credentials

java.lang.Object

com.google.auth.Credentials

com.google.auth.oauth2.OAuth2Credentials

Direct Known Subclasses:

GoogleCredentials

public class OAuth2Credentials
extends Credentials

Base type for Credentials using OAuth2.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OAuth2Credentials.CredentialsChangedListener Listener for changes to credentials.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(OAuth2Credentials.CredentialsChangedListener listener) Adds a listener that is notified when the Credentials data changes.
AccessToken	getAccessToken()
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.
AccessToken	refreshAccessToken() 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

protected 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

getAccessToken

public final AccessToken getAccessToken()

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 AccessToken refreshAccessToken()
                               throws IOException

Method to refresh the access token according to the specific type of credentials. Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.

Throws:

IOException - from derived implementations

addChangeListener

public final void addChangeListener(OAuth2Credentials.CredentialsChangedListener listener)

Adds a listener that is notified when the Credentials data changes.

This is called when token content changes, such as when the access token is refreshed. This is typically used by code caching the access token.

Parameters:

listener - The listener to be added.