Package com.linecorp.armeria.common

Interface HttpResponse

All Superinterfaces:

HttpMessage, org.reactivestreams.Publisher<HttpObject>, Response, StreamMessage<HttpObject>

All Known Subinterfaces:

HttpResponseWriter

All Known Implementing Classes:

FilteredHttpResponse

public interface HttpResponse
extends Response, HttpMessage

A streamed HTTP/2 Response.

Method Summary

Modifier and Type	Method	Description
default CompletableFuture<AggregatedHttpResponse>	aggregate()	Aggregates this response.
CompletableFuture<AggregatedHttpResponse>	aggregate(AggregationOptions options)	Aggregates this response with the specified AggregationOptions.
default CompletableFuture<AggregatedHttpResponse>	aggregate(EventExecutor executor)	Aggregates this response.
default CompletableFuture<AggregatedHttpResponse>	aggregateWithPooledObjects(ByteBufAllocator alloc)	Deprecated. Use aggregate(AggregationOptions) with AggregationOptions.usePooledObjects(ByteBufAllocator).
default CompletableFuture<AggregatedHttpResponse>	aggregateWithPooledObjects(EventExecutor executor, ByteBufAllocator alloc)	Deprecated. Use aggregate(AggregationOptions) with AggregationOptions.usePooledObjects(ByteBufAllocator).
static HttpResponseBuilder	builder()	Returns a new HttpResponseBuilder.
static HttpResponse	delayed(AggregatedHttpResponse response, Duration delay)	Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.
static HttpResponse	delayed(AggregatedHttpResponse response, Duration delay, ScheduledExecutorService executor)	Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.
static HttpResponse	delayed(HttpResponse response, Duration delay)	Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.
static HttpResponse	delayed(HttpResponse response, Duration delay, ScheduledExecutorService executor)	Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.
static HttpResponse	delayed(Supplier<? extends HttpResponse> responseSupplier, Duration delay)	Invokes the specified Supplier and creates a new HTTP response that delegates to the provided HttpResponse by Supplier.
static HttpResponse	delayed(Supplier<? extends HttpResponse> responseSupplier, Duration delay, ScheduledExecutorService executor)	Invokes the specified Supplier and creates a new HTTP response that delegates to the provided HttpResponse Supplier, beginning publishing after delay has passed from the provided ScheduledExecutorService.
static HttpResponse	from(CompletableFuture<? extends HttpResponse> future)	Deprecated. Use of(CompletionStage).
static HttpResponse	from(CompletionStage<? extends HttpResponse> stage)	Deprecated. Use of(CompletionStage).
static HttpResponse	from(CompletionStage<? extends HttpResponse> stage, EventExecutor subscriberExecutor)	Deprecated. Use of(CompletionStage, EventExecutor).
static HttpResponse	from(Supplier<? extends HttpResponse> responseSupplier, Executor executor)	Deprecated. Use of(Supplier, Executor).
default HttpResponse	mapData(Function<? super HttpData,? extends HttpData> function)	Transforms the HttpDatas emitted by this HttpResponse by applying the specified Function.
default HttpResponse	mapError(Function<? super Throwable,? extends Throwable> function)	Transforms an error emitted by this HttpResponse by applying the specified Function.
default HttpResponse	mapHeaders(Function<? super ResponseHeaders,? extends ResponseHeaders> function)	Transforms the non-informational ResponseHeaders emitted by HttpResponse by applying the specified Function.
default HttpResponse	mapInformational(Function<? super ResponseHeaders,? extends ResponseHeaders> function)	Transforms the informational headers emitted by HttpResponse by applying the specified Function.
default HttpResponse	mapTrailers(Function<? super HttpHeaders,? extends HttpHeaders> function)	Transforms the trailers emitted by this HttpResponse by applying the specified Function.
static HttpResponse	of(int statusCode)	Creates a new HTTP response of the specified statusCode.
static HttpResponse	of(HttpObject... objs)	Creates a new HTTP response of the specified objects.
static HttpResponse	of(HttpStatus status)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, byte[] content)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, HttpData content)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, HttpData content, HttpHeaders trailers)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, CharSequence content)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, String content)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(HttpStatus status, MediaType mediaType, String format, Object... args)	Creates a new HTTP response of the specified HttpStatus.
static HttpResponse	of(MediaType mediaType, String content)	Creates a new HTTP response of OK status with the content.
static HttpResponse	of(MediaType mediaType, String format, Object... args)	Creates a new HTTP response of OK status with the content.
static HttpResponse	of(ResponseHeaders headers)	Creates a new HTTP response of the specified headers.
static HttpResponse	of(ResponseHeaders headers, HttpData content)	Creates a new HTTP response of the specified headers and content.
static HttpResponse	of(ResponseHeaders headers, HttpData content, HttpHeaders trailers)	Creates a new HTTP response of the specified objects.
static HttpResponse	of(ResponseHeaders headers, org.reactivestreams.Publisher<? extends HttpData> publisher, HttpHeaders trailers)	Creates a new HTTP response with the specified headers and trailers whose stream is produced from an existing Publisher.
static HttpResponse	of(ResponseHeaders headers, org.reactivestreams.Publisher<? extends HttpData> publisher, Function<@Nullable Throwable,HttpHeaders> trailersFunction)	Creates a new HTTP response with the specified headers and trailers function whose stream is produced from an existing Publisher.
static HttpResponse	of(ResponseHeaders headers, org.reactivestreams.Publisher<? extends HttpObject> publisher)	Creates a new HTTP response with the specified headers whose stream is produced from an existing Publisher.
static HttpResponse	of(String content)	Creates a new HTTP response of OK status with the content as UTF_8.
static HttpResponse	of(String format, Object... args)	Creates a new HTTP response of OK status with the content as UTF_8.
static HttpResponse	of(CompletableFuture<? extends HttpResponse> future)	Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletableFuture.
static HttpResponse	of(CompletionStage<? extends HttpResponse> stage)	Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage.
static HttpResponse	of(CompletionStage<? extends HttpResponse> stage, EventExecutor subscriberExecutor)	Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage.
static HttpResponse	of(Supplier<? extends HttpResponse> responseSupplier, Executor executor)	Creates a new HTTP response that delegates to the HttpResponse provided by the Supplier.
static HttpResponse	of(org.reactivestreams.Publisher<? extends HttpObject> publisher)	Creates a new HTTP response whose stream is produced from an existing Publisher.
static HttpResponse	ofFailure(Throwable cause)	Creates a new failed HTTP response.
static HttpResponse	ofJson(HttpStatus status, MediaType contentType, Object content)	Creates a new HTTP response with the specified HttpStatus, MediaType and content that is converted into JSON using the default ObjectMapper.
static HttpResponse	ofJson(HttpStatus status, Object content)	Creates a new HTTP response with the specified HttpStatus and content that is converted into JSON using the default ObjectMapper.
static HttpResponse	ofJson(MediaType contentType, Object content)	Creates a new HTTP response with the specified MediaType and content that is converted into JSON using the default ObjectMapper.
static HttpResponse	ofJson(ResponseHeaders headers, Object content)	Creates a new HTTP response with the specified ResponseHeaders and content that is converted into JSON using the default ObjectMapper.
static HttpResponse	ofJson(Object content)	Creates a new HTTP response with the specified content that is converted into JSON using the default ObjectMapper.
static HttpResponse	ofRedirect(HttpStatus redirectStatus, String location)	Creates a new HTTP response of the redirect to specific location.
static HttpResponse	ofRedirect(HttpStatus redirectStatus, String format, Object... args)	Creates a new HTTP response of the redirect to specific location using string format.
static HttpResponse	ofRedirect(String location)	Creates a new HTTP response of the temporary redirect to specific location.
static HttpResponse	ofRedirect(String format, Object... args)	Creates a new HTTP response of the temporary redirect to specific location using string format.
default HttpResponse	peekData(Consumer<? super HttpData> action)	Applies the specified Consumer to the HttpDatas emitted by this HttpResponse.
default HttpResponse	peekError(Consumer<? super Throwable> action)	Applies the specified Consumer to an error emitted by this HttpResponse.
default HttpResponse	peekHeaders(Consumer<? super ResponseHeaders> action)	Applies the specified Consumer to the non-informational ResponseHeaders emitted by this HttpResponse.
default HttpResponse	peekTrailers(Consumer<? super HttpHeaders> action)	Applies the specified Consumer to the trailers emitted by this HttpResponse.
default <T extends Throwable> HttpResponse	recover(Class<T> causeClass, Function<? super T,? extends HttpResponse> function)	Recovers a failed HttpResponse by switching to a returned fallback HttpResponse when the thrown Throwable is the same type or a subtype of the specified causeClass.
default HttpResponse	recover(Function<? super Throwable,? extends HttpResponse> function)	Recovers a failed HttpResponse by switching to a returned fallback HttpResponse when any error occurs before a ResponseHeaders is written.
default SplitHttpResponse	split()	Returns a new SplitHttpResponse which splits a stream of HttpObjects into HttpHeaders and HttpData.
default SplitHttpResponse	split(EventExecutor executor)	Returns a new SplitHttpResponse which splits a stream of HttpObjects into HttpHeaders and HttpData.
static HttpResponseWriter	streaming()	Creates a new HTTP response that can stream an arbitrary number of HttpObject to the client.
default HttpResponse	subscribeOn(EventExecutor eventExecutor)	Calls StreamMessage.subscribe(Subscriber, EventExecutor) to the upstream StreamMessage using the specified EventExecutor and relays the stream transparently downstream.
default HttpResponseDuplicator	toDuplicator()	Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
default HttpResponseDuplicator	toDuplicator(long maxResponseLength)	Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements.
default HttpResponseDuplicator	toDuplicator(EventExecutor executor)	Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements.
default HttpResponseDuplicator	toDuplicator(EventExecutor executor, long maxResponseLength)	Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements.
CompletableFuture<Void>	whenComplete()	Returns a CompletableFuture which completes when 1) the response stream has been closed (the StreamMessage has been completed) or 2) the result value is set (the CompletionStage has completed.)

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

decode, decode

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

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

Method Details

streaming

static HttpResponseWriter streaming()

Creates a new HTTP response that can stream an arbitrary number of HttpObject to the client. The first object written must be of type ResponseHeaders.

from

@Deprecated
static HttpResponse from(CompletionStage<? extends HttpResponse> stage)

Deprecated.

Use of(CompletionStage).

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage. If the specified CompletionStage fails, the returned response will be closed with the same cause as well.

Parameters:

stage - the CompletionStage which will produce the actual HttpResponse

from

@Deprecated
static HttpResponse from(CompletableFuture<? extends HttpResponse> future)

Deprecated.

Use of(CompletionStage).

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletableFuture. If the specified CompletableFuture fails, the returned response will be closed with the same cause as well.

Parameters:

future - the CompletableFuture which will produce the actual HttpResponse

from

@Deprecated
static HttpResponse from(CompletionStage<? extends HttpResponse> stage,
 EventExecutor subscriberExecutor)

Deprecated.

Use of(CompletionStage, EventExecutor).

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage. If the specified CompletionStage fails, the returned response will be closed with the same cause as well.

Parameters:

stage - the CompletionStage which will produce the actual HttpResponse

subscriberExecutor - the EventExecutor which will be used when a user subscribes the returned HttpResponse using StreamMessage.subscribe(Subscriber) or StreamMessage.subscribe(Subscriber, SubscriptionOption...).

from

@Deprecated
static HttpResponse from(Supplier<? extends HttpResponse> responseSupplier,
 Executor executor)

Deprecated.

Use of(Supplier, Executor).

Creates a new HTTP response that delegates to the HttpResponse provided by the Supplier.

Parameters:

responseSupplier - the Supplier invokes returning the provided HttpResponse

executor - the Executor that executes the Supplier.

delayed

static HttpResponse delayed(AggregatedHttpResponse response,
 Duration delay)

Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.

delayed

static HttpResponse delayed(AggregatedHttpResponse response,
 Duration delay,
 ScheduledExecutorService executor)

Creates a new HTTP response that delegates to the provided AggregatedHttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.

delayed

static HttpResponse delayed(HttpResponse response,
 Duration delay)

Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from a random ScheduledExecutorService.

delayed

static HttpResponse delayed(HttpResponse response,
 Duration delay,
 ScheduledExecutorService executor)

Creates a new HTTP response that delegates to the provided HttpResponse, beginning publishing after delay has passed from the provided ScheduledExecutorService.

delayed

static HttpResponse delayed(Supplier<? extends HttpResponse> responseSupplier,
 Duration delay)

Invokes the specified Supplier and creates a new HTTP response that delegates to the provided HttpResponse by Supplier.

The Supplier is invoked from the current thread-local RequestContext's event loop. If there's no thread local RequestContext is set, one of the threads from CommonPools.workerGroup().next() will be used.

delayed

static HttpResponse delayed(Supplier<? extends HttpResponse> responseSupplier,
 Duration delay,
 ScheduledExecutorService executor)

Invokes the specified Supplier and creates a new HTTP response that delegates to the provided HttpResponse Supplier, beginning publishing after delay has passed from the provided ScheduledExecutorService.

of

static HttpResponse of(int statusCode)

Creates a new HTTP response of the specified statusCode.

Throws:

IllegalArgumentException - if the specified statusCode is informational.

of

static HttpResponse of(HttpStatus status)

Creates a new HTTP response of the specified HttpStatus.

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 CharSequence content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 String content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(String content)

Creates a new HTTP response of OK status with the content as UTF_8.

Parameters:

content - the content of the response

of

@FormatMethod
static HttpResponse of(@FormatString
 String format,
 Object... args)

Creates a new HTTP response of OK status with the content as UTF_8. The content of the response is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

of

static HttpResponse of(MediaType mediaType,
 String content)

Creates a new HTTP response of OK status with the content.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

of

@FormatMethod
static HttpResponse of(MediaType mediaType,
 @FormatString
 String format,
 Object... args)

Creates a new HTTP response of OK status with the content. The content of the response is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

mediaType - the MediaType of the response content

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

of

@FormatMethod
static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 @FormatString
 String format,
 Object... args)

Creates a new HTTP response of the specified HttpStatus. The content of the response is formatted by String.format(Locale, String, Object...) with English locale.

Parameters:

mediaType - the MediaType of the response content

format - the format string of the response content

args - the arguments referenced by the format specifiers in the format string

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 byte[] content)

Creates a new HTTP response of the specified HttpStatus. The content will be wrapped using HttpData.wrap(byte[]), so any changes made to content will be reflected in the response.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 HttpData content)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(HttpStatus status,
 MediaType mediaType,
 HttpData content,
 HttpHeaders trailers)

Creates a new HTTP response of the specified HttpStatus.

Parameters:

mediaType - the MediaType of the response content

content - the content of the response

trailers - the HTTP trailers

Throws:

IllegalArgumentException - if the specified HttpStatus is informational.

of

static HttpResponse of(ResponseHeaders headers)

Creates a new HTTP response of the specified headers.

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static HttpResponse of(ResponseHeaders headers,
 HttpData content)

Creates a new HTTP response of the specified headers and content.

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static HttpResponse of(ResponseHeaders headers,
 HttpData content,
 HttpHeaders trailers)

Creates a new HTTP response of the specified objects.

Throws:

IllegalArgumentException - if the status of the specified ResponseHeaders is informational.

of

static HttpResponse of(HttpObject... objs)

Creates a new HTTP response of the specified objects.

of

static HttpResponse of(org.reactivestreams.Publisher<? extends HttpObject> publisher)

Creates a new HTTP response whose stream is produced from an existing Publisher.

Note that the HttpObjects in the Publisher are not released when Subscription.cancel() or StreamMessage.abort() is called. You should add a hook in order to release the elements. See PublisherBasedStreamMessage for more information.

of

static HttpResponse of(ResponseHeaders headers,
 org.reactivestreams.Publisher<? extends HttpObject> publisher)

Creates a new HTTP response with the specified headers whose stream is produced from an existing Publisher.

Note that the HttpObjects in the Publisher are not released when Subscription.cancel() or StreamMessage.abort() is called. You should add a hook in order to release the elements. See PublisherBasedStreamMessage for more information.

of

static HttpResponse of(ResponseHeaders headers,
 org.reactivestreams.Publisher<? extends HttpData> publisher,
 HttpHeaders trailers)

Creates a new HTTP response with the specified headers and trailers whose stream is produced from an existing Publisher.

Note that the HttpDatas in the Publisher are not released when Subscription.cancel() or StreamMessage.abort() is called. You should add a hook in order to release the elements. See PublisherBasedStreamMessage for more information.

of

static HttpResponse of(ResponseHeaders headers,
 org.reactivestreams.Publisher<? extends HttpData> publisher,
 Function<@Nullable Throwable,HttpHeaders> trailersFunction)

Creates a new HTTP response with the specified headers and trailers function whose stream is produced from an existing Publisher.

Note that the HttpDatas in the Publisher are not released when Subscription.cancel() or StreamMessage.abort() is called. You should add a hook in order to release the elements. See PublisherBasedStreamMessage for more information.

of

static HttpResponse of(CompletableFuture<? extends HttpResponse> future)

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletableFuture. If the specified CompletableFuture fails, the returned response will be closed with the same cause as well.

Parameters:

future - the CompletableFuture which will produce the actual HttpResponse

of

static HttpResponse of(CompletionStage<? extends HttpResponse> stage)

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage. If the specified CompletionStage fails, the returned response will be closed with the same cause as well.

Parameters:

stage - the CompletionStage which will produce the actual HttpResponse

of

static HttpResponse of(CompletionStage<? extends HttpResponse> stage,
 EventExecutor subscriberExecutor)

Creates a new HTTP response that delegates to the HttpResponse produced by the specified CompletionStage. If the specified CompletionStage fails, the returned response will be closed with the same cause as well.

Parameters:

stage - the CompletionStage which will produce the actual HttpResponse

subscriberExecutor - the EventExecutor which will be used when a user subscribes the returned HttpResponse using StreamMessage.subscribe(Subscriber) or StreamMessage.subscribe(Subscriber, SubscriptionOption...).

of

static HttpResponse of(Supplier<? extends HttpResponse> responseSupplier,
 Executor executor)

Creates a new HTTP response that delegates to the HttpResponse provided by the Supplier.

Parameters:

responseSupplier - the Supplier invokes returning the provided HttpResponse

executor - the Executor that executes the Supplier.

ofJson

static HttpResponse ofJson(Object content)

Creates a new HTTP response with the specified content that is converted into JSON using the default ObjectMapper.

Throws:

IllegalArgumentException - if failed to encode the content into JSON.

See Also:

• JacksonObjectMapperProvider

ofJson

static HttpResponse ofJson(HttpStatus status,
 Object content)

Creates a new HTTP response with the specified HttpStatus and content that is converted into JSON using the default ObjectMapper.

Throws:

IllegalArgumentException - if failed to encode the content into JSON.

See Also:

• JacksonObjectMapperProvider

ofJson

static HttpResponse ofJson(MediaType contentType,
 Object content)

Creates a new HTTP response with the specified MediaType and content that is converted into JSON using the default ObjectMapper.

Throws:

IllegalArgumentException - if the specified MediaType is not a JSON compatible type; or if failed to encode the content into JSON.

See Also:

• JacksonObjectMapperProvider

ofJson

static HttpResponse ofJson(HttpStatus status,
 MediaType contentType,
 Object content)

Creates a new HTTP response with the specified HttpStatus, MediaType and content that is converted into JSON using the default ObjectMapper.

Throws:

IllegalArgumentException - if the specified MediaType is not a JSON compatible type; or if failed to encode the content into JSON.

See Also:

• JacksonObjectMapperProvider

ofJson

static HttpResponse ofJson(ResponseHeaders headers,
 Object content)

Creates a new HTTP response with the specified ResponseHeaders and content that is converted into JSON using the default ObjectMapper.

Throws:

IllegalArgumentException - if failed to encode the content into JSON.

See Also:

• JacksonObjectMapperProvider

ofRedirect

static HttpResponse ofRedirect(HttpStatus redirectStatus,
 String location)

Creates a new HTTP response of the redirect to specific location.

ofRedirect

static HttpResponse ofRedirect(HttpStatus redirectStatus,
 String format,
 Object... args)

Creates a new HTTP response of the redirect to specific location using string format.

ofRedirect

static HttpResponse ofRedirect(String location)

Creates a new HTTP response of the temporary redirect to specific location.

ofRedirect

static HttpResponse ofRedirect(String format,
 Object... args)

Creates a new HTTP response of the temporary redirect to specific location using string format.

ofFailure

static HttpResponse ofFailure(Throwable cause)

Creates a new failed HTTP response.

builder

@UnstableApi
static HttpResponseBuilder builder()

Returns a new HttpResponseBuilder.

whenComplete

CompletableFuture<Void> whenComplete()

Description copied from interface: Response

Returns a CompletableFuture which completes when 1) the response stream has been closed (the StreamMessage has been completed) or 2) the result value is set (the CompletionStage has completed.)

Specified by:

whenComplete in interface Response

Specified by:

whenComplete in interface StreamMessage<HttpObject>

aggregate

@UnstableApi
CompletableFuture<AggregatedHttpResponse> aggregate(AggregationOptions options)

Aggregates this response with the specified AggregationOptions. The returned CompletableFuture will be notified when the content and the trailers of the response are fully received.

 AggregationOptions options =
     AggregationOptions.builder()
                       .cacheResult(false)
                       .executor(...)
                       .build();
 HttpResponse request = ...;
 AggregatedHttpResponse aggregated = response.aggregate(options).join();
 

aggregate

default CompletableFuture<AggregatedHttpResponse> aggregate()

Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response are received fully.

The AggregatedHttpResponse is cached by default. So it is allowed to repeatedly call this method and get the cached value after the first aggregation.

 HttpResponse response = ...;
 AggregatedHttpResponse aggregated0 = response.aggregate().join();
 AggregatedHttpResponse aggregated1 = response.aggregate().join();
 assert aggregated0 == aggregated1;
 

aggregate

default CompletableFuture<AggregatedHttpResponse> aggregate(EventExecutor executor)

Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response are received fully.

The AggregatedHttpResponse is cached by default. So it is allowed to repeatedly call this method and get the cached value after the first aggregation.

 HttpResponse response = ...;
 AggregatedHttpResponse aggregated0 = response.aggregate(executor).join();
 AggregatedHttpResponse aggregated1 = response.aggregate(executor).join();
 assert aggregated0 == aggregated1;
 

aggregateWithPooledObjects

@Deprecated
@UnstableApi
default CompletableFuture<AggregatedHttpResponse> aggregateWithPooledObjects(ByteBufAllocator alloc)

Deprecated.

Use aggregate(AggregationOptions) with AggregationOptions.usePooledObjects(ByteBufAllocator).

(Advanced users only) Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response are received fully. AggregatedHttpObject.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().

The pooled AggregatedHttpResponse is not cached. So it is NOT allowed to access the AggregatedHttpResponse from this method after the first aggregation.

 HttpResponse response = ...;
 AggregatedHttpResponse aggregated = response.aggregateWithPooledObjects(alloc).join();
 // An `IllegalStateException` will be raised.
 response.aggregateWithPooledObjects(alloc).join();
 

See Also:

• PooledObjects

aggregateWithPooledObjects

@Deprecated
default CompletableFuture<AggregatedHttpResponse> aggregateWithPooledObjects(EventExecutor executor,
 ByteBufAllocator alloc)

Deprecated.

Use aggregate(AggregationOptions) with AggregationOptions.usePooledObjects(ByteBufAllocator).

Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response is received fully. AggregatedHttpObject.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().

The pooled AggregatedHttpResponse is not cached. So it is NOT allowed to access the AggregatedHttpResponse from this method after the first aggregation.

 HttpResponse response = ...;
 AggregatedHttpResponse aggregated = response.aggregateWithPooledObjects(executor, alloc).join();
 // An `IllegalStateException` will be raised.
 response.aggregateWithPooledObjects(executor, alloc).join();
 

toDuplicator

default HttpResponseDuplicator toDuplicator()

Description copied from interface: StreamMessage

Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements. Note that you cannot subscribe to this StreamMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface StreamMessage<HttpObject>

toDuplicator

default HttpResponseDuplicator toDuplicator(EventExecutor executor)

Description copied from interface: StreamMessage

Returns a new StreamMessageDuplicator that duplicates this StreamMessage into one or more StreamMessages, which publish the same elements. Note that you cannot subscribe to this StreamMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface StreamMessage<HttpObject>

Parameters:

executor - the executor to duplicate

toDuplicator

default HttpResponseDuplicator toDuplicator(long maxResponseLength)

Description copied from interface: HttpMessage

Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements. Note that you cannot subscribe to this HttpMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface HttpMessage

Parameters:

maxResponseLength - the maximum content length that the duplicator can hold in its buffer. ContentTooLargeException is raised if the length of the buffered HttpData is greater than this value.

toDuplicator

default HttpResponseDuplicator toDuplicator(EventExecutor executor,
 long maxResponseLength)

Description copied from interface: HttpMessage

Returns a new StreamMessageDuplicator that duplicates this HttpMessage into one or more HttpMessages, which publish the same elements. Note that you cannot subscribe to this HttpMessage anymore after you call this method. To subscribe, call StreamMessageDuplicator.duplicate() from the returned StreamMessageDuplicator.

Specified by:

toDuplicator in interface HttpMessage

Parameters:

executor - the executor to duplicate

maxResponseLength - the maximum content length that the duplicator can hold in its buffer. ContentTooLargeException is raised if the length of the buffered HttpData is greater than this value.

split

@CheckReturnValue
default SplitHttpResponse split()

Returns a new SplitHttpResponse which splits a stream of HttpObjects into HttpHeaders and HttpData. SplitHttpResponse.headers() will be completed before publishing the first HttpData. SplitHttpMessage.trailers() might not complete until the entire response body is consumed completely.

split

@CheckReturnValue
default SplitHttpResponse split(EventExecutor executor)

Returns a new SplitHttpResponse which splits a stream of HttpObjects into HttpHeaders and HttpData. SplitHttpResponse.headers() will be completed before publishing the first HttpData. SplitHttpMessage.trailers() might not complete until the entire response body is consumed completely.

mapInformational

default HttpResponse mapInformational(Function<? super ResponseHeaders,? extends ResponseHeaders> function)

Transforms the informational headers emitted by HttpResponse by applying the specified Function.

mapHeaders

default HttpResponse mapHeaders(Function<? super ResponseHeaders,? extends ResponseHeaders> function)

Transforms the non-informational ResponseHeaders emitted by HttpResponse by applying the specified Function.

For example:

 HttpResponse response = HttpResponse.of("OK");
 HttpResponse transformed = response.mapHeaders(headers -> {
     return headers.withMutations(builder -> {
         builder.set(HttpHeaderNames.USER_AGENT, "my-server");
     });
 });
 assert transformed.aggregate().join().headers()
                   .get(HttpHeaderNames.USER_AGENT).equals("my-server");
 

mapData

default HttpResponse mapData(Function<? super HttpData,? extends HttpData> function)

Transforms the HttpDatas emitted by this HttpResponse by applying the specified Function.

For example:

 HttpResponse response = HttpResponse.of("data1,data2");
 HttpResponse transformed = response.mapData(data -> {
     return HttpData.ofUtf8(data.toStringUtf8().replaceAll(",", "\n"));
 });
 assert transformed.aggregate().join().contentUtf8().equals("data1\ndata2");
 

Specified by:

mapData in interface HttpMessage

mapTrailers

default HttpResponse mapTrailers(Function<? super HttpHeaders,? extends HttpHeaders> function)

Transforms the trailers emitted by this HttpResponse by applying the specified Function.

For example:

 HttpResponse response = HttpResponse.of("data");
 HttpResponse transformed = response.mapTrailers(trailers -> {
     return trailers.withMutations(builder -> builder.add("trailer1", "foo"));
 });
 assert transformed.aggregate().join().trailers().get("trailer1").equals("foo");
 

Specified by:

mapTrailers in interface HttpMessage

mapError

default HttpResponse mapError(Function<? super Throwable,? extends Throwable> function)

Transforms an error emitted by this HttpResponse by applying the specified Function.

For example:

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Something went wrong."));
 HttpResponse transformed = response.mapError(cause -> {
     if (cause instanceof IllegalStateException) {
         return new MyDomainException(cause);
     } else {
         return cause;
     }
 });
 

Specified by:

mapError in interface StreamMessage<HttpObject>

peekHeaders

@UnstableApi
default HttpResponse peekHeaders(Consumer<? super ResponseHeaders> action)

Applies the specified Consumer to the non-informational ResponseHeaders emitted by this HttpResponse.

For example:

 HttpResponse response = HttpResponse.of(ResponseHeaders.of(HttpStatus.OK));
 HttpResponse peeked = response.peekHeaders(headers -> {
      assert headers.status() == HttpStatus.OK;
 });
 

peekData

@UnstableApi
default HttpResponse peekData(Consumer<? super HttpData> action)

Applies the specified Consumer to the HttpDatas emitted by this HttpResponse.

For example:

 HttpResponse response = HttpResponse.of("data1,data2");
 HttpResponse peeked = response.peekData(data -> {
     assert data.toStringUtf8().equals("data1,data2");
 });
 

Specified by:

peekData in interface HttpMessage

peekTrailers

@UnstableApi
default HttpResponse peekTrailers(Consumer<? super HttpHeaders> action)

Applies the specified Consumer to the trailers emitted by this HttpResponse.

For example:

 HttpResponse response = HttpResponse.of(ResponseHeaders.of(HttpStatus.OK),
                                         HttpData.ofUtf8("..."),
                                         HttpHeaders.of("trailer", "foo"));
 HttpResponse peeked = response.peekTrailers(trailers -> {
     assert trailers.get("trailer").equals("foo");
 });
 

Specified by:

peekTrailers in interface HttpMessage

peekError

@UnstableApi
default HttpResponse peekError(Consumer<? super Throwable> action)

Applies the specified Consumer to an error emitted by this HttpResponse.

For example:

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Something went wrong."));
 HttpResponse peeked = response.peekError(cause -> {
     assert cause instanceof IllegalStateException;
 });
 

Specified by:

peekError in interface StreamMessage<HttpObject>

recover

default HttpResponse recover(Function<? super Throwable,? extends HttpResponse> function)

Recovers a failed HttpResponse by switching to a returned fallback HttpResponse when any error occurs before a ResponseHeaders is written. Note that the failed HttpResponse cannot be recovered from an error if a ResponseHeaders was written already.

Example:

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Oops..."));
 // The failed HttpResponse will be recovered by the fallback function.
 HttpResponse recovered = response.recover(cause -> HttpResponse.of("Fallback"));
 assert recovered.aggregate().join().contentUtf8().equals("Fallback");

 // As HTTP headers and body were written already before an error occurred,
 // the fallback function could not be applied for the failed HttpResponse.
 HttpResponseWriter response = HttpResponse.streaming();
 response.write(ResponseHeaders.of(HttpStatus.OK));
 response.write(HttpData.ofUtf8("Hello"));
 response.close(new IllegalStateException("Oops..."));
 HttpResponse notRecovered = response.recover(cause -> HttpResponse.of("Fallback"));
 // The IllegalStateException will be raised even though a fallback function was added.
 notRecovered.aggregate().join();
 

recover

@UnstableApi
default <T extends Throwable> HttpResponse recover(Class<T> causeClass,
 Function<? super T,? extends HttpResponse> function)

Recovers a failed HttpResponse by switching to a returned fallback HttpResponse when the thrown Throwable is the same type or a subtype of the specified causeClass.

Example:

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Oops..."));
 // The failed HttpResponse will be recovered by the fallback function.
 HttpResponse recovered =
     response.recover(IllegalStateException.class, cause -> HttpResponse.of("Fallback"));
 assert recovered.aggregate().join().contentUtf8().equals("Fallback");

 // As HTTP headers and body were written already before an error occurred,
 // the fallback function could not be applied for the failed HttpResponse.
 HttpResponseWriter response = HttpResponse.streaming();
 response.write(ResponseHeaders.of(HttpStatus.OK));
 response.write(HttpData.ofUtf8("Hello"));
 response.close(new IllegalStateException("Oops..."));
 HttpResponse notRecovered =
     response.recover(IllegalStateException.class, cause -> HttpResponse.of("Fallback"));
 // The IllegalStateException will be raised even though a fallback function was added.
 notRecovered.aggregate().join();

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Oops..."));
 // Use the shortcut recover method as a chain.
 HttpResponse recoverChain =
     response.recover(RuntimeException.class, cause -> {
         final IllegalArgumentException ex = new IllegalArgumentException("Oops2...");
         // If a failed response is returned from the first chain
         return HttpResponse.ofFailure(ex);
     })
     // If the shortcut exception type is correct, catch and recover in the second chain.
     .recover(IllegalArgumentException.class, cause -> HttpResponse.of("fallback"));
 recoverChain.aggregate().join();

 HttpResponse response = HttpResponse.ofFailure(new IllegalStateException("Oops..."));
 // If the exception type does not match
 HttpResponse mismatchRecovered =
     response.recover(IllegalArgumentException.class, cause -> HttpResponse.of("Fallback"));
 // In this case, CompletionException is thrown. (can't recover exception)
 mismatchRecovered.aggregate().join();
 

subscribeOn

default HttpResponse subscribeOn(EventExecutor eventExecutor)

Description copied from interface: StreamMessage

Calls StreamMessage.subscribe(Subscriber, EventExecutor) to the upstream StreamMessage using the specified EventExecutor and relays the stream transparently downstream. This may be useful if one would like to hide an EventExecutor from an upstream Publisher.

For example:

 Subscriber<Integer> mySubscriber = null;
 StreamMessage<Integer> upstream = ...; // publisher callbacks are invoked by eventLoop1
 upstream.subscribeOn(eventLoop1)
         .subscribe(mySubscriber, eventLoop2); // mySubscriber callbacks are invoked with eventLoop2
 

Specified by:

subscribeOn in interface StreamMessage<HttpObject>