View Javadoc

1   /*
2    * ====================================================================
3    *
4    *  Licensed to the Apache Software Foundation (ASF) under one or more
5    *  contributor license agreements.  See the NOTICE file distributed with
6    *  this work for additional information regarding copyright ownership.
7    *  The ASF licenses this file to You under the Apache License, Version 2.0
8    *  (the "License"); you may not use this file except in compliance with
9    *  the License.  You may obtain a copy of the License at
10   *
11   *      http://www.apache.org/licenses/LICENSE-2.0
12   *
13   *  Unless required by applicable law or agreed to in writing, software
14   *  distributed under the License is distributed on an "AS IS" BASIS,
15   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   *  See the License for the specific language governing permissions and
17   *  limitations under the License.
18   * ====================================================================
19   *
20   * This software consists of voluntary contributions made by many
21   * individuals on behalf of the Apache Software Foundation.  For more
22   * information on the Apache Software Foundation, please see
23   * <http://www.apache.org/>.
24   *
25   */
26  package org.apache.http.client.entity;
27  
28  import java.io.IOException;
29  import java.io.InputStream;
30  import java.util.zip.GZIPInputStream;
31  
32  import org.apache.http.Header;
33  import org.apache.http.HttpEntity;
34  import org.apache.http.entity.HttpEntityWrapper;
35  
36  /**
37   * {@link HttpEntityWrapper} for handling gzip Content Coded responses.
38   *
39   * @since 4.1
40   */
41  public class GzipDecompressingEntity extends DecompressingEntity {
42  
43      /**
44       * Creates a new {@link GzipDecompressingEntity} which will wrap the specified
45       * {@link HttpEntity}.
46       *
47       * @param entity
48       *            the non-null {@link HttpEntity} to be wrapped
49       */
50      public GzipDecompressingEntity(final HttpEntity entity) {
51          super(entity);
52      }
53  
54      @Override
55      InputStream decorate(final InputStream wrapped) throws IOException {
56          return new GZIPInputStream(wrapped);
57      }
58  
59      /**
60       * {@inheritDoc}
61       */
62      @Override
63      public Header getContentEncoding() {
64  
65          /* This HttpEntityWrapper has dealt with the Content-Encoding. */
66          return null;
67      }
68  
69      /**
70       * {@inheritDoc}
71       */
72      @Override
73      public long getContentLength() {
74  
75          /* length of ungzipped content is not known */
76          return -1;
77      }
78  
79  }