Класс 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, содержащий обработчик файлов cookie этого клиента

public abstract Optional<Duration> connectTimeout()

Возвращает:

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

public abstract HttpClient.Redirect followRedirects()

Возвращает:

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

public abstract Optional<ProxySelector> proxy()

Возвращает:

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

public abstract SSLContext sslContext()

Возвращает:

контекст SSL этого клиента

public abstract SSLParameters sslParameters()

Возвращает:

параметры SSL этого клиента

public abstract Optional<Authenticator> authenticator()

Возвращает:

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

public abstract HttpClient.Version version()

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

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

Возвращает:

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

public abstract Optional<Executor> executor()

Возвращает:

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

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)

Type Parameters:

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

Parameters:

request - запрос

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

pushPromiseHandler - обработчик обещаний, может быть null

Returns:

CompletableFuture<HttpResponse<T>>

Throws:

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);

Implementation Requirements:

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

Implementation Note:

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

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

Returns:

WebSocket.Builder

Throws:

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

public void shutdown()

Implementation Requirements:

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

Since:

21

See Also:

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

public boolean awaitTermination(Duration duration) throws InterruptedException

Implementation Requirements:

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

Parameters:

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

Returns:

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

Throws:

InterruptedException - если прервано во время ожидания

Since:

21

See Also:

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

public boolean isTerminated()

Implementation Requirements:

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

Returns:

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

Since:

21

See Also:

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

public void shutdownNow()

Implementation Requirements:

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

Since:

21

See Also:

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

public void close()

Specified by:

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

Implementation Requirements:

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

Since:

21

See Also:

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