Class PathEntityProducer

java.lang.Object

org.apache.hc.core5.http.nio.entity.PathEntityProducer

All Implemented Interfaces:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder

public final class PathEntityProducer
extends Object
implements AsyncEntityProducer

AsyncEntityProducer implementation that generates a data stream from the content at a Path.

Since:

5.2

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	BUFFER_SIZE
private final ByteBuffer	byteBuffer
private final AtomicReference<SeekableByteChannel>	channelRef
private final boolean	chunked
private final ContentType	contentType
private boolean	eof
private final AtomicReference<Exception>	exception
private final Path	file
private final long	length
private final OpenOption[]	openOptions

Constructor Summary

Constructors

Constructor	Description
PathEntityProducer(Path file, int bufferSize, ContentType contentType, boolean chunked, OpenOption... openOptions)
PathEntityProducer(Path file, OpenOption... openOptions)
PathEntityProducer(Path file, ContentType contentType, boolean chunked, OpenOption... openOptions)
PathEntityProducer(Path file, ContentType contentType, OpenOption... openOptions)

Method Summary

Modifier and Type	Method	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()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

BUFFER_SIZE

private static final int BUFFER_SIZE

See Also:

• Constant Field Values

file

private final Path file

openOptions

private final OpenOption[] openOptions

byteBuffer

private final ByteBuffer byteBuffer

length

private final long length

contentType

private final ContentType contentType

chunked

private final boolean chunked

exception

private final AtomicReference<Exception> exception

channelRef

private final AtomicReference<SeekableByteChannel> channelRef

eof

private boolean eof

Constructor Details

PathEntityProducer

public PathEntityProducer(Path file,
 ContentType contentType,
 boolean chunked,
 OpenOption... openOptions)
                   throws IOException

Throws:

IOException

PathEntityProducer

public PathEntityProducer(Path file,
 ContentType contentType,
 OpenOption... openOptions)
                   throws IOException

Throws:

IOException

PathEntityProducer

public PathEntityProducer(Path file,
 int bufferSize,
 ContentType contentType,
 boolean chunked,
 OpenOption... openOptions)
                   throws IOException

Throws:

IOException

PathEntityProducer

public PathEntityProducer(Path file,
 OpenOption... openOptions)
                   throws IOException

Throws:

IOException

Method Details

available

public int available()

Description copied from interface: AsyncDataProducer

Returns the number of bytes immediately available for output. This method can be used as a hint to control output events of the underlying I/O session.

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().

Specified by:

available in interface AsyncDataProducer

Returns:

the number of bytes immediately available for output

See Also:

• AsyncDataProducer.produce(DataStreamChannel)
• DataStreamChannel.requestOutput()

failed

public void failed(Exception cause)

Description copied from interface: AsyncEntityProducer

Triggered to signal a failure in data generation.

Specified by:

failed in interface AsyncEntityProducer

Parameters:

cause - the cause of the failure.

getContentEncoding

public String getContentEncoding()

Description copied from interface: EntityDetails

Gets content encoding of this entity, if known.

Specified by:

getContentEncoding in interface EntityDetails

Returns:

the content encoding of this entity, may be null.

getContentLength

public long getContentLength()

Description copied from interface: EntityDetails

Gets length of this entity, if known.

Specified by:

getContentLength in interface EntityDetails

Returns:

the length of this entity, may be 0.

getContentType

public String getContentType()

Description copied from interface: EntityDetails

Gets content type of this entity, if known.

Specified by:

getContentType in interface EntityDetails

Returns:

the content type of this entity, may be null.

getException

public Exception getException()

getTrailerNames

public Set<String> getTrailerNames()

Description copied from interface: EntityDetails

Gets the preliminary declaration of trailing headers.

Specified by:

getTrailerNames in interface EntityDetails

Returns:

the preliminary declaration of trailing headers.

isChunked

public boolean isChunked()

Description copied from interface: EntityDetails

Tests the chunked transfer hint for this entity.

The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

Specified by:

isChunked in interface EntityDetails

Returns:

the chunked transfer hint for this entity.

isRepeatable

public boolean isRepeatable()

Description copied from interface: AsyncEntityProducer

Determines whether the producer can consistently produce the same content after invocation of ResourceHolder.releaseResources().

Specified by:

isRepeatable in interface AsyncEntityProducer

produce

public void produce(DataStreamChannel dataStreamChannel)
             throws IOException

Description copied from interface: AsyncDataProducer

Triggered to signal the ability of the underlying data channel to accept more data. The data producer can choose to write data immediately inside the call or asynchronously at some later point.

Please note this method gets triggered only if AsyncDataProducer.available() returns a positive value.

Specified by:

produce in interface AsyncDataProducer

Parameters:

dataStreamChannel - the data channel capable of accepting more data.

Throws:

IOException - in case of an I/O error.

See Also:

• AsyncDataProducer.available()

releaseResources

public void releaseResources()

Specified by:

releaseResources in interface ResourceHolder