Package dev.relism.flash.testing

Class FlashRequest

java.lang.Object

dev.relism.flash.testing.FlashRequest

public final class FlashRequest
extends Object

A request being built against a FlashTest server. The HTTP verb is terminal — it sends the request and hands back a FlashResponse:

 app.request()
    .header("Authorization", "Bearer " + token)
    .json("{\"name\":\"bob\"}")
    .post("/api/users")
    .expectStatus(201);
 

For a bodyless GET or DELETE, FlashTest.get(java.lang.String) and FlashTest.delete(java.lang.String) skip the builder entirely.

Method Summary

Modifier and Type	Method	Description
FlashRequest	body(byte[] bytes)	Sets a raw request body.
FlashRequest	body(String text)	Sets a UTF-8 request body.
FlashResponse	delete(String path)
FlashResponse	get(String path)
FlashResponse	head(String path)
FlashRequest	header(String name, String value)	Adds a header.
FlashRequest	json(String json)	Sets a UTF-8 body and content-type: application/json.
FlashResponse	options(String path)
FlashResponse	patch(String path)
FlashResponse	post(String path)
FlashResponse	put(String path)
FlashResponse	send(String method, String path)	Sends any method, including the ones Flash adds beyond RFC 9110 (PURGE, QUERY).
FlashRequest	with(Consumer<FlashRequest> customizer)	Applies customizer — how an extension's test kit attaches a credential, for instance.

Methods inherited from class java.lang.Object

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

Method Details

header

public FlashRequest header(String name,
 String value)

Adds a header. Repeatable — a name may be sent more than once.

with

public FlashRequest with(Consumer<FlashRequest> customizer)

Applies customizer — how an extension's test kit attaches a credential, for instance.

body

public FlashRequest body(String text)

Sets a UTF-8 request body.

body

public FlashRequest body(byte[] bytes)

Sets a raw request body.

json

public FlashRequest json(String json)

Sets a UTF-8 body and content-type: application/json.

get

public FlashResponse get(String path)

post

public FlashResponse post(String path)

put

public FlashResponse put(String path)

patch

public FlashResponse patch(String path)

delete

public FlashResponse delete(String path)

head

public FlashResponse head(String path)

options

public FlashResponse options(String path)

send

public FlashResponse send(String method,
 String path)

Sends any method, including the ones Flash adds beyond RFC 9110 (PURGE, QUERY).