Module io.helidon.media.common

Package io.helidon.media.common

Interface MessageBodyFilters

All Known Subinterfaces:

ServerResponse

All Known Implementing Classes:

MessageBodyContext, MessageBodyReadableContent, MessageBodyReaderContext, MessageBodyWriterContext

public interface MessageBodyFilters

Registry of MessageBodyFilters.

Method Summary

Modifier and Type	Method	Description
MessageBodyFilters	registerFilter(MessageBodyFilter filter)	Registers a message body filter.

Method Detail

registerFilter

MessageBodyFilters registerFilter(MessageBodyFilter filter)

Registers a message body filter.

The registered filters are applied to form a chain from the first registered to the last registered. The first evaluation of the function transforms the original publisher to a new publisher. Any subsequent evaluation receives the publisher transformed by the last previously registered filter.

Parameters:

filter - a function to map previously registered or original Publisher to the new one. If returns null then the result will be ignored.

Returns:

this instance of MessageBodyFilters

Throws:

NullPointerException - if parameter function is null

See Also:

MessageBodyContext.applyFilters(Flow.Publisher)