org.apache.hc.client5.http.entity

Class DecompressingEntity

java.lang.Object

org.apache.hc.core5.http.io.entity.HttpEntityWrapper

org.apache.hc.client5.http.entity.DecompressingEntity

All Implemented Interfaces:

Closeable, AutoCloseable, EntityDetails, HttpEntity

Direct Known Subclasses:

DeflateDecompressingEntity, GzipDecompressingEntity

public class DecompressingEntity
extends HttpEntityWrapper

Common base class for decompressing HttpEntity implementations.

Since:

4.4

Constructor Summary

Constructors

Constructor and Description
DecompressingEntity(HttpEntity wrapped, InputStreamFactory inputStreamFactory) Creates a new DecompressingEntity.

Method Summary

Modifier and Type	Method and Description
InputStream	getContent() Returns a content stream of the entity.
String	getContentEncoding() Returns content encoding of the entity, if known.
long	getContentLength() Returns length of the entity, if known.
void	writeTo(OutputStream outStream) Writes the entity content out to the output stream.

Methods inherited from class org.apache.hc.core5.http.io.entity.HttpEntityWrapper

close, getContentType, getTrailerNames, getTrailers, isChunked, isRepeatable, isStreaming, toString

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DecompressingEntity

public DecompressingEntity(HttpEntity wrapped,
                           InputStreamFactory inputStreamFactory)

Creates a new DecompressingEntity.

Parameters:

wrapped - the non-null HttpEntity to be wrapped

inputStreamFactory - factory to create decompressing stream.

Method Detail

getContent

public InputStream getContent()
                       throws IOException

Description copied from interface: HttpEntity

Returns a content stream of the entity. Repeatable entities are expected to create a new instance of InputStream for each invocation of this method and therefore can be consumed multiple times. Entities that are not repeatable are expected to return the same InputStream 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 interface HttpEntity

Overrides:

getContent in class HttpEntityWrapper

Returns:

content stream of the entity.

Throws:

IOException - if the stream could not be created

See Also:

HttpEntity.isRepeatable()

getContentEncoding

public String getContentEncoding()

Description copied from interface: EntityDetails

Returns content encoding of the entity, if known.

Specified by:

getContentEncoding in interface EntityDetails

Overrides:

getContentEncoding in class HttpEntityWrapper

getContentLength

public long getContentLength()

Description copied from interface: EntityDetails

Returns length of the entity, if known.

Specified by:

getContentLength in interface EntityDetails

Overrides:

getContentLength in class HttpEntityWrapper

writeTo

public void writeTo(OutputStream outStream)
             throws IOException

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 interface HttpEntity

Overrides:

writeTo in class HttpEntityWrapper

Parameters:

outStream - the output stream to write entity content to

Throws:

IOException - if an I/O error occurs