Module io.inverno.mod.http.client

Package io.inverno.mod.http.client

Interface RequestBody

All Known Subinterfaces:

WebRequestBody

public interface RequestBody

Represents the request payload sent by a client to a server in a client exchange.

The request body basically provides multiple ways to specify the payload.

Since:

1.8

Author:

Jeremy Kuhn

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	RequestBody.Multipart<A extends Part.Factory,B extends Part<?>>	A Multipart form data producer.
static interface	RequestBody.Resource	A resource data producer.
static interface	RequestBody.UrlEncoded<A extends Parameter.Factory>	A URL encoded data producer.

Method Summary

Modifier and Type	Method	Description
default RequestBody	after(Mono<Void> after)	Transforms the payload publisher to subscribe to the specified publisher after payload publisher completion.
default RequestBody	before(Mono<Void> before)	Transforms the payload publisher to subscribe to the specified publisher before subscribing to the payload publisher.
void	empty()	Produces an empty payload.
RequestBody.Multipart<? extends Part.Factory,Part<?>>	multipart()	Returns a Multipart form data producer.
OutboundData<ByteBuf>	raw()	Returns a raw outbound data producer.
RequestBody.Resource	resource()	Returns a resource data producer.
<T extends CharSequence> OutboundData<T>	string()	Returns a string outbound data producer.
RequestBody	transform(Function<Publisher<ByteBuf>,Publisher<ByteBuf>> transformer)	Transforms the payload publisher.
RequestBody.UrlEncoded<Parameter.Factory>	urlEncoded()	Returns a URL encoded data producer.

Method Details

transform

RequestBody transform(Function<Publisher<ByteBuf>,Publisher<ByteBuf>> transformer)

Transforms the payload publisher.

Parameters:

transformer - a payload publisher transformer

Returns:

the request body

before

default RequestBody before(Mono<Void> before)

Transforms the payload publisher to subscribe to the specified publisher before subscribing to the payload publisher.

This basically allows to perform actions before the request is actually sent.

Parameters:

before - the publisher to subscribe before the request body publisher

Returns:

the request body

after

default RequestBody after(Mono<Void> after)

Transforms the payload publisher to subscribe to the specified publisher after payload publisher completion.

This basically allows to perform actions after the request has been sent.

Parameters:

after - the publisher to subscribe before the request body publisher

Returns:

the request body

empty

void empty()

Produces an empty payload.

A typical usage is:

 exchange.request().body().ifPresent(body -> body.empty());
 

raw

OutboundData<ByteBuf> raw()

Returns a raw outbound data producer.

A typical usage is:

 exchange.request().body().ifPresent(body -> body.raw().stream(
     Flux.just(
         Unpooled.unreleasableBuffer(Unpooled.copiedBuffer("Hello ", Charsets.DEFAULT)), 
         Unpooled.unreleasableBuffer(Unpooled.copiedBuffer("World!", Charsets.DEFAULT))
     )
 ));
 

Returns:

a raw outbound data

string

<T extends CharSequence> OutboundData<T> string()

Returns a string outbound data producer.

A typical usage is:

 exchange.request().body().ifPresent(body -> body.string().stream(
     Flux.just(
         Unpooled.unreleasableBuffer("Hello "), 
         Unpooled.unreleasableBuffer("World!")
     )
 ));
 

Type Parameters:

T - the type of char sequence

Returns:

a string outbound data

resource

RequestBody.Resource resource()

Returns a resource data producer.

A typical usage is:

 ResourceService resourceService = ... 
 exchange.request().body().ifPresent(body -> body.resource().value(resourceService.get("file:/path/to/resource")));
 

Returns:

a resource payload producer

urlEncoded

RequestBody.UrlEncoded<Parameter.Factory> urlEncoded()

Returns a URL encoded data producer.

A typical usage is:

 exchange.request().body().ifPresent(body -> body.urlEncoded().from( 
     (factory, output) -> output.stream(Flux.just(
         factory.create("p1", "abc"), 
         factory.create("p2", List.of("a", "b", "c"))
 ))));
 

Returns:

a URL encoded data producer

multipart

RequestBody.Multipart<? extends Part.Factory,Part<?>> multipart()

Returns a Multipart form data producer.

A typical usage is:

 exchange.request().body().ifPresent(body -> body.multipart().from( 
     (factory, output) -> output.stream(Flux.just(
         factory.string(part -> part.name("key").value("value")),
         factory.resource(part -> part
             .name("myfile")
             .headers(headers -> headers.contentType("application/json"))
             .value(new FileResource("sample.json")))
 ))));
 

Returns:

a Multipart form data producer