FileEntityProducer (Apache HttpComponents Core HTTP/1.1 5.1 API)

java.lang.Object
- org.apache.hc.core5.http.nio.entity.FileEntityProducer

All Implemented Interfaces:

EntityDetails, AsyncDataProducer, AsyncEntityProducer, ResourceHolder
```
public final class FileEntityProducer
extends Object
implements AsyncEntityProducer
```
AsyncEntityProducer implementation that generates data stream from content of a File.

Since:

5.0

Constructor Summary

Constructors
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)`

Method Summary

Methods
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()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileEntityProducer
```
public FileEntityProducer(File file,
                  int bufferSize,
                  ContentType contentType,
                  boolean chunked)
```
  - FileEntityProducer
```
public FileEntityProducer(File file,
                  ContentType contentType,
                  boolean chunked)
```
  - FileEntityProducer
```
public FileEntityProducer(File file,
                  ContentType contentType)
```
  - FileEntityProducer
```
public FileEntityProducer(File file)
```
- Method Detail
  - 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
  - getContentType
```
public String getContentType()
```
    Description copied from interface: EntityDetails
    
    Returns content type of the entity, if known.
    
    Specified by:
    
    getContentType in interface EntityDetails
  - getContentLength
```
public long getContentLength()
```
    Description copied from interface: EntityDetails
    
    Returns length of the entity, if known.
    
    Specified by:
    
    getContentLength in interface EntityDetails
  - 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 interface AsyncDataProducer
    
    Returns:
    the number of bytes immediately available for output
  - getContentEncoding
```
public String getContentEncoding()
```
    Description copied from interface: EntityDetails
    
    Returns content encoding of the entity, if known.
    
    Specified by:
    
    getContentEncoding in interface EntityDetails
  - 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 interface EntityDetails
  - getTrailerNames
```
public Set<String> getTrailerNames()
```
    Description copied from interface: EntityDetails
    
    Preliminary declaration of trailing headers.
    
    Specified by:
    
    getTrailerNames in interface EntityDetails
  - produce
```
public void produce(DataStreamChannel channel)
             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.
    
    Specified by:
    
    produce in interface AsyncDataProducer
    
    Parameters:
    channel - the data channel capable to accepting more data.
    
    Throws:
    
    IOException
  - 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.
  - getException
```
public Exception getException()
```
  - releaseResources
```
public void releaseResources()
```
    Specified by:
    
    releaseResources in interface ResourceHolder

Class FileEntityProducer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileEntityProducer

FileEntityProducer

FileEntityProducer

FileEntityProducer

Method Detail

isRepeatable

getContentType

getContentLength

available

getContentEncoding

isChunked

getTrailerNames

produce

failed

getException

releaseResources