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()
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 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()
AsyncDataProduceravailable in interface AsyncDataProducerpublic void failed(Exception cause)
AsyncEntityProducerfailed in interface AsyncEntityProducercause - the cause of the failure.public String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailspublic long getContentLength()
EntityDetailsgetContentLength in interface EntityDetailspublic String getContentType()
EntityDetailsgetContentType in interface EntityDetailspublic 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
AsyncDataProducerproduce in interface AsyncDataProducerdataStreamChannel - the data channel capable to accepting more data.IOExceptionpublic void releaseResources()
releaseResources in interface ResourceHolderCopyright © 2005–2021 The Apache Software Foundation. All rights reserved.