com.linecorp.armeria.common.HttpRequest Maven / Gradle / Ivy
/*
* Copyright 2016 LINE Corporation
*
* LINE Corporation licenses this file to you under the Apache License,
* version 2.0 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at:
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*/
package com.linecorp.armeria.common;
import static com.linecorp.armeria.common.HttpHeaderNames.CONTENT_LENGTH;
import static java.util.Objects.requireNonNull;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Formatter;
import java.util.Locale;
import java.util.concurrent.CompletableFuture;
import org.reactivestreams.Publisher;
import org.reactivestreams.Subscriber;
import com.linecorp.armeria.common.FixedHttpRequest.EmptyFixedHttpRequest;
import com.linecorp.armeria.common.FixedHttpRequest.OneElementFixedHttpRequest;
import com.linecorp.armeria.common.FixedHttpRequest.RegularFixedHttpRequest;
import com.linecorp.armeria.common.FixedHttpRequest.TwoElementFixedHttpRequest;
import com.linecorp.armeria.common.stream.StreamMessage;
import io.netty.buffer.ByteBufAllocator;
import io.netty.util.concurrent.EventExecutor;
/**
* A streamed HTTP/2 {@link Request}.
*
* Note: The initial {@link HttpHeaders} is not signaled to {@link Subscriber}s. It is readily available
* via {@link #headers()}.
*/
public interface HttpRequest extends Request, StreamMessage {
// Note: Ensure we provide the same set of `of()` methods with the `of()` methods of
// AggregatedHttpMessage for consistency.
/**
* Creates a new HTTP request that can be used to stream an arbitrary number of {@link HttpObject}
* with the initial {@link HttpHeaders} of the specified {@link HttpMethod} and {@code path}.
*/
static HttpRequestWriter streaming(HttpMethod method, String path) {
requireNonNull(method, "method");
requireNonNull(path, "path");
return streaming(HttpHeaders.of(method, path));
}
/**
* Creates a new HTTP request that can be used to stream an arbitrary number of {@link HttpObject}
* with the specified initial {@link HttpHeaders}.
*/
static HttpRequestWriter streaming(HttpHeaders headers) {
requireNonNull(headers, "headers");
return new DefaultHttpRequest(headers);
}
/**
* Creates a new HTTP request with empty content and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
*/
static HttpRequest of(HttpMethod method, String path) {
requireNonNull(method, "method");
requireNonNull(path, "path");
return of(HttpHeaders.of(method, path));
}
/**
* Creates a new HTTP request and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param content the content of the request
*/
static HttpRequest of(HttpMethod method, String path, MediaType mediaType, String content) {
requireNonNull(content, "content");
requireNonNull(mediaType, "mediaType");
return of(method, path,
mediaType, content.getBytes(mediaType.charset().orElse(StandardCharsets.UTF_8)));
}
/**
* Creates a new HTTP request and closes the stream. The content of the request is formatted by
* {@link String#format(Locale, String, Object...)} with {@linkplain Locale#ENGLISH English locale}.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param format {@linkplain Formatter the format string} of the request content
* @param args the arguments referenced by the format specifiers in the format string
*/
static HttpRequest of(HttpMethod method, String path, MediaType mediaType, String format, Object... args) {
requireNonNull(method, "method");
requireNonNull(path, "path");
return of(method,
path,
mediaType,
String.format(Locale.ENGLISH, format, args).getBytes(
mediaType.charset().orElse(StandardCharsets.UTF_8)));
}
/**
* Creates a new HTTP request and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param content the content of the request
*/
static HttpRequest of(HttpMethod method, String path, MediaType mediaType, byte[] content) {
requireNonNull(content, "content");
return of(method, path, mediaType, HttpData.of(content));
}
/**
* Creates a new HTTP request and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param content the content of the request
* @param offset the start offset of {@code content}
* @param length the length of {@code content}
*/
static HttpRequest of(
HttpMethod method, String path, MediaType mediaType, byte[] content, int offset, int length) {
requireNonNull(content, "content");
return of(method, path, mediaType, HttpData.of(content, offset, length));
}
/**
* Creates a new HTTP request and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param content the content of the request
*/
static HttpRequest of(HttpMethod method, String path, MediaType mediaType, HttpData content) {
return of(method, path, mediaType, content, HttpHeaders.EMPTY_HEADERS);
}
/**
* Creates a new HTTP request and closes the stream.
*
* @param method the HTTP method of the request
* @param path the path of the request
* @param mediaType the {@link MediaType} of the request content
* @param content the content of the request
* @param trailingHeaders the trailing HTTP headers
*/
static HttpRequest of(HttpMethod method, String path, MediaType mediaType, HttpData content,
HttpHeaders trailingHeaders) {
requireNonNull(method, "method");
requireNonNull(path, "path");
requireNonNull(mediaType, "mediaType");
return of(HttpHeaders.of(method, path).contentType(mediaType), content, trailingHeaders);
}
/**
* Creates a new {@link HttpRequest} with empty content and closes the stream.
*/
static HttpRequest of(HttpHeaders headers) {
return of(headers, HttpData.EMPTY_DATA);
}
/**
* Creates a new {@link HttpRequest} and closes the stream.
*/
static HttpRequest of(HttpHeaders headers, HttpData content) {
return of(headers, content, HttpHeaders.EMPTY_HEADERS);
}
/**
* Creates a new {@link HttpRequest} and closes the stream.
*
* @throws IllegalStateException if the headers are malformed.
*/
static HttpRequest of(HttpHeaders headers, HttpData content, HttpHeaders trailingHeaders) {
requireNonNull(headers, "headers");
requireNonNull(content, "content");
requireNonNull(trailingHeaders, "trailingHeaders");
// From the section 8.1.2.3 of RFC 7540:
//// All HTTP/2 requests MUST include exactly one valid value for the :method, :scheme, and :path
//// pseudo-header fields, unless it is a CONNECT request (Section 8.3)
// NB: ':scheme' will be filled when a request is written.
if (headers.method() == null) {
throw new IllegalStateException("not a request (missing :method)");
}
if (headers.path() == null) {
throw new IllegalStateException("not a request (missing :path)");
}
if (content.isEmpty()) {
headers.remove(CONTENT_LENGTH);
} else {
headers.setInt(CONTENT_LENGTH, content.length());
}
if (!content.isEmpty()) {
if (trailingHeaders.isEmpty()) {
return new OneElementFixedHttpRequest(headers, content);
} else {
return new TwoElementFixedHttpRequest(headers, content, trailingHeaders);
}
} else if (!trailingHeaders.isEmpty()) {
return new OneElementFixedHttpRequest(headers, trailingHeaders);
} else {
return new EmptyFixedHttpRequest(headers);
}
}
/**
* Creates a new {@link HttpRequest} that publishes the given {@link HttpObject}s and closes the stream.
* {@code objs} must not contain {@link HttpHeaders}.
*/
static HttpRequest of(HttpHeaders headers, HttpObject... objs) {
if (Arrays.stream(objs).anyMatch(obj -> obj instanceof HttpHeaders)) {
throw new IllegalArgumentException("objs contains HttpHeaders, which is not allowed.");
}
switch (objs.length) {
case 0:
return new EmptyFixedHttpRequest(headers);
case 1:
return new OneElementFixedHttpRequest(headers, objs[0]);
case 2:
return new TwoElementFixedHttpRequest(headers, objs[0], objs[1]);
default:
for (int i = 0; i < objs.length; i++) {
if (objs[i] == null) {
throw new NullPointerException("objs[" + i + "] is null");
}
}
return new RegularFixedHttpRequest(headers, objs);
}
}
/**
* Converts the {@link AggregatedHttpMessage} into a new {@link HttpRequest} and closes the stream.
*/
static HttpRequest of(AggregatedHttpMessage message) {
return of(message.headers(), message.content(), message.trailingHeaders());
}
/**
* Creates a new instance from an existing {@link HttpHeaders} and {@link Publisher}.
*/
static HttpRequest of(HttpHeaders headers, Publisher publisher) {
requireNonNull(publisher, "publisher");
return new PublisherBasedHttpRequest(headers, publisher);
}
/**
* Returns the initial HTTP/2 headers of this request.
*/
HttpHeaders headers();
/**
* Returns the scheme of this request. This method is a shortcut of {@code headers().scheme()}.
*/
default String scheme() {
return headers().scheme();
}
/**
* Sets the scheme of this request. This method is a shortcut of {@code headers().scheme(...)}.
*
* @return {@code this}
*/
default HttpRequest scheme(String scheme) {
headers().scheme(scheme);
return this;
}
/**
* Returns the method of this request. This method is a shortcut of {@code headers().method()}.
*/
default HttpMethod method() {
return headers().method();
}
/**
* Sets the method of this request. This method is a shortcut of {@code headers().method(...)}.
*
* @return {@code this}
*/
default HttpRequest method(HttpMethod method) {
headers().method(method);
return this;
}
/**
* Returns the path of this request. This method is a shortcut of {@code headers().path()}.
*/
default String path() {
return headers().path();
}
/**
* Sets the path of this request. This method is a shortcut of {@code headers().path(...)}.
*
* @return {@code this}
*/
default HttpRequest path(String path) {
headers().path(path);
return this;
}
/**
* Returns the authority of this request. This method is a shortcut of {@code headers().authority()}.
*/
default String authority() {
return headers().authority();
}
/**
* Sets the authority of this request. This method is a shortcut of {@code headers().authority(...)}.
*
* @return {@code this}
*/
default HttpRequest authority(String authority) {
headers().authority(authority);
return this;
}
/**
* Aggregates this request. The returned {@link CompletableFuture} will be notified when the content and
* the trailing headers of the request is received fully.
*/
default CompletableFuture aggregate() {
final CompletableFuture future = new CompletableFuture<>();
final HttpRequestAggregator aggregator = new HttpRequestAggregator(this, future, null);
completionFuture().whenComplete(aggregator);
subscribe(aggregator);
return future;
}
/**
* Aggregates this request. The returned {@link CompletableFuture} will be notified when the content and
* the trailing headers of the request is received fully.
*/
default CompletableFuture aggregate(EventExecutor executor) {
requireNonNull(executor, "executor");
final CompletableFuture future = new CompletableFuture<>();
final HttpRequestAggregator aggregator = new HttpRequestAggregator(this, future, null);
completionFuture().whenCompleteAsync(aggregator, executor);
subscribe(aggregator, executor);
return future;
}
/**
* Aggregates this request. The returned {@link CompletableFuture} will be notified when the content and
* the trailing headers of the request is received fully. {@link AggregatedHttpMessage#content()} will
* return a pooled object, and the caller must ensure to release it. If you don't know what this means,
* use {@link HttpResponse#aggregate()}.
*/
default CompletableFuture aggregateWithPooledObjects(ByteBufAllocator alloc) {
requireNonNull(alloc, "alloc");
final CompletableFuture future = new CompletableFuture<>();
final HttpRequestAggregator aggregator = new HttpRequestAggregator(this, future, alloc);
completionFuture().whenComplete(aggregator);
subscribe(aggregator, true);
return future;
}
/**
* Aggregates this request. The returned {@link CompletableFuture} will be notified when the content and
* the trailing headers of the request is received fully. {@link AggregatedHttpMessage#content()} will
* return a pooled object, and the caller must ensure to release it. If you don't know what this means,
* use {@link HttpResponse#aggregate()}.
*/
default CompletableFuture aggregateWithPooledObjects(
EventExecutor executor, ByteBufAllocator alloc) {
requireNonNull(executor, "executor");
requireNonNull(alloc, "alloc");
final CompletableFuture future = new CompletableFuture<>();
final HttpRequestAggregator aggregator = new HttpRequestAggregator(this, future, alloc);
completionFuture().whenCompleteAsync(aggregator, executor);
subscribe(aggregator, executor, true);
return future;
}
}