Mokksy/dev.mokksy.mokksy/JavaRequestSpecificationBuilder

JavaRequestSpecificationBuilder

class JavaRequestSpecificationBuilder<P : Any>(source)

Java-friendly wrapper around RequestSpecificationBuilder that replaces Kotlin functional types with their java.util.function equivalents.

Java callers receive this type from dev.mokksy.Mokksy's stub-registration methods (get, post, etc.) and use it to configure request-matching criteria.

All methods return this for fluent chaining:

mokksy.post(spec -> spec
    .path("/items")
    .bodyMatchesPredicate(body -> body.contains("token")))
  .respondsWith(builder -> builder.body("ok"));

Type Parameters

P

The type of the request payload.

Functions

fun body(configurer: Consumer<JavaBodySpecBuilder<P>>): JavaRequestSpecificationBuilder<P>

Configures body matching through a JavaBodySpecBuilder scope.

fun bodyContains(vararg strings: String): JavaRequestSpecificationBuilder<P>

Requires the request body string to contain all of strings.

bodyMatchesPredicate

fun bodyMatchesPredicate(predicate: Predicate<P>): JavaRequestSpecificationBuilder<P>

Adds a predicate to match against the deserialized request body.

fun bodyMatchesPredicate(description: String?, predicate: Predicate<P>): JavaRequestSpecificationBuilder<P>

Adds a predicate to match against the deserialized request body, with a description.

@ExperimentalMokksyApi

fun bodyText(expectedValue: String): JavaRequestSpecificationBuilder<P>

Matches the request body string exactly against expectedValue.

bodyTextMatches

@ExperimentalMokksyApi

fun bodyTextMatches(predicate: Predicate<String?>): JavaRequestSpecificationBuilder<P>

Matches the request body string against a Predicate.

@ExperimentalMokksyApi

fun bodyTextMatches(description: String?, predicate: Predicate<String?>): JavaRequestSpecificationBuilder<P>

Matches the request body string against a Predicate, with a description.

fun containsHeader(name: String, value: String): JavaRequestSpecificationBuilder<P>

fun cookie(name: String, value: String): JavaRequestSpecificationBuilder<P>

Requires a request cookie with name to equal value.

fun cookieAbsent(name: String): JavaRequestSpecificationBuilder<P>

Requires that the request does not contain a cookie with name.

fun cookieMatches(name: String, predicate: Predicate<String?>): JavaRequestSpecificationBuilder<P>

Requires a request cookie with name to match predicate.

fun path(matcher: Matcher<String>): JavaRequestSpecificationBuilder<P>

Matches the request path using a Kotest Matcher.

fun path(path: String): JavaRequestSpecificationBuilder<P>

Matches the request path exactly against path.

fun priority(value: Int): JavaRequestSpecificationBuilder<P>

Sets the priority for this stub. Higher values win over lower values.