Класс HttpResponse.BodySubscribers

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

Возвращает подписчика на тело ответа, который передает всё тело ответа заданному Flow.Subscriber. Этап завершения (completion stage) возвращаемого подписчика на тело завершается после вызова одного из заданных подписчиков onComplete или onError.

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

Возвращает подписчика на тело ответа, который передает всё тело ответа заданному Flow.Subscriber. Этап завершения (completion stage) возвращаемого подписчика на тело завершается после вызова одного из заданных подписчиков onComplete или onError.

Переданная функция finisher применяется после вызова onComplete заданного подписчика. Функция finisher вызывается с заданным подписчиком и возвращает значение, устанавливаемое как тело ответа.

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

Возвращает подписчика на тело ответа, который передает всё тело ответа заданному Flow.Subscriber по строкам. Этап завершения (completion stage) возвращаемого подписчика на тело завершается после вызова одного из заданных подписчиков onComplete или onError. Байты декодируются с помощью кодировки UTF-8, а строки разделяются по принципу BufferedReader.readLine().

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)

Возвращает подписчика на тело ответа, который передает всё тело ответа заданному Flow.Subscriber по строкам. Этап завершения (completion stage) возвращаемого подписчика на тело завершается после вызова одного из заданных подписчиков onComplete или onError.

Переданная функция finisher применяется после вызова onComplete заданного подписчика. Функция finisher вызывается с заданным подписчиком и возвращает значение, устанавливаемое как тело ответа.

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

Возвращает подписчика на тело ответа, который хранит тело ответа как строку, преобразованную с использованием заданной кодировки Charset.

HttpResponse с этим подписчиком доступен после полного чтения ответа.

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

Возвращает BodySubscriber, который хранит тело ответа в виде массива байтов.

HttpResponse с этим подписчиком доступен после полного чтения ответа.

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

Возвращает BodySubscriber, который сохраняет тело ответа в файл, открытый с заданными параметрами и именем. Файл будет открыт с заданными параметрами с помощью FileChannel.open непосредственно перед чтением тела. Любые исключения будут возвращены или брошены из HttpClient::send или HttpClient::sendAsync в зависимости от ситуации.

HttpResponse с этим подписчиком доступен после полного чтения ответа.

В случае использования стандартного поставщика файловой системы, проверки разрешений менеджера безопасности производятся в этом методе фабрики, когда BodySubscriber создаётся. В противном случае, проверки разрешений могут быть выполнены асинхронно в контексте вызывающего кода при доступе к файлу. Следует позаботиться о том, чтобы BodySubscriber не был доступен небезопасным участкам кода.

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

Возвращает BodySubscriber, который сохраняет тело ответа в файл с заданным именем.

Эквивалентно: ofFile(file, CREATE, WRITE)

В случае использования стандартного поставщика файловой системы, проверки разрешений менеджера безопасности производятся в этом методе фабрики, когда BodySubscriber создаётся. В противном случае, проверки разрешений могут быть выполнены асинхронно в контексте вызывающего кода при доступе к файлу. Следует позаботиться о том, чтобы BodySubscriber не был доступен небезопасным участкам кода.

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

Возвращает BodySubscriber, который предоставляет входящие данные тела заданному обработчику Optional<byte[]>. Каждый вызов Consumer.accept() будет содержать непустой Optional, за исключением последнего вызова после чтения всех данных тела, когда Optional будет пустым.

HttpResponse с этим подписчиком доступен после полного чтения ответа.

public static HttpResponse.BodySubscriber<InputStream> ofInputStream()

Возвращает BodySubscriber, который получает тело ответа как поток InputStream.

Объект HttpResponse, использующий этого подписчика, доступен сразу после чтения заголовков ответа, без необходимости ожидания обработки всего тела. Тело ответа можно прочитать напрямую из потока InputStream.

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

Возвращает BodySubscriber, который получает тело ответа как поток Stream<String>, где каждая строка в потоке соответствует строке, как определено в BufferedReader.lines().

Объект HttpResponse, использующий этого подписчика, доступен сразу после чтения заголовков ответа, без необходимости ожидания обработки всего тела. Тело ответа можно прочитать напрямую из потока Stream.

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

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

Объект HttpResponse, использующий этого подписчика, доступен сразу после чтения заголовков ответа, без необходимости ожидания обработки всего тела. Байты тела ответа можно получить, подписавшись на издателя, возвращаемого методом HttpResponse body.

На издатель, возвращаемый методом body, можно подписаться только один раз. Первый подписчик получит байты тела ответа, если подписка успешна, или приведет к отмене подписки в противном случае. Если будут попытки подписки, последующие подписчики будут немедленно подписаны с пустой подпиской, и их метод onError будет вызван с IllegalStateException.

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

Возвращает подписчика ответа, который игнорирует тело ответа. Предоставленное значение — значение, которое будет возвращено из HttpResponse.body().

public static HttpResponse.BodySubscriber<Void> discarding()

Возвращает подписчика ответа, который отбрасывает тело ответа.

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

Возвращает BodySubscriber который буферизует данные перед передачей их заданному подписчику вниз по потоку. Подписчик гарантирует передачу bufferSize байт данных в каждый вызов метода onNext подписчика вниз по потоку, за исключением последнего вызова, непосредственно перед вызовом onComplete. Последний вызов onNext может содержать меньше, чем bufferSize байт.

Возвращаемый подписчик делегирует метод getBody() подписчику вниз по потоку.

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

Возвращает BodySubscriber, значение тела ответа которого является результатом применения заданной функции к объекту тела ответа заданного upstream BodySubscriber.

Функция преобразования выполняется с помощью потока потока клиента и, следовательно, может использоваться для преобразования любого типа тела ответа, включая блокирующий InputStream. Однако выполнение любой блокирующей операции в функции преобразования повышает вероятность блокирования потока исполнителя на неизвестное время (по крайней мере, до завершения блокирующей операции), что может привести к истощению доступных потоков в исполнителе. Поэтому в случае, когда преобразование к желаемому типу может заблокировать (например, путем чтения из InputStream), предпочтительнее преобразовать в Supplier желаемого типа и отложить блокирующую операцию до вызова Supplier::get потоком вызывающей стороны, как показано в следующем примере, использующем известный парсер JSON для преобразования InputStream в любой анотированный тип Java.

Например:

  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;
  }