Класс HttpClient

HttpClient

protected HttpClient()

newHttpClient

public static HttpClient newHttpClient()

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

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

Возвращает:

новый HttpClient

Исключение:

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

newBuilder

public static HttpClient.Builder newBuilder()

Возвращает:

HttpClient.Builder

cookieHandler

public abstract Optional<CookieHandler> cookieHandler()

Возвращает:

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

connectTimeout

public abstract Optional<Duration> connectTimeout()

Возвращает:

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

followRedirects

public abstract HttpClient.Redirect followRedirects()

Возвращает:

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

proxy

public abstract Optional<ProxySelector> proxy()

Возвращает:

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

sslContext

public abstract SSLContext sslContext()

Возвращает:

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

sslParameters

public abstract SSLParameters sslParameters()

Возвращает:

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

authenticator

public abstract Optional<Authenticator> authenticator()

Возвращает:

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

version

public abstract HttpClient.Version version()

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

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

Возвращает:

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

executor

public abstract Optional<Executor> executor()

Возвращает:

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

send

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

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

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

Параметры:

request - запрос

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

Возвращает:

ответ

Исключение:

IOException - если происходит ошибка ввода-вывода при отправке или приёме, или клиент закрыт

InterruptedException - если операция прервана

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

SecurityException - Если установлен менеджер безопасности и он отказывается от access для URL в заданном запросе или прокси, если он настроен. См. проверки безопасности для получения дополнительной информации.

sendAsync

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

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

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

Параметры:

request - запрос

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

Возвращает:

CompletableFuture<HttpResponse<T>>

Исключение:

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

sendAsync

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

Type Parameters:

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

Parameters:

request - запрос

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

pushPromiseHandler - обработчик запросов к push-обязательствам, может быть null

Returns:

выполнимое будущее

Throws:

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

newWebSocketBuilder

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 отправит сообщение Закрыть, которое имеет тот же код, что и полученное сообщение, и пустое описание причины.

Returns:

билдер WebSocket.Builder

Throws:

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

shutdown

public void shutdown()

Implementation Requirements:

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

Since:

21

See Also:

• Implementation Note on closing the HttpClient

awaitTermination

public boolean awaitTermination(Duration duration) throws InterruptedException

Implementation Requirements:

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

Parameters:

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

Returns:

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

Throws:

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

Since:

21

See Also:

• Implementation Note on closing the HttpClient

isTerminated

public boolean isTerminated()

Implementation Requirements:

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

Returns:

true если все задачи завершились после запроса на остановку

Since:

21

See Also:

• Implementation Note on closing the HttpClient

shutdownNow

public void shutdownNow()

Implementation Requirements:

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

Since:

21

See Also:

• Implementation Note on closing the HttpClient

close

public void close()

Specified by:

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

Implementation Requirements:

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

Since:

21

See Also:

• Implementation Note on closing the HttpClient