Package com.google.api.client.testing.http

Class MockLowLevelHttpRequest

java.lang.Object

com.google.api.client.http.LowLevelHttpRequest

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

@Beta
public class MockLowLevelHttpRequest
extends LowLevelHttpRequest

Beta
Mock for LowLevelHttpRequest.

Implementation is not thread-safe.

Since:

1.3

Field Summary

Fields

Modifier and Type	Field	Description
private java.util.Map<java.lang.String,java.util.List<java.lang.String>>	headersMap	Map of lowercase header name to values.
private MockLowLevelHttpResponse	response	HTTP response to return from execute().
private java.lang.String	url	Request URL or null for none.

Constructor Summary

Constructors

Constructor	Description
MockLowLevelHttpRequest()
MockLowLevelHttpRequest(java.lang.String url)

Method Summary

Modifier and Type	Method	Description
void	addHeader(java.lang.String name, java.lang.String value)	Adds a header to the HTTP request.
LowLevelHttpResponse	execute()	Executes the request and returns a low-level HTTP response object.
java.lang.String	getContentAsString()	Returns HTTP content as a string, taking care of any encodings of the content if necessary.
java.lang.String	getFirstHeaderValue(java.lang.String name)	Returns the value of the first header of the given name or null for none.
java.util.Map<java.lang.String,java.util.List<java.lang.String>>	getHeaders()	Returns an unmodifiable view of the map of lowercase header name to values.
java.util.List<java.lang.String>	getHeaderValues(java.lang.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().
java.lang.String	getUrl()	Returns the request URL or null for none.
MockLowLevelHttpRequest	setResponse(MockLowLevelHttpResponse response)	Sets the HTTP response to return from execute().
MockLowLevelHttpRequest	setUrl(java.lang.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

Field Detail

url

private java.lang.String url

Request URL or null for none.

headersMap

private final java.util.Map<java.lang.String,java.util.List<java.lang.String>> headersMap

Map of lowercase header name to values.

response

private MockLowLevelHttpResponse response

HTTP response to return from execute().

By default this is a new instance of MockLowLevelHttpResponse.

Constructor Detail

MockLowLevelHttpRequest

public MockLowLevelHttpRequest()

MockLowLevelHttpRequest

public MockLowLevelHttpRequest(java.lang.String url)

Parameters:

url - Request URL or null for none

Since:

1.4

Method Detail

addHeader

public void addHeader(java.lang.String name,
                      java.lang.String value)
               throws java.io.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:

java.io.IOException

execute

public LowLevelHttpResponse execute()
                             throws java.io.IOException

Description copied from class: LowLevelHttpRequest

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

Specified by:

execute in class LowLevelHttpRequest

Throws:

java.io.IOException

getUrl

public java.lang.String getUrl()

Returns the request URL or null for none.

Since:

1.5

getHeaders

public java.util.Map<java.lang.String,java.util.List<java.lang.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.

Since:

1.5

getFirstHeaderValue

public java.lang.String getFirstHeaderValue(java.lang.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 java.util.List<java.lang.String> getHeaderValues(java.lang.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(java.lang.String url)

Sets the request URL or null for none.

Since:

1.5

getContentAsString

public java.lang.String getContentAsString()
                                    throws java.io.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:

java.io.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.