okhttp3.mockwebserver

Class MockWebServer

java.lang.Object

org.junit.rules.ExternalResource

okhttp3.mockwebserver.MockWebServer

All Implemented Interfaces:

Closeable, AutoCloseable, org.junit.rules.TestRule

public final class MockWebServer
extends org.junit.rules.ExternalResource
implements Closeable

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

Constructor Summary

Constructors

Constructor and Description
MockWebServer()

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
void	close()
void	enqueue(MockResponse response) Scripts response to be returned to a request made in sequence.
String	getHostName()
int	getPort()
int	getRequestCount() Returns the number of HTTP requests received thus far by this server.
void	setBodyLimit(long maxBodyLength) Sets the number of bytes of the POST body to keep in memory to the given limit.
void	setDispatcher(Dispatcher dispatcher) Sets the dispatcher used to match incoming requests to mock responses.
void	setProtocolNegotiationEnabled(boolean protocolNegotiationEnabled) Sets whether ALPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1 or HTTP/2.
void	setProtocols(List<Protocol> protocols) Indicates the protocols supported by ALPN on incoming HTTPS connections.
void	setServerSocketFactory(ServerSocketFactory serverSocketFactory)
void	shutdown()
void	start() Equivalent to start(0).
void	start(InetAddress inetAddress, int port) Starts the server on the given address and port.
void	start(int port) Starts the server on the loopback interface for the given port.
RecordedRequest	takeRequest() Awaits the next HTTP request, removes it, and returns it.
RecordedRequest	takeRequest(long timeout, TimeUnit unit) Awaits the next HTTP request (waiting up to the specified wait time if necessary), removes it, and returns it.
Proxy	toProxyAddress()
String	toString()
HttpUrl	url(String path) Returns a URL for connecting to this server.
void	useHttps(SSLSocketFactory sslSocketFactory, boolean tunnelProxy) Serve requests with HTTPS rather than otherwise.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Constructor Detail

MockWebServer

public MockWebServer()

Method Detail

before

protected void before()

Overrides:

before in class org.junit.rules.ExternalResource

getPort

public int getPort()

getHostName

public String getHostName()

toProxyAddress

public Proxy toProxyAddress()

setServerSocketFactory

public void setServerSocketFactory(ServerSocketFactory serverSocketFactory)

url

public HttpUrl url(String path)

Returns a URL for connecting to this server.

Parameters:

path - the request path, such as "/".

setBodyLimit

public void setBodyLimit(long maxBodyLength)

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

setProtocolNegotiationEnabled

public void setProtocolNegotiationEnabled(boolean protocolNegotiationEnabled)

Sets whether ALPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1 or HTTP/2. Call this method to disable negotiation and restrict connections to HTTP/1.1.

setProtocols

public void setProtocols(List<Protocol> protocols)

Indicates the protocols supported by ALPN on incoming HTTPS connections. This list is ignored when negotiation is disabled.

Parameters:

protocols - the protocols to use, in order of preference. The list must contain Protocol.HTTP_1_1. It must not contain null.

useHttps

public void useHttps(SSLSocketFactory sslSocketFactory,
                     boolean tunnelProxy)

Serve requests with HTTPS rather than otherwise.

Parameters:

tunnelProxy - true to expect the HTTP CONNECT method before negotiating TLS.

takeRequest

public RecordedRequest takeRequest()
                            throws InterruptedException

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.

Returns:

the head of the request queue

Throws:

InterruptedException

takeRequest

public RecordedRequest takeRequest(long timeout,
                                   TimeUnit unit)
                            throws InterruptedException

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.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

the head of the request queue

Throws:

InterruptedException

getRequestCount

public int getRequestCount()

Returns 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.

enqueue

public void enqueue(MockResponse response)

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.

Throws:

ClassCastException - if the default dispatcher has been replaced with setDispatcher(Dispatcher).

start

public void start()
           throws IOException

Equivalent to start(0).

Throws:

IOException

start

public void start(int port)
           throws IOException

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

Parameters:

port - the port to listen to, or 0 for any available port. Automated tests should always use port 0 to avoid flakiness when a specific port is unavailable.

Throws:

IOException

start

public void start(InetAddress inetAddress,
                  int port)
           throws IOException

Starts the server on the given address and port.

Parameters:

inetAddress - the address to create the server socket on

port - the port to listen to, or 0 for any available port. Automated tests should always use port 0 to avoid flakiness when a specific port is unavailable.

Throws:

IOException

shutdown

public void shutdown()
              throws IOException

Throws:

IOException

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource

setDispatcher

public void setDispatcher(Dispatcher dispatcher)

Sets the dispatcher used to match incoming requests to mock responses. The default dispatcher simply serves a fixed sequence of responses from a queue; custom dispatchers can vary the response based on timing or the content of the request.

toString

public String toString()

Overrides:

toString in class Object

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException