com.google.api.client.testing.http

Class MockHttpTransport

java.lang.Object

com.google.api.client.http.HttpTransport

com.google.api.client.testing.http.MockHttpTransport

public class MockHttpTransport
extends HttpTransport

Mock for HttpTransport.

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

Upgrade warning: in prior version 1.11 this used HttpMethod to specify the set of supported methods, but now it uses a String instead to allow for arbitrary methods to be specified.

Since:

1.3

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	MockHttpTransport()
protected	MockHttpTransport(Set<String> supportedMethods)

Method Summary

Methods

Modifier and Type	Method and Description
LowLevelHttpRequest	buildDeleteRequest(String url) Deprecated.
static MockHttpTransport.Builder	builder() Returns an instance of a new builder.
LowLevelHttpRequest	buildGetRequest(String url) Deprecated.
LowLevelHttpRequest	buildHeadRequest(String url) Deprecated.
LowLevelHttpRequest	buildPatchRequest(String url) Deprecated.
LowLevelHttpRequest	buildPostRequest(String url) Deprecated.
LowLevelHttpRequest	buildPutRequest(String url) Deprecated.
protected LowLevelHttpRequest	buildRequest(String method, String url) Builds a low level HTTP request for the given HTTP method.
Set<String>	getSupportedMethods() Returns the unmodifiable set of supported HTTP methods or null to specify that all methods are supported.
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, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

MockHttpTransport

public MockHttpTransport()

MockHttpTransport

protected MockHttpTransport(Set<String> supportedMethods)

Parameters:

supportedMethods - supported HTTP methods or null to specify that all methods are supported

Since:

1.12

Method Detail

supportsMethod

public boolean supportsMethod(String method)
                       throws IOException

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

Throws:

IOException - I/O exception

buildRequest

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

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

Throws:

IOException - I/O exception

getSupportedMethods

public final Set<String> getSupportedMethods()

Returns the unmodifiable set of supported HTTP methods or null to specify that all methods are supported.

buildDeleteRequest

@Deprecated
public LowLevelHttpRequest buildDeleteRequest(String url)
                                       throws IOException

Deprecated.

Description copied from class: HttpTransport

Builds a DELETE request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildDeleteRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException

buildGetRequest

@Deprecated
public LowLevelHttpRequest buildGetRequest(String url)
                                    throws IOException

Deprecated.

Description copied from class: HttpTransport

Builds a GET request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildGetRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException

buildHeadRequest

@Deprecated
public LowLevelHttpRequest buildHeadRequest(String url)
                                     throws IOException

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

Throws:

IOException

buildPatchRequest

@Deprecated
public LowLevelHttpRequest buildPatchRequest(String url)
                                      throws IOException

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

Throws:

IOException

buildPostRequest

@Deprecated
public LowLevelHttpRequest buildPostRequest(String url)
                                     throws IOException

Deprecated.

Description copied from class: HttpTransport

Builds a POST request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildPostRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException

buildPutRequest

@Deprecated
public LowLevelHttpRequest buildPutRequest(String url)
                                    throws IOException

Deprecated.

Description copied from class: HttpTransport

Builds a PUT request.

Default implementation calls HttpTransport.buildRequest().

Overrides:

buildPutRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException

supportsHead

@Deprecated
public boolean supportsHead()
                     throws IOException

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

Throws:

IOException

supportsPatch

@Deprecated
public boolean supportsPatch()
                      throws IOException

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

Throws:

IOException

builder

public static MockHttpTransport.Builder builder()

Returns an instance of a new builder.

Since:

1.5