Класс HttpClient

protected HttpClient()

public static HttpClient newHttpClient()

Примечание по реализации:

Системные значения по умолчанию извлекаются в момент создания экземпляра HttpClient. Изменение системных значений после создания экземпляра HttpClient, например путем вызова ProxySelector.setDefault(ProxySelector) или SSLContext.setDefault(SSLContext), не влияет на уже созданные экземпляры.

Возвращает:

новый HttpClient

Исключения:

UncheckedIOException — если невозможно выделить необходимые базовые ресурсы ввода-вывода для создания нового HttpClient.

public static HttpClient.Builder newBuilder()

Возвращает:

HttpClient.Builder

public abstract Optional<CookieHandler> cookieHandler()

Возвращает:

Optional, содержащий CookieHandler этого клиента

public abstract Optional<Duration> connectTimeout()

Возвращает:

Optional, содержащий длительность ожидания подключения для этого клиента

public abstract HttpClient.Redirect followRedirects()

Возвращает:

настройку перенаправления для этого клиента

public abstract Optional<ProxySelector> proxy()

Возвращает:

Optional, содержащий селектор прокси, переданный этому клиенту.

public abstract SSLContext sslContext()

Возвращает:

SSLContext этого клиента

public abstract SSLParameters sslParameters()

Возвращает:

SSLParameters этого клиента

public abstract Optional<Authenticator> authenticator()

Возвращает:

Optional, содержащий Authenticator этого клиента

public abstract HttpClient.Version version()

Примечание по реализации:

На версию протокола, которую HttpClient в конечном итоге выбирает для запроса, влияют различные факторы, указанные в разделе Выбор версии протокола.

Возвращает:

запрошенную версию протокола HTTP

public abstract Optional<Executor> executor()

Возвращает:

Optional, содержащий Executor этого клиента

public abstract <T> HttpResponse<T> send(HttpRequest request, HttpResponse.BodyHandler<T> responseBodyHandler) throws IOException, InterruptedException

Параметры типа:

T — тип тела ответа

Параметры:

request — запрос

responseBodyHandler — обработчик тела ответа

Возвращает:

ответ

Исключения:

IOException — если при отправке или получении произошла ошибка ввода-вывода либо клиент был закрыт

InterruptedException — если выполнение операции прервано

IllegalArgumentException — если аргумент request не является запросом, который можно было бы корректно создать согласно спецификации HttpRequest.Builder.

public abstract <T> CompletableFuture<HttpResponse<T>> sendAsync(HttpRequest request, HttpResponse.BodyHandler<T> responseBodyHandler)

Параметры типа:

T — тип тела ответа

Параметры:

request — запрос

responseBodyHandler — обработчик тела ответа

Возвращает:

CompletableFuture<HttpResponse<T>>

Исключения:

IllegalArgumentException — если аргумент request не является запросом, который можно было бы корректно создать согласно спецификации HttpRequest.Builder.

public abstract <T> CompletableFuture<HttpResponse<T>> sendAsync(HttpRequest request, HttpResponse.BodyHandler<T> responseBodyHandler, HttpResponse.PushPromiseHandler<T> pushPromiseHandler)

Параметры типа:

T — тип тела ответа

Параметры:

request — запрос

responseBodyHandler — обработчик тела ответа

pushPromiseHandler — обработчик обещаний push; может иметь значение null

Возвращает:

CompletableFuture<HttpResponse<T>>

Исключения:

IllegalArgumentException — если аргумент request не является запросом, который можно было бы корректно создать согласно спецификации HttpRequest.Builder.

public WebSocket.Builder newWebSocketBuilder()

HttpClient client = HttpClient.newHttpClient();
CompletableFuture<WebSocket> ws = client.newWebSocketBuilder()
   .buildAsync(URI.create("ws://websocket.example.com"), listener);

InetSocketAddress addr = new InetSocketAddress("proxy.example.com", 80);
HttpClient client = HttpClient.newBuilder()
        .proxy(ProxySelector.of(addr))
        .build();

CompletableFuture<WebSocket> ws = client.newWebSocketBuilder()
        .buildAsync(URI.create("ws://websocket.example.com"), listener);

Требования к реализации:

Реализация этого метода по умолчанию выбрасывает UnsupportedOperationException. Клиенты, полученные с помощью newHttpClient() или newBuilder(), возвращают конструктор WebSocket.

Примечание по реализации:

И конструктор, и созданные с его помощью WebSocket работают неблокирующим образом. То есть их методы не блокируют выполнение перед возвратом CompletableFuture. Асинхронные задачи выполняются в исполнителе этого HttpClient.

Когда завершается CompletionStage, возвращенный из Listener.onClose, WebSocket отправляет сообщение Close с тем же кодом, что и у полученного сообщения, и пустой причиной.

Возвращает:

WebSocket.Builder

Исключения:

UnsupportedOperationException — если этот HttpClient не поддерживает WebSocket

public void shutdown()

Требования к реализации:

Реализация этого метода по умолчанию ничего не делает. Подклассам следует переопределить этот метод, чтобы реализовать соответствующее поведение.

Начиная с:

21

См. также:

• Примечание по реализации: закрытие HttpClient

public boolean awaitTermination(Duration duration) throws InterruptedException

Требования к реализации:

Реализация этого метода по умолчанию проверяет аргументы на null, но в остальном ничего не делает и возвращает true. Подклассам следует переопределить этот метод, чтобы реализовать требуемое поведение.

Параметры:

duration — максимальное время ожидания

Возвращает:

true, если работа этого клиента завершена, и false, если время ожидания истекло до завершения работы

Исключения:

InterruptedException — если во время ожидания произошло прерывание

Начиная с:

21

См. также:

• Примечание по реализации: закрытие HttpClient

public boolean isTerminated()

Требования к реализации:

Реализация этого метода по умолчанию ничего не делает и возвращает false. Подклассам следует переопределить этот метод, чтобы реализовать требуемое поведение.

Возвращает:

true, если после завершения работы все задачи выполнены

Начиная с:

21

См. также:

• Примечание по реализации: закрытие HttpClient

public void shutdownNow()

Требования к реализации:

Реализация этого метода по умолчанию просто вызывает shutdown(). Подклассам следует переопределить этот метод, чтобы реализовать соответствующее поведение.

Начиная с:

21

См. также:

• Примечание по реализации: закрытие HttpClient

public void close()

Определено в:

close в интерфейсе AutoCloseable

Требования к реализации:

Реализация этого метода по умолчанию вызывает shutdown() и ожидает завершения выполнения задач с помощью awaitTermination.

Начиная с:

21

См. также:

• Примечание по реализации: закрытие HttpClient