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.Contract;
30  import org.apache.http.annotation.ThreadingBehavior;
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
44   * org.apache.http.client.HttpClient} and still have uncompressed responses be cached.
45   * Users are encouraged to use the {@link DecompressingHttpClient} instead
46   * of this class, which can be wired in either before or after caching, depending on
47   * whether you want to cache responses in compressed or uncompressed form.
48   *
49   * @since 4.1
50   *
51   * @deprecated (4.2) use {@link HttpClientBuilder}
52   */
53  @Deprecated
54  @Contract(threading = ThreadingBehavior.SAFE_CONDITIONAL) // since DefaultHttpClient is
55  public class ContentEncodingHttpClient extends DefaultHttpClient {
56  
57      /**
58       * Creates a new HTTP client from parameters and a connection manager.
59       *
60       * @param params    the parameters
61       * @param conman    the connection manager
62       */
63      public ContentEncodingHttpClient(final ClientConnectionManager conman, final HttpParams params) {
64          super(conman, params);
65      }
66  
67      /**
68       * @param params
69       */
70      public ContentEncodingHttpClient(final HttpParams params) {
71          this(null, params);
72      }
73  
74      /**
75       *
76       */
77      public ContentEncodingHttpClient() {
78          this(null);
79      }
80  
81      /**
82       * {@inheritDoc}
83       */
84      @Override
85      protected BasicHttpProcessor createHttpProcessor() {
86          final BasicHttpProcessor result = super.createHttpProcessor();
87  
88          result.addRequestInterceptor(new RequestAcceptEncoding());
89          result.addResponseInterceptor(new ResponseContentEncoding());
90  
91          return result;
92      }
93  
94  }