com.google.api.client.http.apache

Class ApacheHttpTransport

java.lang.Object

com.google.api.client.http.HttpTransport

com.google.api.client.http.apache.ApacheHttpTransport

public final class ApacheHttpTransport
extends HttpTransport

Thread-safe HTTP transport based on the Apache HTTP Client library.

Implementation is thread-safe, as long as any parameter modification to the Apache HTTP Client is only done at initialization time. For maximum efficiency, applications should use a single globally-shared instance of the HTTP transport.

Default settings are specified in newDefaultHttpClient(). Use the ApacheHttpTransport(HttpClient) constructor to override the Apache HTTP Client used. Alternatively, use ApacheHttpTransport() and change the getHttpClient(). Please read the Apache HTTP Client connection management tutorial for more complex configuration options.

Since:

1.0

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
ApacheHttpTransport() Constructor that uses newDefaultHttpClient() for the Apache HTTP client.
ApacheHttpTransport(org.apache.http.client.HttpClient httpClient) Constructor that allows an alternative Apache HTTP client to be used.

Method Summary

Methods

Modifier and Type	Method and Description
com.google.api.client.http.apache.ApacheHttpRequest	buildDeleteRequest(String url) Deprecated.
com.google.api.client.http.apache.ApacheHttpRequest	buildGetRequest(String url) Deprecated.
com.google.api.client.http.apache.ApacheHttpRequest	buildHeadRequest(String url) Deprecated.
com.google.api.client.http.apache.ApacheHttpRequest	buildPatchRequest(String url) Deprecated.
com.google.api.client.http.apache.ApacheHttpRequest	buildPostRequest(String url) Deprecated.
com.google.api.client.http.apache.ApacheHttpRequest	buildPutRequest(String url) Deprecated.
protected com.google.api.client.http.apache.ApacheHttpRequest	buildRequest(String method, String url) Builds a low level HTTP request for the given HTTP method.
org.apache.http.client.HttpClient	getHttpClient() Returns the Apache HTTP client.
static org.apache.http.impl.client.DefaultHttpClient	newDefaultHttpClient() Creates a new instance of the Apache HTTP client that is used by the ApacheHttpTransport() constructor.
void	shutdown() Shuts down the connection manager and releases allocated resources.
boolean	supportsHead() Deprecated.
boolean	supportsMethod(String method) Returns whether a specified HTTP method is supported by this transport.
boolean	supportsPatch() Deprecated.

Methods inherited from class com.google.api.client.http.HttpTransport

createRequestFactory, createRequestFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

ApacheHttpTransport

public ApacheHttpTransport()

Constructor that uses newDefaultHttpClient() for the Apache HTTP client.

Use ApacheHttpTransport.Builder to modify HTTP client options.

Upgrade warning: in prior version 1.12 the route planner was DefaultHttpRoutePlanner but starting with version 1.13 the route planner is ProxySelectorRoutePlanner.

Since:

1.3

ApacheHttpTransport

public ApacheHttpTransport(org.apache.http.client.HttpClient httpClient)

Constructor that allows an alternative Apache HTTP client to be used.

Note that a few settings are overridden:

• HTTP version is set to 1.1 using HttpProtocolParams.setVersion(org.apache.http.params.HttpParams, org.apache.http.ProtocolVersion) with HttpVersion.HTTP_1_1.
• Redirects are disabled using ClientPNames.HANDLE_REDIRECTS.
• ConnManagerParams.setTimeout(org.apache.http.params.HttpParams, long) and HttpConnectionParams.setConnectionTimeout(org.apache.http.params.HttpParams, int) are set on each request based on HttpRequest.getConnectTimeout().
• HttpConnectionParams.setSoTimeout(org.apache.http.params.HttpParams, int) is set on each request based on HttpRequest.getReadTimeout().

Use ApacheHttpTransport.Builder for a more user-friendly way to modify the HTTP client options.

Parameters:

httpClient - Apache HTTP client to use

Since:

1.6

Method Detail

newDefaultHttpClient

public static org.apache.http.impl.client.DefaultHttpClient newDefaultHttpClient()

Creates a new instance of the Apache HTTP client that is used by the ApacheHttpTransport() constructor.

Use this constructor if you want to customize the default Apache HTTP client. Settings:

• The client connection manager is set to ThreadSafeClientConnManager.
• The socket buffer size is set to 8192 using HttpConnectionParams.setSocketBufferSize(org.apache.http.params.HttpParams, int).
• new DefaultHttpRequestRetryHandler(0, false).
• The route planner uses ProxySelectorRoutePlanner with ProxySelector.getDefault(), which uses the proxy settings from system properties.

Upgrade warning: in prior version 1.12 the route planner was DefaultHttpRoutePlanner but starting with version 1.13 the route planner is ProxySelectorRoutePlanner.

Returns:

new instance of the Apache HTTP client

Since:

1.6

supportsMethod

public boolean supportsMethod(String method)

Description copied from class: HttpTransport

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.

Overrides:

supportsMethod in class HttpTransport

Parameters:

method - HTTP method

buildRequest

protected com.google.api.client.http.apache.ApacheHttpRequest buildRequest(String method,
                                                               String url)

Description copied from class: HttpTransport

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.

Overrides:

buildRequest in class HttpTransport

Parameters:

method - HTTP method

url - URL

Returns:

new low level HTTP request

supportsHead

@Deprecated
public boolean supportsHead()

Deprecated.

Description copied from class: HttpTransport

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

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

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

Overrides:

supportsHead in class HttpTransport

supportsPatch

@Deprecated
public boolean supportsPatch()

Deprecated.

Description copied from class: HttpTransport

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

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

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

Overrides:

supportsPatch in class HttpTransport

buildDeleteRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildDeleteRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a DELETE request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildDeleteRequest in class HttpTransport

Parameters:

url - URL

buildGetRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildGetRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a GET request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildGetRequest in class HttpTransport

Parameters:

url - URL

buildHeadRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildHeadRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a HEAD request.

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

Default implementation calls HttpTransport.buildRequest().

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

Overrides:

buildHeadRequest in class HttpTransport

Parameters:

url - URL

buildPatchRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildPatchRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a PATCH request.

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

Default implementation calls HttpTransport.buildRequest().

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

Overrides:

buildPatchRequest in class HttpTransport

Parameters:

url - URL

buildPostRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildPostRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a POST request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildPostRequest in class HttpTransport

Parameters:

url - URL

buildPutRequest

@Deprecated
public com.google.api.client.http.apache.ApacheHttpRequest buildPutRequest(String url)

Deprecated.

Description copied from class: HttpTransport

Builds a PUT request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildPutRequest in class HttpTransport

Parameters:

url - URL

shutdown

public void shutdown()

Shuts down the connection manager and releases allocated resources. This includes closing all connections, whether they are currently used or not.

Overrides:

shutdown in class HttpTransport

Since:

1.4

getHttpClient

public org.apache.http.client.HttpClient getHttpClient()

Returns the Apache HTTP client.

Since:

1.5