public final class PathEntityProducer extends Object implements AsyncEntityProducer
AsyncEntityProducer implementation that generates a data stream from the content at a Path.| Constructor and Description |
|---|
PathEntityProducer(Path file,
ContentType contentType,
boolean chunked,
OpenOption... openOptions) |
PathEntityProducer(Path file,
ContentType contentType,
OpenOption... openOptions) |
PathEntityProducer(Path file,
int bufferSize,
ContentType contentType,
boolean chunked,
OpenOption... openOptions) |
PathEntityProducer(Path file,
OpenOption... openOptions) |
| 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 dataStreamChannel)
Triggered to signal the ability of the underlying data channel
to accept more data.
|
void |
releaseResources() |
public PathEntityProducer(Path file, ContentType contentType, boolean chunked, OpenOption... openOptions) throws IOException
IOExceptionpublic PathEntityProducer(Path file, ContentType contentType, OpenOption... openOptions) throws IOException
IOExceptionpublic PathEntityProducer(Path file, int bufferSize, ContentType contentType, boolean chunked, OpenOption... openOptions) throws IOException
IOExceptionpublic PathEntityProducer(Path file, OpenOption... openOptions) throws IOException
IOExceptionpublic 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 failed(Exception cause)
AsyncEntityProducerfailed in interface AsyncEntityProducercause - the cause of the failure.public String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailsnull.public long getContentLength()
EntityDetailsgetContentLength in interface EntityDetails0.public String getContentType()
EntityDetailsgetContentType in interface EntityDetailsnull.public Exception getException()
public Set<String> getTrailerNames()
EntityDetailsgetTrailerNames in interface EntityDetailspublic boolean isChunked()
EntityDetailsThe behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked in interface EntityDetailspublic boolean isRepeatable()
AsyncEntityProducerResourceHolder.releaseResources().isRepeatable in interface AsyncEntityProducerpublic void produce(DataStreamChannel dataStreamChannel) throws IOException
AsyncDataProducer
Please note this method gets triggered only if AsyncDataProducer.available()
returns a positive value.
produce in interface AsyncDataProducerdataStreamChannel - the data channel capable of accepting more data.IOException - in case of an I/O error.AsyncDataProducer.available()public void releaseResources()
releaseResources in interface ResourceHolderCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.