org.mockserver.client.server

Class MockServerClient

java.lang.Object

org.mockserver.client.AbstractClient<MockServerClient>

org.mockserver.client.server.MockServerClient

All Implemented Interfaces:

Closeable, AutoCloseable

public class MockServerClient
extends AbstractClient<MockServerClient>

Author:

jamesdbloom

Field Summary

Fields inherited from class org.mockserver.client.AbstractClient

contextPath, expectationSerializer, host, httpRequestSerializer, logger, nettyHttpClient, port, portBindingSerializer, verificationSequenceSerializer, verificationSerializer

Constructor Summary

Constructors

Constructor and Description
MockServerClient(String host, int port) Start the client communicating to a MockServer at the specified host and port for example:
MockServerClient(String host, int port, String contextPath) Start the client communicating to a MockServer at the specified host and port and contextPath for example:

Method Summary

Methods

Modifier and Type	Method and Description
Expectation[]	retrieveActiveExpectations(HttpRequest httpRequest) Retrieve the already setup expectations match the httpRequest parameter, use null for the parameter to retrieve all expectations
ForwardChainExpectation	when(HttpRequest httpRequest) Specify an unlimited expectation that will respond regardless of the number of matching http for example:
ForwardChainExpectation	when(HttpRequest httpRequest, Times times) Specify an limited expectation that will respond a specified number of times when the http is matched for example:
ForwardChainExpectation	when(HttpRequest httpRequest, Times times, TimeToLive timeToLive) Specify an limited expectation that will respond a specified number of times when the http is matched for example:

Methods inherited from class org.mockserver.client.AbstractClient

bind, calculatePath, clear, clear, close, contextPath, formatErrorMessage, isRunning, isRunning, remoteAddress, reset, retrieveRecordedExpectations, retrieveRecordedRequests, sendRequest, stop, stop, verify, verify, verifyZeroInteractions

Methods inherited from class java.lang.Object

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

Constructor Detail

MockServerClient

public MockServerClient(String host,
                int port)

Start the client communicating to a MockServer at the specified host and port for example:

MockServerClient mockServerClient = new MockServerClient("localhost", 1080);

Parameters:

host - the host for the MockServer to communicate with

port - the port for the MockServer to communicate with

MockServerClient

public MockServerClient(String host,
                int port,
                String contextPath)

Start the client communicating to a MockServer at the specified host and port and contextPath for example:

MockServerClient mockServerClient = new MockServerClient("localhost", 1080, "/mockserver");

Parameters:

host - the host for the MockServer to communicate with

port - the port for the MockServer to communicate with

contextPath - the context path that the MockServer war is deployed to

Method Detail

when

public ForwardChainExpectation when(HttpRequest httpRequest)

Specify an unlimited expectation that will respond regardless of the number of matching http for example:

mockServerClient .when(request().withPath("/some_path").withBody("some_request_body")) .respond(response().withBody("some_response_body").withHeader("responseName", "responseValue"))

Parameters:

httpRequest - the http request that must be matched for this expectation to respond

Returns:

an Expectation object that can be used to specify the response

when

public ForwardChainExpectation when(HttpRequest httpRequest,
                           Times times)

Specify an limited expectation that will respond a specified number of times when the http is matched for example:

mockServerClient .when(request().withPath("/some_path").withBody("some_request_body"), Times.exactly(5)) .respond(response().withBody("some_response_body").withHeader("responseName", "responseValue"))

Parameters:

httpRequest - the http request that must be matched for this expectation to respond

times - the number of times to respond when this http is matched

Returns:

an Expectation object that can be used to specify the response

when

public ForwardChainExpectation when(HttpRequest httpRequest,
                           Times times,
                           TimeToLive timeToLive)

Specify an limited expectation that will respond a specified number of times when the http is matched for example:

mockServerClient .when(request().withPath("/some_path").withBody("some_request_body"), Times.exactly(5), TimeToLive.exactly(TimeUnit.SECONDS, 120)) .respond(response().withBody("some_response_body").withHeader("responseName", "responseValue"))

Parameters:

httpRequest - the http request that must be matched for this expectation to respond

times - the number of times to respond when this http is matched

timeToLive - the length of time from when the server receives the expectation that the expectation should be active

Returns:

an Expectation object that can be used to specify the response

retrieveActiveExpectations

public Expectation[] retrieveActiveExpectations(HttpRequest httpRequest)

Retrieve the already setup expectations match the httpRequest parameter, use null for the parameter to retrieve all expectations

Parameters:

httpRequest - the http request that is matched against when deciding whether to return each expectation, use null for the parameter to retrieve for all requests

Returns:

an array of all expectations that have been setup