|
||||||||||
| 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, 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 |
|---|
public NFileEntity(File file,
ContentType 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(File file)
public NFileEntity(File file,
ContentType contentType)
File
with the given content type.
file - the source file.contentType - the content type of the file.
@Deprecated
public NFileEntity(File file,
String contentType,
boolean useFileChannels)
NFileEntity(File, ContentType, boolean)
@Deprecated
public NFileEntity(File file,
String contentType)
NFileEntity(File, ContentType)
| Method Detail |
|---|
public void close()
throws IOException
close in interface CloseableIOException
@Deprecated
public void finish()
throws IOException
close()
finish in interface ProducingNHttpEntityIOExceptionpublic long getContentLength()
getContentLength in interface HttpEntitypublic boolean isRepeatable()
HttpAsyncContentProducer
isRepeatable in interface HttpEntityisRepeatable in interface HttpAsyncContentProducer
public void produceContent(ContentEncoder encoder,
IOControl ioctrl)
throws IOException
HttpAsyncContentProducerContentEncoder.
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.
produceContent in interface HttpAsyncContentProducerproduceContent in interface ProducingNHttpEntityencoder - content encoder.ioctrl - I/O control of the underlying connection.
IOExceptionpublic boolean isStreaming()
isStreaming in interface HttpEntity
public InputStream getContent()
throws IOException
getContent in interface HttpEntityIOException
public void writeTo(OutputStream outstream)
throws IOException
writeTo in interface HttpEntityIOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||