groovyx.net.http.GZIPEncoding Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of http-builder Show documentation

A builder-style HTTP client API, including authentication, and extensible handling of common content-types such as JSON and XML. It is built on top of Apache's HttpClient.

There is a newer version: 0.7.1

Show newest version

/*
 * Copyright 2008-2011 Thomas Nichols.  http://blog.thomnichols.org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * You are receiving this code free of charge, which represents many hours of
 * effort from other individuals and corporations.  As a responsible member
 * of the community, you are encouraged (but not required) to donate any
 * enhancements or improvements back to the community under a similar open
 * source license.  Thank you. -TMN
 */
package groovyx.net.http;

import static groovyx.net.http.ContentEncoding.Type.GZIP;

import java.io.IOException;
import java.io.InputStream;
import java.util.zip.GZIPInputStream;

import org.apache.http.HttpEntity;
import org.apache.http.entity.HttpEntityWrapper;

/**
 * Content encoding used to handle GZIP responses.
 * @author Tom Nichols
 */
public class GZIPEncoding extends ContentEncoding {

    /**
     * Returns the {@link ContentEncoding.Type#GZIP} encoding string which is
     * added to the Accept-Encoding header by the base class.
     */
    @Override
    public String getContentEncoding() {
        return GZIP.toString();
    }

    /**
     * Wraps the raw entity in a {@link GZIPDecompressingEntity}.
     */
    @Override
    public HttpEntity wrapResponseEntity( HttpEntity raw ) {
        return new GZIPDecompressingEntity( raw );
    }

    /**
     * Entity used to interpret a GZIP-encoded response
     * @author Tom Nichols
     */
    protected static class GZIPDecompressingEntity extends HttpEntityWrapper {

        public GZIPDecompressingEntity(final HttpEntity entity) {
            super(entity);
        }

        /**
         * returns a {@link GZIPInputStream} which wraps the original entity's
         * content stream
         * @see HttpEntity#getContent()
         */
        @Override
        public InputStream getContent() throws IOException, IllegalStateException {
            return new GZIPInputStream( wrappedEntity.getContent() );
        }

        /**
         * @return -1
         */
        @Override
        public long getContentLength() {
            // length of un-gzipped content is not known
            return -1;
        }
    }
}