com.squareup.okhttp.mockwebserver

Class MockResponse

java.lang.Object

com.squareup.okhttp.mockwebserver.MockResponse

All Implemented Interfaces:

Cloneable

public final class MockResponse
extends Object
implements Cloneable

A scripted response to be replayed by the mock web server.

Constructor Summary

Constructors

Constructor and Description
MockResponse() Creates a new mock response with an empty body.

Method Summary

Methods

Modifier and Type	Method and Description
MockResponse	addHeader(String header) Adds header as an HTTP header.
MockResponse	addHeader(String name, Object value) Adds a new header with the name and value.
MockResponse	clearHeaders() Removes all HTTP headers including any "Content-Length" and "Transfer-encoding" headers that were added by default.
MockResponse	clone()
byte[]	getBody() Returns the raw HTTP payload, or null if this response is streamed.
int	getBodyDelayTimeMs()
List<String>	getHeaders() Returns the HTTP headers, such as "Content-Length: 0".
List<PushPromise>	getPushPromises() Returns the streams the server will push with this response.
SocketPolicy	getSocketPolicy()
String	getStatus() Returns the HTTP response line, such as "HTTP/1.1 200 OK".
int	getThrottleBytesPerPeriod()
long	getThrottlePeriod()
TimeUnit	getThrottleUnit()
MockResponse	removeHeader(String name) Removes all headers named name.
MockResponse	setBody(byte[] body)
MockResponse	setBody(InputStream bodyStream, long bodyLength)
MockResponse	setBody(String body) Sets the response body to the UTF-8 encoded bytes of body.
MockResponse	setBodyDelayTimeMs(int delay) Set the delayed time of the response body to delay.
MockResponse	setChunkedBody(byte[] body, int maxChunkSize) Sets the response body to body, chunked every maxChunkSize bytes.
MockResponse	setChunkedBody(String body, int maxChunkSize) Sets the response body to the UTF-8 encoded bytes of body, chunked every maxChunkSize bytes.
MockResponse	setHeader(String name, Object value) Removes all headers named name, then adds a new header with the name and value.
MockResponse	setResponseCode(int code)
MockResponse	setSocketPolicy(SocketPolicy socketPolicy)
MockResponse	setStatus(String status)
MockResponse	throttleBody(int bytesPerPeriod, long period, TimeUnit unit) Throttles the response body writer to sleep for the given period after each series of bytesPerPeriod bytes are written.
String	toString()
MockResponse	withPush(PushPromise promise) When protocols include a SPDY variant, this attaches a pushed stream to this response.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockResponse

public MockResponse()

Creates a new mock response with an empty body.

Method Detail

clone

public MockResponse clone()

Overrides:

clone in class Object

getStatus

public String getStatus()

Returns the HTTP response line, such as "HTTP/1.1 200 OK".

setResponseCode

public MockResponse setResponseCode(int code)

setStatus

public MockResponse setStatus(String status)

getHeaders

public List<String> getHeaders()

Returns the HTTP headers, such as "Content-Length: 0".

clearHeaders

public MockResponse clearHeaders()

Removes all HTTP headers including any "Content-Length" and "Transfer-encoding" headers that were added by default.

addHeader

public MockResponse addHeader(String header)

Adds header as an HTTP header. For well-formed HTTP header should contain a name followed by a colon and a value.

addHeader

public MockResponse addHeader(String name,
                     Object value)

Adds a new header with the name and value. This may be used to add multiple headers with the same name.

setHeader

public MockResponse setHeader(String name,
                     Object value)

Removes all headers named name, then adds a new header with the name and value.

removeHeader

public MockResponse removeHeader(String name)

Removes all headers named name.

getBody

public byte[] getBody()

Returns the raw HTTP payload, or null if this response is streamed.

setBody

public MockResponse setBody(byte[] body)

setBody

public MockResponse setBody(InputStream bodyStream,
                   long bodyLength)

setBody

public MockResponse setBody(String body)

Sets the response body to the UTF-8 encoded bytes of body.

setChunkedBody

public MockResponse setChunkedBody(byte[] body,
                          int maxChunkSize)

Sets the response body to body, chunked every maxChunkSize bytes.

setChunkedBody

public MockResponse setChunkedBody(String body,
                          int maxChunkSize)

Sets the response body to the UTF-8 encoded bytes of body, chunked every maxChunkSize bytes.

getSocketPolicy

public SocketPolicy getSocketPolicy()

setSocketPolicy

public MockResponse setSocketPolicy(SocketPolicy socketPolicy)

throttleBody

public MockResponse throttleBody(int bytesPerPeriod,
                        long period,
                        TimeUnit unit)

Throttles the response body writer to sleep for the given period after each series of bytesPerPeriod bytes are written. Use this to simulate network behavior.

getThrottleBytesPerPeriod

public int getThrottleBytesPerPeriod()

getThrottlePeriod

public long getThrottlePeriod()

getThrottleUnit

public TimeUnit getThrottleUnit()

setBodyDelayTimeMs

public MockResponse setBodyDelayTimeMs(int delay)

Set the delayed time of the response body to delay. This applies to the response body only; response headers are not affected.

getBodyDelayTimeMs

public int getBodyDelayTimeMs()

withPush

public MockResponse withPush(PushPromise promise)

When protocols include a SPDY variant, this attaches a pushed stream to this response.

getPushPromises

public List<PushPromise> getPushPromises()

Returns the streams the server will push with this response.

toString

public String toString()

Overrides:

toString in class Object