org.mockserver.client

Class MockServerClient

java.lang.Object

org.mockserver.client.MockServerClient

public class MockServerClient
extends Object

Author:

jamesdbloom

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 mockServerClient = new MockServerClient("localhost", 8080);

Method Summary

Methods

Modifier and Type	Method and Description
void	clear(HttpRequest httpRequest) Clear all expectations that match the request
void	dumpToLog() Pretty-print the json for all expectations already setup to the log.
void	reset() Reset MockServer by clearing all expectations
protected void	sendExpectation(Expectation expectation)
ForwardChainExpectation	when(HttpRequest httpRequest) Specify an unlimited expectation that will respond regardless of the number of matching request for example: mockServerClient .when( new HttpRequest() .withPath("/some_path") .withBody("some_request_body") ) .respond( new HttpResponse() .withBody("some_response_body") .withHeaders( new Header("responseName", "responseValue") ) );
ForwardChainExpectation	when(HttpRequest httpRequest, Times times) Specify an limited expectation that will respond a specified number of times when the request is matched for example: mockServerClient .when( new HttpRequest() .withPath("/some_path") .withBody("some_request_body"), Times.exactly(5) ) .respond( new HttpResponse() .withBody("some_response_body") .withHeaders( new Header("responseName", "responseValue") ) );

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", 8080);

Parameters:

host - the host for the MockServer to communicate with

port - the port for the MockServer to communicate with

Method Detail

when

public ForwardChainExpectation when(HttpRequest httpRequest)

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

mockServerClient .when( new HttpRequest() .withPath("/some_path") .withBody("some_request_body") ) .respond( new HttpResponse() .withBody("some_response_body") .withHeaders( new Header("responseName", "responseValue") ) );

Parameters:

httpRequest - the 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 request is matched for example:

mockServerClient .when( new HttpRequest() .withPath("/some_path") .withBody("some_request_body"), Times.exactly(5) ) .respond( new HttpResponse() .withBody("some_response_body") .withHeaders( new Header("responseName", "responseValue") ) );

Parameters:

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

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

Returns:

an Expectation object that can be used to specify the response

dumpToLog

public void dumpToLog()

Pretty-print the json for all expectations already setup to the log. They are printed at WARN level to ensure they appear even if the default logging level has not been altered

reset

public void reset()

Reset MockServer by clearing all expectations

clear

public void clear(HttpRequest httpRequest)

Clear all expectations that match the request

Parameters:

httpRequest - the request that is matched against when deciding whether to clear each expectation

sendExpectation

protected void sendExpectation(Expectation expectation)