|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.http.entity.HttpEntityWrapper
org.apache.http.nio.entity.BufferingNHttpEntity
public class BufferingNHttpEntity
A ConsumingNHttpEntity
that consumes content into a buffer. The
content can be retrieved as an InputStream via
HttpEntity.getContent()
, or written to an output stream via
HttpEntity.writeTo(OutputStream)
.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
wrappedEntity |
Constructor Summary | |
---|---|
BufferingNHttpEntity(HttpEntity httpEntity,
ByteBufferAllocator allocator)
|
Method Summary | |
---|---|
void |
consumeContent()
TODO: The name of this method is misnomer. |
void |
consumeContent(ContentDecoder decoder,
IOControl ioctrl)
Notification that content is available to be read from the decoder. |
void |
finish()
Notification that any resources allocated for reading can be released. |
InputStream |
getContent()
Obtains entity's content as InputStream . |
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 |
writeTo(OutputStream outstream)
Writes the entity content to the output stream. |
Methods inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
getContentEncoding, getContentLength, getContentType, isChunked |
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 |
---|
getContentEncoding, getContentLength, getContentType, isChunked |
Constructor Detail |
---|
public BufferingNHttpEntity(HttpEntity httpEntity, ByteBufferAllocator allocator)
Method Detail |
---|
public void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws IOException
ConsumingNHttpEntity
IOControl
instance passed as a parameter to the method can be
used to suspend input events if the entity is temporarily unable to
allocate more storage to accommodate all incoming content.
consumeContent
in interface ConsumingNHttpEntity
decoder
- content decoder.ioctrl
- I/O control of the underlying connection.
IOException
public void finish()
ConsumingNHttpEntity
finish
in interface ConsumingNHttpEntity
public void consumeContent() throws IOException
HttpEntity
connection
. The entity
needs to be consumed completely in order to re-use the connection
with keep-alive.
consumeContent
in interface HttpEntity
consumeContent
in class HttpEntityWrapper
IOException
- if an I/O error occurs.
This indicates that connection keep-alive is not possible.public InputStream getContent() throws IOException
InputStream
.
getContent
in interface HttpEntity
getContent
in class HttpEntityWrapper
IllegalStateException
- if content of the entity has not been
fully received or has already been consumed.
IOException
- if the stream could not be createdpublic boolean isRepeatable()
HttpEntity
isRepeatable
in interface HttpEntity
isRepeatable
in class HttpEntityWrapper
public boolean isStreaming()
HttpEntity
true
until the
content has been consumed, false
afterwards.
Self-contained entities should return false
.
Wrapping entities should delegate this call to the wrapped entity.
getContent
has been read to EOF,
or after consumeContent
has been called.
If a streamed entity can not detect whether the stream has been
read to EOF, it should return true
until
consumeContent
is called.
isStreaming
in interface HttpEntity
isStreaming
in class HttpEntityWrapper
true
if the entity content is streamed and
not yet consumed, false
otherwisepublic void writeTo(OutputStream outstream) throws IOException
HttpEntity
writeTo
in interface HttpEntity
writeTo
in class HttpEntityWrapper
outstream
- the output stream to write entity content to
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |