Package org.apache.http.nio.entity

Class NFileEntity

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.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

    • Field Summary

      • Fields inherited from class org.apache.http.entity.AbstractHttpEntity

        chunked, contentEncoding, contentType, OUTPUT_BUFFER_SIZE

    • Constructor Summary

      Constructors 
      Constructor Description
      NFileEntity​(java.io.File file)  
      NFileEntity​(java.io.File file, java.lang.String contentType)
      Deprecated.
      (4.2) use NFileEntity(File, ContentType)
      NFileEntity​(java.io.File file, java.lang.String contentType, boolean useFileChannels)
      Deprecated.
      (4.2) use NFileEntity(File, ContentType, boolean)
      NFileEntity​(java.io.File file, org.apache.http.entity.ContentType contentType)
      Creates new instance of NFileEntity from the given source File with the given content type.
      NFileEntity​(java.io.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.

    • Method Summary

      All Methods Instance Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void close()
      void finish()
      Deprecated.
      (4.2) use close()
      java.io.InputStream getContent()  
      long getContentLength()  
      boolean isRepeatable()
      Determines whether or not this producer is capable of producing its content more than once.
      boolean isStreaming()  
      void produceContent​(ContentEncoder encoder, IOControl ioControl)
      Invoked to write out a chunk of content to the ContentEncoder.
      void writeTo​(java.io.OutputStream outStream)  

      • Methods inherited from class org.apache.http.entity.AbstractHttpEntity

        consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType, toString

      • Methods inherited from class java.lang.Object

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

      • Methods inherited from interface org.apache.http.HttpEntity

        consumeContent, getContentEncoding, getContentType, isChunked

    • Constructor Detail

      • NFileEntity

        public NFileEntity​(java.io.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​(java.io.File file)
        Since:
        4.2

      • NFileEntity

        public NFileEntity​(java.io.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​(java.io.File file,
                   java.lang.String contentType)
        Deprecated.
        (4.2) use NFileEntity(File, ContentType)

    • Method Detail

      • close

        public void close()
           throws java.io.IOException
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Throws:
        java.io.IOException
        Since:
        4.2

      • finish

        @Deprecated
public void finish()
            throws java.io.IOException
        Deprecated.
        (4.2) use close()
        Notification that any resources allocated for writing can be released.
        Specified by:
        finish in interface ProducingNHttpEntity
        Throws:
        java.io.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 java.io.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:
        java.io.IOException

      • isStreaming

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

      • getContent

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

      • writeTo

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