- Type Parameters:
T- the response body type
- All Superinterfaces:
- Enclosing interface:
public static interface HttpResponse.BodySubscriber<T> extends Flow.Subscriber<List<ByteBuffer>>
BodySubscriberconsumes response body bytes and converts them into a higher-level Java type. The class
BodySubscribersprovides implementations of many common body subscribers.
The object acts as a
ByteBuffer>> to the HTTP Client implementation, which publishes
lists of ByteBuffers containing the response body. The Flow of data, as
well as the order of ByteBuffers in the Flow lists, is a strictly ordered
representation of the response body. Both the Lists and the ByteBuffers,
once passed to the subscriber, are no longer used by the HTTP Client. The
subscriber converts the incoming buffers of data to some higher-level
getBody() method returns a
<T> that provides the response body
CompletionStage must be obtainable at any time. When
it completes depends on the nature of type
T. In many cases,
T represents the entire body after being consumed then
CompletionStage completes after the body has been consumed.
T is a streaming type, such as
InputStream, then it completes before the body has been read, because
the calling code uses the
InputStream to consume the data.
- API Note:
- To ensure that all resources associated with the corresponding
HTTP exchange are properly released, an implementation of
BodySubscribershould ensure to request more data until one of
onErrorare signalled, or
cancelits subscription if unable or unwilling to do so. Calling
cancelbefore exhausting the response body data may cause the underlying HTTP connection to be closed and prevent it from being reused for subsequent operations.
- Implementation Note:
- The flow of data containing the response body is immutable. Specifically, it is a flow of unmodifiable lists of read-only ByteBuffers.
- See Also:
Modifier and Type Method Description
CompletionStagewhich when completed will return the response body object.
Methods declared in interface java.util.concurrent.Flow.Subscriber
onComplete, onError, onNext, onSubscribe
getBodyCompletionStage<T> getBody()Returns a
CompletionStagewhich when completed will return the response body object. This method can be called at any time relative to the other
Flow.Subscribermethods and is invoked using the client's
- a CompletionStage for the response body