Package org.mockserver.client

Class MockServerClient.Builder

java.lang.Object

org.mockserver.client.MockServerClient.Builder

Enclosing class:

MockServerClient

public static final class MockServerClient.Builder
extends Object

Fluent builder for MockServerClient.

Covers every dimension exposed by the MockServerClient constructors and with... setters:

• configuration(ClientConfiguration) / configuration(Configuration)
• host(String) (default "localhost")
• port(int) (default 1080)
• contextPath(String) (default empty)
• portFuture(CompletableFuture) (mutually exclusive with host/port/contextPath)
• secure(boolean) — TLS, delegates to MockServerClient.withSecure(boolean)
• proxyConfiguration(ProxyConfiguration) — delegates to MockServerClient.withProxyConfiguration(ProxyConfiguration)
• controlPlaneJWT(String) / controlPlaneJWT(Supplier) — delegates to MockServerClient.withControlPlaneJWT(Supplier)
• requestOverride(HttpRequest) — delegates to MockServerClient.withRequestOverride(HttpRequest)

The builder performs no construction work until build() is called, at which point it selects the matching constructor and applies the configured setters, so the resulting client is identical to one built directly. Validation (for example, the empty-host check) is inherited from the constructors and surfaces from build().

Method Summary

Modifier and Type	Method	Description
MockServerClient	build()	Build the MockServerClient, selecting the matching constructor and applying the configured with... setters.
MockServerClient.Builder	configuration(ClientConfiguration configuration)	Use the given ClientConfiguration.
MockServerClient.Builder	configuration(Configuration configuration)	Use the given Configuration, wrapped as a ClientConfiguration (the same conversion the MockServerClient(Configuration, ...) constructors perform).
MockServerClient.Builder	contextPath(String contextPath)	The context path that the MockServer war is deployed to.
MockServerClient.Builder	controlPlaneJWT(String controlPlaneJWT)	A fixed JWT for control plane authorisation.
MockServerClient.Builder	controlPlaneJWT(Supplier<String> controlPlaneJWTSupplier)	A JWT supplier for control plane authorisation.
MockServerClient.Builder	host(String host)	The host of the MockServer to communicate with.
MockServerClient.Builder	port(int port)	The port of the MockServer to communicate with.
MockServerClient.Builder	portFuture(CompletableFuture<Integer> portFuture)	Resolve the port lazily from a CompletableFuture, for use when the MockServer port is not yet known at client-construction time.
MockServerClient.Builder	proxyConfiguration(ProxyConfiguration proxyConfiguration)	Route communication to MockServer via a proxy.
MockServerClient.Builder	requestOverride(HttpRequest requestOverride)	A request override applied to every control plane request.
MockServerClient.Builder	secure(boolean secure)	Whether to communicate with MockServer over TLS.

Methods inherited from class java.lang.Object

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

Method Details

configuration

public MockServerClient.Builder configuration(ClientConfiguration configuration)

Use the given ClientConfiguration. When null the client falls back to the default configuration, matching the constructors' behaviour.

configuration

public MockServerClient.Builder configuration(Configuration configuration)

Use the given Configuration, wrapped as a ClientConfiguration (the same conversion the MockServerClient(Configuration, ...) constructors perform).

host

public MockServerClient.Builder host(String host)

The host of the MockServer to communicate with. Defaults to "localhost".

port

public MockServerClient.Builder port(int port)

The port of the MockServer to communicate with. Defaults to 1080.

contextPath

public MockServerClient.Builder contextPath(String contextPath)

The context path that the MockServer war is deployed to. Defaults to empty.

portFuture

public MockServerClient.Builder portFuture(CompletableFuture<Integer> portFuture)

Resolve the port lazily from a CompletableFuture, for use when the MockServer port is not yet known at client-construction time. This is mutually exclusive with host(String), port(int) and contextPath(String): the future-based constructor always communicates with localhost using an empty context path.

secure

public MockServerClient.Builder secure(boolean secure)

Whether to communicate with MockServer over TLS. Delegates to MockServerClient.withSecure(boolean).

proxyConfiguration

public MockServerClient.Builder proxyConfiguration(ProxyConfiguration proxyConfiguration)

Route communication to MockServer via a proxy. Delegates to MockServerClient.withProxyConfiguration(ProxyConfiguration).

controlPlaneJWT

public MockServerClient.Builder controlPlaneJWT(String controlPlaneJWT)

A fixed JWT for control plane authorisation. Delegates to MockServerClient.withControlPlaneJWT(String).

controlPlaneJWT

public MockServerClient.Builder controlPlaneJWT(Supplier<String> controlPlaneJWTSupplier)

A JWT supplier for control plane authorisation. Delegates to MockServerClient.withControlPlaneJWT(Supplier).

requestOverride

public MockServerClient.Builder requestOverride(HttpRequest requestOverride)

A request override applied to every control plane request. Delegates to MockServerClient.withRequestOverride(HttpRequest).

build

public MockServerClient build()

Build the MockServerClient, selecting the matching constructor and applying the configured with... setters. Constructor validation (such as the empty-host check) surfaces from here.

Throws:

IllegalArgumentException - if portFuture(CompletableFuture) is combined with an explicit host, port or context path, or if a constructor rejects the supplied values