Package org.mockserver.integration

Class ClientAndServer

java.lang.Object

org.mockserver.client.MockServerClient

org.mockserver.integration.ClientAndServer

All Implemented Interfaces:

Closeable, AutoCloseable, Stoppable

public class ClientAndServer
extends MockServerClient

Author:

jamesdbloom

Field Summary

Fields inherited from class org.mockserver.client.MockServerClient

portFuture

Constructor Summary

Constructors

Constructor	Description
ClientAndServer(Integer... ports)
ClientAndServer(String remoteHost, Integer remotePort, Integer... ports)
ClientAndServer(Configuration configuration, Integer... ports)
ClientAndServer(Configuration configuration, String remoteHost, Integer remotePort, Integer... ports)

Method Summary

Modifier and Type	Method	Description
Integer	getLocalPort()
List<Integer>	getLocalPorts()
Integer	getPort()
InetSocketAddress	getRemoteAddress()
boolean	hasStarted()	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
boolean	isRunning()	Returns whether MockServer is running, if called too quickly after starting MockServer this may return false because MockServer has not yet started, to ensure MockServer has started use hasStarted()
ClientAndServer	openUI()	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
ClientAndServer	openUI(TimeUnit timeUnit, long pause)	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
ClientAndServer	registerListener(ExpectationsListener expectationsListener)
static void	setLogEventListener(Consumer<LogEntry> listener)
static ClientAndServer	startClientAndServer(Integer... port)
static ClientAndServer	startClientAndServer(String remoteHost, Integer remotePort, Integer... port)
static ClientAndServer	startClientAndServer(List<Integer> ports)
static ClientAndServer	startClientAndServer(Configuration configuration, Integer... port)
static ClientAndServer	startClientAndServer(Configuration configuration, String remoteHost, Integer remotePort, Integer... port)
static ClientAndServer	startClientAndServer(Configuration configuration, List<Integer> ports)
void	stop()	Stop MockServer gracefully (only support for Netty version, not supported for WAR version)
CompletableFuture	stopAsync()	Stop MockServer gracefully (only support for Netty version, not supported for WAR version)

Methods inherited from class org.mockserver.client.MockServerClient

bind, clear, clear, clear, clear, clear, clear, clearGrpcDescriptors, close, contextPath, crud, debugMismatch, hasStarted, hasStopped, hasStopped, isRunning, isSecure, remoteAddress, reset, retrieveActiveExpectations, retrieveActiveExpectations, retrieveConfiguration, retrieveGrpcServices, retrieveLogEntries, retrieveLogEntries, retrieveLogEntriesByCorrelationId, retrieveLogMessages, retrieveLogMessagesArray, retrieveLogsByCorrelationId, retrieveMetrics, retrieveRecordedExpectations, retrieveRecordedExpectations, retrieveRecordedRequests, retrieveRecordedRequests, retrieveRecordedRequestsAndResponses, retrieveRecordedRequestsAndResponses, sendExpectation, setProxyConfiguration, setRequestOverride, stop, updateConfiguration, uploadGrpcDescriptor, upsert, upsert, verify, verify, verify, verify, verify, verify, verify, verify, verify, verify, verifyZeroInteractions, when, when, when, when, withControlPlaneJWT, withControlPlaneJWT, withProxyConfiguration, withRequestOverride, withSecure

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientAndServer

public ClientAndServer(Integer... ports)

ClientAndServer

public ClientAndServer(Configuration configuration,
                       Integer... ports)

ClientAndServer

public ClientAndServer(String remoteHost,
                       Integer remotePort,
                       Integer... ports)

ClientAndServer

public ClientAndServer(Configuration configuration,
                       String remoteHost,
                       Integer remotePort,
                       Integer... ports)

Method Detail

startClientAndServer

public static ClientAndServer startClientAndServer(List<Integer> ports)

startClientAndServer

public static ClientAndServer startClientAndServer(Configuration configuration,
                                                   List<Integer> ports)

startClientAndServer

public static ClientAndServer startClientAndServer(Integer... port)

startClientAndServer

public static ClientAndServer startClientAndServer(Configuration configuration,
                                                   Integer... port)

startClientAndServer

public static ClientAndServer startClientAndServer(String remoteHost,
                                                   Integer remotePort,
                                                   Integer... port)

startClientAndServer

public static ClientAndServer startClientAndServer(Configuration configuration,
                                                   String remoteHost,
                                                   Integer remotePort,
                                                   Integer... port)

openUI

public ClientAndServer openUI()

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

Overrides:

openUI in class MockServerClient

openUI

public ClientAndServer openUI(TimeUnit timeUnit,
                              long pause)

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

Overrides:

openUI in class MockServerClient

Parameters:

timeUnit - TimeUnit the time unit, for example TimeUnit.SECONDS

pause - the number of time units to delay before the function returns to ensure the UI is receiving logs

isRunning

public boolean isRunning()

Description copied from class: MockServerClient

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

Overrides:

isRunning in class MockServerClient

hasStarted

public boolean hasStarted()

Description copied from class: 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

Overrides:

hasStarted in class MockServerClient

stopAsync

public CompletableFuture stopAsync()

Description copied from class: MockServerClient

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

Overrides:

stopAsync in class MockServerClient

stop

public void stop()

Description copied from class: MockServerClient

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

Specified by:

stop in interface Stoppable

Overrides:

stop in class MockServerClient

getPort

public Integer getPort()

Overrides:

getPort in class MockServerClient

getLocalPort

public Integer getLocalPort()

getLocalPorts

public List<Integer> getLocalPorts()

getRemoteAddress

public InetSocketAddress getRemoteAddress()

registerListener

public ClientAndServer registerListener(ExpectationsListener expectationsListener)

setLogEventListener

public static void setLogEventListener(Consumer<LogEntry> listener)