MockWebServer (MockWebServer 3.12.11 API)

java.lang.Object
- org.junit.rules.ExternalResource
- - okhttp3.mockwebserver.MockWebServer

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable
```
public final class MockWebServer
extends org.junit.rules.ExternalResource
implements java.io.Closeable
```
A scriptable web server. Callers supply canned responses and the server replays them upon request in sequence.

Constructor Summary

Constructors
Constructor Description

MockWebServer()

Constructors
Constructor	Description
`MockWebServer()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`after()`
`protected void`	`before()`
`void`	`close()`
`void`	`enqueue(MockResponse response)`	Scripts `response` to be returned to a request made in sequence.
`java.lang.String`	`getHostName()`
`int`	`getPort()`
`int`	`getRequestCount()`	Returns the number of HTTP requests received thus far by this server.
`void`	`noClientAuth()`	Configure the server to not perform SSL authentication of the client.
`java.util.List<okhttp3.Protocol>`	`protocols()`
`void`	`requestClientAuth()`	Configure the server to want client auth.
`void`	`requireClientAuth()`	Configure the server to need client auth.
`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(java.util.List<okhttp3.Protocol> protocols)`	Indicates the protocols supported by ALPN on incoming HTTPS connections.
`void`	`setServerSocketFactory(javax.net.ServerSocketFactory serverSocketFactory)`
`void`	`shutdown()`
`void`	`start()`	Equivalent to `start(0)`.
`void`	`start(int port)`	Starts the server on the loopback interface for the given port.
`void`	`start(java.net.InetAddress inetAddress, int port)`	Starts the server on the given address and port.
`RecordedRequest`	`takeRequest()`	Awaits the next HTTP request, removes it, and returns it.
`RecordedRequest`	`takeRequest(long timeout, java.util.concurrent.TimeUnit unit)`	Awaits the next HTTP request (waiting up to the specified wait time if necessary), removes it, and returns it.
`java.net.Proxy`	`toProxyAddress()`
`java.lang.String`	`toString()`
`okhttp3.HttpUrl`	`url(java.lang.String path)`	Returns a URL for connecting to this server.
`void`	`useHttps(javax.net.ssl.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 java.lang.String getHostName()
```
  - toProxyAddress
```
public java.net.Proxy toProxyAddress()
```
  - setServerSocketFactory
```
public void setServerSocketFactory(javax.net.ServerSocketFactory serverSocketFactory)
```
  - url
```
public okhttp3.HttpUrl url(java.lang.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(java.util.List<okhttp3.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.
  - protocols
```
public java.util.List<okhttp3.Protocol> protocols()
```
  - useHttps
```
public void useHttps(javax.net.ssl.SSLSocketFactory sslSocketFactory,
                     boolean tunnelProxy)
```
    Serve requests with HTTPS rather than otherwise.
    
    Parameters:
    
    tunnelProxy - true to expect the HTTP CONNECT method before negotiating TLS.
  - noClientAuth
```
public void 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
```
public void 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
```
public void 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.
  - takeRequest
```
public RecordedRequest takeRequest()
                            throws java.lang.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:
    
    java.lang.InterruptedException
  - takeRequest
```
public RecordedRequest takeRequest(long timeout,
                                   java.util.concurrent.TimeUnit unit)
                            throws java.lang.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:
    
    java.lang.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:
    
    java.lang.ClassCastException - if the default dispatcher has been replaced with setDispatcher(Dispatcher).
  - start
```
public void start()
           throws java.io.IOException
```
    Equivalent to start(0).
    
    Throws:
    
    java.io.IOException
  - start
```
public void start(int port)
           throws java.io.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:
    
    java.io.IOException
  - start
```
public void start(java.net.InetAddress inetAddress,
                  int port)
           throws java.io.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:
    
    java.io.IOException
  - shutdown
```
public void shutdown()
              throws java.io.IOException
```
    Throws:
    
    java.io.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 java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - close
```
public void close()
           throws java.io.IOException
```
    Specified by:
    
    close in interface java.lang.AutoCloseable
    
    Specified by:
    
    close in interface java.io.Closeable
    
    Throws:
    
    java.io.IOException

Class MockWebServer

Constructor Summary

Method Summary

Methods inherited from class org.junit.rules.ExternalResource

Methods inherited from class java.lang.Object

Constructor Detail

MockWebServer

Method Detail

before

getPort

getHostName

toProxyAddress

setServerSocketFactory

url

setBodyLimit

setProtocolNegotiationEnabled

setProtocols

protocols

useHttps

noClientAuth

requestClientAuth

requireClientAuth

takeRequest

takeRequest

getRequestCount

enqueue

start

start

start

shutdown

after

setDispatcher

toString

close