io.fabric8.mockwebserver

Class DefaultMockServer

java.lang.Object

io.fabric8.mockwebserver.DefaultMockServer

All Implemented Interfaces:

MockServer

public class DefaultMockServer
extends Object
implements MockServer

Constructor Summary

Constructors

Constructor and Description
DefaultMockServer()
DefaultMockServer(boolean useHttps)
DefaultMockServer(Context context, okhttp3.mockwebserver.MockWebServer server, Map<ServerRequest,Queue<ServerResponse>> responses, boolean useHttps)
DefaultMockServer(Context context, okhttp3.mockwebserver.MockWebServer server, Map<ServerRequest,Queue<ServerResponse>> responses, okhttp3.mockwebserver.Dispatcher dispatcher, boolean useHttps)
DefaultMockServer(okhttp3.mockwebserver.MockWebServer server, Map<ServerRequest,Queue<ServerResponse>> responses, boolean useHttps)

Method Summary

Modifier and Type	Method and Description
MockServerExpectation	expect() Returns a MockServerExpectation to set the expectations.
String	getHostName() The host name for the MockWebServer.
okhttp3.mockwebserver.RecordedRequest	getLastRequest() Returns the last (most recent) HTTP request processed by the MockWebServer.
int	getPort() The port for the MockWebServer.
int	getRequestCount() Returns the number of HTTP requests received thus far by this server.
void	shutdown()
void	start()
void	start(InetAddress inetAddress, int port)
void	start(int port)
okhttp3.mockwebserver.RecordedRequest	takeRequest() Awaits the next HTTP request, removes it, and returns it.
okhttp3.mockwebserver.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() Returns a Proxy for the MockWebServer with the current HostName and Port.
String	url(String path) Returns a String URL for connecting to this server.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.fabric8.mockwebserver.MockServer

onShutdown, onStart

Constructor Detail

DefaultMockServer

public DefaultMockServer()

DefaultMockServer

public DefaultMockServer(boolean useHttps)

DefaultMockServer

public DefaultMockServer(okhttp3.mockwebserver.MockWebServer server,
                         Map<ServerRequest,Queue<ServerResponse>> responses,
                         boolean useHttps)

DefaultMockServer

public DefaultMockServer(Context context,
                         okhttp3.mockwebserver.MockWebServer server,
                         Map<ServerRequest,Queue<ServerResponse>> responses,
                         boolean useHttps)

DefaultMockServer

public DefaultMockServer(Context context,
                         okhttp3.mockwebserver.MockWebServer server,
                         Map<ServerRequest,Queue<ServerResponse>> responses,
                         okhttp3.mockwebserver.Dispatcher dispatcher,
                         boolean useHttps)

Method Detail

start

public final void start()

start

public final void start(int port)

start

public final void start(InetAddress inetAddress,
                        int port)

shutdown

public final void shutdown()

url

public String url(String path)

Returns a String URL for connecting to this server.

Specified by:

url in interface MockServer

Parameters:

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

getPort

public int getPort()

The port for the MockWebServer.

Specified by:

getPort in interface MockServer

Returns:

the MockWebServer port.

getHostName

public String getHostName()

The host name for the MockWebServer.

Specified by:

getHostName in interface MockServer

Returns:

the MockWebServer host name;

toProxyAddress

public Proxy toProxyAddress()

Returns a Proxy for the MockWebServer with the current HostName and Port.

Specified by:

toProxyAddress in interface MockServer

Returns:

a Proxy for the MockWebServer.

expect

public MockServerExpectation expect()

Returns a MockServerExpectation to set the expectations.

Specified by:

expect in interface MockServer

Returns:

the MockServerExpectation builder.

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.

Specified by:

getRequestCount in interface MockServer

takeRequest

public okhttp3.mockwebserver.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.

Specified by:

takeRequest in interface MockServer

Returns:

the head of the request queue

Throws:

InterruptedException

takeRequest

public okhttp3.mockwebserver.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.

Specified by:

takeRequest in interface MockServer

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

getLastRequest

public okhttp3.mockwebserver.RecordedRequest getLastRequest()
                                                     throws InterruptedException

Returns the last (most recent) HTTP request processed by the MockWebServer. n.b. This method clears the request queue.

Specified by:

getLastRequest in interface MockServer

Returns:

the most recent RecordedRequest or null if none was processed.

Throws:

InterruptedException