public abstract class AbstractClassicEntityProducer extends Object implements AsyncEntityProducer
AsyncEntityProducer implementation that acts as a compatibility
layer for classic OutputStream based interfaces. Blocking output
processing is executed through an Executor.| Constructor and Description |
|---|
AbstractClassicEntityProducer(int initialBufferSize,
ContentType contentType,
Executor executor) |
| 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.
|
Exception |
getException() |
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.
|
protected abstract void |
produceData(ContentType contentType,
OutputStream outputStream)
Writes out entity data into the given stream.
|
void |
releaseResources() |
public AbstractClassicEntityProducer(int initialBufferSize,
ContentType contentType,
Executor executor)
protected abstract void produceData(ContentType contentType, OutputStream outputStream) throws IOException
contentType - the entity content typeoutputStream - the output streamIOException - in case of an I/O error.public final boolean isRepeatable()
AsyncEntityProducerResourceHolder.releaseResources().isRepeatable in interface AsyncEntityProducerpublic final 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 final 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 final long getContentLength()
EntityDetailsgetContentLength in interface EntityDetails0.public final String getContentType()
EntityDetailsgetContentType in interface EntityDetailsnull.public String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailsnull.public final boolean isChunked()
EntityDetailsThe behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked in interface EntityDetailspublic final Set<String> getTrailerNames()
EntityDetailsgetTrailerNames in interface EntityDetailspublic final void failed(Exception cause)
AsyncEntityProducerfailed in interface AsyncEntityProducercause - the cause of the failure.public final Exception getException()
public void releaseResources()
releaseResources in interface ResourceHolderCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.