@Contract(threading=SAFE) public final class ReactiveEntityProducer extends Object implements AsyncEntityProducer
AsyncEntityProducer that subscribes to a Publisher
instance, as defined by the Reactive Streams specification.| Constructor and Description |
|---|
ReactiveEntityProducer(org.reactivestreams.Publisher<ByteBuffer> publisher,
long contentLength,
ContentType contentType,
String contentEncoding)
Creates a new
ReactiveEntityProducer with the given parameters. |
| Modifier and Type | Method and Description |
|---|---|
int |
available()
Returns the number of bytes immediately available for output.
|
void |
failed(Exception cause)
Triggered to signal a failure in data generation.
|
String |
getContentEncoding()
Gets content encoding of this entity, if known.
|
long |
getContentLength()
Gets length of this entity, if known.
|
String |
getContentType()
Gets content type of this entity, if known.
|
Set<String> |
getTrailerNames()
Gets the preliminary declaration of trailing headers.
|
boolean |
isChunked()
Tests the chunked transfer hint for this entity.
|
boolean |
isRepeatable()
Determines whether the producer can consistently produce the same content
after invocation of
ResourceHolder.releaseResources(). |
void |
produce(DataStreamChannel channel)
Triggered to signal the ability of the underlying data channel
to accept more data.
|
void |
releaseResources() |
public ReactiveEntityProducer(org.reactivestreams.Publisher<ByteBuffer> publisher, long contentLength, ContentType contentType, String contentEncoding)
ReactiveEntityProducer with the given parameters.publisher - the publisher of the entity stream.contentLength - the length of the entity, or -1 if unknown (implies chunked encoding).contentType - the Content-Type of the entity, or null if none.contentEncoding - the Content-Encoding of the entity, or null if none.public int available()
AsyncDataProducer
Please note this method should return zero if the data producer
is unable to produce any more data, in which case
AsyncDataProducer.produce(DataStreamChannel) method will not get triggered.
The producer can resume writing out data asynchronously
once more data becomes available or request output readiness events
with DataStreamChannel.requestOutput().
available in interface AsyncDataProducerAsyncDataProducer.produce(DataStreamChannel),
DataStreamChannel.requestOutput()public void produce(DataStreamChannel channel) throws IOException
AsyncDataProducer
Please note this method gets triggered only if AsyncDataProducer.available()
returns a positive value.
produce in interface AsyncDataProducerchannel - the data channel capable of accepting more data.IOException - in case of an I/O error.AsyncDataProducer.available()public void releaseResources()
releaseResources in interface ResourceHolderpublic boolean isRepeatable()
AsyncEntityProducerResourceHolder.releaseResources().isRepeatable in interface AsyncEntityProducerpublic void failed(Exception cause)
AsyncEntityProducerfailed in interface AsyncEntityProducercause - the cause of the failure.public long getContentLength()
EntityDetailsgetContentLength in interface EntityDetails0.public String getContentType()
EntityDetailsgetContentType in interface EntityDetailsnull.public String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailsnull.public boolean isChunked()
EntityDetailsThe behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked in interface EntityDetailspublic Set<String> getTrailerNames()
EntityDetailsgetTrailerNames in interface EntityDetailsCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.