mockwebserver3/mockwebserver3/RecordedRequest

RecordedRequest

class RecordedRequest(val connectionIndex: Int, val exchangeIndex: Int, val handshake: Handshake?, val handshakeServerNames: List<String>, val method: String, val target: String, val version: String, val url: HttpUrl, val headers: Headers, val body: ByteString?, val bodySize: Long, val chunkSizes: List<Int>?, val failure: IOException? = null)

An HTTP request that came into the mock web server.

Constructors

RecordedRequest

constructor(connectionIndex: Int, exchangeIndex: Int, handshake: Handshake?, handshakeServerNames: List<String>, method: String, target: String, version: String, url: HttpUrl, headers: Headers, body: ByteString?, bodySize: Long, chunkSizes: List<Int>?, failure: IOException? = null)

Properties

body

val body: ByteString?

The body of this request, or null if it has none. This may be truncated.

bodySize

val bodySize: Long

The total size of the body of this request (before truncation).

chunkSizes

val chunkSizes: List<Int>?

The sizes of the chunks of this request's body, or null if the request's body was not encoded with chunked encoding.

connectionIndex

val connectionIndex: Int

The index of the socket connection that carried this request. If two recorded requests share a connection index, they also shared a socket connection.

exchangeIndex

val exchangeIndex: Int

The index of this exchange on its HTTP connection. A request is uniquely identified by the (connection index, exchange index) pair.

failure

val failure: IOException? = null

The failure MockWebServer recorded when attempting to decode this request. If, for example, the inbound request was truncated, this exception will be non-null.

handshake

val handshake: Handshake?

The TLS handshake of the connection that carried this request, or null if the request was received without TLS.

handshakeServerNames

val handshakeServerNames: List<String>

Returns the name of the server the client requested via the SNI (Server Name Indication) attribute in the TLS handshake. Unlike the rest of the HTTP exchange, this name is sent in cleartext and may be monitored or blocked by a proxy or other middlebox.

headers

val headers: Headers

All headers.

method

val method: String

A string like GET or POST.

requestLine

val requestLine: String

target

val target: String

The request target from the original HTTP request.

url