Class AuthorizationCodeTokenRequest
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.auth.oauth2.TokenRequest
-
- com.google.api.client.auth.oauth2.AuthorizationCodeTokenRequest
-
public class AuthorizationCodeTokenRequest extends TokenRequest
OAuth 2.0 request for an access token using an authorization code as specified in Access Token Request.Use
Credential
to access protected resources from the resource server using theTokenResponse
returned byTokenRequest.execute()
. On error, it will instead throwTokenResponseException
.Sample usage:
static void requestAccessToken() throws IOException { try { TokenResponse response = new AuthorizationCodeTokenRequest(new NetHttpTransport(), new JacksonFactory(), new GenericUrl("https://server.example.com/token"), "SplxlOBeZQQYbYS6WxSbIA") .setRedirectUri("https://client.example.com/rd") .setClientAuthentication( new BasicAuthentication("s6BhdRkqt3", "7Fjfp0ZBr1KtDRbnfVdmIw")).execute(); System.out.println("Access token: " + response.getAccessToken()); } catch (TokenResponseException e) { if (e.getDetails() != null) { System.err.println("Error: " + e.getDetails().getError()); if (e.getDetails().getErrorDescription() != null) { System.err.println(e.getDetails().getErrorDescription()); } if (e.getDetails().getErrorUri() != null) { System.err.println(e.getDetails().getErrorUri()); } } else { System.err.println(e.getMessage()); } } }
Some OAuth 2.0 providers don't support
BasicAuthentication
but instead supportClientParametersAuthentication
. In the above sample code, simply replace the class name and it will work the same way.Implementation is not thread-safe.
- Since:
- 1.7
- Author:
- Yaniv Inbar
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags
-
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>
-
-
Constructor Summary
Constructors Constructor Description AuthorizationCodeTokenRequest(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.GenericUrl tokenServerUrl, String code)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getCode()
Returns the authorization code generated by the authorization server.String
getRedirectUri()
Returns the redirect URI parameter matching the redirect URI parameter in the authorization request ornull
for none.AuthorizationCodeTokenRequest
set(String fieldName, Object value)
AuthorizationCodeTokenRequest
setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
Sets the client authentication ornull
for none.AuthorizationCodeTokenRequest
setCode(String code)
Sets the authorization code generated by the authorization server.AuthorizationCodeTokenRequest
setGrantType(String grantType)
Sets the grant type ("authorization_code"
,"password"
,"client_credentials"
,"refresh_token"
or absolute URI of the extension grant type).AuthorizationCodeTokenRequest
setRedirectUri(String redirectUri)
Sets the redirect URI parameter matching the redirect URI parameter in the authorization request ornull
for none.AuthorizationCodeTokenRequest
setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
Sets the HTTP request initializer ornull
for none.AuthorizationCodeTokenRequest
setScopes(Collection<String> scopes)
Sets the list of scopes (as specified in Access Token Scope) ornull
for none.AuthorizationCodeTokenRequest
setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)
Sets the token server URL.-
Methods inherited from class com.google.api.client.auth.oauth2.TokenRequest
execute, executeUnparsed, getClientAuthentication, getGrantType, getJsonFactory, getRequestInitializer, getScopes, getTokenServerUrl, getTransport
-
Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys
-
Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values
-
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll
-
-
-
-
Constructor Detail
-
AuthorizationCodeTokenRequest
public AuthorizationCodeTokenRequest(com.google.api.client.http.HttpTransport transport, com.google.api.client.json.JsonFactory jsonFactory, com.google.api.client.http.GenericUrl tokenServerUrl, String code)
- Parameters:
transport
- HTTP transportjsonFactory
- JSON factorytokenServerUrl
- token server URLcode
- authorization code generated by the authorization server
-
-
Method Detail
-
setRequestInitializer
public AuthorizationCodeTokenRequest setRequestInitializer(com.google.api.client.http.HttpRequestInitializer requestInitializer)
Description copied from class:TokenRequest
Sets the HTTP request initializer ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Overrides:
setRequestInitializer
in classTokenRequest
-
setTokenServerUrl
public AuthorizationCodeTokenRequest setTokenServerUrl(com.google.api.client.http.GenericUrl tokenServerUrl)
Description copied from class:TokenRequest
Sets the token server URL.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Overrides:
setTokenServerUrl
in classTokenRequest
-
setScopes
public AuthorizationCodeTokenRequest setScopes(Collection<String> scopes)
Description copied from class:TokenRequest
Sets the list of scopes (as specified in Access Token Scope) ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Overrides:
setScopes
in classTokenRequest
- Parameters:
scopes
- collection of scopes to be joined by a space separator (or a single value containing multiple space-separated scopes)
-
setGrantType
public AuthorizationCodeTokenRequest setGrantType(String grantType)
Description copied from class:TokenRequest
Sets the grant type ("authorization_code"
,"password"
,"client_credentials"
,"refresh_token"
or absolute URI of the extension grant type).Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Overrides:
setGrantType
in classTokenRequest
-
setClientAuthentication
public AuthorizationCodeTokenRequest setClientAuthentication(com.google.api.client.http.HttpExecuteInterceptor clientAuthentication)
Description copied from class:TokenRequest
Sets the client authentication ornull
for none.The recommended initializer by the specification is
BasicAuthentication
. All authorization servers must support that. A common alternative isClientParametersAuthentication
. An alternative client authentication method may be provided that implementsHttpRequestInitializer
.This HTTP request execute interceptor is guaranteed to be the last execute interceptor before the request is executed, and after any execute interceptor set by the
TokenRequest.getRequestInitializer()
.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
- Overrides:
setClientAuthentication
in classTokenRequest
-
getCode
public final String getCode()
Returns the authorization code generated by the authorization server.
-
setCode
public AuthorizationCodeTokenRequest setCode(String code)
Sets the authorization code generated by the authorization server.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
getRedirectUri
public final String getRedirectUri()
Returns the redirect URI parameter matching the redirect URI parameter in the authorization request ornull
for none.
-
setRedirectUri
public AuthorizationCodeTokenRequest setRedirectUri(String redirectUri)
Sets the redirect URI parameter matching the redirect URI parameter in the authorization request ornull
for none.Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.
-
set
public AuthorizationCodeTokenRequest set(String fieldName, Object value)
- Overrides:
set
in classTokenRequest
-
-