Package com.google.api.client.auth.oauth

Class AbstractOAuthGetToken

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.http.GenericUrl

com.google.api.client.auth.oauth.AbstractOAuthGetToken

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

OAuthGetAccessToken, OAuthGetTemporaryToken

@Beta
public abstract class AbstractOAuthGetToken
extends com.google.api.client.http.GenericUrl

Beta
Generic OAuth 1.0a URL to request a temporary or long-lived token from an authorization server.

Since:

1.0

Author:

Yaniv Inbar

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K extends Object,V extends Object>, AbstractMap.SimpleImmutableEntry<K extends Object,V extends Object>

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Field Summary

Fields

Modifier and Type	Field	Description
String	consumerKey	Required identifier portion of the client credentials (equivalent to a username).
OAuthSigner	signer	Required OAuth signature algorithm.
com.google.api.client.http.HttpTransport	transport	HTTP transport required for executing request in execute().
protected boolean	usePost	true for POST request or the default false for GET request.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOAuthGetToken(String authorizationServerUrl)

Method Summary

Modifier and Type	Method	Description
OAuthParameters	createParameters()	Returns a new instance of the OAuth authentication provider.
OAuthCredentialsResponse	execute()	Executes the HTTP request for a temporary or long-lived token.

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class com.google.api.client.util.GenericData

entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class com.google.api.client.http.GenericUrl

appendRawPath, build, buildAuthority, buildRelativeUrl, clone, equals, getAll, getFirst, getFragment, getHost, getPathParts, getPort, getRawPath, getScheme, getUserInfo, hashCode, set, setFragment, setHost, setPathParts, setPort, setRawPath, setScheme, setUserInfo, toPathParts, toString, toURI, toURL, toURL

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

transport

public com.google.api.client.http.HttpTransport transport

HTTP transport required for executing request in execute().

Since:

1.3

consumerKey

public String consumerKey

Required identifier portion of the client credentials (equivalent to a username).

signer

public OAuthSigner signer

Required OAuth signature algorithm.

usePost

protected boolean usePost

true for POST request or the default false for GET request.

Constructor Detail

AbstractOAuthGetToken

protected AbstractOAuthGetToken(String authorizationServerUrl)

Parameters:

authorizationServerUrl - encoded authorization server URL

Method Detail

execute

public final OAuthCredentialsResponse execute()
                                       throws IOException

Executes the HTTP request for a temporary or long-lived token.

Returns:

OAuth credentials response object

Throws:

IOException

createParameters

public OAuthParameters createParameters()

Returns a new instance of the OAuth authentication provider. Subclasses may override by calling this super implementation and then adding OAuth parameters.