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
IOException
public PathEntityProducer(Path file, ContentType contentType, OpenOption... openOptions) throws IOException
IOException
public PathEntityProducer(Path file, int bufferSize, ContentType contentType, boolean chunked, OpenOption... openOptions) throws IOException
IOException
public PathEntityProducer(Path file, OpenOption... openOptions) throws IOException
IOException
public int available()
AsyncDataProducer
available
in interface AsyncDataProducer
public void failed(Exception cause)
AsyncEntityProducer
failed
in interface AsyncEntityProducer
cause
- the cause of the failure.public String getContentEncoding()
EntityDetails
getContentEncoding
in interface EntityDetails
public long getContentLength()
EntityDetails
getContentLength
in interface EntityDetails
public String getContentType()
EntityDetails
getContentType
in interface EntityDetails
public Exception getException()
public Set<String> getTrailerNames()
EntityDetails
getTrailerNames
in interface EntityDetails
public boolean isChunked()
EntityDetails
The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
isChunked
in interface EntityDetails
public boolean isRepeatable()
AsyncEntityProducer
ResourceHolder.releaseResources()
.isRepeatable
in interface AsyncEntityProducer
public void produce(DataStreamChannel dataStreamChannel) throws IOException
AsyncDataProducer
produce
in interface AsyncDataProducer
dataStreamChannel
- the data channel capable to accepting more data.IOException
public void releaseResources()
releaseResources
in interface ResourceHolder
Copyright © 2005–2021 The Apache Software Foundation. All rights reserved.