|
||||||||||
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.NHttpEntityWrapper
public class NHttpEntityWrapper
ProducingNHttpEntity
compatibility adaptor for blocking HTTP
entities.
Field Summary |
---|
Fields inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
wrappedEntity |
Constructor Summary | |
---|---|
NHttpEntityWrapper(HttpEntity httpEntity)
|
Method Summary | |
---|---|
void |
consumeContent()
This method is equivalent to the finish() method. |
void |
finish()
Notification that any resources allocated for writing can be released. |
java.io.InputStream |
getContent()
This method throws UnsupportedOperationException . |
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 out)
This method throws UnsupportedOperationException . |
Methods inherited from class org.apache.http.entity.HttpEntityWrapper |
---|
getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable |
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, isRepeatable |
Constructor Detail |
---|
public NHttpEntityWrapper(HttpEntity httpEntity) throws java.io.IOException
java.io.IOException
Method Detail |
---|
public java.io.InputStream getContent() throws java.io.IOException, java.lang.UnsupportedOperationException
UnsupportedOperationException
.
getContent
in interface HttpEntity
getContent
in class HttpEntityWrapper
java.io.IOException
- if the stream could not be created
java.lang.UnsupportedOperationException
HttpEntity.isRepeatable()
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
isStreaming
in class HttpEntityWrapper
true
if the entity content is streamed,
false
otherwisepublic void writeTo(java.io.OutputStream out) throws java.io.IOException, java.lang.UnsupportedOperationException
UnsupportedOperationException
.
writeTo
in interface HttpEntity
writeTo
in class HttpEntityWrapper
out
- the output stream to write entity content to
java.io.IOException
- if an I/O error occurs
java.lang.UnsupportedOperationException
public void consumeContent() throws java.io.IOException
finish()
method.
consumeContent
in interface HttpEntity
consumeContent
in class HttpEntityWrapper
java.io.IOException
- if an I/O error occurs.and #writeTo(OutputStream)
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 void finish()
ProducingNHttpEntity
finish
in interface ProducingNHttpEntity
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |