Package com.linecorp.armeria.common

Class FilteredHttpRequest

java.lang.Object

com.linecorp.armeria.common.stream.AggregationSupport

com.linecorp.armeria.common.stream.FilteredStreamMessage<HttpObject,HttpObject>

com.linecorp.armeria.common.FilteredHttpRequest

All Implemented Interfaces:

HttpMessage, HttpRequest, Request, StreamMessage<HttpObject>, org.reactivestreams.Publisher<HttpObject>

public abstract class FilteredHttpRequest
extends FilteredStreamMessage<HttpObject,HttpObject>
implements HttpRequest

An HttpRequest that filters objects as they are published. The filtering will happen from an I/O thread, meaning the order of the filtering will match the order that the delegate processes the objects in.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FilteredHttpRequest(HttpRequest delegate)	Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.
protected	FilteredHttpRequest(HttpRequest delegate, boolean withPooledObjects)	(Advanced users only) Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.

Method Summary

Modifier and Type	Method	Description
CompletableFuture<AggregatedHttpRequest>	aggregate(AggregationOptions options)	Aggregates an HttpMessage into an AggregatedHttpMessage using the specified AggregationOptions.
RequestHeaders	headers()	Returns the initial HTTP/2 headers of this request.

Methods inherited from class com.linecorp.armeria.common.stream.FilteredStreamMessage

abort, abort, beforeComplete, beforeError, beforeSubscribe, collect, defaultSubscriberExecutor, demand, filter, isEmpty, isOpen, onCancellation, subscribe, subscribe, whenComplete

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.linecorp.armeria.common.HttpMessage

decode, decode

Methods inherited from interface com.linecorp.armeria.common.HttpRequest

acceptLanguages, aggregate, aggregate, aggregateWithPooledObjects, aggregateWithPooledObjects, authority, contentType, mapData, mapError, mapHeaders, mapTrailers, method, path, peekData, peekError, peekTrailers, scheme, selectLocale, selectLocale, split, split, toDuplicator, toDuplicator, toDuplicator, toDuplicator, uri, withHeaders, withHeaders

Methods inherited from interface com.linecorp.armeria.common.stream.StreamMessage

abort, abort, collect, collect, collect, decode, decode, defaultSubscriberExecutor, demand, filter, isComplete, isEmpty, isOpen, map, mapAsync, mapParallel, mapParallel, peek, peek, recoverAndResume, recoverAndResume, subscribe, subscribe, subscribe, subscribe, subscribe, toInputStream, toInputStream, whenComplete, writeTo

Constructor Details

FilteredHttpRequest

protected FilteredHttpRequest(HttpRequest delegate)

Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.

FilteredHttpRequest

@UnstableApi
protected FilteredHttpRequest(HttpRequest delegate,
 boolean withPooledObjects)

(Advanced users only) Creates a new FilteredHttpRequest that filters objects published by delegate before passing to a subscriber.

Parameters:

withPooledObjects - if true, FilteredStreamMessage.filter(Object) receives the pooled HttpData as is, without making a copy. If you don't know what this means, use FilteredHttpRequest(HttpRequest).

See Also:

• PooledObjects

Method Details

aggregate

public CompletableFuture<AggregatedHttpRequest> aggregate(AggregationOptions options)

Description copied from class: AggregationSupport

Aggregates an HttpMessage into an AggregatedHttpMessage using the specified AggregationOptions.

Note that this method is added for internal usage. Therefore, you must not override or call this method if you are not familiar with Armeria's internal implementation.

Specified by:

aggregate in interface HttpRequest

Overrides:

aggregate in class AggregationSupport

headers

public RequestHeaders headers()

Description copied from interface: HttpRequest

Returns the initial HTTP/2 headers of this request.

Specified by:

headers in interface HttpRequest