com.google.api.client.googleapis.services

Class AbstractGoogleClient

java.lang.Object

com.google.api.client.googleapis.services.AbstractGoogleClient

Direct Known Subclasses:

AbstractGoogleJsonClient, MockGoogleClient

public abstract class AbstractGoogleClient
extends Object

Abstract thread-safe Google client.

Since:

1.12

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractGoogleClient.Builder Builder for AbstractGoogleClient.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGoogleClient(com.google.api.client.http.HttpTransport transport, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer, String rootUrl, String servicePath, com.google.api.client.util.ObjectParser objectParser) Constructor with required parameters.
protected	AbstractGoogleClient(com.google.api.client.http.HttpTransport transport, com.google.api.client.http.HttpRequestInitializer httpRequestInitializer, String rootUrl, String servicePath, com.google.api.client.util.ObjectParser objectParser, GoogleClientRequestInitializer googleClientRequestInitializer, String applicationName, boolean suppressPatternChecks)

Method Summary

Methods

Modifier and Type	Method and Description
BatchRequest	batch() Create an BatchRequest object from this Google API client instance.
BatchRequest	batch(com.google.api.client.http.HttpRequestInitializer httpRequestInitializer) Create an BatchRequest object from this Google API client instance.
String	getApplicationName() Returns the application name to be sent in the User-Agent header of each request or null for none.
String	getBaseUrl() Returns the URL-encoded base URL of the service, for example "https://www.googleapis.com/tasks/v1/".
GoogleClientRequestInitializer	getGoogleClientRequestInitializer() Returns the Google client request initializer or null for none.
com.google.api.client.util.ObjectParser	getObjectParser() Returns the object parser or null for none.
com.google.api.client.http.HttpRequestFactory	getRequestFactory() Returns the HTTP request factory.
String	getRootUrl() Returns the URL-encoded root URL of the service, for example "https://www.googleapis.com/".
String	getServicePath() Returns the URL-encoded service path of the service, for example "tasks/v1/".
boolean	getSuppressPatternChecks() Returns whether discovery pattern checks should be suppressed on required parameters.
protected void	initialize(AbstractGoogleClientRequest<?> httpClientRequest) Initializes a AbstractGoogleClientRequest using a GoogleClientRequestInitializer.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractGoogleClient

protected AbstractGoogleClient(com.google.api.client.http.HttpTransport transport,
                    com.google.api.client.http.HttpRequestInitializer httpRequestInitializer,
                    String rootUrl,
                    String servicePath,
                    com.google.api.client.util.ObjectParser objectParser)

Constructor with required parameters.

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

Parameters:

transport - HTTP transport

httpRequestInitializer - HTTP request initializer or null for none

rootUrl - root URL of the service

servicePath - service path

objectParser - object parser

AbstractGoogleClient

protected AbstractGoogleClient(com.google.api.client.http.HttpTransport transport,
                    com.google.api.client.http.HttpRequestInitializer httpRequestInitializer,
                    String rootUrl,
                    String servicePath,
                    com.google.api.client.util.ObjectParser objectParser,
                    GoogleClientRequestInitializer googleClientRequestInitializer,
                    String applicationName,
                    boolean suppressPatternChecks)

Parameters:

transport - HTTP transport

httpRequestInitializer - HTTP request initializer or null for none

rootUrl - root URL of the service

servicePath - service path

objectParser - object parser or null for none

googleClientRequestInitializer - Google request initializer or null for none

applicationName - application name to be sent in the User-Agent header of requests or null for none

suppressPatternChecks - whether discovery pattern checks should be suppressed on required parameters

Method Detail

getRootUrl

public final String getRootUrl()

Returns the URL-encoded root URL of the service, for example "https://www.googleapis.com/".

Must end with a "/".

getServicePath

public final String getServicePath()

Returns the URL-encoded service path of the service, for example "tasks/v1/".

Must end with a "/" and not begin with a "/". It is allowed to be an empty string "" or a forward slash "/", if it is a forward slash then it is treated as an empty string

getBaseUrl

public final String getBaseUrl()

Returns the URL-encoded base URL of the service, for example "https://www.googleapis.com/tasks/v1/".

Must end with a "/". It is guaranteed to be equal to getRootUrl() + getServicePath().

getApplicationName

public final String getApplicationName()

Returns the application name to be sent in the User-Agent header of each request or null for none.

getRequestFactory

public final com.google.api.client.http.HttpRequestFactory getRequestFactory()

Returns the HTTP request factory.

getGoogleClientRequestInitializer

public final GoogleClientRequestInitializer getGoogleClientRequestInitializer()

Returns the Google client request initializer or null for none.

getObjectParser

public com.google.api.client.util.ObjectParser getObjectParser()

Returns the object parser or null for none.

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

initialize

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

Initializes a AbstractGoogleClientRequest using a GoogleClientRequestInitializer.

Must be called before the Google client request is executed, preferably right after the request is instantiated. Sample usage:

    public class Get extends HttpClientRequest {
      ...
    }

    public Get get(String userId) throws IOException {
      Get result = new Get(userId);
      initialize(result);
      return result;
    }
 

Subclasses may override by calling the super implementation.

Parameters:

httpClientRequest - Google client request type

Throws:

IOException

batch

public final BatchRequest batch()

Create an BatchRequest object from this Google API client instance.

Sample usage:

     client.batch()
         .queue(...)
         .queue(...)
         .execute();
 

Returns:

newly created Batch request

batch

public final BatchRequest batch(com.google.api.client.http.HttpRequestInitializer httpRequestInitializer)

Create an BatchRequest object from this Google API client instance.

Sample usage:

     client.batch(httpRequestInitializer)
         .queue(...)
         .queue(...)
         .execute();
 

Parameters:

httpRequestInitializer - The initializer to use when creating the top-level batch HTTP request or null for none

Returns:

newly created Batch request

getSuppressPatternChecks

public final boolean getSuppressPatternChecks()

Returns whether discovery pattern checks should be suppressed on required parameters.