com.google.api.client.extensions.appengine.http

Class UrlFetchTransport

java.lang.Object

com.google.api.client.http.HttpTransport

com.google.api.client.extensions.appengine.http.UrlFetchTransport

public final class UrlFetchTransport
extends HttpTransport

Thread-safe HTTP transport for Google App Engine based on URL Fetch.

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

URL Fetch is only available on Google App Engine (not on any other Java environment), and is the underlying HTTP transport used for App Engine. Their implementation of HttpURLConnection is simply an abstraction layer on top of URL Fetch. By implementing a transport that directly uses URL Fetch, we can optimize the behavior slightly, and can potentially take advantage of features in URL Fetch that are not available in HttpURLConnection. Furthermore, there is currently a serious bug in how HTTP headers are processed in the App Engine implementation of HttpURLConnection, which we are able to avoid using this implementation. Therefore, this is the recommended transport to use on App Engine.

Since:

1.10

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
UrlFetchTransport() Constructor with the default fetch options.

Method Summary

Modifier and Type	Method and Description
protected com.google.api.client.extensions.appengine.http.UrlFetchRequest	buildRequest(String method, String url) Builds a low level HTTP request for the given HTTP method.
static UrlFetchTransport	getDefaultInstance() Returns a global thread-safe instance.
boolean	supportsMethod(String method) Returns whether a specified HTTP method is supported by this transport.

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

createRequestFactory, createRequestFactory, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

UrlFetchTransport

public UrlFetchTransport()

Constructor with the default fetch options.

Use UrlFetchTransport.Builder to modify fetch options.

Method Detail

getDefaultInstance

public static UrlFetchTransport getDefaultInstance()

Returns a global thread-safe instance.

Since:

1.17

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.extensions.appengine.http.UrlFetchRequest buildRequest(String method,
                                                                                       String url)
                                                                                throws IOException

Description copied from class: HttpTransport

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

Specified by:

buildRequest in class HttpTransport

Parameters:

method - HTTP method

url - URL

Returns:

new low level HTTP request

Throws:

IOException