Package io.micronaut.http.server.netty

Interface HttpContentProcessor

All Superinterfaces:

io.micronaut.core.util.Toggleable

All Known Implementing Classes:

AbstractHttpContentProcessor, DefaultHttpContentProcessor, FormDataHttpContentProcessor, JsonContentProcessor

public interface HttpContentProcessor
extends io.micronaut.core.util.Toggleable

This class represents the first step of the HTTP body parsing pipeline. It transforms ByteBufHolder instances that come from a StreamedHttpRequest into parsed objects, e.g. json nodes or form data fragments.
Processors are stateful. They can receive repeated calls to add(io.netty.buffer.ByteBufHolder, java.util.Collection<java.lang.Object>) with more data, followed by a call to complete(java.util.Collection<java.lang.Object>) to finish up. Both of these methods accept a Collection out parameter that is populated with the processed items.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
void	add(io.netty.buffer.ByteBufHolder data, Collection<Object> out)	Process more data.
default void	cancel()	Cancel processing, clean up any data.
default void	complete(Collection<Object> out)	Finish processing data.
default HttpContentProcessor	resultType(io.micronaut.core.type.Argument<?> type)	Set the type of the values returned by this processor.

Methods inherited from interface io.micronaut.core.util.Toggleable

isEnabled

Method Details

add

void add(io.netty.buffer.ByteBufHolder data,
 Collection<Object> out)
  throws Throwable

Process more data.

Parameters:

data - The input data

out - The collection to add output items to

Throws:

Throwable

complete

default void complete(Collection<Object> out)
               throws Throwable

Finish processing data.

Parameters:

out - The collection to add remaining output items to

Throws:

Throwable

cancel

default void cancel()
             throws Throwable

Cancel processing, clean up any data. After this, there should be no more calls to add(io.netty.buffer.ByteBufHolder, java.util.Collection<java.lang.Object>) and complete(java.util.Collection<java.lang.Object>).

Throws:

Throwable

resultType

default HttpContentProcessor resultType(io.micronaut.core.type.Argument<?> type)

Set the type of the values returned by this processor. Most processors do not respect this setting, but e.g. the JsonContentProcessor does.

Parameters:

type - The type produced by this processor

Returns:

This processor, for chaining