Class MockHttpTransport

java.lang.Object

com.google.api.client.http.HttpTransport

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

@Beta
public class MockHttpTransport
extends HttpTransport

Beta
Mock for HttpTransport.

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

Since:

1.3

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	Description
private MockLowLevelHttpRequest	lowLevelHttpRequest	The MockLowLevelHttpRequest to be returned by buildRequest(String, String).
private MockLowLevelHttpResponse	lowLevelHttpResponse	The MockLowLevelHttpResponse to be returned when this MockHttpTransport executes the associated request.
private Set<String>	supportedMethods	Supported HTTP methods or null to specify that all methods are supported.

Constructor Summary

Constructors

Modifier	Constructor	Description
	MockHttpTransport()
protected	MockHttpTransport(MockHttpTransport.Builder builder)

Method Summary

Modifier and Type	Method	Description
LowLevelHttpRequest	buildRequest(String method, String url)	Builds a low level HTTP request for the given HTTP method.
final MockLowLevelHttpRequest	getLowLevelHttpRequest()	Returns the MockLowLevelHttpRequest that is associated with this MockHttpTransport.Builder, or null if no such instance exists.
final Set<String>	getSupportedMethods()	Returns the unmodifiable set of supported HTTP methods or null to specify that all methods are supported.
boolean	supportsMethod(String method)	Returns whether a specified HTTP method is supported by this transport.

Methods inherited from class HttpTransport

createRequestFactory, createRequestFactory, isMtls, isShutdown, shutdown

Methods inherited from class Object

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

Field Details

supportedMethods

private Set<String> supportedMethods

Supported HTTP methods or null to specify that all methods are supported.

lowLevelHttpRequest

private MockLowLevelHttpRequest lowLevelHttpRequest

The MockLowLevelHttpRequest to be returned by buildRequest(String, String). If this field is null, buildRequest(String, String) will create a new instance from its arguments.

lowLevelHttpResponse

private MockLowLevelHttpResponse lowLevelHttpResponse

The MockLowLevelHttpResponse to be returned when this MockHttpTransport executes the associated request. Note that this field is ignored if the caller provided a non-null MockLowLevelHttpRequest with this MockHttpTransport was built.

Constructor Details

MockHttpTransport

public MockHttpTransport()

MockHttpTransport

protected MockHttpTransport(MockHttpTransport.Builder builder)

Parameters:

builder - builder

Since:

1.14

Method Details

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

public LowLevelHttpRequest 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

getSupportedMethods

public final Set<String> getSupportedMethods()

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

getLowLevelHttpRequest

public final MockLowLevelHttpRequest getLowLevelHttpRequest()

Returns the MockLowLevelHttpRequest that is associated with this MockHttpTransport.Builder, or null if no such instance exists.

Since:

1.18