Package org.apache.http.nio.entity
Class ConsumingNHttpEntityTemplate
- java.lang.Object
-
- org.apache.http.entity.HttpEntityWrapper
-
- org.apache.http.nio.entity.ConsumingNHttpEntityTemplate
-
- All Implemented Interfaces:
HttpEntity
,ConsumingNHttpEntity
@Deprecated public class ConsumingNHttpEntityTemplate extends HttpEntityWrapper implements ConsumingNHttpEntity
Deprecated.use (4.2)BasicAsyncRequestProducer
orBasicAsyncResponseProducer
AConsumingNHttpEntity
that forwards available content to aContentListener
.- Since:
- 4.0
-
-
Constructor Summary
Constructors Constructor Description ConsumingNHttpEntityTemplate(HttpEntity httpEntity, ContentListener contentListener)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
consumeContent(ContentDecoder decoder, IOControl ioctrl)
Deprecated.Notification that content is available to be read from the decoder.void
finish()
Deprecated.Notification that any resources allocated for reading can be released.java.io.InputStream
getContent()
Deprecated.Returns a content stream of the entity.ContentListener
getContentListener()
Deprecated.boolean
isStreaming()
Deprecated.Tells whether this entity depends on an underlying stream.void
writeTo(java.io.OutputStream out)
Deprecated.Writes the entity content out to the output stream.-
Methods inherited from class org.apache.http.entity.HttpEntityWrapper
consumeContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.apache.http.HttpEntity
consumeContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable
-
-
-
-
Constructor Detail
-
ConsumingNHttpEntityTemplate
public ConsumingNHttpEntityTemplate(HttpEntity httpEntity, ContentListener contentListener)
Deprecated.
-
-
Method Detail
-
getContentListener
public ContentListener getContentListener()
Deprecated.
-
getContent
public java.io.InputStream getContent() throws java.io.IOException, java.lang.UnsupportedOperationException
Deprecated.Description copied from interface:HttpEntity
Returns a content stream of the entity.Repeatable
entities are expected to create a new instance ofInputStream
for each invocation of this method and therefore can be consumed multiple times. Entities that are notrepeatable
are expected to return the sameInputStream
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 interfaceHttpEntity
- Overrides:
getContent
in classHttpEntityWrapper
- Returns:
- content stream of the entity.
- Throws:
java.io.IOException
- if the stream could not be createdjava.lang.UnsupportedOperationException
- if entity content cannot be represented asInputStream
.- See Also:
HttpEntity.isRepeatable()
-
isStreaming
public boolean isStreaming()
Deprecated.Description copied from interface:HttpEntity
Tells whether this entity depends on an underlying stream. Streamed entities that read data directly from the socket should returntrue
. Self-contained entities should returnfalse
. Wrapping entities should delegate this call to the wrapped entity.- Specified by:
isStreaming
in interfaceHttpEntity
- Overrides:
isStreaming
in classHttpEntityWrapper
- Returns:
true
if the entity content is streamed,false
otherwise
-
writeTo
public void writeTo(java.io.OutputStream out) throws java.io.IOException, java.lang.UnsupportedOperationException
Deprecated.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 interfaceHttpEntity
- Overrides:
writeTo
in classHttpEntityWrapper
- Parameters:
out
- the output stream to write entity content to- Throws:
java.io.IOException
- if an I/O error occursjava.lang.UnsupportedOperationException
-
consumeContent
public void consumeContent(ContentDecoder decoder, IOControl ioctrl) throws java.io.IOException
Deprecated.Description copied from interface:ConsumingNHttpEntity
Notification that content is available to be read from the decoder.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.- Specified by:
consumeContent
in interfaceConsumingNHttpEntity
- Parameters:
decoder
- content decoder.ioctrl
- I/O control of the underlying connection.- Throws:
java.io.IOException
-
finish
public void finish()
Deprecated.Description copied from interface:ConsumingNHttpEntity
Notification that any resources allocated for reading can be released.- Specified by:
finish
in interfaceConsumingNHttpEntity
-
-