public final class FileEntityProducer extends Object implements AsyncEntityProducer
AsyncEntityProducer implementation that generates data stream
from content of a File.| Constructor and Description |
|---|
FileEntityProducer(File file) |
FileEntityProducer(File file,
ContentType contentType) |
FileEntityProducer(File file,
ContentType contentType,
boolean chunked) |
FileEntityProducer(File file,
int bufferSize,
ContentType contentType,
boolean chunked) |
| 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.
|
void |
releaseResources() |
public FileEntityProducer(File file, int bufferSize, ContentType contentType, boolean chunked)
public FileEntityProducer(File file, ContentType contentType, boolean chunked)
public FileEntityProducer(File file, ContentType contentType)
public FileEntityProducer(File file)
public boolean isRepeatable()
AsyncEntityProducerResourceHolder.releaseResources().isRepeatable in interface AsyncEntityProducerpublic String getContentType()
EntityDetailsgetContentType in interface EntityDetailspublic long getContentLength()
EntityDetailsgetContentLength in interface EntityDetailspublic int available()
AsyncDataProduceravailable in interface AsyncDataProducerpublic String getContentEncoding()
EntityDetailsgetContentEncoding in interface EntityDetailspublic 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 EntityDetailspublic void produce(DataStreamChannel channel) throws IOException
AsyncDataProducerproduce in interface AsyncDataProducerchannel - the data channel capable to accepting more data.IOExceptionpublic void failed(Exception cause)
AsyncEntityProducerfailed in interface AsyncEntityProducercause - the cause of the failure.public Exception getException()
public void releaseResources()
releaseResources in interface ResourceHolderCopyright © 2005–2022 The Apache Software Foundation. All rights reserved.