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.
A
ConsumingNHttpEntity
that forwards available content to a
ContentListener
.- Since:
- 4.0
-
Field Summary
FieldsFields inherited from class org.apache.http.entity.HttpEntityWrapper
wrappedEntity
-
Constructor Summary
ConstructorsConstructorDescriptionConsumingNHttpEntityTemplate
(HttpEntity httpEntity, ContentListener contentListener) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
consumeContent
(ContentDecoder decoder, IOControl ioControl) 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.Deprecated.Returns a content stream of the entity.Deprecated.boolean
Deprecated.Tells whether this entity depends on an underlying stream.void
writeTo
(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
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.apache.http.HttpEntity
consumeContent, getContentEncoding, getContentLength, getContentType, isChunked, isRepeatable
-
Field Details
-
contentListener
Deprecated.
-
-
Constructor Details
-
ConsumingNHttpEntityTemplate
Deprecated.
-
-
Method Details
-
getContentListener
Deprecated. -
getContent
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:
IOException
- if the stream could not be createdUnsupportedOperationException
- if entity content cannot be represented asInputStream
.- See Also:
-
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
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:
IOException
- if an I/O error occursUnsupportedOperationException
-
consumeContent
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.ioControl
- I/O control of the underlying connection.- Throws:
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
-
BasicAsyncRequestProducer
orBasicAsyncResponseProducer