Spec-Zone.ru › OpenJDK 21

Интерфейс HttpResponse<T>

Type Parameters:
T - тип тела ответа
public interface HttpResponse<T>
Ответ HTTP.

Объект HttpResponse не создаётся напрямую, а возвращается в результате отправки запроса HttpRequest. Объект HttpResponse становится доступным после получения кода состояния и заголовков ответа, обычно после того, как тело ответа также будет полностью получено. Доступ к HttpResponse до полного получения тела ответа зависит от BodyHandler предоставленного при отправке HttpRequest.

Этот класс предоставляет методы для доступа к коду состояния ответа, заголовкам, телу ответа и HttpRequest соответствующего данному ответу.

Вот пример получения ответа в виде строки:

HttpResponse<String> response = client
  .send(request, BodyHandlers.ofString());

Класс BodyHandlers предоставляет реализации многих распространённых обработчиков ответов. В качестве альтернативы можно использовать собственную реализацию BodyHandler.

Since:
11

Краткое описание вложенных классов

Модификатор и тип Интерфейс Описание
static interface  HttpResponse.BodyHandler<T>
Обработчик тела ответа.
static class  HttpResponse.BodyHandlers
Реализации BodyHandler, реализующие различные полезные обработчики, такие как обработка тела ответа как строки или потоковая передача тела ответа в файл.
static interface  HttpResponse.BodySubscriber<T>
BodySubscriber потребляет байты тела ответа и преобразует их в тип Java более высокого уровня.
static class  HttpResponse.BodySubscribers
Реализации BodySubscriber, реализующие различные полезные подписчики, такие как преобразование байтов тела ответа в строку или потоковая передача байтов в файл.
static interface  HttpResponse.PushPromiseHandler<T>
Обработчик push-обещаний.
static interface  HttpResponse.ResponseInfo
Первоначальная информация об ответе, предоставленная BodyHandler, когда ответ первоначально получен и до обработки тела.

Краткое описание методов

Модификатор и тип Метод Описание
T body()
Возвращает тело.
HttpHeaders headers()
Возвращает полученные заголовки ответа.
Optional<HttpResponse<T>> previousResponse()
Возвращает Optional, содержащий предыдущий промежуточный ответ, если он был получен.
HttpRequest request()
Возвращает HttpRequest, соответствующий этому ответу.
Optional<SSLSession> sslSession()
Возвращает Optional, содержащий SSLSession, действующий для этого ответа.
int statusCode()
Возвращает код состояния этого ответа.
URI uri()
Возвращает URI от которого был получен ответ.
HttpClient.Version version()
Возвращает версию HTTP-протокола, используемую для этого ответа.

Подробное описание методов

statusCode

int statusCode()
Возвращает код состояния этого ответа.
Возвращает:
код ответа

request

HttpRequest request()
Возвращает HttpRequest, соответствующий этому ответу.

Возвращаемый HttpRequest может не быть исходным запросом, предоставленным при отправке. Например, если исходный запрос был перенаправлен, запрос, возвращённый этим методом, будет содержать URI перенаправления, который отличается от URI исходного запроса.

Возвращает:
запрос
См. также:
  • previousResponse()

previousResponse

Optional<HttpResponse<T>> previousResponse()
Возвращает Optional, содержащий предыдущий промежуточный ответ, если он был получен. Промежуточный ответ - это ответ, полученный в результате перенаправления или аутентификации. Если предыдущий ответ не был получен, возвращается пустое Optional.
Возвращает:
Optional, содержащий HttpResponse, если есть.

headers

HttpHeaders headers()
Возвращает полученные заголовки ответа.
Возвращает:
заголовки ответа

body

T body()
Возвращает тело. В зависимости от типа T, возвращаемое тело может представлять тело после его чтения (например, byte[], или String, или Path) или объект, с помощью которого тело читается, например, InputStream.

Если этот HttpResponse был возвращен из вызова previousResponse(), то этот метод возвращает null

Возвращает:
тело

sslSession

Optional<SSLSession> sslSession()
Возвращает Optional, содержащий SSLSession, действующий для этого ответа. Возвращает пустое Optional если это не ответ HTTPS.
Возвращает:
Optional, содержащий SSLSession связанный с ответом

uri

URI uri()
Возвращает URI, с которого получен ответ. Это может отличаться от запроса URI если произошло перенаправление.
Возвращает:
URI ответа

version

HttpClient.Version version()
Возвращает версию HTTP-протокола, используемую для этого ответа.
Возвращает:
версия HTTP-протокола

© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.net.http/java/net/http/HttpResponse.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API