Mokksy/dev.mokksy.mokksy/MokksyServerJava

MokksyServerJava

class MokksyServerJava(val delegate: MokksyServer) : AutoCloseable(source)

Java-friendly wrapper around MokksyServer that provides a fully instance-method-based API.

Eliminates Kotlin-specific boilerplate from Java test code:

start() and shutdown() are instance methods
HTTP stub methods (get, post, etc.) accept Consumer<RequestSpecificationBuilder<P>> instead of Kotlin lambdas with receivers (no return Unit.INSTANCE)
Returns JavaBuildingStep, which exposes respondsWith and respondsWithStream as chainable instance methods (no separate MokksyJava.respondsWith(step, ...) call)

Example:

@TestInstance(TestInstance.Lifecycle.PER_CLASS)
class MyTest {
    private final MokksyServerJava mokksy = new MokksyServerJava();

    @BeforeAll void setUp() { mokksy.start(); }
    @AfterAll void tearDown() { mokksy.shutdown(); }

    @Test
    void myTest() throws Exception {
        mokksy.get(spec -> spec.path("/ping"))
              .respondsWith(builder -> builder.setBody("Pong"));
        // ... make HTTP call and assert
    }
}

Constructors

MokksyServerJava

constructor(delegate: MokksyServer)

Wraps an existing MokksyServer instance.

constructor(port: Int = 0, host: String = DEFAULT_HOST, verbose: Boolean = false)

Creates a MokksyServerJava backed by a new MokksyServer.

Properties

val delegate: MokksyServer

The underlying MokksyServer. Accessible for advanced configuration and for Kotlin callers that mix the two APIs.

Functions

fun baseUrl(): String

Returns the base URL of the server in the form http://<host>:<port>.

open override fun close()

Closes the resource, releasing any underlying resources.

fun delete(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a DELETE stub with a String request body.

fun delete(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a DELETE stub with a String request body and StubConfiguration.

fun <P : Any> delete(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a DELETE stub with a typed request body.

fun <P : Any> delete(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a DELETE stub with a typed request body and StubConfiguration.

findAllUnexpectedRequests

fun findAllUnexpectedRequests(): List<RecordedRequest>

Returns all requests that were not matched by any stub.

findAllUnmatchedStubs

fun findAllUnmatchedStubs(): List<RequestSpecification<*>>

Returns all stubs that were never matched.

fun get(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a GET stub with a String request body.

fun get(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a GET stub with a String request body and StubConfiguration.

fun <P : Any> get(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a GET stub with a typed request body.

fun <P : Any> get(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a GET stub with a typed request body and StubConfiguration.

fun head(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a HEAD stub.

fun head(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a HEAD stub with StubConfiguration.

fun <P : Any> head(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a HEAD stub with a typed request body.

fun <P : Any> head(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a HEAD stub with a typed request body and StubConfiguration.

fun options(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers an OPTIONS stub.

fun options(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers an OPTIONS stub with StubConfiguration.

fun <P : Any> options(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers an OPTIONS stub with a typed request body.

fun <P : Any> options(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers an OPTIONS stub with a typed request body and StubConfiguration.

fun patch(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a PATCH stub with a String request body.

fun patch(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a PATCH stub with a String request body and StubConfiguration.

fun <P : Any> patch(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a PATCH stub with a typed request body.

fun <P : Any> patch(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a PATCH stub with a typed request body and StubConfiguration.

fun port(): Int

Returns the port the server is bound to.

fun post(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a POST stub with a String request body.

fun post(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a POST stub with a String request body and StubConfiguration.

fun <P : Any> post(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a POST stub with a typed request body.

fun <P : Any> post(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a POST stub with a typed request body and StubConfiguration.

fun put(spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a PUT stub with a String request body.

fun put(configuration: StubConfiguration, spec: Consumer<RequestSpecificationBuilder<String>>): JavaBuildingStep<String>

Registers a PUT stub with a String request body and StubConfiguration.

fun <P : Any> put(requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a PUT stub with a typed request body.

fun <P : Any> put(configuration: StubConfiguration, requestType: Class<P>, spec: Consumer<RequestSpecificationBuilder<P>>): JavaBuildingStep<P>

Registers a PUT stub with a typed request body and StubConfiguration.

resetMatchCounts

fun resetMatchCounts()

Resets stub match counts and clears the request journal.

fun shutdown(gracePeriodMillis: Long = 500, timeoutMillis: Long = 1000)

Stops the server and blocks the calling thread until shutdown is complete.

fun start()

Starts the server and blocks the calling thread until the port is bound and the server is ready to accept requests.

verifyNoUnexpectedRequests

fun verifyNoUnexpectedRequests()

Asserts that every request received by the server was matched by a stub.

verifyNoUnmatchedStubs

fun verifyNoUnmatchedStubs()

Asserts that every registered stub was matched at least once.