com.google.gdata.client

Class GoogleAuthTokenFactory.OAuth2Token

java.lang.Object

com.google.gdata.client.GoogleAuthTokenFactory.OAuth2Token

All Implemented Interfaces:

AuthTokenFactory.AuthToken, HttpAuthToken

Enclosing class:

GoogleAuthTokenFactory

public static class GoogleAuthTokenFactory.OAuth2Token
extends Object
implements HttpAuthToken

Encapsulates the OAuth 2.0 information used by applications to login on behalf of a user.

Constructor Summary

Constructors

Constructor and Description
GoogleAuthTokenFactory.OAuth2Token(com.google.api.client.auth.oauth2.Credential credential) Create a new GoogleAuthTokenFactory.OAuth2Token object.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAuthorizationHeader(URL requestUrl, String requestMethod) Returns the authorization header using the user's OAuth 2.0 credentials.
boolean	refreshToken() Use the Credential to request a new access token from the authorization endpoint.

Methods inherited from class java.lang.Object

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

Constructor Detail

GoogleAuthTokenFactory.OAuth2Token

public GoogleAuthTokenFactory.OAuth2Token(com.google.api.client.auth.oauth2.Credential credential)

Create a new GoogleAuthTokenFactory.OAuth2Token object. Store the Credential to use when generating the header.

Parameters:

credential - the required OAuth 2.0 credentials

Method Detail

getAuthorizationHeader

public String getAuthorizationHeader(URL requestUrl,
                            String requestMethod)

Returns the authorization header using the user's OAuth 2.0 credentials.

Specified by:

getAuthorizationHeader in interface HttpAuthToken

Parameters:

requestUrl - the URL being requested

requestMethod - the HTTP method of the request

Returns:

the authorization header to be used for the request

refreshToken

public boolean refreshToken()
                     throws AuthenticationException

Use the Credential to request a new access token from the authorization endpoint.

Returns:

whether a new access token was successfully retrieved

Throws:

AuthenticationException