bayou.gzip

Class GzipHttpEntity

java.lang.Object

bayou.gzip.GzipHttpEntity

All Implemented Interfaces:

HttpEntity, HttpEntityWrapper

public class GzipHttpEntity
extends Object
implements HttpEntityWrapper

Compresses the origin HttpEntity with gzip.

The body of this entity will be the body of the origin entity compressed in gzip format.

If the origin entity has ETag, this entity will append ".gzip" to it.

This entity is sharable iff the origin entity is sharable. If this entity is sharable and to be served to multiple http messages, consider the CachedHttpEntity wrapper.

Constructor Summary

Constructors

Constructor and Description
GzipHttpEntity(HttpEntity origin, int compressionLevel) Create a GzipHttpEntity, which compresses the origin entity body with gzip.

Method Summary

Instance Methods
HttpEntity	getOriginEntity() The origin entity.
ByteSource	body() The body after compression.
Long	contentLength() The length of the body (after compression).
String	contentEncoding() The content encoding, containing "gzip".
String	etag() The ETag.

Methods inherited from class java.lang.Object

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

Methods inherited from interface bayou.http.HttpEntityWrapper

contentType, etagIsWeak, expires, lastModified

Methods inherited from interface bayou.http.HttpEntity

bodyBytes, bodyString

Constructor Detail

GzipHttpEntity

public GzipHttpEntity(HttpEntity origin,
                      int compressionLevel)

Create a GzipHttpEntity, which compresses the origin entity body with gzip.

`compressionLevel` can be 0-9. For on-the-fly gzip, consider compressionLevel=1, which is faster, with pretty good compression ratio.

Method Detail

getOriginEntity

public HttpEntity getOriginEntity()

The origin entity.

Specified by:

getOriginEntity in interface HttpEntityWrapper

body

public ByteSource body()

The body after compression.

The body of this entity will be the body of the origin entity compressed in gzip format.

See also GzipByteSource.

Specified by:

body in interface HttpEntity

Specified by:

body in interface HttpEntityWrapper

contentLength

public Long contentLength()

The length of the body (after compression).

This implementation usually returns null, because the length is unknown without actually performing the compression.

Specified by:

contentLength in interface HttpEntity

Specified by:

contentLength in interface HttpEntityWrapper

contentEncoding

public String contentEncoding()

The content encoding, containing "gzip".

If the origin entity has no content encoding, this method returns "gzip".

If the origin entity has a content encoding, this method appends ", gzip" to it.

Specified by:

contentEncoding in interface HttpEntity

Specified by:

contentEncoding in interface HttpEntityWrapper

etag

public String etag()

The ETag.

If the origin entity has no ETag, this method returns null.

If the origin entity has an ETag, this method appends ".gzip" to it.

Specified by:

etag in interface HttpEntity

Specified by:

etag in interface HttpEntityWrapper