mockwebserver3/mockwebserver3/MockWebServer

MockWebServer

@ExperimentalOkHttpApi

class MockWebServer : Closeable

A scriptable web server. Callers supply canned responses and the server replays them upon request in sequence.

Constructors

MockWebServer

constructor()

Types

Companion

@ExperimentalOkHttpApi

object Companion

Properties

bodyLimit

var bodyLimit: Long

The number of bytes of the POST body to keep in memory to the given limit.

dispatcher

var dispatcher: Dispatcher

The dispatcher used to respond to HTTP requests. The default dispatcher is a QueueDispatcher, which serves a fixed sequence of responses from a queue.

hostName

val hostName: String

inetSocketAddress

val inetSocketAddress: InetSocketAddress

port

val port: Int

protocolNegotiationEnabled

var protocolNegotiationEnabled: Boolean

True if ALPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1 or HTTP/2. This is true by default; set to false to disable negotiation and restrict connections to HTTP/1.1.

protocols

var protocols: List<Protocol>

The protocols supported by ALPN on incoming HTTPS connections in order of preference. The list must contain Protocol.HTTP_1_1. It must not contain null.

requestCount

val requestCount: Int

The number of HTTP requests received thus far by this server. This may exceed the number of HTTP connections when connection reuse is in practice.

serverSocketFactory

@get:Synchronized

@set:Synchronized

var serverSocketFactory: ServerSocketFactory?

started

var started: Boolean

Functions

open override fun close()

enqueue

fun enqueue(response: MockResponse)

Scripts response to be returned to a request made in sequence. The first request is served by the first enqueued response; the second request by the second enqueued response; and so on.

noClientAuth

fun noClientAuth()

Configure the server to not perform SSL authentication of the client. This leaves authentication to another layer such as in an HTTP cookie or header. This is the default and most common configuration.

requestClientAuth

fun requestClientAuth()

Configure the server to want client auth. If the client presents a certificate that is trusted the handshake will proceed normally. The connection will also proceed normally if the client presents no certificate at all! But if the client presents an untrusted certificate the handshake will fail and no connection will be established.

requireClientAuth

fun requireClientAuth()

Configure the server to need client auth. If the client presents a certificate that is trusted the handshake will proceed normally. If the client presents an untrusted certificate or no certificate at all the handshake will fail and no connection will be established.

fun shutdown()

fun start(port: Int = 0)

Starts the server on the loopback interface for the given port.

fun start(inetAddress: InetAddress, port: Int)

Starts the server on the given address and port.

takeRequest

fun takeRequest(): RecordedRequest

Awaits the next HTTP request, removes it, and returns it. Callers should use this to verify the request was sent as intended. This method will block until the request is available, possibly forever.

fun takeRequest(timeout: Long, unit: TimeUnit): RecordedRequest?

Awaits the next HTTP request (waiting up to the specified wait time if necessary), removes it, and returns it. Callers should use this to verify the request was sent as intended within the given time.

toProxyAddress

fun toProxyAddress(): Proxy

toString

open override fun toString(): String

url

fun url(path: String): HttpUrl

Returns a URL for connecting to this server.

useHttps

fun useHttps(sslSocketFactory: SSLSocketFactory)

Serve requests with HTTPS rather than otherwise.