io.fabric8.mockwebserver

Interface MockServer

All Known Implementing Classes:

DefaultMockServer

public interface MockServer

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.
default void	onShutdown() This method is called right after shutdown.
default void	onStart() This method is called right before start.
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.

Method Detail

onStart

default void onStart()

This method is called right before start. Override it to add extra initialization.

onShutdown

default void onShutdown()

This method is called right after shutdown. Override it to add extra cleanup.

getPort

int getPort()

The port for the MockWebServer.

Returns:

the MockWebServer port.

getHostName

String getHostName()

The host name for the MockWebServer.

Returns:

the MockWebServer host name;

toProxyAddress

Proxy toProxyAddress()

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

Returns:

a Proxy for the MockWebServer.

url

String url(String path)

Returns a String URL for connecting to this server.

Parameters:

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

expect

MockServerExpectation expect()

Returns a MockServerExpectation to set the expectations.

Returns:

the MockServerExpectation builder.

getRequestCount

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.

takeRequest

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.

Returns:

the head of the request queue

Throws:

InterruptedException

takeRequest

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.

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

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.

Returns:

the most recent RecordedRequest or null if none was processed.

Throws:

InterruptedException