Package org.apache.http.client.entity

Class GzipCompressingEntity

java.lang.Object
org.apache.http.entity.HttpEntityWrapper
org.apache.http.client.entity.GzipCompressingEntity
All Implemented Interfaces:
HttpEntity
public class GzipCompressingEntity extends HttpEntityWrapper
Wrapping entity that compresses content when writing.
Since:
4.0

  • Constructor Details

    • GzipCompressingEntity

      public GzipCompressingEntity(HttpEntity entity)

  • Method Details

    • getContentEncoding

      public Header getContentEncoding()
      Description copied from interface: HttpEntity
      Obtains the Content-Encoding header, if known. This is the header that should be used when sending the entity, or the one that was received with the entity. Wrapping entities that modify the content encoding should adjust this header accordingly.
      Specified by:
      getContentEncoding in interface HttpEntity
      Overrides:
      getContentEncoding in class HttpEntityWrapper
      Returns:
      the Content-Encoding header for this entity, or null if the content encoding is unknown

    • getContentLength

      public long getContentLength()
      Description copied from interface: HttpEntity
      Tells the length of the content, if known.
      Specified by:
      getContentLength in interface HttpEntity
      Overrides:
      getContentLength in class HttpEntityWrapper
      Returns:
      the number of bytes of the content, or a negative number if unknown. If the content length is known but exceeds Long.MAX_VALUE, a negative number is returned.

    • isChunked

      public boolean isChunked()
      Description copied from interface: HttpEntity
      Tells about chunked encoding for this entity. The primary purpose of this method is to indicate whether chunked encoding should be used when the entity is sent. For entities that are received, it can also indicate whether the entity was received with chunked encoding.

      The behavior of wrapping entities is implementation dependent, but should respect the primary purpose.

      Specified by:
      isChunked in interface HttpEntity
      Overrides:
      isChunked in class HttpEntityWrapper
      Returns:
      true if chunked encoding is preferred for this entity, or false if it is not

    • 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:

    • 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