|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.google.gdata.client.authn.oauth.OAuthParameters
com.google.gdata.client.authn.oauth.GoogleOAuthParameters
public class GoogleOAuthParameters
Defines the parameters necessary for making OAuth requests against Google. Currently the only parameter is "scope", which indicates the resources the user can access.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.google.gdata.client.authn.oauth.OAuthParameters |
---|
OAuthParameters.OAuthType |
Field Summary | |
---|---|
static java.lang.String |
SCOPE_KEY
|
Fields inherited from class com.google.gdata.client.authn.oauth.OAuthParameters |
---|
baseParameters, extraParameters, OAUTH_CALLBACK_KEY, OAUTH_CONSUMER_KEY, OAUTH_CONSUMER_SECRET, OAUTH_KEY, OAUTH_NONCE_KEY, OAUTH_SIGNATURE_KEY, OAUTH_SIGNATURE_METHOD_KEY, OAUTH_TIMESTAMP_KEY, OAUTH_TOKEN_KEY, OAUTH_TOKEN_SECRET_KEY, OAUTH_VERIFIER_KEY, REALM_KEY, XOAUTH_REQUESTOR_ID_KEY |
Constructor Summary | |
---|---|
GoogleOAuthParameters()
|
Method Summary | |
---|---|
void |
assertScopeExists()
Checks to see if the scope exists. |
boolean |
checkScopeExists()
Checks to see if the scope exists. |
java.lang.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(java.lang.String scope)
Sets the request scope. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String SCOPE_KEY
Constructor Detail |
---|
public GoogleOAuthParameters()
Method Detail |
---|
public java.lang.String getScope()
public void setScope(java.lang.String scope)
getScope()
to learn more about this
parameter.
public boolean checkScopeExists()
getScope()
to learn more
about this parameter.
public void assertScopeExists() throws OAuthException
getScope()
to learn more about this parameter.
OAuthException
- if the scope does not existpublic void reset()
reset
in class OAuthParameters
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |