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.impl.client;
28  
29  import org.apache.http.annotation.ThreadSafe;
30  import org.apache.http.client.HttpClient;
31  import org.apache.http.client.protocol.RequestAcceptEncoding;
32  import org.apache.http.client.protocol.ResponseContentEncoding;
33  import org.apache.http.conn.ClientConnectionManager;
34  import org.apache.http.params.HttpParams;
35  import org.apache.http.protocol.BasicHttpProcessor;
36  
37  /**
38   * {@link DefaultHttpClient} sub-class which includes a {@link RequestAcceptEncoding}
39   * for the request and response.
40   * 
41   * <b>Deprecation note:</b> due to the way this class modifies a response body
42   * without changing the response headers to reflect the entity changes, it cannot
43   * be used as the &quot;backend&quot; for a caching {@link HttpClient} and still
44   * have uncompressed responses be cached. Users are encouraged to use the
45   * {@link DecompressingHttpClient} instead of this class, which can be wired in
46   * either before or after caching, depending on whether you want to cache
47   * responses in compressed or uncompressed form.
48   *
49   * @since 4.1
50   */
51  @Deprecated
52  @ThreadSafe // since DefaultHttpClient is
53  public class ContentEncodingHttpClient extends DefaultHttpClient {
54  
55      /**
56       * Creates a new HTTP client from parameters and a connection manager.
57       *
58       * @param params    the parameters
59       * @param conman    the connection manager
60       */
61      public ContentEncodingHttpClient(ClientConnectionManager conman, HttpParams params) {
62          super(conman, params);
63      }
64  
65      /**
66       * @param params
67       */
68      public ContentEncodingHttpClient(HttpParams params) {
69          this(null, params);
70      }
71  
72      /**
73       *
74       */
75      public ContentEncodingHttpClient() {
76          this(null);
77      }
78  
79      /**
80       * {@inheritDoc}
81       */
82      @Override
83      protected BasicHttpProcessor createHttpProcessor() {
84          BasicHttpProcessor result = super.createHttpProcessor();
85  
86          result.addRequestInterceptor(new RequestAcceptEncoding());
87          result.addResponseInterceptor(new ResponseContentEncoding());
88  
89          return result;
90      }
91  
92  }