Module io.inverno.mod.web.server

Package io.inverno.mod.web.server

Interface WebRequestBody

All Superinterfaces:

RequestBody

public interface WebRequestBody
extends RequestBody

A request body with payload decoding support.

Implementors should rely on MediaTypeConverter to decode a payload based on the content type of the request.

Since:

1.0

Author:

Jeremy Kuhn

See Also:

• WebRequest
• MediaTypeConverter

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	WebRequestBody.WebMultipart	A multipart/form-data consumer with payload decoding support.

Nested classes/interfaces inherited from interface io.inverno.mod.http.server.RequestBody

RequestBody.Multipart<A extends Part>, RequestBody.UrlEncoded

Method Summary

Modifier and Type	Method	Description
<A> InboundDataDecoder<A>	decoder(Class<A> type)	Returns a decoder to decode the payload to the specified type based on the content type of the request.
<A> InboundDataDecoder<A>	decoder(Type type)	Returns a decoder to decode the payload to the specified type based on the content type of the request.
RequestBody.Multipart<? extends WebPart>	multipart()	Returns a multipart/form-data payload consumer.
WebRequestBody	transform(Function<Publisher<ByteBuf>,Publisher<ByteBuf>> transformer)	Transforms the payload publisher.

Methods inherited from interface io.inverno.mod.http.server.RequestBody

raw, string, urlEncoded

Method Details

transform

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

Description copied from interface: RequestBody

Transforms the payload publisher.

This can be used in an exchange interceptor in order to decorate the request data publisher.

Specified by:

transform in interface RequestBody

Parameters:

transformer - a request payload publisher transformer

Returns:

the request body

decoder

<A> InboundDataDecoder<A> decoder(Class<A> type)

Returns a decoder to decode the payload to the specified type based on the content type of the request.

Type Parameters:

A - the decoded type

Parameters:

type - a class of A

Returns:

a decoder

decoder

<A> InboundDataDecoder<A> decoder(Type type)

Returns a decoder to decode the payload to the specified type based on the content type of the request.

Type Parameters:

A - the decoded type

Parameters:

type - the decoded type

Returns:

a decoder

multipart

RequestBody.Multipart<? extends WebPart> multipart()
                                            throws IllegalStateException

Description copied from interface: RequestBody

Returns a multipart/form-data payload consumer.

Specified by:

multipart in interface RequestBody

Returns:

body a multipart/form-data payload consumer

Throws:

IllegalStateException - if the payload has already been consumed using another decoder