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  
32  import org.apache.http.Header;
33  import org.apache.http.HttpEntity;
34  
35  /**
36   * {@link org.apache.http.entity.HttpEntityWrapper} responsible for handling
37   * deflate Content Coded responses. In RFC2616 terms, <code>deflate</code>
38   * means a <code>zlib</code> stream as defined in RFC1950. Some server
39   * implementations have misinterpreted RFC2616 to mean that a
40   * <code>deflate</code> stream as defined in RFC1951 should be used
41   * (or maybe they did that since that's how IE behaves?). It's confusing
42   * that <code>deflate</code> in HTTP 1.1 means <code>zlib</code> streams
43   * rather than <code>deflate</code> streams. We handle both types in here,
44   * since that's what is seen on the internet. Moral - prefer
45   * <code>gzip</code>!
46   *
47   * @see GzipDecompressingEntity
48   *
49   * @since 4.1
50   */
51  public class DeflateDecompressingEntity extends DecompressingEntity {
52  
53      /**
54       * Creates a new {@link DeflateDecompressingEntity} which will wrap the specified
55       * {@link HttpEntity}.
56       *
57       * @param entity
58       *            a non-null {@link HttpEntity} to be wrapped
59       */
60      public DeflateDecompressingEntity(final HttpEntity entity) {
61          super(entity);
62      }
63  
64      /**
65       * Returns the non-null InputStream that should be returned to by all requests to
66       * {@link #getContent()}.
67       *
68       * @return a non-null InputStream
69       * @throws IOException if there was a problem
70       */
71      @Override
72      InputStream decorate(final InputStream wrapped) throws IOException {
73          return new DeflateInputStream(wrapped);
74      }
75  
76      /**
77       * {@inheritDoc}
78       */
79      @Override
80      public Header getContentEncoding() {
81  
82          /* This HttpEntityWrapper has dealt with the Content-Encoding. */
83          return null;
84      }
85  
86      /**
87       * {@inheritDoc}
88       */
89      @Override
90      public long getContentLength() {
91  
92          /* Length of inflated content is unknown. */
93          return -1;
94      }
95  
96  }