com.google.api.client.googleapis.services
Class GoogleClient

java.lang.Object
  extended by com.google.api.client.http.json.JsonHttpClient
      extended by com.google.api.client.googleapis.services.GoogleClient

public class GoogleClient
extends JsonHttpClient

Google API client.

Since:
1.6
Author:
Ravi Mistry

Nested Class Summary
static class GoogleClient.Builder
          Builder for GoogleClient.
 
Constructor Summary
  GoogleClient(HttpTransport transport, JsonFactory jsonFactory, String baseUrl)
          Constructor with required parameters.
protected GoogleClient(HttpTransport transport, JsonHttpRequestInitializer jsonHttpRequestInitializer, HttpRequestInitializer httpRequestInitializer, JsonFactory jsonFactory, String baseUrl, String applicationName)
          Construct the GoogleClient.
 
Method Summary
static GoogleClient.Builder builder(HttpTransport transport, JsonFactory jsonFactory, GenericUrl baseUrl)
          Returns an instance of a new builder.
protected  HttpRequest buildHttpRequest(HttpMethod method, GenericUrl url, Object body)
          Create an HttpRequest suitable for use against this service.
protected  HttpResponse executeUnparsed(HttpMethod method, GenericUrl url, Object body)
           
 
Methods inherited from class com.google.api.client.http.json.JsonHttpClient
createParser, createSerializer, executeAsInputStream, getApplicationName, getBaseUrl, getJsonFactory, getJsonHttpParser, getJsonHttpRequestInitializer, getRequestFactory, initialize
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GoogleClient

public GoogleClient(HttpTransport transport,
                    JsonFactory jsonFactory,
                    String baseUrl)
Constructor with required parameters.

Use builder(HttpTransport, JsonFactory, GenericUrl) if you need to specify any of the optional parameters.

Parameters:
transport - The transport to use for requests
jsonFactory - A factory for creating JSON parsers and serializers
baseUrl - The base URL of the service. Must end with a "/"

GoogleClient

protected GoogleClient(HttpTransport transport,
                       JsonHttpRequestInitializer jsonHttpRequestInitializer,
                       HttpRequestInitializer httpRequestInitializer,
                       JsonFactory jsonFactory,
                       String baseUrl,
                       String applicationName)
Construct the GoogleClient.

Parameters:
transport - The transport to use for requests
jsonHttpRequestInitializer - The initializer to use when creating an JsonHttpRequest or null for none
httpRequestInitializer - The initializer to use when creating an HttpRequest or null for none
jsonFactory - A factory for creating JSON parsers and serializers
baseUrl - The base URL of the service. Must end with a "/"
applicationName - The application name to be sent in the User-Agent header of requests or null for none
Method Detail

buildHttpRequest

protected HttpRequest buildHttpRequest(HttpMethod method,
                                       GenericUrl url,
                                       Object body)
                                throws IOException
Create an HttpRequest suitable for use against this service.

Overrides:
buildHttpRequest in class JsonHttpClient
Parameters:
method - HTTP Method type
url - The complete URL of the service where requests should be sent. It includes the base path along with the URI template
body - A POJO that can be serialized into JSON or null for none
Returns:
newly created HttpRequest
Throws:
IOException

builder

public static GoogleClient.Builder builder(HttpTransport transport,
                                           JsonFactory jsonFactory,
                                           GenericUrl baseUrl)
Returns an instance of a new builder.

Parameters:
transport - The transport to use for requests
jsonFactory - A factory for creating JSON parsers and serializers
baseUrl - The base URL of the service. Must end with a "/"

executeUnparsed

protected HttpResponse executeUnparsed(HttpMethod method,
                                       GenericUrl url,
                                       Object body)
                                throws IOException
Overrides:
executeUnparsed in class JsonHttpClient
Throws:
IOException


Copyright © 2010-2012 Google. All Rights Reserved.