001/*
002 * Copyright 2008-2011 Thomas Nichols.  http://blog.thomnichols.org
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 *
016 * You are receiving this code free of charge, which represents many hours of
017 * effort from other individuals and corporations.  As a responsible member
018 * of the community, you are encouraged (but not required) to donate any
019 * enhancements or improvements back to the community under a similar open
020 * source license.  Thank you. -TMN
021 */
022package groovyx.net.http;
023
024import static groovyx.net.http.ContentEncoding.Type.GZIP;
025
026import org.apache.http.HttpEntity;
027import org.apache.http.client.entity.GzipDecompressingEntity;
028
029/**
030 * Content encoding used to handle GZIP responses.
031 * @author <a href='mailto:tomstrummer+httpbuilder@gmail.com'>Tom Nichols</a>
032 */
033public class GZIPEncoding extends ContentEncoding {
034
035    /**
036     * Returns the {@link ContentEncoding.Type#GZIP} encoding string which is
037     * added to the <code>Accept-Encoding</code> header by the base class.
038     */
039    @Override
040    public String getContentEncoding() {
041        return GZIP.toString();
042    }
043
044    /**
045     * Wraps the raw entity in a {@link GZIPDecompressingEntity}.
046     */
047    @Override
048    public HttpEntity wrapResponseEntity( HttpEntity raw ) {
049        return new GzipDecompressingEntity( raw );
050    }
051
052}