org.apache.http.nio.entity
Class NFileEntity

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

@NotThreadSafe
public class NFileEntity
extends 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
NFileEntity(File file)
           
NFileEntity(File file, ContentType contentType)
          Creates new instance of NFileEntity from the given source File with the given content type.
NFileEntity(File file, ContentType contentType, boolean useFileChannels)
          Creates new instance of NFileEntity from the given source File with the given content type.
NFileEntity(File file, String contentType)
          Deprecated. (4.2) use NFileEntity(File, ContentType)
NFileEntity(File file, String contentType, boolean useFileChannels)
          Deprecated. (4.2) use NFileEntity(File, ContentType, boolean)
 
Method Summary
 void close()
          
 void finish()
          Deprecated. (4.2) use close()
 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 ioctrl)
          Invoked to write out a chunk of content to the ContentEncoder.
 void writeTo(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(File file,
                   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,
                   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)
Deprecated. (4.2) use NFileEntity(File, ContentType, boolean)


NFileEntity

@Deprecated
public NFileEntity(File file,
                              String contentType)
Deprecated. (4.2) use NFileEntity(File, ContentType)

Method Detail

close

public void close()
           throws IOException

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 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 HttpEntity
Specified by:
isRepeatable in interface HttpAsyncContentProducer

produceContent

public void produceContent(ContentEncoder encoder,
                           IOControl ioctrl)
                    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.
ioctrl - I/O control of the underlying connection.
Throws:
IOException

isStreaming

public boolean isStreaming()
Specified by:
isStreaming in interface HttpEntity

getContent

public InputStream getContent()
                       throws IOException
Specified by:
getContent in interface HttpEntity
Throws:
IOException

writeTo

public void writeTo(OutputStream outstream)
             throws IOException
Specified by:
writeTo in interface HttpEntity
Throws:
IOException


Copyright © 2005–2015 The Apache Software Foundation. All rights reserved.