com.google.api.client.testing.http

Class MockLowLevelHttpRequest

java.lang.Object

com.google.api.client.http.LowLevelHttpRequest

com.google.api.client.testing.http.MockLowLevelHttpRequest

public class MockLowLevelHttpRequest
extends LowLevelHttpRequest

Mock for LowLevelHttpRequest.

Implementation is not thread-safe.

Since:

1.3

Author:

Yaniv Inbar

Constructor Summary

Constructors

Constructor and Description
MockLowLevelHttpRequest()
MockLowLevelHttpRequest(String url)

Method Summary

Methods

Modifier and Type	Method and Description
void	addHeader(String name, String value) Adds a header to the HTTP request.
LowLevelHttpResponse	execute() Executes the request and returns a low-level HTTP response object.
HttpContent	getContent() Deprecated. (scheduled to be removed in 1.15) Use LowLevelHttpRequest.getContentLength(), LowLevelHttpRequest.getContentEncoding(), LowLevelHttpRequest.getContentType(), or LowLevelHttpRequest.getStreamingContent() instead.
String	getContentAsString() Returns HTTP content as a string, taking care of any encodings of the content if necessary.
String	getFirstHeaderValue(String name) Returns the value of the first header of the given name or null for none.
Map<String,List<String>>	getHeaders() Returns an unmodifiable view of the map of lowercase header name to values.
List<String>	getHeaderValues(String name) Returns the unmodifiable list of values of the headers of the given name (may be empty).
MockLowLevelHttpResponse	getResponse() HTTP response to return from execute().
String	getUrl() Returns the request URL or null for none.
void	setContent(HttpContent content) Deprecated.
MockLowLevelHttpRequest	setResponse(MockLowLevelHttpResponse response) Sets the HTTP response to return from execute().
MockLowLevelHttpRequest	setUrl(String url) Sets the request URL or null for none.

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

getContentEncoding, getContentLength, getContentType, getStreamingContent, setContentEncoding, setContentLength, setContentType, setStreamingContent, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

MockLowLevelHttpRequest

public MockLowLevelHttpRequest()

MockLowLevelHttpRequest

public MockLowLevelHttpRequest(String url)

Parameters:

url - Request URL or null for none

Since:

1.4

Method Detail

addHeader

public void addHeader(String name,
             String value)
               throws IOException

Description copied from class: LowLevelHttpRequest

Adds a header to the HTTP request.

Note that multiple headers of the same name need to be supported, in which case LowLevelHttpRequest.addHeader(java.lang.String, java.lang.String) will be called for each instance of the header.

Specified by:

addHeader in class LowLevelHttpRequest

Parameters:

name - header name

value - header value

Throws:

IOException

execute

public LowLevelHttpResponse execute()
                             throws IOException

Description copied from class: LowLevelHttpRequest

Executes the request and returns a low-level HTTP response object.

Specified by:

execute in class LowLevelHttpRequest

Throws:

IOException

setContent

@Deprecated
public void setContent(HttpContent content)
                throws IOException

Deprecated.

Description copied from class: LowLevelHttpRequest

Sets the HTTP request content.

Default implementation does nothing.

Overrides:

setContent in class LowLevelHttpRequest

Throws:

IOException - I/O exception

getUrl

public String getUrl()

Returns the request URL or null for none.

Since:

1.5

getHeaders

public Map<String,List<String>> getHeaders()

Returns an unmodifiable view of the map of lowercase header name to values.

Note that unlike this method, getFirstHeaderValue(String) and getHeaderValues(String) are not case sensitive with respect to the input header name.

Upgrade warning: in prior version 1.13 the keys could be in any case, but starting with version 1.14, the keys will all be lowercase.

Since:

1.5

getFirstHeaderValue

public String getFirstHeaderValue(String name)

Returns the value of the first header of the given name or null for none.

Parameters:

name - header name (may be any case)

Since:

1.13

getHeaderValues

public List<String> getHeaderValues(String name)

Returns the unmodifiable list of values of the headers of the given name (may be empty).

Parameters:

name - header name (may be any case)

Since:

1.13

setUrl

public MockLowLevelHttpRequest setUrl(String url)

Sets the request URL or null for none.

Since:

1.5

getContent

@Deprecated
public HttpContent getContent()

Deprecated. (scheduled to be removed in 1.15) Use LowLevelHttpRequest.getContentLength(), LowLevelHttpRequest.getContentEncoding(), LowLevelHttpRequest.getContentType(), or LowLevelHttpRequest.getStreamingContent() instead.

Returns the HTTP content or null for none.

Since:

1.5

getContentAsString

public String getContentAsString()
                          throws IOException

Returns HTTP content as a string, taking care of any encodings of the content if necessary.

Returns an empty string if there is no HTTP content.

Throws:

IOException

Since:

1.12

getResponse

public MockLowLevelHttpResponse getResponse()

HTTP response to return from execute().

Since:

1.8

setResponse

public MockLowLevelHttpRequest setResponse(MockLowLevelHttpResponse response)

Sets the HTTP response to return from execute().

By default this is a new instance of MockLowLevelHttpResponse.