View Javadoc

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