Класс HttpResponse.BodySubscribers

public static HttpResponse.BodySubscriber<Void> fromSubscriber(Flow.Subscriber<? super List<ByteBuffer>> subscriber)

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

Этот метод можно использовать в качестве адаптера между BodySubscriber и Flow.Subscriber.

Параметры:

subscriber — подписчик

Возвращает:

подписчик тела

public static <S extends Flow.Subscriber<? super List<ByteBuffer>>, T> HttpResponse.BodySubscriber<T> fromSubscriber(S subscriber, Function<? super S, ? extends T> finisher)

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

Этот метод можно использовать в качестве адаптера между BodySubscriber и Flow.Subscriber.

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

S — тип подписчика

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

Параметры:

subscriber — подписчик

finisher — функция, применяемая после завершения работы подписчика

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<Void> fromLineSubscriber(Flow.Subscriber<? super String> subscriber)

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

Этот метод можно использовать в качестве адаптера между BodySubscriber и Flow.Subscriber.

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

Этот метод эквивалентен вызову

fromLineSubscriber(subscriber, s -> null, StandardCharsets.UTF_8, null)

Параметры:

subscriber — подписчик

Возвращает:

подписчик тела

public static <S extends Flow.Subscriber<? super String>, T> HttpResponse.BodySubscriber<T> fromLineSubscriber(S subscriber, Function<? super S, ? extends T> finisher, Charset charset, String lineSeparator)

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

Этот метод можно использовать в качестве адаптера между BodySubscriber и Flow.Subscriber.

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

S — тип подписчика

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

Параметры:

subscriber — подписчик

finisher — функция, применяемая после завершения работы подписчика

charset — Charset для декодирования байтов

lineSeparator — необязательный разделитель строк: может быть null, и в этом случае строки будут разделяться так же, как в методе BufferedReader.readLine().

Возвращает:

подписчик тела

Вызывает:

IllegalArgumentException — если указанное значение lineSeparator является пустой строкой

public static HttpResponse.BodySubscriber<String> ofString(Charset charset)

Параметры:

charset — набор символов для преобразования String

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<byte[]> ofByteArray()

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<Path> ofFile(Path file, OpenOption... openOptions)

Параметры:

file — файл для сохранения тела

openOptions — список параметров открытия файла

Возвращает:

подписчик тела

Вызывает:

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

public static HttpResponse.BodySubscriber<Path> ofFile(Path file)

Параметры:

file — файл для сохранения тела

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<Void> ofByteArrayConsumer(Consumer<Optional<byte[]>> consumer)

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

Этот подписчик не управляет потоком данных. Поэтому предоставленный потребитель должен своевременно обрабатывать любой объём переданных данных.

Параметры:

consumer — потребитель массивов байтов

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<InputStream> ofInputStream()

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

Чтобы обеспечить корректное освобождение всех ресурсов, связанных с соответствующим обменом, вызывающий код должен либо прочитать все байты до достижения EOF, либо вызвать InputStream.close(), если он не может или не желает этого делать. Вызов close до исчерпания потока может привести к закрытию базового HTTP-соединения и помешать его повторному использованию для последующих операций.

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

Метод read объекта InputStream, возвращаемого реализацией этого метода по умолчанию, выбрасывает IOException с установленным флагом прерывания потока, если поток прерывается во время блокировки при чтении. В этом случае запрос также будет отменён, а InputStream будет закрыт.

Возвращает:

подписчик потокового тела, который передаёт тело ответа в виде InputStream.

public static HttpResponse.BodySubscriber<Stream<String>> ofLines(Charset charset)

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

Чтобы обеспечить корректное освобождение всех ресурсов, связанных с соответствующим обменом, вызывающий код должен либо прочитать все строки до исчерпания потока, либо вызвать BaseStream.close(), если он не может или не желает этого делать. Вызов close до исчерпания потока может привести к закрытию базового HTTP-соединения и помешать его повторному использованию для последующих операций.

Параметры:

charset — набор символов для преобразования байтов в символы

Возвращает:

подписчик потокового тела, который передаёт тело ответа в виде Stream<String>.

См. также:

• BufferedReader.lines()

public static HttpResponse.BodySubscriber<Flow.Publisher<List<ByteBuffer>>> ofPublisher()

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

Чтобы обеспечить корректное освобождение всех ресурсов, связанных с соответствующим обменом, вызывающий код должен один раз подписаться на предоставленного издателя и либо запросить все байты до вызова onComplete или onError, либо отменить предоставленную подписку, если он не может или не желает этого делать. Обратите внимание, что в зависимости от фактической версии версии HTTP, используемой для обмена, отмена подписки вместо исчерпания потока может привести к закрытию базового HTTP-соединения и помешать его повторному использованию для последующих операций.

Возвращает:

подписчик, публикующий тело, который публикует тело ответа через Publisher<List<ByteBuffer>>.

public static <U> HttpResponse.BodySubscriber<U> replacing(U value)

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

U — тип тела ответа

Параметры:

value — значение, возвращаемое методом HttpResponse.body(); может быть null

Возвращает:

подписчик тела

public static HttpResponse.BodySubscriber<Void> discarding()

Возвращает:

подписчик тела ответа

public static <T> HttpResponse.BodySubscriber<T> buffering(HttpResponse.BodySubscriber<T> downstream, int bufferSize)

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

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

Параметры:

downstream — нижестоящий подписчик

bufferSize — размер буфера

Возвращает:

подписчик тела с буферизацией

Вызывает:

IllegalArgumentException — если bufferSize <= 0

public static <T,U> HttpResponse.BodySubscriber<U> mapping(HttpResponse.BodySubscriber<T> upstream, Function<? super T, ? extends U> mapper)

 public static <W> BodySubscriber<Supplier<W>> asJSON(Class<W> targetType) {
   BodySubscriber<InputStream> upstream = BodySubscribers.ofInputStream();

   BodySubscriber<Supplier<W>> downstream = BodySubscribers.mapping(
         upstream,
         (InputStream is) -> () -> {
             try (InputStream stream = is) {
                 ObjectMapper objectMapper = new ObjectMapper();
                 return objectMapper.readValue(stream, targetType);
             } catch (IOException e) {
                 throw new UncheckedIOException(e);
             }
         });
  return downstream;
}

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

T — тип исходного тела

U — тип возвращаемого подписчика тела

Параметры:

upstream — подписчик тела для отображения

mapper — функция отображения

Возвращает:

подписчик тела с отображением

public static <T> HttpResponse.BodySubscriber<T> limiting(HttpResponse.BodySubscriber<T> downstreamSubscriber, long capacity)

Параметры:

downstreamSubscriber — нижестоящий подписчик, которому передаются полученные данные

capacity — максимально допустимое количество байтов

Возвращает:

BodySubscriber, ограничивающий количество байтов тела, передаваемых указанному downstreamSubscriber

Вызывает:

IllegalArgumentException — если значение capacity отрицательно

Начиная с:

25