Package com.linecorp.armeria.common.stream

Class AggregationSupport

java.lang.Object

com.linecorp.armeria.common.stream.AggregationSupport

Direct Known Subclasses:

DefaultStreamMessage, DeferredStreamMessage, FilteredStreamMessage, PublisherBasedStreamMessage, StreamMessageWrapper

@UnstableApi
public abstract class AggregationSupport
extends Object

A helper class to support caching the aggregated result of HttpMessage.

Note that StreamMessage does not support aggregation because it doesn't know how to aggregate a stream of arbitrary objects in a StreamMessage. Although this class is not directly used in StreamMessage's API, it is injected on top of StreamMessage implementations due to the limitation of the multiple class hierarchy so that all variants of HttpRequest and HttpResponse take advantage of the caching logic in this class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AggregationSupport()	Creates a new instance.

Method Summary

Modifier and Type	Method	Description
protected <U extends AggregatedHttpMessage> CompletableFuture<U>	aggregate(AggregationOptions options)	Aggregates an HttpMessage into an AggregatedHttpMessage using the specified AggregationOptions.

Methods inherited from class java.lang.Object

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

Constructor Details

AggregationSupport

protected AggregationSupport()

Creates a new instance.

Method Details

aggregate

@UnstableApi
protected <U extends AggregatedHttpMessage>
CompletableFuture<U> aggregate(AggregationOptions options)

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.