Класс HttpResponse.BodyHandlers

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

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

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

Например:

TextSubscriber subscriber = new TextSubscriber();
HttpResponse<Void> response = client.sendAsync(request,
    BodyHandlers.fromSubscriber(subscriber)).join();
System.out.println(response.statusCode());

Параметры:

subscriber — подписчик

Возвращает:

обработчик тела ответа

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

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

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

Например:

TextSubscriber subscriber = ...;  // accumulates bytes and transforms them into a String
HttpResponse<String> response = client.sendAsync(request,
    BodyHandlers.fromSubscriber(subscriber, TextSubscriber::getTextResult)).join();
String text = response.body();

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

S — тип Subscriber

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

Параметры:

subscriber — подписчик

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

Возвращает:

обработчик тела ответа

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

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

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

Например:

// A PrintSubscriber that implements Flow.Subscriber<String>
// and print lines received by onNext() on System.out
PrintSubscriber subscriber = new PrintSubscriber(System.out);
client.sendAsync(request, BodyHandlers.fromLineSubscriber(subscriber))
    .thenApply(HttpResponse::statusCode)
    .thenAccept((status) -> {
        if (status != 200) {
            System.err.printf("ERROR: %d status received%n", status);
        }
    });

Параметры:

subscriber — подписчик

Возвращает:

обработчик тела ответа

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

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

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

Например:

// A LineParserSubscriber that implements Flow.Subscriber<String>
// and accumulates lines that match a particular pattern
Pattern pattern = ...;
LineParserSubscriber subscriber = new LineParserSubscriber(pattern);
HttpResponse<List<String>> response = client.send(request,
    BodyHandlers.fromLineSubscriber(subscriber, s -> s.getMatchingLines(), "\n"));
if (response.statusCode() != 200) {
    System.err.printf("ERROR: %d status received%n", response.statusCode());
}

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

S — тип Subscriber

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

Параметры:

subscriber — подписчик

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

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

Возвращает:

обработчик тела ответа

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

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

public static HttpResponse.BodyHandler<Void> discarding()

Возвращает:

обработчик тела ответа

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

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

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

Параметры:

value — значение U, возвращаемое в качестве тела ответа; может быть null

Возвращает:

обработчик тела ответа

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

Параметры:

charset — кодировка, используемая для преобразования тела

Возвращает:

обработчик тела ответа

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

Параметры:

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

openOptions — параметры, используемые при открытии/создании файла

Возвращает:

обработчик тела ответа

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

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

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

Параметры:

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

Возвращает:

обработчик тела ответа

public static HttpResponse.BodyHandler<Path> ofFileDownload(Path directory, OpenOption... openOptions)

Параметры:

directory — каталог для сохранения файла

openOptions — параметры открытия, используемые при открытии файла

Возвращает:

обработчик тела ответа

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

IllegalArgumentException — если указанный путь не существует, не относится к файловой системе по умолчанию, не является каталогом, недоступен для записи или указан недопустимый набор параметров открытия

public static HttpResponse.BodyHandler<InputStream> ofInputStream()

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

Дополнительные сведения см. в разделе HttpResponse.BodySubscribers.ofInputStream().

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

Возвращает:

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

public static HttpResponse.BodyHandler<Stream<String>> ofLines()

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

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

Возвращает:

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

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

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

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

Параметры:

consumer — Consumer, принимающий тело ответа

Возвращает:

обработчик тела ответа

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

Возвращает:

обработчик тела ответа

public static HttpResponse.BodyHandler<String> ofString()

Возвращает:

обработчик тела ответа

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

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

Дополнительные сведения см. в разделе HttpResponse.BodySubscribers.ofPublisher().

Чтобы обеспечить надлежащее освобождение всех ресурсов, связанных с соответствующим обменом, вызывающий код должен подписаться на publisher и соблюдать правила, изложенные в HttpResponse.BodySubscribers.ofPublisher()

Возвращает:

обработчик тела ответа с публикацией

public static <T> HttpResponse.BodyHandler<T> buffering(HttpResponse.BodyHandler<T> downstreamHandler, int bufferSize)

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

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

Параметры:

downstreamHandler — нижестоящий обработчик

bufferSize — параметр размера буфера, передаваемый в BodySubscribers.buffering

Возвращает:

обработчик тела ответа

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

IllegalArgumentException — если bufferSize <= 0

public static <T> HttpResponse.BodyHandler<T> limiting(HttpResponse.BodyHandler<T> downstreamHandler, long capacity)

Параметры:

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

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

Возвращает:

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

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

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

Начиная с версии:

25