Package org.apache.juneau.rest.mock

Class MockRestResponse

java.lang.Object

org.apache.juneau.rest.client.RestResponse

org.apache.juneau.rest.mock.MockRestResponse

All Implemented Interfaces:

AutoCloseable, HttpMessage, HttpResponse

public class MockRestResponse
extends RestResponse

A subclass of RestResponse with additional features for mocked testing.

See Also:

• juneau-rest-mock Basics

Constructor Summary

Constructors

Constructor	Description
MockRestResponse(RestClient client, RestRequest request, HttpResponse response, Parser parser)	Constructor.

Method Summary

Modifier and Type	Method	Description
MockRestResponse	cacheContent()	Caches the response body so that it can be read as a stream multiple times.
MockRestResponse	consume()	Consumes the response body.

Methods inherited from class org.apache.juneau.rest.client.RestResponse

addHeader, addHeader, assertCharset, assertContent, assertContent, assertContentMatches, assertHeader, assertStatus, assertStatus, close, containsHeader, getAllHeaders, getCharacterEncoding, getContent, getContentType, getEntity, getFirstHeader, getHeader, getHeaders, getLastHeader, getLocale, getParams, getPartParserSession, getPartParserSession, getProtocolVersion, getReasonPhrase, getRequest, getStatusCode, getStatusLine, getStringHeader, headerIterator, headerIterator, log, log, removeHeader, removeHeaders, setEntity, setHeader, setHeader, setHeaders, setLocale, setParams, setReasonPhrase, setStatusCode, setStatusLine, setStatusLine, setStatusLine

Methods inherited from class java.lang.Object

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

Constructor Details

MockRestResponse

public MockRestResponse(RestClient client,
 RestRequest request,
 HttpResponse response,
 Parser parser)

Constructor.

Parameters:

client - The RestClient that created this response.

request - The REST request.

response - The HTTP response. Can be null.

parser - The overridden parser passed into RestRequest.parser(Parser).

Method Details

cacheContent

public MockRestResponse cacheContent()

Description copied from class: RestResponse

Caches the response body so that it can be read as a stream multiple times. This is equivalent to calling the following:

getContent().cache();

Overrides:

cacheContent in class RestResponse

Returns:

The body of the response.

consume

public MockRestResponse consume()

Description copied from class: RestResponse

Consumes the response body.

This is equivalent to closing the input stream.

Any exceptions thrown during close are logged but not propagated.

Overrides:

consume in class RestResponse

Returns:

This object.