Google OAuth2 API v2 (revision 36)

com.google.api.services.oauth2
Class Oauth2

java.lang.Object
  com.google.api.client.googleapis.services.AbstractGoogleClient
      com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient
          com.google.api.services.oauth2.Oauth2

public class Oauth2
extends AbstractGoogleJsonClient

Service definition for Oauth2 (v2).

Lets you access OAuth2 protocol related APIs.

For more information about this service, see the API Documentation

This service uses Oauth2RequestInitializer to initialize global parameters via its Oauth2.Builder.

Upgrade warning: this class now extends AbstractGoogleJsonClient, whereas in prior version 1.8 it extended GoogleClient.

Since:

1.3

Author:

Google, Inc.

Nested Class Summary

static class	Oauth2.Builder Builder for Oauth2.
class	Oauth2.Tokeninfo
class	Oauth2.Userinfo The "userinfo" collection of methods.

Field Summary

static String	DEFAULT_BASE_URL Deprecated. (scheduled to be removed in 1.13)
static String	DEFAULT_ROOT_URL The default encoded root URL of the service.
static String	DEFAULT_SERVICE_PATH The default encoded service path of the service.

Constructor Summary

Oauth2(HttpTransport transport, JsonFactory jsonFactory, HttpRequestInitializer httpRequestInitializer)
Constructor.

Method Summary

protected void	initialize(AbstractGoogleClientRequest<?> httpClientRequest)
Oauth2.Tokeninfo	tokeninfo() Create a request for the method "tokeninfo".
Oauth2.Userinfo	userinfo() An accessor for creating requests from the Userinfo collection.

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClient

getJsonFactory, getObjectParser

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClient

batch, batch, getApplicationName, getBaseUrl, getGoogleClientRequestInitializer, getRequestFactory, getRootUrl, getServicePath, getSuppressPatternChecks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ROOT_URL

public static final String DEFAULT_ROOT_URL

The default encoded root URL of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_SERVICE_PATH

public static final String DEFAULT_SERVICE_PATH

The default encoded service path of the service. This is determined when the library is generated and normally should not be changed.

Since:

1.7

See Also:

Constant Field Values

DEFAULT_BASE_URL

@Deprecated
public static final String DEFAULT_BASE_URL

Deprecated. (scheduled to be removed in 1.13)

The default encoded base URL of the service. This is determined when the library is generated and normally should not be changed.

See Also:

Constant Field Values

Constructor Detail

Oauth2

public Oauth2(HttpTransport transport,
              JsonFactory jsonFactory,
              HttpRequestInitializer httpRequestInitializer)

Constructor.

Use Oauth2.Builder if you need to specify any of the optional parameters.

Parameters:

transport - HTTP transport

jsonFactory - JSON factory

httpRequestInitializer - HTTP request initializer or null for none

Since:

1.7

Method Detail

initialize

protected void initialize(AbstractGoogleClientRequest<?> httpClientRequest)
                   throws IOException

Overrides:

initialize in class AbstractGoogleClient

Throws:

IOException

userinfo

public Oauth2.Userinfo userinfo()

An accessor for creating requests from the Userinfo collection.

The typical use is:

   Oauth2 oauth2 = new Oauth2(...);
   Oauth2.Userinfo.List request = oauth2.userinfo().list(parameters ...)
 

Returns:

the resource collection

tokeninfo

public Oauth2.Tokeninfo tokeninfo()
                           throws IOException

Create a request for the method "tokeninfo". This request holds the parameters needed by the the oauth2 server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Returns:

the request

Throws:

IOException