Class PathEntityProducer
java.lang.Object
org.apache.hc.core5.http.nio.entity.PathEntityProducer
- All Implemented Interfaces:
EntityDetails
,AsyncDataProducer
,AsyncEntityProducer
,ResourceHolder
AsyncEntityProducer
implementation that generates a data stream from the content at a Path
.- Since:
- 5.2
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
private final ByteBuffer
private final AtomicReference
<SeekableByteChannel> private final boolean
private final ContentType
private boolean
private final AtomicReference
<Exception> private final Path
private final long
private final OpenOption[]
-
Constructor Summary
ConstructorsConstructorDescriptionPathEntityProducer
(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 TypeMethodDescriptionint
Returns the number of bytes immediately available for output.void
Triggered to signal a failure in data generation.Returns content encoding of the entity, if known.long
Returns length of the entity, if known.Returns content type of the entity, if known.Preliminary declaration of trailing headers.boolean
Returns chunked transfer hint for this entity.boolean
Determines whether the producer can consistently produce the same content after invocation ofResourceHolder.releaseResources()
.void
produce
(DataStreamChannel dataStreamChannel) Triggered to signal the ability of the underlying data channel to accept more data.void
-
Field Details
-
BUFFER_SIZE
private static final int BUFFER_SIZE- See Also:
-
file
-
openOptions
-
byteBuffer
-
length
private final long length -
contentType
-
chunked
private final boolean chunked -
exception
-
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
- 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.- Specified by:
available
in interfaceAsyncDataProducer
- Returns:
- the number of bytes immediately available for output
-
failed
Description copied from interface:AsyncEntityProducer
Triggered to signal a failure in data generation.- Specified by:
failed
in interfaceAsyncEntityProducer
- Parameters:
cause
- the cause of the failure.
-
getContentEncoding
Description copied from interface:EntityDetails
Returns content encoding of the entity, if known.- Specified by:
getContentEncoding
in interfaceEntityDetails
-
getContentLength
public long getContentLength()Description copied from interface:EntityDetails
Returns length of the entity, if known.- Specified by:
getContentLength
in interfaceEntityDetails
-
getContentType
Description copied from interface:EntityDetails
Returns content type of the entity, if known.- Specified by:
getContentType
in interfaceEntityDetails
-
getException
-
getTrailerNames
Description copied from interface:EntityDetails
Preliminary declaration of trailing headers.- Specified by:
getTrailerNames
in interfaceEntityDetails
-
isChunked
public boolean isChunked()Description copied from interface:EntityDetails
Returns chunked transfer hint for this entity.The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.
- Specified by:
isChunked
in interfaceEntityDetails
-
isRepeatable
public boolean isRepeatable()Description copied from interface:AsyncEntityProducer
Determines whether the producer can consistently produce the same content after invocation ofResourceHolder.releaseResources()
.- Specified by:
isRepeatable
in interfaceAsyncEntityProducer
-
produce
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.- Specified by:
produce
in interfaceAsyncDataProducer
- Parameters:
dataStreamChannel
- the data channel capable to accepting more data.- Throws:
IOException
-
releaseResources
public void releaseResources()- Specified by:
releaseResources
in interfaceResourceHolder
-