Class MockClientHttpRequest

java.lang.Object

org.springframework.mock.http.MockHttpOutputMessage

org.springframework.mock.http.client.MockClientHttpRequest

All Implemented Interfaces:

ClientHttpRequest, HttpMessage, HttpOutputMessage, HttpRequest

public class MockClientHttpRequest
extends MockHttpOutputMessage
implements ClientHttpRequest

Mock implementation of ClientHttpRequest.

Since:

3.2

Author:

Rossen Stoyanchev, Brian Clozel, Sam Brannen

Constructor Summary

Constructors

Constructor	Description
MockClientHttpRequest()	Create a MockClientHttpRequest with GET as the HTTP request method and "/" as the URI.
MockClientHttpRequest(HttpMethod httpMethod, String uriTemplate, Object... vars)	Create a MockClientHttpRequest with the given HttpMethod, URI template, and URI template variable values.
MockClientHttpRequest(HttpMethod httpMethod, URI uri)	Create a MockClientHttpRequest with the given HttpMethod and URI.

Method Summary

Modifier and Type	Method	Description
final ClientHttpResponse	execute()	Set the executed flag to true and return the configured response.
protected ClientHttpResponse	executeInternal()	The default implementation returns the configured response.
Map<String,Object>	getAttributes()	Return a mutable map of request attributes for this request.
HttpMethod	getMethod()	Return the HTTP method of the request.
URI	getURI()	Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).
boolean	isExecuted()	Get the executed flag.
void	setMethod(HttpMethod httpMethod)	Set the HTTP method of the request.
void	setResponse(ClientHttpResponse clientHttpResponse)	Set the ClientHttpResponse to be used as the result of executing this request.
void	setURI(URI uri)	Set the URI of the request.
String	toString()

Methods inherited from class MockHttpOutputMessage

getBody, getBodyAsBytes, getBodyAsString, getBodyAsString, getHeaders

Methods inherited from class Object

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

Methods inherited from interface HttpMessage

getHeaders

Methods inherited from interface HttpOutputMessage

getBody

Constructor Details

MockClientHttpRequest

public MockClientHttpRequest()

Create a MockClientHttpRequest with GET as the HTTP request method and "/" as the URI.

MockClientHttpRequest

public MockClientHttpRequest(HttpMethod httpMethod,
 String uriTemplate,
 Object... vars)

Create a MockClientHttpRequest with the given HttpMethod, URI template, and URI template variable values.

Since:

6.0.3

MockClientHttpRequest

public MockClientHttpRequest(HttpMethod httpMethod,
 URI uri)

Create a MockClientHttpRequest with the given HttpMethod and URI.

Method Details

setMethod

public void setMethod(HttpMethod httpMethod)

Set the HTTP method of the request.

getMethod

public HttpMethod getMethod()

Description copied from interface: HttpRequest

Return the HTTP method of the request.

Specified by:

getMethod in interface HttpRequest

Returns:

the HTTP method as an HttpMethod value

See Also:

• HttpMethod.valueOf(String)

setURI

public void setURI(URI uri)

Set the URI of the request.

getURI

public URI getURI()

Description copied from interface: HttpRequest

Return the URI of the request (including a query string if any, but only if it is well-formed for a URI representation).

Specified by:

getURI in interface HttpRequest

Returns:

the URI of the request (never null)

setResponse

public void setResponse(ClientHttpResponse clientHttpResponse)

Set the ClientHttpResponse to be used as the result of executing this request.

See Also:

• execute()

isExecuted

public boolean isExecuted()

Get the executed flag.

See Also:

• execute()

getAttributes

public Map<String,Object> getAttributes()

Description copied from interface: HttpRequest

Return a mutable map of request attributes for this request.

Specified by:

getAttributes in interface HttpRequest

execute

public final ClientHttpResponse execute()
                                 throws IOException

Set the executed flag to true and return the configured response.

Specified by:

execute in interface ClientHttpRequest

Returns:

the response result of the execution

Throws:

IOException - in case of I/O errors

See Also:

• executeInternal()

executeInternal

protected ClientHttpResponse executeInternal()
                                      throws IOException

The default implementation returns the configured response.

Override this method to execute the request and provide a response, potentially different from the configured response.

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object