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

Returns:

WebSocket.Builder

Throws:

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