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, as long as supportedOptionalMethods is not modified directly (which is deprecated usage). For maximum efficiency, applications should use a single globally-shared instance of the HTTP transport.

Since:

1.3

Author:

Yaniv Inbar

Nested Class Summary

static class

MockHttpTransport.Builder Builder for MockHttpTransport.

Field Summary

static Set<HttpMethod>	DEFAULT_SUPPORTED_OPTIONAL_METHODS Default supported optional methods.
EnumSet<HttpMethod>	supportedOptionalMethods Deprecated. (scheduled to be made private in 1.6) Use getSupportedOptionalMethods() or MockHttpTransport.Builder.setSupportedOptionalMethods(java.util.Set)

Constructor Summary

	MockHttpTransport()
protected	MockHttpTransport(Set<HttpMethod> supportedOptionalMethods)

Method Summary

LowLevelHttpRequest	buildDeleteRequest(String url) Builds a DELETE request.
static MockHttpTransport.Builder	builder() Returns an instance of a new builder.
LowLevelHttpRequest	buildGetRequest(String url) Builds a GET request.
LowLevelHttpRequest	buildHeadRequest(String url) Builds a HEAD request.
LowLevelHttpRequest	buildPatchRequest(String url) Builds a PATCH request.
LowLevelHttpRequest	buildPostRequest(String url) Builds a POST request.
LowLevelHttpRequest	buildPutRequest(String url) Builds a PUT request.
Set<HttpMethod>	getSupportedOptionalMethods() Returns the set of supported optional methods.
void	setSupportedOptionalMethods(EnumSet<HttpMethod> supportedOptionalMethods)
boolean	supportsHead() Returns whether this HTTP transport implementation supports the HEAD request method.
boolean	supportsPatch() Returns whether this HTTP transport implementation supports the PATCH request method.

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

Field Detail

DEFAULT_SUPPORTED_OPTIONAL_METHODS

public static final Set<HttpMethod> DEFAULT_SUPPORTED_OPTIONAL_METHODS

Default supported optional methods.

Since:

1.5

supportedOptionalMethods

@Deprecated
public EnumSet<HttpMethod> supportedOptionalMethods

Deprecated. (scheduled to be made private in 1.6) Use getSupportedOptionalMethods() or MockHttpTransport.Builder.setSupportedOptionalMethods(java.util.Set)

Set of supported optional methods or HttpMethod.HEAD and HttpMethod.PATCH by default.

Constructor Detail

MockHttpTransport

public MockHttpTransport()

MockHttpTransport

protected MockHttpTransport(Set<HttpMethod> supportedOptionalMethods)

Parameters:

supportedOptionalMethods - set of supported optional methods

Since:

1.5

Method Detail

getSupportedOptionalMethods

public final Set<HttpMethod> getSupportedOptionalMethods()

Returns the set of supported optional methods.

Default value is DEFAULT_SUPPORTED_OPTIONAL_METHODS.

Since:

1.5

setSupportedOptionalMethods

public void setSupportedOptionalMethods(EnumSet<HttpMethod> supportedOptionalMethods)

Parameters:

supportedOptionalMethods - the supportedOptionalMethods to set

buildDeleteRequest

public LowLevelHttpRequest buildDeleteRequest(String url)
                                       throws IOException

Description copied from class: HttpTransport

Builds a DELETE request.

Specified by:

buildDeleteRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

buildGetRequest

public LowLevelHttpRequest buildGetRequest(String url)
                                    throws IOException

Description copied from class: HttpTransport

Builds a GET request.

Specified by:

buildGetRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

buildHeadRequest

public LowLevelHttpRequest buildHeadRequest(String url)
                                     throws IOException

Description copied from class: HttpTransport

Builds a HEAD request. Won't be called if HttpTransport.supportsHead() returns false .

Default implementation throws an UnsupportedOperationException.

Overrides:

buildHeadRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

buildPatchRequest

public LowLevelHttpRequest buildPatchRequest(String url)
                                      throws IOException

Description copied from class: HttpTransport

Builds a PATCH request. Won't be called if HttpTransport.supportsPatch() returns false.

Default implementation throws an UnsupportedOperationException.

Overrides:

buildPatchRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

buildPostRequest

public LowLevelHttpRequest buildPostRequest(String url)
                                     throws IOException

Description copied from class: HttpTransport

Builds a POST request.

Specified by:

buildPostRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

buildPutRequest

public LowLevelHttpRequest buildPutRequest(String url)
                                    throws IOException

Description copied from class: HttpTransport

Builds a PUT request.

Specified by:

buildPutRequest in class HttpTransport

Parameters:

url - URL

Throws:

IOException - I/O exception

supportsHead

public boolean supportsHead()

Description copied from class: HttpTransport

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

Default implementation returns false.

Overrides:

supportsHead in class HttpTransport

supportsPatch

public boolean supportsPatch()

Description copied from class: HttpTransport

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

Default implementation returns false.

Overrides:

supportsPatch in class HttpTransport

builder

public static MockHttpTransport.Builder builder()

Returns an instance of a new builder.

Since:

1.5