Класс 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()

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

На выбор версии протокола также могут влиять ограничения. Например, если через прокси запрошен HTTP/2, а реализация не поддерживает этот режим, может использоваться HTTP/1.1

Возвращает:

запрошенную версию протокола 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