MockResponse (MockWebServer 3.1.1 API)

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

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`	`addHeaderLenient(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()`
`okio.Buffer`	`getBody()` Returns a copy of the raw HTTP payload.
`long`	`getBodyDelay(TimeUnit unit)`
`Headers`	`getHeaders()` Returns the HTTP headers, such as "Content-Length: 0".
`List<PushPromise>`	`getPushPromises()` Returns the streams the server will push with this response.
`okhttp3.internal.framed.Settings`	`getSettings()`
`SocketPolicy`	`getSocketPolicy()`
`String`	`getStatus()` Returns the HTTP response line, such as "HTTP/1.1 200 OK".
`long`	`getThrottleBytesPerPeriod()`
`long`	`getThrottlePeriod(TimeUnit unit)`
`WebSocketListener`	`getWebSocketListener()`
`MockResponse`	`removeHeader(String name)` Removes all headers named `name`.
`MockResponse`	`setBody(okio.Buffer body)`
`MockResponse`	`setBody(String body)` Sets the response body to the UTF-8 encoded bytes of `body`.
`MockResponse`	`setBodyDelay(long delay, TimeUnit unit)` Set the delayed time of the response body to `delay`.
`MockResponse`	`setChunkedBody(okio.Buffer 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`	`setHeaders(Headers headers)` Replaces all headers with those specified in `headers`.
`MockResponse`	`setResponseCode(int code)`
`MockResponse`	`setSocketPolicy(SocketPolicy socketPolicy)`
`MockResponse`	`setStatus(String status)`
`MockResponse`	`throttleBody(long bytesPerPeriod, long period, TimeUnit unit)` Throttles the request reader and response writer to sleep for the given period after each series of `bytesPerPeriod` bytes are transferred.
`String`	`toString()`
`MockResponse`	`withPush(PushPromise promise)` When `protocols` include Protocol.HTTP_2, this attaches a pushed stream to this response.
`MockResponse`	`withSettings(okhttp3.internal.framed.Settings settings)` When protocols include HTTP/2, this pushes `settings` before writing the response.
`MockResponse`	`withWebSocketUpgrade(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 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 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(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.
  - addHeaderLenient
```
public MockResponse addHeaderLenient(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. Unlike addHeader(String, Object) this does not validate the name and value.
  - setHeader
```
public MockResponse setHeader(String name,
                     Object value)
```
    Removes all headers named name, then adds a new header with the name and value.
  - setHeaders
```
public MockResponse setHeaders(Headers headers)
```
    Replaces all headers with those specified in headers.
  - removeHeader
```
public MockResponse removeHeader(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(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(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(long bytesPerPeriod,
                        long period,
                        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(TimeUnit unit)
```
  - setBodyDelay
```
public MockResponse setBodyDelay(long delay,
                        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(TimeUnit unit)
```
  - withPush
```
public MockResponse withPush(PushPromise promise)
```
    When protocols include Protocol.HTTP_2, this attaches a pushed stream to this response.
  - getPushPromises
```
public List<PushPromise> getPushPromises()
```
    Returns the streams the server will push with this response.
  - withSettings
```
public MockResponse withSettings(okhttp3.internal.framed.Settings settings)
```
    When protocols include HTTP/2, this pushes settings before writing the response.
  - getSettings
```
public okhttp3.internal.framed.Settings getSettings()
```
  - withWebSocketUpgrade
```
public MockResponse withWebSocketUpgrade(WebSocketListener listener)
```
    Attempts to perform a web socket upgrade on the connection. This will overwrite any previously set status or body.
  - getWebSocketListener
```
public WebSocketListener getWebSocketListener()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class MockResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockResponse

Method Detail

clone

getStatus

setResponseCode

setStatus

getHeaders

clearHeaders

addHeader

addHeader

addHeaderLenient

setHeader

setHeaders

removeHeader

getBody

setBody

setBody

setChunkedBody

setChunkedBody

getSocketPolicy

setSocketPolicy

throttleBody

getThrottleBytesPerPeriod

getThrottlePeriod

setBodyDelay

getBodyDelay

withPush

getPushPromises

withSettings

getSettings

withWebSocketUpgrade

getWebSocketListener

toString