Package okhttp3.mockwebserver

Class MockResponse

java.lang.Object

okhttp3.mockwebserver.MockResponse

All Implemented Interfaces:

java.lang.Cloneable

public final class MockResponse
extends java.lang.Object
implements java.lang.Cloneable

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
MockResponse	addHeader(java.lang.String header)	Adds header as an HTTP header.
MockResponse	addHeader(java.lang.String name, java.lang.Object value)	Adds a new header with the name and value.
MockResponse	addHeaderLenient(java.lang.String name, java.lang.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()
okio.Buffer	getBody()	Returns a copy of the raw HTTP payload.
long	getBodyDelay(java.util.concurrent.TimeUnit unit)
okhttp3.Headers	getHeaders()	Returns the HTTP headers, such as "Content-Length: 0".
long	getHeadersDelay(java.util.concurrent.TimeUnit unit)
int	getHttp2ErrorCode()
java.util.List<PushPromise>	getPushPromises()	Returns the streams the server will push with this response.
okhttp3.internal.http2.Settings	getSettings()
SocketPolicy	getSocketPolicy()
java.lang.String	getStatus()	Returns the HTTP response line, such as "HTTP/1.1 200 OK".
long	getThrottleBytesPerPeriod()
long	getThrottlePeriod(java.util.concurrent.TimeUnit unit)
okhttp3.WebSocketListener	getWebSocketListener()
MockResponse	removeHeader(java.lang.String name)	Removes all headers named name.
MockResponse	setBody(java.lang.String body)	Sets the response body to the UTF-8 encoded bytes of body.
MockResponse	setBody(okio.Buffer body)
MockResponse	setBodyDelay(long delay, java.util.concurrent.TimeUnit unit)	Set the delayed time of the response body to delay.
MockResponse	setChunkedBody(java.lang.String body, int maxChunkSize)	Sets the response body to the UTF-8 encoded bytes of body, chunked every maxChunkSize bytes.
MockResponse	setChunkedBody(okio.Buffer body, int maxChunkSize)	Sets the response body to body, chunked every maxChunkSize bytes.
MockResponse	setHeader(java.lang.String name, java.lang.Object value)	Removes all headers named name, then adds a new header with the name and value.
MockResponse	setHeaders(okhttp3.Headers headers)	Replaces all headers with those specified in headers.
MockResponse	setHeadersDelay(long delay, java.util.concurrent.TimeUnit unit)
MockResponse	setHttp2ErrorCode(int http2ErrorCode)	Sets the HTTP/2 error code to be returned when resetting the stream.
MockResponse	setResponseCode(int code)
MockResponse	setSocketPolicy(SocketPolicy socketPolicy)
MockResponse	setStatus(java.lang.String status)
MockResponse	throttleBody(long bytesPerPeriod, long period, java.util.concurrent.TimeUnit unit)	Throttles the request reader and response writer to sleep for the given period after each series of bytesPerPeriod bytes are transferred.
java.lang.String	toString()
MockResponse	withPush(PushPromise promise)	When protocols include Protocol.HTTP_2, this attaches a pushed stream to this response.
MockResponse	withSettings(okhttp3.internal.http2.Settings settings)	When protocols include HTTP/2, this pushes settings before writing the response.
MockResponse	withWebSocketUpgrade(okhttp3.WebSocketListener listener)	Attempts to perform a web socket upgrade on the connection.

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 java.lang.Object

getStatus

public java.lang.String getStatus()

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

setResponseCode

public MockResponse setResponseCode(int code)

setStatus

public MockResponse setStatus(java.lang.String status)

getHeaders

public okhttp3.Headers 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(java.lang.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(java.lang.String name,
                              java.lang.Object value)

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

addHeaderLenient

public MockResponse addHeaderLenient(java.lang.String name,
                                     java.lang.Object value)

Adds a new header with the name and value. This may be used to add multiple headers with the same name. Unlike addHeader(String, Object) this does not validate the name and value.

setHeader

public MockResponse setHeader(java.lang.String name,
                              java.lang.Object value)

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

setHeaders

public MockResponse setHeaders(okhttp3.Headers headers)

Replaces all headers with those specified in headers.

removeHeader

public MockResponse removeHeader(java.lang.String name)

Removes all headers named name.

getBody

public okio.Buffer getBody()

Returns a copy of the raw HTTP payload.

setBody

public MockResponse setBody(okio.Buffer body)

setBody

public MockResponse setBody(java.lang.String body)

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

setChunkedBody

public MockResponse setChunkedBody(okio.Buffer body,
                                   int maxChunkSize)

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

setChunkedBody

public MockResponse setChunkedBody(java.lang.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)

getHttp2ErrorCode

public int getHttp2ErrorCode()

setHttp2ErrorCode

public MockResponse setHttp2ErrorCode(int http2ErrorCode)

Sets the HTTP/2 error code to be returned when resetting the stream. This is only valid with SocketPolicy.RESET_STREAM_AT_START.

throttleBody

public MockResponse throttleBody(long bytesPerPeriod,
                                 long period,
                                 java.util.concurrent.TimeUnit unit)

Throttles the request reader and response writer to sleep for the given period after each series of bytesPerPeriod bytes are transferred. Use this to simulate network behavior.

getThrottleBytesPerPeriod

public long getThrottleBytesPerPeriod()

getThrottlePeriod

public long getThrottlePeriod(java.util.concurrent.TimeUnit unit)

setBodyDelay

public MockResponse setBodyDelay(long delay,
                                 java.util.concurrent.TimeUnit unit)

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

getBodyDelay

public long getBodyDelay(java.util.concurrent.TimeUnit unit)

setHeadersDelay

public MockResponse setHeadersDelay(long delay,
                                    java.util.concurrent.TimeUnit unit)

getHeadersDelay

public long getHeadersDelay(java.util.concurrent.TimeUnit unit)

withPush

public MockResponse withPush(PushPromise promise)

When protocols include Protocol.HTTP_2, this attaches a pushed stream to this response.

getPushPromises

public java.util.List<PushPromise> getPushPromises()

Returns the streams the server will push with this response.

withSettings

public MockResponse withSettings(okhttp3.internal.http2.Settings settings)

When protocols include HTTP/2, this pushes settings before writing the response.

getSettings

public okhttp3.internal.http2.Settings getSettings()

withWebSocketUpgrade

public MockResponse withWebSocketUpgrade(okhttp3.WebSocketListener listener)

Attempts to perform a web socket upgrade on the connection. This will overwrite any previously set status or body.

getWebSocketListener

public okhttp3.WebSocketListener getWebSocketListener()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object