Class FileEntity

java.lang.Object
org.apache.hc.core5.http.io.entity.AbstractHttpEntity
org.apache.hc.core5.http.io.entity.FileEntity
All Implemented Interfaces:
Closeable, AutoCloseable, EntityDetails, HttpEntity
@Contract(threading=IMMUTABLE_CONDITIONAL) public class FileEntity extends AbstractHttpEntity
A self contained, repeatable entity that obtains its content from a file.

This class contains immutable attributes but subclasses may contain additional immutable or mutable attributes.

Since:
4.0

  • Field Details

    • file

      private final File file

  • Constructor Details

    • FileEntity

      public FileEntity(File file, ContentType contentType, String contentEncoding)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      Parameters:
      file - The message body contents will be set from this file.
      contentType - The content-type, may be null.
      contentEncoding - The content encoding string, may be null.

    • FileEntity

      public FileEntity(File file, ContentType contentType)
      Constructs a new instance with the given attributes kept as immutable.

      The new instance:

      • is not chunked.
      • does not define a content encoding.
      Parameters:
      file - The message body contents will be set from this file.
      contentType - The content-type, may be null.

  • Method Details

    • isRepeatable

      public final boolean isRepeatable()
      Tests if the entity is capable of producing its data more than once. A repeatable entity's getContent() and writeTo(OutputStream) methods can be called more than once whereas a non-repeatable entity's can not.

      This implementation always returns false.

      This implementation always returns true.

      Specified by:
      isRepeatable in interface HttpEntity
      Overrides:
      isRepeatable in class AbstractHttpEntity
      Returns:
      true if the entity is repeatable, false otherwise.

    • getContentLength

      public final long getContentLength()
      Gets length of this entity, if known.

      This implementation returns the underlying file's current file length.

      Returns:
      the length of this entity, may be 0.

    • getContent

      public final InputStream getContent() throws IOException
      Description copied from interface: HttpEntity
      Gets a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream instance and therefore may not be consumed more than once.

      If this entity belongs to an incoming HTTP message, calling InputStream.close() on the returned InputStream will try to consume the complete entity content to keep the connection alive. In cases where this is undesired, e.g. when only a small part of the content is relevant and consuming the complete entity content would be too inefficient, only the HTTP message from which this entity was obtained should be closed (if supported).

      IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated after the InputStream.close() method is invoked.

      Returns:
      content stream of the entity.
      Throws:
      IOException - if the stream could not be created
      See Also:

    • isStreaming

      public final boolean isStreaming()
      Tests whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should return true. Self-contained entities should return false. Wrapping entities should delegate this call to the wrapped entity.

      This implementation always returns false.

      Returns:
      true if the entity content is streamed, false otherwise

    • close

      public final void close() throws IOException

      This implementation is a no-op.

      Throws:
      IOException