public class

GoogleOAuthParameters

extends OAuthParameters

java.lang.Object
↳	com.google.gdata.client.authn.oauth.OAuthParameters
	↳	com.google.gdata.client.authn.oauth.GoogleOAuthParameters

Class Overview

Defines the parameters necessary for making OAuth requests against Google. Currently the only parameter is "scope", which indicates the resources the user can access.

Summary

Constants
String	SCOPE_KEY

[Expand]

Inherited Constants

From class com.google.gdata.client.authn.oauth.OAuthParameters

[Expand]

Inherited Fields

From class com.google.gdata.client.authn.oauth.OAuthParameters

Public Constructors
	GoogleOAuthParameters()

Public Methods
void	assertScopeExists() Checks to see if the scope exists.
boolean	checkScopeExists() Checks to see if the scope exists.
String	getScope() Return the request scope.
void	reset() Since the scope parameter may be different for each OAuth request, it is cleared between requests, and must be manually set before each request.
void	setScope(String scope) Sets the request scope.

[Expand]

Inherited Methods

From class com.google.gdata.client.authn.oauth.OAuthParameters

void	addCustomBaseParameter(String key, String value) Adds a parameter to be used when generating the OAuth signature.
void	addExtraParameter(String key, String value) Sets a parameter related to OAuth (but not used when generating the signature).
void	assertExists(String key, Map<String, String> params) Checks the given key to see if it exists, and throws an exception if it does not.
void	assertOAuthCallbackExists() Checks to see if the OAuth callback exists.
void	assertOAuthConsumerKeyExists() Checks to see if the OAuth Consumer Key exists.
void	assertOAuthConsumerSecretExists()
void	assertOAuthNonceExists() Checks to see if the OAuth nonce exists.
void	assertOAuthSignatureExists() Checks to see if the OAuth signature exists.
void	assertOAuthSignatureMethodExists() Checks to see if the OAuth signature method exists.
void	assertOAuthTimestampExists() Checks to see if the OAuth timestamp exists.
void	assertOAuthTokenExists() Checks to see if the OAuth token exists.
void	assertOAuthTokenSecretExists() Checks to see if the OAuth token secret exists.
void	assertOAuthVerifierExists() Checks to see if the OAuth Verifier exists.
void	assertRealmExists() Checks to see if the realm exists.
boolean	checkExists(String key, Map<String, String> params) Checks the given key to see if it exists.
boolean	checkOAuthCallbackExists() Checks to see if the OAuth callback exists.
boolean	checkOAuthConsumerKeyExists() Checks to see if the OAuth Consumer Key exists.
boolean	checkOAuthConsumerSecretExists()
boolean	checkOAuthNonceExists() Checks to see if the OAuth nonce exists.
boolean	checkOAuthSignatureExists() Checks to see if the OAuth signature exists.
boolean	checkOAuthSignatureMethodExists() Checks to see if the OAuth signature method exists.
boolean	checkOAuthTimestampExists() Checks to see if the OAuth timestamp exists.
boolean	checkOAuthTokenExists() Checks to see if the OAuth token exists.
boolean	checkOAuthTokenSecretExists() Checks to see if the OAuth token secret exists.
boolean	checkOAuthVerifierExists() Checks to see if the OAuth Verifier exists.
boolean	checkRealmExists() Checks to see if the realm exists.
String	get(String key, Map<String, String> params) Retrieves the value with the given key from the input map.
Map<String, String>	getBaseParameters() Return the parameters used to calculate the OAuth signature.
Map<String, String>	getExtraParameters() Returns any other parameters used in the OAuth process, such as the OAuth callback url.
String	getOAuthCallback() Returns the OAuth callback url.
String	getOAuthConsumerKey() Returns the OAuth Consumer Key.
String	getOAuthConsumerSecret()
String	getOAuthNonce() Returns the OAuth nonce.
String	getOAuthSignature() Returns the OAuth signature used to sign the current request.
String	getOAuthSignatureMethod() Returns the OAuth Signature Method.
String	getOAuthTimestamp() Returns the OAuth timestamp.
String	getOAuthToken() Returns the OAuth token.
String	getOAuthTokenSecret() Returns the OAuth Token Secret.
OAuthParameters.OAuthType	getOAuthType() Retrieves the OAuth type requested.
String	getOAuthVerifier() Returns the OAuth Verifier.
String	getRealm() Returns the Realm parameter to be used in the authorization header, as defined by	void	put(String key, String value, Map<String, String> params) Adds the key/value pair to the input map.
void	remove(String key, Map<String, String> params) Removes a key/value pair from the input map.
void	removeCustomBaseParameter(String key) Removes a parameter from the OAuth signature.
void	reset() Resets all transient parameters related to a single request, so that these parameters do not interfere with multiple requests.
void	setOAuthCallback(String oauthCallback) Sets the OAuth callback url.
void	setOAuthConsumerKey(String consumerKey) Sets the OAuth Consumer Key.
void	setOAuthConsumerSecret(String consumerSecret)
void	setOAuthNonce(String oauthNonce) Sets the OAuth nonce.
void	setOAuthSignature(String signature) Sets the OAuth signature used to sign the current request.
void	setOAuthSignatureMethod(String signatureMethod) Sets the OAuth Signature Method.
void	setOAuthTimestamp(String timestamp) Sets the OAuth timestamp.
void	setOAuthToken(String token) Sets the OAuth token.
void	setOAuthTokenSecret(String tokenSecret) Returns the OAuth Token Secret.
void	setOAuthType(OAuthParameters.OAuthType type) Sets the value of the OAuth type.
void	setOAuthVerifier(String verifier) Returns the OAuth Verifier.
void	setRealm(String realm) Sets the Realm parameter.

From class java.lang.Object

Constants

public static final String SCOPE_KEY

Constant Value: "scope"

Public Constructors

public GoogleOAuthParameters ()

Public Methods

public void assertScopeExists ()

Checks to see if the scope exists. Throws an exception if it does not. See getScope() to learn more about this parameter.

Throws

OAuthException	if the scope does not exist

public boolean checkScopeExists ()

Checks to see if the scope exists. See getScope() to learn more about this parameter.

Returns

true if the scope exists, false otherwise

public String getScope ()

Return the request scope. The scope is a URI defined by each Google service that indicates which resources the user has permissions to access. It is used when retrieving the unauthorized request token. Multiple scopes are separated with a space. This parameter is required for OAuth requests against Google.

public void reset ()

Since the scope parameter may be different for each OAuth request, it is cleared between requests, and must be manually set before each request.

public void setScope (String scope)

Sets the request scope. See getScope() to learn more about this parameter.

Parameters

scope

Interfaces

Classes

Enums

Exceptions

GoogleOAuthParameters

Class Overview

Summary

Constants

public static final String SCOPE_KEY

Public Constructors

public GoogleOAuthParameters ()

Public Methods

public void assertScopeExists ()

Throws

public boolean checkScopeExists ()

Returns

public String getScope ()

public void reset ()

public void setScope (String scope)

Parameters