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()
Returns content encoding of the entity, if known.
|
long |
getContentLength()
Returns length of the entity, if known.
|
String |
getContentType()
Returns content type of the entity, if known.
|
Exception |
getException() |
Set<String> |
getTrailerNames()
Preliminary declaration of trailing headers.
|
boolean |
isChunked()
Returns 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 streamIOExceptionpublic final boolean isRepeatable()
AsyncEntityProducerResourceHolder.releaseResources().isRepeatable in interface AsyncEntityProducerpublic final int available()
AsyncDataProduceravailable in interface AsyncDataProducerpublic final void produce(DataStreamChannel channel) throws IOException
AsyncDataProducerproduce in interface AsyncDataProducerchannel - the data channel capable to accepting more data.IOExceptionpublic final long getContentLength()
EntityDetailsgetContentLength in interface EntityDetailspublic final String getContentType()
EntityDetailsgetContentType in interface EntityDetailspublic String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailspublic 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.