Class AuthorizationCodeTokenRequest (1.36.0)

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 the TokenResponse returned by #execute(). On error, it will instead throw TokenResponseException.

Sample usage:

static void requestAccessToken() throws IOException { try { TokenResponse response = new AuthorizationCodeTokenRequest(new NetHttpTransport(), new GsonFactory(), 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 support ClientParametersAuthentication. In the above sample code, simply replace the class name and it will work the same way.

Implementation is not thread-safe.

Inheritance

Object > java.util.AbstractMap > com.google.api.client.util.GenericData > TokenRequest > AuthorizationCodeTokenRequest

Inherited Members

TokenRequest.execute()

TokenRequest.executeUnparsed()

TokenRequest.getClientAuthentication()

TokenRequest.getGrantType()

TokenRequest.getJsonFactory()

TokenRequest.getRequestInitializer()

TokenRequest.getResponseClass()

TokenRequest.getScopes()

TokenRequest.getTokenServerUrl()

TokenRequest.getTransport()

TokenRequest.set(String,Object)

TokenRequest.setClientAuthentication(HttpExecuteInterceptor)

TokenRequest.setGrantType(String)

TokenRequest.setRequestInitializer(HttpRequestInitializer)

TokenRequest.setResponseClass(Class<? extends TokenResponse>)

TokenRequest.setScopes(Collection<String>)

TokenRequest.setTokenServerUrl(GenericUrl)

com.google.api.client.util.GenericData.clone()

com.google.api.client.util.GenericData.entrySet()

com.google.api.client.util.GenericData.equals(java.lang.Object)

com.google.api.client.util.GenericData.get(java.lang.Object)

com.google.api.client.util.GenericData.getClassInfo()

com.google.api.client.util.GenericData.getUnknownKeys()

com.google.api.client.util.GenericData.hashCode()

com.google.api.client.util.GenericData.put(java.lang.String,java.lang.Object)

com.google.api.client.util.GenericData.putAll(java.util.Map<? extends java.lang.String,?>)

com.google.api.client.util.GenericData.remove(java.lang.Object)

com.google.api.client.util.GenericData.setUnknownKeys(java.util.Map<java.lang.String,java.lang.Object>)

com.google.api.client.util.GenericData.toString()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

AbstractMap.clear()

AbstractMap.containsKey(Object)

AbstractMap.containsValue(Object)

AbstractMap.isEmpty()

AbstractMap.keySet()

AbstractMap.put(K,V)

AbstractMap.putAll(Map<? extends K,? extends V>)

AbstractMap.size()

AbstractMap.values()

Constructors

AuthorizationCodeTokenRequest(HttpTransport transport, JsonFactory jsonFactory, GenericUrl tokenServerUrl, String code)

public AuthorizationCodeTokenRequest(HttpTransport transport, JsonFactory jsonFactory, GenericUrl tokenServerUrl, String code)

Parameters
Name	Description
`transport`	`com.google.api.client.http.HttpTransport` HTTP transport
`jsonFactory`	`com.google.api.client.json.JsonFactory` JSON factory
`tokenServerUrl`	`com.google.api.client.http.GenericUrl` token server URL
`code`	`String` authorization code generated by the authorization server

Methods

getCode()

public final String getCode()

Returns the authorization code generated by the authorization server.

Returns
Type	Description
`String`

getRedirectUri()

public final String getRedirectUri()

Returns the redirect URI parameter matching the redirect URI parameter in the authorization request or null for none.

Returns
Type	Description
`String`

set(String fieldName, Object value)

public AuthorizationCodeTokenRequest set(String fieldName, Object value)

Parameters
Name	Description
`fieldName`	`String`
`value`	`Object`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.set(String fieldName, Object value)

setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

public AuthorizationCodeTokenRequest setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

Sets the client authentication or null for none.

The recommended initializer by the specification is BasicAuthentication. All authorization servers must support that. A common alternative is ClientParametersAuthentication. An alternative client authentication method may be provided that implements HttpRequestInitializer.

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 #getRequestInitializer().

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name	Description
`clientAuthentication`	`com.google.api.client.http.HttpExecuteInterceptor`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setClientAuthentication(HttpExecuteInterceptor clientAuthentication)

setCode(String code)

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.

Parameter
Name	Description
`code`	`String`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

setGrantType(String grantType)

public AuthorizationCodeTokenRequest setGrantType(String grantType)

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.

Parameter
Name	Description
`grantType`	`String`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setGrantType(String grantType)

setRedirectUri(String redirectUri)

public AuthorizationCodeTokenRequest setRedirectUri(String redirectUri)

Sets the redirect URI parameter matching the redirect URI parameter in the authorization request or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name	Description
`redirectUri`	`String`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

setRequestInitializer(HttpRequestInitializer requestInitializer)

public AuthorizationCodeTokenRequest setRequestInitializer(HttpRequestInitializer requestInitializer)

Sets the HTTP request initializer or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name	Description
`requestInitializer`	`com.google.api.client.http.HttpRequestInitializer`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setRequestInitializer(HttpRequestInitializer requestInitializer)

setResponseClass(Class<? extends TokenResponse> responseClass)

public AuthorizationCodeTokenRequest setResponseClass(Class<? extends TokenResponse> responseClass)

Sets the TokenResponse class to allow specifying object parsing.

Parameter
Name	Description
`responseClass`	`Class<? extends com.google.api.client.auth.oauth2.TokenResponse>`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setResponseClass(Class<? extends TokenResponse> responseClass)

setScopes(Collection<String> scopes)

public AuthorizationCodeTokenRequest setScopes(Collection<String> scopes)

Sets the list of scopes (as specified in Access Token Scope) or null for none.

Overriding is only supported for the purpose of calling the super implementation and changing the return type, but nothing else.

Parameter
Name	Description
`scopes`	`Collection<String>`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setScopes(Collection<String> scopes)

setTokenServerUrl(GenericUrl tokenServerUrl)

public AuthorizationCodeTokenRequest setTokenServerUrl(GenericUrl tokenServerUrl)

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.

Parameter
Name	Description
`tokenServerUrl`	`com.google.api.client.http.GenericUrl`

Returns
Type	Description
`AuthorizationCodeTokenRequest`

Overrides

TokenRequest.setTokenServerUrl(GenericUrl tokenServerUrl)