|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.AbstractHttpEntity
org.apache.http.nio.entity.NFileEntity
public class NFileEntity
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.
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 |
---|
public NFileEntity(java.io.File file, java.lang.String contentType, boolean useFileChannels)
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.
file
- the source file.contentType
- the content type of the file.useFileChannels
- flag whether the direct transfer from the file
channel should be attempted.public NFileEntity(java.io.File file, java.lang.String contentType)
Method Detail |
---|
public void finish()
ProducingNHttpEntity
finish
in interface ProducingNHttpEntity
public long getContentLength()
HttpEntity
getContentLength
in interface HttpEntity
Long.MAX_VALUE
,
a negative number is returned.public boolean isRepeatable()
HttpEntity
isRepeatable
in interface HttpEntity
public void produceContent(ContentEncoder encoder, IOControl ioctrl) throws java.io.IOException
ProducingNHttpEntity
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.
produceContent
in interface ProducingNHttpEntity
encoder
- content encoder.ioctrl
- I/O control of the underlying connection.
java.io.IOException
public boolean isStreaming()
HttpEntity
true
. Self-contained entities should return
false
. Wrapping entities should delegate this call
to the wrapped entity.
isStreaming
in interface HttpEntity
true
if the entity content is streamed,
false
otherwisepublic java.io.InputStream getContent() throws java.io.IOException
HttpEntity
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.
getContent
in interface HttpEntity
java.io.IOException
- if the stream could not be createdHttpEntity.isRepeatable()
public void writeTo(java.io.OutputStream outstream) throws java.io.IOException
HttpEntity
IMPORTANT: Please note all entity implementations must ensure that all allocated resources are properly deallocated when this method returns.
writeTo
in interface HttpEntity
outstream
- the output stream to write entity content to
java.io.IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |