HttpResponse (filter-service-metrics 1.13 1.13 API)

All Superinterfaces:

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

All Known Subinterfaces:

HttpResponseWriter

All Known Implementing Classes:

DefaultHttpResponse, DeferredHttpResponse, FilteredHttpResponse
```
public interface HttpResponse
extends Response, StreamMessage<HttpObject>
```
A streamed HTTP/2 Response.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default CompletableFuture<AggregatedHttpResponse>`	`aggregate()` Aggregates this response.
`default CompletableFuture<AggregatedHttpResponse>`	`aggregate(io.netty.util.concurrent.EventExecutor executor)` Aggregates this response.
`default CompletableFuture<AggregatedHttpResponse>`	`aggregateWithPooledObjects(io.netty.buffer.ByteBufAllocator alloc)` Aggregates this response.
`default CompletableFuture<AggregatedHttpResponse>`	`aggregateWithPooledObjects(io.netty.util.concurrent.EventExecutor executor, io.netty.buffer.ByteBufAllocator alloc)` Aggregates this response.
`default CompletableFuture<Void>`	`closeFuture()` Deprecated.
`default CompletableFuture<Void>`	`completionFuture()` Deprecated.
`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`	`from(CompletionStage<? extends HttpResponse> stage)` Creates a new HTTP response that delegates to the `HttpResponse` produced by the specified `CompletionStage`.
`static HttpResponse`	`from(CompletionStage<? extends HttpResponse> stage, io.netty.util.concurrent.EventExecutor subscriberExecutor)` Creates a new HTTP response that delegates to the `HttpResponse` produced by the specified `CompletionStage`.
`static HttpResponse`	`of(AggregatedHttpResponse res)` Deprecated. Use `AggregatedHttpResponse.toHttpResponse()`.
`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, CharSequence 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, 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(int statusCode)` Creates a new HTTP response of the specified `statusCode`.
`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(org.reactivestreams.Publisher<? extends HttpObject> publisher)` Creates a new HTTP response whose stream is produced from an existing `Publisher`.
`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(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`	`ofFailed(Throwable cause)` Deprecated. Use `ofFailure(Throwable)`.
`static HttpResponse`	`ofFailure(Throwable cause)` Creates a new failed HTTP response.
`static HttpResponseWriter`	`streaming()` Creates a new HTTP response that can stream an arbitrary number of `HttpObject` to the client.
`default HttpResponseDuplicator`	`toDuplicator()` Returns a new `HttpResponseDuplicator` that duplicates this `HttpResponse` into one or more `HttpResponse`s, which publish the same elements.
`default HttpResponseDuplicator`	`toDuplicator(io.netty.util.concurrent.EventExecutor executor)` Returns a new `HttpResponseDuplicator` that duplicates this `HttpResponse` into one or more `HttpResponse`s, which publish the same elements.
`default HttpResponseDuplicator`	`toDuplicator(io.netty.util.concurrent.EventExecutor executor, long maxResponseLength)` Returns a new `HttpResponseDuplicator` that duplicates this `HttpResponse` into one or more `HttpResponse`s, which publish the same elements.
`default HttpResponseDuplicator`	`toDuplicator(long maxResponseLength)` Returns a new `HttpResponseDuplicator` that duplicates this `HttpResponse` into one or more `HttpResponse`s, 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.stream.StreamMessage
abort, abort, defaultSubscriberExecutor, drainAll, drainAll, drainAll, drainAll, isComplete, isEmpty, isOpen, of, subscribe, subscribe, subscribe, subscribe

- Method Detail
  - 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
```
static HttpResponse from(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
  - from
```
static HttpResponse from(CompletionStage<? extends HttpResponse> stage,
                         io.netty.util.concurrent.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...).
  - 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.
  - of
```
static HttpResponse of(int statusCode)
```
    Creates a new HTTP response of the specified statusCode.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
    
    Throws:
    
    IllegalArgumentException - if the HttpStatusClass is informational (1xx).
  - of
```
static HttpResponse of(HttpStatus status)
```
    Creates a new HTTP response of the specified HttpStatus.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
    
    Throws:
    
    IllegalArgumentException - if the HttpStatusClass is informational (1xx).
  - 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
  - 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
  - of
```
static HttpResponse of(String content)
```
    Creates a new HTTP response of OK status with the content as UTF_8.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
    
    Parameters:
    
    content - the content of the response
  - of
```
static HttpResponse of(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.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
    
    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.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
    
    Parameters:
    
    mediaType - the MediaType of the response content
    
    content - the content of the response
  - of
```
static HttpResponse of(MediaType mediaType,
                       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
```
static HttpResponse of(HttpStatus status,
                       MediaType mediaType,
                       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
  - 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
  - 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
  - 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
  - of
```
static HttpResponse of(ResponseHeaders headers)
```
    Creates a new HTTP response of the specified headers.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
  - of
```
static HttpResponse of(ResponseHeaders headers,
                       HttpData content)
```
    Creates a new HTTP response of the specified headers and content.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
  - of
```
static HttpResponse of(ResponseHeaders headers,
                       HttpData content,
                       HttpHeaders trailers)
```
    Creates a new HTTP response of the specified objects.
  - of
```
static HttpResponse of(HttpObject... objs)
```
    Creates a new HTTP response of the specified objects.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
  - of
```
@Deprecated
static HttpResponse of(AggregatedHttpResponse res)
```
    Deprecated. Use AggregatedHttpResponse.toHttpResponse().
    
    Converts the AggregatedHttpResponse into a new complete HttpResponse.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
  - of
```
static HttpResponse of(org.reactivestreams.Publisher<? extends HttpObject> publisher)
```
    Creates a new HTTP response whose stream is produced from an existing Publisher.
    
    Specified by:
    
    of in interface StreamMessage<HttpObject>
  - ofFailure
```
static HttpResponse ofFailure(Throwable cause)
```
    Creates a new failed HTTP response.
  - ofFailed
```
@Deprecated
static HttpResponse ofFailed(Throwable cause)
```
    Deprecated. Use ofFailure(Throwable).
    
    Creates a new failed HTTP response.
  - closeFuture
```
@Deprecated
default CompletableFuture<Void> closeFuture()
```
    Deprecated.
    
    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:
    
    closeFuture in interface Response
    
    Specified by:
    
    closeFuture in interface StreamMessage<HttpObject>
  - completionFuture
```
@Deprecated
default CompletableFuture<Void> completionFuture()
```
    Deprecated.
    
    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:
    
    completionFuture in interface Response
    
    Specified by:
    
    completionFuture in interface StreamMessage<HttpObject>
  - 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
```
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.
  - aggregate
```
default CompletableFuture<AggregatedHttpResponse> aggregate(io.netty.util.concurrent.EventExecutor executor)
```
    Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response are received fully.
  - aggregateWithPooledObjects
```
default CompletableFuture<AggregatedHttpResponse> aggregateWithPooledObjects(io.netty.buffer.ByteBufAllocator alloc)
```
    Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the response are received fully. AggregatedHttpMessage.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().
  - aggregateWithPooledObjects
```
default CompletableFuture<AggregatedHttpResponse> aggregateWithPooledObjects(io.netty.util.concurrent.EventExecutor executor,
                                                                             io.netty.buffer.ByteBufAllocator alloc)
```
    Aggregates this response. The returned CompletableFuture will be notified when the content and the trailers of the request is received fully. AggregatedHttpMessage.content() will return a pooled object, and the caller must ensure to release it. If you don't know what this means, use aggregate().
  - toDuplicator
```
default HttpResponseDuplicator toDuplicator()
```
    Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements. Note that you cannot subscribe to this HttpResponse anymore after you call this method. To subscribe, call HttpResponseDuplicator.duplicate() from the returned HttpResponseDuplicator.
    
    Specified by:
    
    toDuplicator in interface StreamMessage<HttpObject>
  - toDuplicator
```
default HttpResponseDuplicator toDuplicator(io.netty.util.concurrent.EventExecutor executor)
```
    Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements. Note that you cannot subscribe to this HttpResponse anymore after you call this method. To subscribe, call HttpResponseDuplicator.duplicate() from the returned HttpResponseDuplicator.
    
    Specified by:
    
    toDuplicator in interface StreamMessage<HttpObject>
    
    Parameters:
    
    executor - the executor to duplicate
  - toDuplicator
```
default HttpResponseDuplicator toDuplicator(long maxResponseLength)
```
    Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements. Note that you cannot subscribe to this HttpResponse anymore after you call this method. To subscribe, call HttpResponseDuplicator.duplicate() from the returned HttpResponseDuplicator.
    
    Parameters:
    
    maxResponseLength - the maximum response 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(io.netty.util.concurrent.EventExecutor executor,
                                            long maxResponseLength)
```
    Returns a new HttpResponseDuplicator that duplicates this HttpResponse into one or more HttpResponses, which publish the same elements. Note that you cannot subscribe to this HttpResponse anymore after you call this method. To subscribe, call HttpResponseDuplicator.duplicate() from the returned HttpResponseDuplicator.
    
    Parameters:
    
    executor - the executor to duplicate
    
    maxResponseLength - the maximum response length that the duplicator can hold in its buffer. ContentTooLargeException is raised if the length of the buffered HttpData is greater than this value.

Interface HttpResponse

Method Summary

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

Method Detail

streaming

from

from

delayed

delayed

delayed

delayed

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

of

ofFailure

ofFailed

closeFuture

completionFuture

whenComplete

aggregate

aggregate

aggregateWithPooledObjects

aggregateWithPooledObjects

toDuplicator

toDuplicator

toDuplicator

toDuplicator