Class NFileEntity

java.lang.Object
org.apache.http.entity.AbstractHttpEntity
org.apache.http.nio.entity.NFileEntity
All Implemented Interfaces:
Closeable, AutoCloseable, org.apache.http.HttpEntity, HttpAsyncContentProducer, ProducingNHttpEntity

public class NFileEntity extends org.apache.http.entity.AbstractHttpEntity implements HttpAsyncContentProducer, ProducingNHttpEntity
A self contained, repeatable non-blocking entity that retrieves its content from a file. This class is mostly used to stream large files of different types, so one needs to supply the content type of the file to make sure the content can be correctly recognized and processed by the recipient.
Since:
4.0
  • Constructor Details

    • NFileEntity

      public NFileEntity(File file, org.apache.http.entity.ContentType contentType, boolean useFileChannels)
      Creates new instance of NFileEntity from the given source File with the given content type. If useFileChannels is set to true, the entity will try to use FileContentEncoder interface to stream file content directly from the file channel.
      Parameters:
      file - the source file.
      contentType - the content type of the file.
      useFileChannels - flag whether the direct transfer from the file channel should be attempted.
      Since:
      4.2
    • NFileEntity

      public NFileEntity(File file)
      Since:
      4.2
    • NFileEntity

      public NFileEntity(File file, org.apache.http.entity.ContentType contentType)
      Creates new instance of NFileEntity from the given source File with the given content type.
      Parameters:
      file - the source file.
      contentType - the content type of the file.
      Since:
      4.2
    • NFileEntity

      @Deprecated public NFileEntity(File file, String contentType, boolean useFileChannels)
    • NFileEntity

      @Deprecated public NFileEntity(File file, String contentType)
      Deprecated.
  • Method Details

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Throws:
      IOException
      Since:
      4.2
    • finish

      @Deprecated public void finish() throws IOException
      Deprecated.
      (4.2) use close()
      Notification that any resources allocated for writing can be released.
      Specified by:
      finish in interface ProducingNHttpEntity
      Throws:
      IOException
    • getContentLength

      public long getContentLength()
      Specified by:
      getContentLength in interface org.apache.http.HttpEntity
    • isRepeatable

      public boolean isRepeatable()
      Description copied from interface: HttpAsyncContentProducer
      Determines whether or not this producer is capable of producing its content more than once. Repeatable content producers are expected to be able to recreate their content even after having been closed.
      Specified by:
      isRepeatable in interface HttpAsyncContentProducer
      Specified by:
      isRepeatable in interface org.apache.http.HttpEntity
    • produceContent

      public void produceContent(ContentEncoder encoder, IOControl ioControl) throws IOException
      Description copied from interface: HttpAsyncContentProducer
      Invoked to write out a chunk of content to the ContentEncoder. The IOControl interface can be used to suspend output event notifications if the entity is temporarily unable to produce more content.

      When all content is finished, the producer MUST call ContentEncoder.complete(). Failure to do so may cause the entity to be incorrectly delimited.

      Please note that the ContentEncoder object is not thread-safe and should only be used within the context of this method call. The IOControl object can be shared and used on other thread to resume output event notifications when more content is made available.

      Specified by:
      produceContent in interface HttpAsyncContentProducer
      Specified by:
      produceContent in interface ProducingNHttpEntity
      Parameters:
      encoder - content encoder.
      ioControl - I/O control of the underlying connection.
      Throws:
      IOException
    • isStreaming

      public boolean isStreaming()
      Specified by:
      isStreaming in interface org.apache.http.HttpEntity
    • getContent

      public InputStream getContent() throws IOException
      Specified by:
      getContent in interface org.apache.http.HttpEntity
      Throws:
      IOException
    • writeTo

      public void writeTo(OutputStream outStream) throws IOException
      Specified by:
      writeTo in interface org.apache.http.HttpEntity
      Throws:
      IOException