com.google.api.client.http

Class HttpTransport

java.lang.Object

com.google.api.client.http.HttpTransport

Direct Known Subclasses:

ApacheHttpTransport, MockHttpTransport, NetHttpTransport

public abstract class HttpTransport
extends Object

Thread-safe abstract HTTP transport.

Implementation is thread-safe, and sub-classes must be thread-safe. For maximum efficiency, applications should use a single globally-shared instance of the HTTP transport.

The recommended concrete implementation HTTP transport library to use depends on what environment you are running in:

• Google App Engine: use com.google.api.client.appengine.UrlFetchTransport.
  • com.google.api.client.apache.ApacheHttpTransport doesn't work on App Engine because the Apache HTTP Client opens its own sockets (though in theory there are ways to hack it to work on App Engine that might work).
  • com.google.api.client.javanet.NetHttpTransport is discouraged due to a bug in the App Engine SDK itself in how it parses HTTP headers in the response.
• Android:
  • Starting with SDK 2.3, strongly recommended to use com.google.api.client.javanet.NetHttpTransport. Their Apache HTTP Client implementation is not as well maintained.
  • For SDK 2.2 and earlier, use com.google.api.client.apache.ApacheHttpTransport. com.google.api.client.javanet.NetHttpTransport is not recommended due to some bugs in the Android SDK implementation of HttpURLConnection.
• Other Java environments
  • com.google.api.client.javanet.NetHttpTransport is based on the HttpURLConnection built into the Java SDK, so it is normally the preferred choice.
  • com.google.api.client.apache.ApacheHttpTransport is a good choice for users of the Apache HTTP Client, especially if you need some of the configuration options available in that library.

Some HTTP transports do not support all HTTP methods. Use supportsMethod(String) to check if a certain HTTP method is supported. Calling buildRequest() on a method that is not supported will result in an IllegalArgumentException.

Subclasses should override supportsMethod(String) and buildRequest(String, String) to build requests and specify which HTTP methods are supported.

Since:

1.0

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
HttpTransport()

Method Summary

Methods

Modifier and Type	Method and Description
protected LowLevelHttpRequest	buildDeleteRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildGetRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildHeadRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildPatchRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildPostRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildPutRequest(String url) Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead
protected LowLevelHttpRequest	buildRequest(String method, String url) Builds a low level HTTP request for the given HTTP method.
HttpRequestFactory	createRequestFactory() Returns a new instance of an HTTP request factory based on this HTTP transport.
HttpRequestFactory	createRequestFactory(HttpRequestInitializer initializer) Returns a new instance of an HTTP request factory based on this HTTP transport with the given HTTP request initializer.
void	shutdown() Default implementation does nothing, but subclasses may override to possibly release allocated system resources or close connections.
boolean	supportsHead() Deprecated. (scheduled to be removed in 1.14) Use supportsMethod(String) instead
boolean	supportsMethod(String method) Returns whether a specified HTTP method is supported by this transport.
boolean	supportsPatch() Deprecated. (scheduled to be removed in 1.14) Use supportsMethod(String) instead

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpTransport

public HttpTransport()

Method Detail

createRequestFactory

public final HttpRequestFactory createRequestFactory()

Returns a new instance of an HTTP request factory based on this HTTP transport.

Returns:

new instance of an HTTP request factory

Since:

1.4

createRequestFactory

public final HttpRequestFactory createRequestFactory(HttpRequestInitializer initializer)

Returns a new instance of an HTTP request factory based on this HTTP transport with the given HTTP request initializer.

Parameters:

initializer - HTTP request initializer or null for none

Returns:

new instance of an HTTP request factory

Since:

1.4

supportsHead

@Deprecated
public boolean supportsHead()
                     throws IOException

Deprecated. (scheduled to be removed in 1.14) Use supportsMethod(String) instead

Returns whether this HTTP transport implementation supports the HEAD request method.

Default implementation calls supportsMethod(java.lang.String).

Upgrade warning: this method now throws an IOException. In prior version 1.11 it did not throw an exception.

Throws:

IOException

Since:

1.3

supportsPatch

@Deprecated
public boolean supportsPatch()
                      throws IOException

Deprecated. (scheduled to be removed in 1.14) Use supportsMethod(String) instead

Returns whether this HTTP transport implementation supports the PATCH request method.

Default implementation calls supportsMethod(java.lang.String).

Upgrade warning: this method now throws an IOException. In prior version 1.11 it did not throw an exception.

Throws:

IOException

Since:

1.3

supportsMethod

public boolean supportsMethod(String method)
                       throws IOException

Returns whether a specified HTTP method is supported by this transport.

Default implementation returns true if and only if the request method is "DELETE", "GET", "POST", or "PUT". Subclasses should override.

Parameters:

method - HTTP method

Throws:

IOException - I/O exception

Since:

1.12

buildRequest

protected LowLevelHttpRequest buildRequest(String method,
                               String url)
                                    throws IOException

Builds a low level HTTP request for the given HTTP method.

Warning: for backwards compatibility, in version 1.12 a default implementation that throws an IllegalArgumentException is provided, but it will be made abstract in the next version 1.13.

Parameters:

method - HTTP method

url - URL

Returns:

new low level HTTP request

Throws:

IllegalArgumentException - if HTTP method is not supported

IOException - I/O exception

Since:

1.12

buildDeleteRequest

@Deprecated
protected LowLevelHttpRequest buildDeleteRequest(String url)
                                          throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a DELETE request.

Default implementation calls buildRequest().

Parameters:

url - URL

Throws:

IOException

Since:

1.3

buildGetRequest

@Deprecated
protected LowLevelHttpRequest buildGetRequest(String url)
                                       throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a GET request.

Default implementation calls buildRequest().

Parameters:

url - URL

Throws:

IOException

Since:

1.3

buildHeadRequest

@Deprecated
protected LowLevelHttpRequest buildHeadRequest(String url)
                                        throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a HEAD request.

Won't be called if supportsHead() returns false.

Default implementation calls buildRequest().

Upgrade warning: in prior version it threw an UnsupportedOperationException by default}.

Parameters:

url - URL

Throws:

IOException

Since:

1.3

buildPatchRequest

@Deprecated
protected LowLevelHttpRequest buildPatchRequest(String url)
                                         throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a PATCH request.

Won't be called if supportsPatch() returns false.

Default implementation calls buildRequest().

Upgrade warning: in prior version it threw an UnsupportedOperationException by default}.

Parameters:

url - URL

Throws:

IOException

Since:

1.3

buildPostRequest

@Deprecated
protected LowLevelHttpRequest buildPostRequest(String url)
                                        throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a POST request.

Default implementation calls buildRequest().

Parameters:

url - URL

Throws:

IOException

Since:

1.3

buildPutRequest

@Deprecated
protected LowLevelHttpRequest buildPutRequest(String url)
                                       throws IOException

Deprecated. (scheduled to be removed in 1.14) Use buildRequest(String, String) instead

Builds a PUT request.

Default implementation calls buildRequest().

Parameters:

url - URL

Throws:

IOException

Since:

1.3

shutdown

public void shutdown()
              throws IOException

Default implementation does nothing, but subclasses may override to possibly release allocated system resources or close connections.

Throws:

IOException - I/O exception

Since:

1.4