com.squareup.okhttp.mockwebserver

Class MockWebServer

java.lang.Object

com.squareup.okhttp.mockwebserver.MockWebServer

public final class MockWebServer
extends Object

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

Methods

Modifier and Type	Method and Description
void	enqueue(MockResponse response) Scripts response to be returned to a request made in sequence.
String	getCookieDomain() Returns a cookie domain for this server.
String	getHostName()
int	getPort()
int	getRequestCount() Returns the number of HTTP requests received thus far by this server.
URL	getUrl(String path) Returns a URL for connecting to this server.
void	play() Equivalent to play(0).
void	play(int port) Starts the server, serves all enqueued requests, and shuts the server down.
void	setBodyLimit(int 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	setNpnEnabled(boolean npnEnabled) Sets whether NPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1 or SPDY/3.
void	setNpnProtocols(List<Protocol> protocols) Indicates the protocols supported by NPN on incoming HTTPS connections.
void	shutdown()
RecordedRequest	takeRequest() Awaits the next HTTP request, removes it, and returns it.
Proxy	toProxyAddress()
void	useHttps(SSLSocketFactory sslSocketFactory, boolean tunnelProxy) Serve requests with HTTPS rather than otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockWebServer

public MockWebServer()

Method Detail

getPort

public int getPort()

getHostName

public String getHostName()

toProxyAddress

public Proxy toProxyAddress()

getUrl

public URL getUrl(String path)

Returns a URL for connecting to this server.

Parameters:

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

getCookieDomain

public String getCookieDomain()

Returns a cookie domain for this server. This returns the server's non-loopback host name if it is known. Otherwise this returns ".local" for this server's loopback name.

setBodyLimit

public void setBodyLimit(int maxBodyLength)

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

setNpnEnabled

public void setNpnEnabled(boolean npnEnabled)

Sets whether NPN is used on incoming HTTPS connections to negotiate a protocol like HTTP/1.1 or SPDY/3. Call this method to disable NPN and SPDY.

setNpnProtocols

public void setNpnProtocols(List<Protocol> protocols)

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

Parameters:

protocols - the protocols to use, in order of preference. The list must contain "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.

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

play

public void play()
          throws IOException

Equivalent to play(0).

Throws:

IOException

play

public void play(int port)
          throws IOException

Starts the server, serves all enqueued requests, and shuts the server down.

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

shutdown

public void shutdown()
              throws IOException

Throws:

IOException

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.