Интерфейс HttpClient.Builder

static final ProxySelector NO_PROXY

HttpClient.Builder cookieHandler(CookieHandler cookieHandler)

Параметры:

cookieHandler — обработчик файлов cookie

Возвращает:

этот построитель

HttpClient.Builder connectTimeout(Duration duration)

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

Время ожидания подключения применяется ко всей фазе подключения — от момента запроса на подключение до его установления. Реализациям рекомендуется учитывать в этом времени ожидания TLS-рукопожатия.

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

Встроенная реализация JDK учитывает в ожидании подключения любые TLS-рукопожатия.

Параметры:

duration — время, отведенное на установление базового подключения

Возвращает:

этот построитель

Выбрасывает:

IllegalArgumentException — если длительность неположительна

См. также:

• Настройка времени ожидания выполнения запроса

HttpClient.Builder sslContext(SSLContext sslContext)

Параметры:

sslContext — SSLContext

Возвращает:

этот построитель

HttpClient.Builder sslParameters(SSLParameters sslParameters)

Параметры:

sslParameters — SSLParameters

Возвращает:

этот построитель

HttpClient.Builder executor(Executor executor)

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

Исполнитель по умолчанию использует пул потоков с пользовательской фабрикой потоков.

Параметры:

executor — Executor

Возвращает:

этот построитель

HttpClient.Builder followRedirects(HttpClient.Redirect policy)

Параметры:

policy — политика перенаправления

Возвращает:

этот построитель

HttpClient.Builder version(HttpClient.Version version)

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

На выбор фактической версии протокола могут также влиять некоторые ограничения.

Параметры:

version — запрашиваемая версия протокола HTTP

Возвращает:

этот построитель

HttpClient.Builder priority(int priority)

Параметры:

priority — весовой коэффициент приоритета

Возвращает:

этот построитель

Выбрасывает:

IllegalArgumentException — если указанный приоритет выходит за допустимый диапазон

HttpClient.Builder proxy(ProxySelector proxySelector)

Примечание к API:

ProxySelector::of предоставляет ProxySelector, который использует один прокси для всех запросов. Системный селектор прокси можно получить с помощью ProxySelector.getDefault().

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

Если этот метод не вызван до создания, новые клиенты будут использовать селектор прокси по умолчанию, которого обычно достаточно для клиентских приложений. Селектор прокси по умолчанию поддерживает набор системных свойств, связанных с настройками прокси. Это поведение по умолчанию можно отключить, указав явный селектор прокси, например NO_PROXY или селектор, возвращаемый методом ProxySelector::of, до вызова создания.

Параметры:

proxySelector — ProxySelector

Возвращает:

этот построитель

HttpClient.Builder authenticator(Authenticator authenticator)

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

Во встроенной реализации HttpClient в JDK, если для HttpRequest задан заголовок Authorization или Proxy-Authorization, его значение используется, а Authenticator не вызывается для соответствующей аутентификации. В этом случае ошибки аутентификации возвращаются пользователю, а запросы не повторяются автоматически. Кроме того, встроенная реализация JDK в настоящее время поддерживает только HTTP-аутентификацию Basic.

Параметры:

authenticator — Authenticator

Возвращает:

этот построитель

default HttpClient.Builder localAddress(InetAddress localAddr)

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

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

Параметры:

localAddr — локальный адрес сокета. Может быть равен null.

Возвращает:

этот построитель

Выбрасывает:

UnsupportedOperationException — если этот построитель не поддерживает настройку локального адреса или если переданный localAddr не поддерживается этой реализацией HttpClient.

Начиная с:

19

HttpClient build()

Возвращает:

новый HttpClient

Выбрасывает:

UncheckedIOException — может быть выброшено, если не удается выделить базовые ресурсы ввода-вывода, необходимые для реализации, или если полученная конфигурация не соответствует требованиям реализации. Например, если реализации требуется Selector, но его не удается открыть из-за нехватки необходимых ресурсов, или если предпочтительная версия протокола не поддерживается реализацией или не может использоваться в этой конфигурации.