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:
HttpEntity, ProducingNHttpEntity

public class NFileEntity
extends AbstractHttpEntity
implements 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
 
Constructor Summary
NFileEntity(java.io.File file, java.lang.String contentType)
           
NFileEntity(java.io.File file, java.lang.String contentType, boolean useFileChannels)
          Creates new instance of NFileEntity from the given source File with the given content type.
 
Method Summary
 void finish()
          Notification that any resources allocated for writing can be released.
 java.io.InputStream getContent()
          Returns a content stream of the entity.
 long getContentLength()
          Tells the length of the content, if known.
 boolean isRepeatable()
          Tells if the entity is capable of producing its data more than once.
 boolean isStreaming()
          Tells whether this entity depends on an underlying stream.
 void produceContent(ContentEncoder encoder, IOControl ioctrl)
          Notification that content should be written to the encoder.
 void writeTo(java.io.OutputStream outstream)
          Writes the entity content out to the output stream.
 
Methods inherited from class org.apache.http.entity.AbstractHttpEntity
consumeContent, getContentEncoding, getContentType, isChunked, setChunked, setContentEncoding, setContentEncoding, setContentType, setContentType
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.http.HttpEntity
consumeContent, getContentEncoding, getContentType, isChunked
 

Constructor Detail

NFileEntity

public NFileEntity(java.io.File file,
                   java.lang.String 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.

NFileEntity

public NFileEntity(java.io.File file,
                   java.lang.String contentType)
Method Detail

finish

public void finish()
Description copied from interface: ProducingNHttpEntity
Notification that any resources allocated for writing can be released.

Specified by:
finish in interface ProducingNHttpEntity

getContentLength

public long getContentLength()
Description copied from interface: HttpEntity
Tells the length of the content, if known.

Specified by:
getContentLength in interface HttpEntity
Returns:
the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

isRepeatable

public boolean isRepeatable()
Description copied from interface: HttpEntity
Tells 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.

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

produceContent

public void produceContent(ContentEncoder encoder,
                           IOControl ioctrl)
                    throws java.io.IOException
Description copied from interface: ProducingNHttpEntity
Notification that content should be written to the encoder. IOControl instance passed as a parameter to the method can be used to suspend output events if the entity is temporarily unable to produce more content.

When all content is finished, this MUST call ContentEncoder.complete(). Failure to do so could result in the entity never being written.

Specified by:
produceContent in interface ProducingNHttpEntity
Parameters:
encoder - content encoder.
ioctrl - I/O control of the underlying connection.
Throws:
java.io.IOException

isStreaming

public boolean isStreaming()
Description copied from interface: HttpEntity
Tells 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.

Specified by:
isStreaming in interface HttpEntity
Returns:
true if the entity content is streamed, false otherwise

getContent

public java.io.InputStream getContent()
                               throws java.io.IOException
Description copied from interface: HttpEntity
Returns 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.

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

Specified by:
getContent in interface HttpEntity
Returns:
content stream of the entity.
Throws:
java.io.IOException - if the stream could not be created
See Also:
HttpEntity.isRepeatable()

writeTo

public void writeTo(java.io.OutputStream outstream)
             throws java.io.IOException
Description copied from interface: HttpEntity
Writes the entity content out to the output stream.

IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.

Specified by:
writeTo in interface HttpEntity
Parameters:
outstream - the output stream to write entity content to
Throws:
java.io.IOException - if an I/O error occurs


Copyright © 2005-2011 The Apache Software Foundation. All Rights Reserved.