B C E F G H I M O P R S U V W

B

bind(Integer...) - Method in class org.mockserver.client.MockServerClient

Bind new ports to listen on

C

clear(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Clear all expectations and logs that match the request matcher

clear(String) - Method in class org.mockserver.client.MockServerClient

Clear all expectations and logs that match the expectation id

clear(ExpectationId) - Method in class org.mockserver.client.MockServerClient

Clear all expectations and logs that match the expectation id

clear(RequestDefinition, ClearType) - Method in class org.mockserver.client.MockServerClient

Clear expectations, logs or both that match the request matcher

clear(String, ClearType) - Method in class org.mockserver.client.MockServerClient

Clear expectations, logs or both that match the expectation id

clear(ExpectationId, ClearType) - Method in class org.mockserver.client.MockServerClient

Clear expectations, logs or both that match the expectation id

ClientException - Exception in org.mockserver.client

close() - Method in class org.mockserver.client.MockServerClient

contextPath() - Method in class org.mockserver.client.MockServerClient

E

error(HttpError) - Method in class org.mockserver.client.ForwardChainExpectation

Return error when expectation is matched

ExpectationInitializer - Interface in org.mockserver.client.initialize

Deprecated.

instead use org.mockserver.client.initialize.PluginExpectationInitializer or org.mockserver.server.initialize.ExpectationInitializer

F

forward(HttpForward) - Method in class org.mockserver.client.ForwardChainExpectation

Forward request to the specified host and port when expectation is matched

forward(HttpTemplate) - Method in class org.mockserver.client.ForwardChainExpectation

Evaluate Velocity or JavaScript template to generate request to forward when expectation is matched

forward(HttpClassCallback) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on local class in same JVM implementing ExpectationResponseCallback to generate request to forward when expectation is matched

forward(ExpectationForwardCallback) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate request to forward when expectation is matched

forward(ExpectationForwardCallback, ExpectationForwardAndResponseCallback) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate request to forward when expectation is matched

forward(ExpectationForwardCallback, Delay) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate request to forward when expectation is matched

forward(ExpectationForwardCallback, ExpectationForwardAndResponseCallback, Delay) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate request to forward when expectation is matched

forward(HttpOverrideForwardedRequest) - Method in class org.mockserver.client.ForwardChainExpectation

Override fields, headers, and cookies etc in request being forwarded with specified fields, headers and cookies, etc in the specified request when expectation is matched

ForwardChainExpectation - Class in org.mockserver.client

G

getPort() - Method in class org.mockserver.client.MockServerClient

H

hasStarted() - Method in class org.mockserver.client.MockServerClient

Returns whether MockServer has started, if called after MockServer has been stopped this method will block for 5 seconds while confirming MockServer is not starting

hasStarted(int, long, TimeUnit) - Method in class org.mockserver.client.MockServerClient

Returns whether server MockServer has started, by polling the MockServer a configurable amount of times

hasStopped() - Method in class org.mockserver.client.MockServerClient

Returns whether MockServer has stopped, if called too quickly after starting MockServer this may return false because MockServer has not yet started, to ensure MockServer has started use hasStarted()

hasStopped(int, long, TimeUnit) - Method in class org.mockserver.client.MockServerClient

Returns whether server MockServer has stopped, by polling the MockServer a configurable amount of times.

I

initializeExpectations(MockServerClient) - Method in interface org.mockserver.client.initialize.ExpectationInitializer

Deprecated.

initializeExpectations(MockServerClient) - Method in interface org.mockserver.client.initialize.PluginExpectationInitializer

isRunning() - Method in class org.mockserver.client.MockServerClient

Deprecated.

use hasStopped() or hasStarted() instead

isRunning(int, long, TimeUnit) - Method in class org.mockserver.client.MockServerClient

Deprecated.

use hasStopped() or hasStarted() instead

isSecure() - Method in class org.mockserver.client.MockServerClient

M

MockServerClient - Class in org.mockserver.client

MockServerClient(Configuration, CompletableFuture<Integer>) - Constructor for class org.mockserver.client.MockServerClient

Start the client communicating to a MockServer on localhost at the port specified with the Future

MockServerClient(ClientConfiguration, CompletableFuture<Integer>) - Constructor for class org.mockserver.client.MockServerClient

Start the client communicating to a MockServer on localhost at the port specified with the Future

MockServerClient(String, int) - Constructor for class org.mockserver.client.MockServerClient

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

MockServerClient(Configuration, String, int) - Constructor for class org.mockserver.client.MockServerClient

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

MockServerClient(ClientConfiguration, String, int) - Constructor for class org.mockserver.client.MockServerClient

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

MockServerClient(String, int, String) - Constructor for class org.mockserver.client.MockServerClient

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

MockServerClient(Configuration, String, int, String) - Constructor for class org.mockserver.client.MockServerClient

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

MockServerClient(ClientConfiguration, String, int, String) - Constructor for class org.mockserver.client.MockServerClient

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

O

openUI() - Method in class org.mockserver.client.MockServerClient

Launch UI and wait the default period to allow the UI to launch and start collecting logs, this ensures that the log are visible in the UI even if MockServer is shutdown by a test shutdown function, such as After, AfterClass, AfterAll, etc

openUI(TimeUnit, long) - Method in class org.mockserver.client.MockServerClient

Launch UI and wait a specified period to allow the UI to launch and start collecting logs, this ensures that the log are visible in the UI even if MockServer is shutdown by a test shutdown function, such as After, AfterClass, AfterAll, etc

org.mockserver.client - package org.mockserver.client

org.mockserver.client.initialize - package org.mockserver.client.initialize

P

PluginExpectationInitializer - Interface in org.mockserver.client.initialize

If the MockServer is started using the Maven Plugin a initializationClass property can be specified to initialize expectations, when the MockServer starts.

portFuture - Variable in class org.mockserver.client.MockServerClient

R

remoteAddress() - Method in class org.mockserver.client.MockServerClient

reset() - Method in class org.mockserver.client.MockServerClient

Reset MockServer by clearing all expectations

respond(HttpResponse) - Method in class org.mockserver.client.ForwardChainExpectation

Return response when expectation is matched

respond(HttpTemplate) - Method in class org.mockserver.client.ForwardChainExpectation

Evaluate Velocity or JavaScript template to generate response to return when expectation is matched

respond(HttpClassCallback) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on local class in same JVM implementing ExpectationResponseCallback to generate response to return when expectation is matched

respond(ExpectationResponseCallback) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate response to return when expectation is matched

respond(ExpectationResponseCallback, Delay) - Method in class org.mockserver.client.ForwardChainExpectation

Call method on object locally or remotely (over web socket) to generate response to return when expectation is matched

retrieveActiveExpectations(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

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

retrieveActiveExpectations(RequestDefinition, Format) - Method in class org.mockserver.client.MockServerClient

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

retrieveLogMessages(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc

retrieveLogMessagesArray(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Retrieve the logs associated to a specific requests, this shows all logs for expectation matching, verification, clearing, etc

retrieveRecordedExpectations(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests

retrieveRecordedExpectations(RequestDefinition, Format) - Method in class org.mockserver.client.MockServerClient

Retrieve the request-response combinations that have been recorded as a list of expectations, only those that match the httpRequest parameter are returned, use null to retrieve all requests

retrieveRecordedRequests(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests

retrieveRecordedRequests(RequestDefinition, Format) - Method in class org.mockserver.client.MockServerClient

Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests

retrieveRecordedRequestsAndResponses(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

Retrieve the recorded requests and responses that match the httpRequest parameter, use null for the parameter to retrieve all requests and responses

retrieveRecordedRequestsAndResponses(RequestDefinition, Format) - Method in class org.mockserver.client.MockServerClient

Retrieve the recorded requests that match the httpRequest parameter, use null for the parameter to retrieve all requests

S

sendExpectation(Expectation...) - Method in class org.mockserver.client.MockServerClient

Deprecated.

this is deprecated due to unclear naming, use method upsert(Expectation... expectations) instead

setProxyConfiguration(ProxyConfiguration) - Method in class org.mockserver.client.MockServerClient

Deprecated.

use withProxyConfiguration which is more consistent with MockServer API style

setRequestOverride(HttpRequest) - Method in class org.mockserver.client.MockServerClient

Deprecated.

use withRequestOverride which is more consistent with MockServer API style

stop() - Method in class org.mockserver.client.MockServerClient

Stop MockServer gracefully (only support for Netty version, not supported for WAR version)

stop(boolean) - Method in class org.mockserver.client.MockServerClient

Stop MockServer gracefully (only support for Netty version, not supported for WAR version)

stopAsync() - Method in class org.mockserver.client.MockServerClient

Stop MockServer gracefully (only support for Netty version, not supported for WAR version)

U

upsert(OpenAPIExpectation...) - Method in class org.mockserver.client.MockServerClient

Specify OpenAPI and operations and responses to create matchers and example responses

upsert(Expectation...) - Method in class org.mockserver.client.MockServerClient

Specify one or more expectations to be create, or updated (if the id matches).

V

verify(RequestDefinition...) - Method in class org.mockserver.client.MockServerClient

Verify a list of requests have been sent in the order specified for example:

verify(Integer, RequestDefinition...) - Method in class org.mockserver.client.MockServerClient

Verify a list of requests have been sent in the order specified for example:

verify(String...) - Method in class org.mockserver.client.MockServerClient

Verify a list of requests have been sent in the order specified for example:

verify(ExpectationId...) - Method in class org.mockserver.client.MockServerClient

Verify a list of requests have been sent in the order specified for example:

verify(Integer, ExpectationId...) - Method in class org.mockserver.client.MockServerClient

Verify a list of requests have been sent in the order specified for example:

verify(RequestDefinition, VerificationTimes) - Method in class org.mockserver.client.MockServerClient

Verify a request has been sent for example:

verify(RequestDefinition, VerificationTimes, Integer) - Method in class org.mockserver.client.MockServerClient

Verify a request has been sent for example:

verify(String, VerificationTimes) - Method in class org.mockserver.client.MockServerClient

Verify a request has been sent for example:

verify(ExpectationId, VerificationTimes) - Method in class org.mockserver.client.MockServerClient

Verify a request has been sent for example:

verify(ExpectationId, VerificationTimes, Integer) - Method in class org.mockserver.client.MockServerClient

Verify a request has been sent for example:

verifyZeroInteractions() - Method in class org.mockserver.client.MockServerClient

Verify no requests have been sent.

W

when(RequestDefinition) - Method in class org.mockserver.client.MockServerClient

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

when(RequestDefinition, Times) - Method in class org.mockserver.client.MockServerClient

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

when(RequestDefinition, Times, TimeToLive) - Method in class org.mockserver.client.MockServerClient

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

when(RequestDefinition, Times, TimeToLive, Integer) - Method in class org.mockserver.client.MockServerClient

Specify a limited expectation that will respond a specified number of times when the http is matched and will be matched according to priority as follows:

withControlPlaneJWT(String) - Method in class org.mockserver.client.MockServerClient

Specify JWT to use for control plane authorisation

withControlPlaneJWT(Supplier<String>) - Method in class org.mockserver.client.MockServerClient

Specify JWT supplier to use for control plane authorisation

withId(String) - Method in class org.mockserver.client.ForwardChainExpectation

Set id of this expectation which can be used to update this expectation later or for clearing or verifying by expectation id.

withPriority(int) - Method in class org.mockserver.client.ForwardChainExpectation

Set priority of this expectation which is used to determine the matching order of expectations when a request is received.

withProxyConfiguration(ProxyConfiguration) - Method in class org.mockserver.client.MockServerClient

Configure communication to MockServer to go via a proxy

withRequestOverride(HttpRequest) - Method in class org.mockserver.client.MockServerClient

withSecure(boolean) - Method in class org.mockserver.client.MockServerClient

B C E F G H I M O P R S U V W