Интерфейс 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()

Возвращает код состояния для данного ответа.

Returns:: код ответа

request

HttpRequest request()

Возвращает HttpRequest, соответствующий данному ответу.

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

Returns:

запрос

See Also:

previousResponse()

previousResponse

Optional<HttpResponse<T>> previousResponse()

Возвращает Optional, содержащий предыдущий промежуточный ответ, если он был получен. Промежуточный ответ — это ответ, полученный в результате перенаправления или аутентификации. Если предыдущий ответ не был получен, возвращается пустой Optional.

Returns:: Optional, содержащий HttpResponse, если таковой имеется.

headers

HttpHeaders headers()

Возвращает полученные заголовки ответа.

Returns:: заголовки ответа

body

T body()

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

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

Returns:: тело

sslSession

Optional<SSLSession> sslSession()

Возвращает Optional, содержащую SSLSession, действующую для данного ответа. Возвращает пустой Optional если это не HTTPS ответ.

Returns:: Optional содержащий SSLSession связанный с ответом

uri

URI uri()

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

Returns:: URI ответа

version

HttpClient.Version version()

Возвращает версию HTTP-протокола, которая использовалась для получения этого ответа.

Returns:: версия HTTP-протокола

© 1993, 2021, 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/17/docs/api/java.net.http/java/net/http/HttpResponse.html