com.google.api.client.googleapis.services

Class AbstractGoogleClientRequest<T>

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

Type Parameters:

T - type of the response

All Implemented Interfaces:

Cloneable, Map<String,Object>

Direct Known Subclasses:

AbstractGoogleJsonClientRequest, MockGoogleClientRequest

public abstract class AbstractGoogleClientRequest<T>
extends com.google.api.client.util.GenericData

Abstract Google client request for a AbstractGoogleClient.

Implementation is not thread-safe.

Since:

1.12

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,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_AGENT_SUFFIX User agent suffix for all requests.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractGoogleClientRequest(AbstractGoogleClient abstractGoogleClient, String requestMethod, String uriTemplate, com.google.api.client.http.HttpContent httpContent, Class<T> responseClass)

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequest() Create a request suitable for use against this service.
com.google.api.client.http.GenericUrl	buildHttpRequestUrl() Creates a new instance of GenericUrl suitable for use against this service.
protected com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead() Create a request suitable for use against this service, but using HEAD instead of GET.
protected void	checkRequiredParameter(Object value, String name) Ensures that the specified required parameter is not null or AbstractGoogleClient.getSuppressRequiredParameterChecks() is true.
T	execute() Sends the metadata request to the server and returns the parsed metadata response.
void	executeAndDownloadTo(OutputStream outputStream) Sends the metadata request to the server and writes the metadata content input stream of HttpResponse into the given destination output stream.
InputStream	executeAsInputStream() Sends the metadata request to the server and returns the metadata content input stream of HttpResponse.
protected com.google.api.client.http.HttpResponse	executeMedia() Sends the media request to the server and returns the raw media HttpResponse.
protected void	executeMediaAndDownloadTo(OutputStream outputStream) Sends the media request to the server and writes the media content input stream of HttpResponse into the given destination output stream.
protected InputStream	executeMediaAsInputStream() Sends the media request to the server and returns the media content input stream of HttpResponse.
com.google.api.client.http.HttpResponse	executeUnparsed() Sends the metadata request to the server and returns the raw metadata HttpResponse.
protected com.google.api.client.http.HttpResponse	executeUsingHead() Sends the metadata request using HEAD to the server and returns the raw metadata HttpResponse for the response headers.
AbstractGoogleClient	getAbstractGoogleClient() Returns the Google client.
boolean	getDisableGZipContent() Returns whether to disable GZip compression of HTTP content.
com.google.api.client.http.HttpContent	getHttpContent() Returns the HTTP content or null for none.
com.google.api.client.http.HttpHeaders	getLastResponseHeaders() Returns the HTTP headers of the last response or null before request has been executed.
int	getLastStatusCode() Returns the status code of the last response or -1 before request has been executed.
String	getLastStatusMessage() Returns the status message of the last response or null before request has been executed.
MediaHttpDownloader	getMediaHttpDownloader() Returns the media HTTP downloader or null for none.
MediaHttpUploader	getMediaHttpUploader() Returns the media HTTP Uploader or null for none.
com.google.api.client.http.HttpHeaders	getRequestHeaders() Returns the HTTP headers used for the Google client request.
String	getRequestMethod() Returns the HTTP method.
Class<T>	getResponseClass() Returns the response class to parse into.
boolean	getReturnRawInputSteam() Returns whether response should return raw input stream.
String	getUriTemplate() Returns the URI template for the path relative to the base URL.
protected void	initializeMediaDownload() Initializes the media HTTP downloader.
protected void	initializeMediaUpload(com.google.api.client.http.AbstractInputStreamContent mediaContent) Initializes the media HTTP uploader based on the media content.
protected IOException	newExceptionOnError(com.google.api.client.http.HttpResponse response) Returns the exception to throw on an HTTP error response as defined by HttpResponse.isSuccessStatusCode().
<E> void	queue(BatchRequest batchRequest, Class<E> errorClass, BatchCallback<T,E> callback) Queues the request into the specified batch request container using the specified error class.
AbstractGoogleClientRequest<T>	set(String fieldName, Object value)
AbstractGoogleClientRequest<T>	setDisableGZipContent(boolean disableGZipContent) Sets whether to disable GZip compression of HTTP content.
AbstractGoogleClientRequest<T>	setRequestHeaders(com.google.api.client.http.HttpHeaders headers) Sets the HTTP headers used for the Google client request.
AbstractGoogleClientRequest<T>	setReturnRawInputStream(boolean returnRawInputStream) Sets whether the response should return raw input stream or not.

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, 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

Field Detail

USER_AGENT_SUFFIX

public static final String USER_AGENT_SUFFIX

User agent suffix for all requests.

Since:

1.20

See Also:

Constant Field Values

Constructor Detail

AbstractGoogleClientRequest

protected AbstractGoogleClientRequest(AbstractGoogleClient abstractGoogleClient,
                                      String requestMethod,
                                      String uriTemplate,
                                      com.google.api.client.http.HttpContent httpContent,
                                      Class<T> responseClass)

Parameters:

abstractGoogleClient - Google client

requestMethod - HTTP Method

uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)

httpContent - HTTP content or null for none

responseClass - response class to parse into

Method Detail

getDisableGZipContent

public final boolean getDisableGZipContent()

Returns whether to disable GZip compression of HTTP content.

getReturnRawInputSteam

public final boolean getReturnRawInputSteam()

Returns whether response should return raw input stream.

Since:

1.30

setDisableGZipContent

public AbstractGoogleClientRequest<T> setDisableGZipContent(boolean disableGZipContent)

Sets whether to disable GZip compression of HTTP content.

By default it is false.

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

setReturnRawInputStream

public AbstractGoogleClientRequest<T> setReturnRawInputStream(boolean returnRawInputStream)

Sets whether the response should return raw input stream or not.

By default it is false.

When the response contains a known content-encoding header, the response stream is wrapped with an InputStream that decodes the content. This fails when we download large files in chunks (see #1009 ). Setting this to true will make the response return the raw input stream.

Since:

1.30

getRequestMethod

public final String getRequestMethod()

Returns the HTTP method.

getUriTemplate

public final String getUriTemplate()

Returns the URI template for the path relative to the base URL.

getHttpContent

public final com.google.api.client.http.HttpContent getHttpContent()

Returns the HTTP content or null for none.

getAbstractGoogleClient

public AbstractGoogleClient getAbstractGoogleClient()

Returns the Google client.

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

getRequestHeaders

public final com.google.api.client.http.HttpHeaders getRequestHeaders()

Returns the HTTP headers used for the Google client request.

setRequestHeaders

public AbstractGoogleClientRequest<T> setRequestHeaders(com.google.api.client.http.HttpHeaders headers)

Sets the HTTP headers used for the Google client request.

These headers are set on the request after buildHttpRequest() is called, this means that HttpRequestInitializer.initialize(com.google.api.client.http.HttpRequest) is called first.

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

getLastResponseHeaders

public final com.google.api.client.http.HttpHeaders getLastResponseHeaders()

Returns the HTTP headers of the last response or null before request has been executed.

getLastStatusCode

public final int getLastStatusCode()

Returns the status code of the last response or -1 before request has been executed.

getLastStatusMessage

public final String getLastStatusMessage()

Returns the status message of the last response or null before request has been executed.

getResponseClass

public final Class<T> getResponseClass()

Returns the response class to parse into.

getMediaHttpUploader

public final MediaHttpUploader getMediaHttpUploader()

Returns the media HTTP Uploader or null for none.

initializeMediaUpload

protected final void initializeMediaUpload(com.google.api.client.http.AbstractInputStreamContent mediaContent)

Initializes the media HTTP uploader based on the media content.

Parameters:

mediaContent - media content

getMediaHttpDownloader

public final MediaHttpDownloader getMediaHttpDownloader()

Returns the media HTTP downloader or null for none.

initializeMediaDownload

protected final void initializeMediaDownload()

Initializes the media HTTP downloader.

buildHttpRequestUrl

public com.google.api.client.http.GenericUrl buildHttpRequestUrl()

Creates a new instance of GenericUrl suitable for use against this service.

Subclasses may override by calling the super implementation.

Returns:

newly created GenericUrl

buildHttpRequest

public com.google.api.client.http.HttpRequest buildHttpRequest()
                                                        throws IOException

Create a request suitable for use against this service.

Subclasses may override by calling the super implementation.

Throws:

IOException

buildHttpRequestUsingHead

protected com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                    throws IOException

Create a request suitable for use against this service, but using HEAD instead of GET.

Only supported when the original request method is GET.

Subclasses may override by calling the super implementation.

Throws:

IOException

executeUnparsed

public com.google.api.client.http.HttpResponse executeUnparsed()
                                                        throws IOException

Sends the metadata request to the server and returns the raw metadata HttpResponse.

Callers are responsible for disconnecting the HTTP response by calling HttpResponse.disconnect(). Example usage:

 HttpResponse response = request.executeUnparsed();
 try {
   // process response..
 } finally {
   response.disconnect();
 }
 

Subclasses may override by calling the super implementation.

Returns:

the HttpResponse

Throws:

IOException

executeMedia

protected com.google.api.client.http.HttpResponse executeMedia()
                                                        throws IOException

Sends the media request to the server and returns the raw media HttpResponse.

Callers are responsible for disconnecting the HTTP response by calling HttpResponse.disconnect(). Example usage:

 HttpResponse response = request.executeMedia();
 try {
   // process response..
 } finally {
   response.disconnect();
 }
 

Subclasses may override by calling the super implementation.

Returns:

the HttpResponse

Throws:

IOException

executeUsingHead

protected com.google.api.client.http.HttpResponse executeUsingHead()
                                                            throws IOException

Sends the metadata request using HEAD to the server and returns the raw metadata HttpResponse for the response headers.

Only supported when the original request method is GET. The response content is assumed to be empty and ignored. Calls HttpResponse.ignore() so there is no need to disconnect the response. Example usage:

 HttpResponse response = request.executeUsingHead();
 // look at response.getHeaders()
 

Subclasses may override by calling the super implementation.

Returns:

the HttpResponse

Throws:

IOException

newExceptionOnError

protected IOException newExceptionOnError(com.google.api.client.http.HttpResponse response)

Returns the exception to throw on an HTTP error response as defined by HttpResponse.isSuccessStatusCode().

It is guaranteed that HttpResponse.isSuccessStatusCode() is false. Default implementation is to call HttpResponseException(HttpResponse), but subclasses may override.

Parameters:

response - HTTP response

Returns:

exception to throw

execute

public T execute()
          throws IOException

Sends the metadata request to the server and returns the parsed metadata response.

Subclasses may override by calling the super implementation.

Returns:

parsed HTTP response

Throws:

IOException

executeAsInputStream

public InputStream executeAsInputStream()
                                 throws IOException

Sends the metadata request to the server and returns the metadata content input stream of HttpResponse.

Callers are responsible for closing the input stream after it is processed. Example sample:

 InputStream is = request.executeAsInputStream();
 try {
   // Process input stream..
 } finally {
   is.close();
 }
 

Subclasses may override by calling the super implementation.

Returns:

input stream of the response content

Throws:

IOException

executeMediaAsInputStream

protected InputStream executeMediaAsInputStream()
                                         throws IOException

Sends the media request to the server and returns the media content input stream of HttpResponse.

Callers are responsible for closing the input stream after it is processed. Example sample:

 InputStream is = request.executeMediaAsInputStream();
 try {
   // Process input stream..
 } finally {
   is.close();
 }
 

Subclasses may override by calling the super implementation.

Returns:

input stream of the response content

Throws:

IOException

executeAndDownloadTo

public void executeAndDownloadTo(OutputStream outputStream)
                          throws IOException

Sends the metadata request to the server and writes the metadata content input stream of HttpResponse into the given destination output stream.

This method closes the content of the HTTP response from HttpResponse.getContent().

Subclasses may override by calling the super implementation.

Parameters:

outputStream - destination output stream

Throws:

IOException

executeMediaAndDownloadTo

protected void executeMediaAndDownloadTo(OutputStream outputStream)
                                  throws IOException

Sends the media request to the server and writes the media content input stream of HttpResponse into the given destination output stream.

This method closes the content of the HTTP response from HttpResponse.getContent().

Subclasses may override by calling the super implementation.

Parameters:

outputStream - destination output stream

Throws:

IOException

queue

public final <E> void queue(BatchRequest batchRequest,
                            Class<E> errorClass,
                            BatchCallback<T,E> callback)
                     throws IOException

Queues the request into the specified batch request container using the specified error class.

Batched requests are then executed when BatchRequest.execute() is called.

Parameters:

batchRequest - batch request container

errorClass - data class the unsuccessful response will be parsed into or Void.class to ignore the content

callback - batch callback

Throws:

IOException

set

public AbstractGoogleClientRequest<T> set(String fieldName,
                                          Object value)

Overrides:

set in class com.google.api.client.util.GenericData

checkRequiredParameter

protected final void checkRequiredParameter(Object value,
                                            String name)

Ensures that the specified required parameter is not null or AbstractGoogleClient.getSuppressRequiredParameterChecks() is true.

Parameters:

value - the value of the required parameter

name - the name of the required parameter

Throws:

IllegalArgumentException - if the specified required parameter is null and AbstractGoogleClient.getSuppressRequiredParameterChecks() is false

Since:

1.14