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()
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.
|
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()
AsyncEntityProducer
ResourceHolder.releaseResources()
.isRepeatable
in interface AsyncEntityProducer
public String getContentType()
EntityDetails
getContentType
in interface EntityDetails
null
.public long getContentLength()
EntityDetails
getContentLength
in interface EntityDetails
0
.public 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 AsyncDataProducer
AsyncDataProducer.produce(DataStreamChannel)
,
DataStreamChannel.requestOutput()
public String getContentEncoding()
EntityDetails
getContentEncoding
in interface EntityDetails
null
.public boolean isChunked()
EntityDetails
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked
in interface EntityDetails
public Set<String> getTrailerNames()
EntityDetails
getTrailerNames
in interface EntityDetails
public void produce(DataStreamChannel channel) throws IOException
AsyncDataProducer
Please note this method gets triggered only if AsyncDataProducer.available()
returns a positive value.
produce
in interface AsyncDataProducer
channel
- the data channel capable of accepting more data.IOException
- in case of an I/O error.AsyncDataProducer.available()
public void failed(Exception cause)
AsyncEntityProducer
failed
in interface AsyncEntityProducer
cause
- the cause of the failure.public Exception getException()
public void releaseResources()
releaseResources
in interface ResourceHolder
Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.