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  
28  package org.apache.http.client.protocol;
29  
30  import java.io.IOException;
31  
32  import org.apache.commons.logging.Log;
33  import org.apache.commons.logging.LogFactory;
34  import org.apache.http.HttpException;
35  import org.apache.http.HttpRequest;
36  import org.apache.http.HttpRequestInterceptor;
37  import org.apache.http.annotation.Immutable;
38  import org.apache.http.conn.routing.RouteInfo;
39  import org.apache.http.protocol.HTTP;
40  import org.apache.http.protocol.HttpContext;
41  import org.apache.http.util.Args;
42  
43  /**
44   * This protocol interceptor is responsible for adding {@code Connection}
45   * or {@code Proxy-Connection} headers to the outgoing requests, which
46   * is essential for managing persistence of {@code HTTP/1.0} connections.
47   *
48   * @since 4.0
49   */
50  @Immutable
51  public class RequestClientConnControl implements HttpRequestInterceptor {
52  
53      private final Log log = LogFactory.getLog(getClass());
54  
55      private static final String PROXY_CONN_DIRECTIVE = "Proxy-Connection";
56  
57      public RequestClientConnControl() {
58          super();
59      }
60  
61      @Override
62      public void process(final HttpRequest request, final HttpContext context)
63              throws HttpException, IOException {
64          Args.notNull(request, "HTTP request");
65  
66          final String method = request.getRequestLine().getMethod();
67          if (method.equalsIgnoreCase("CONNECT")) {
68              request.setHeader(PROXY_CONN_DIRECTIVE, HTTP.CONN_KEEP_ALIVE);
69              return;
70          }
71  
72          final HttpClientContext clientContext = HttpClientContext.adapt(context);
73  
74          // Obtain the client connection (required)
75          final RouteInfo route = clientContext.getHttpRoute();
76          if (route == null) {
77              this.log.debug("Connection route not set in the context");
78              return;
79          }
80  
81          if (route.getHopCount() == 1 || route.isTunnelled()) {
82              if (!request.containsHeader(HTTP.CONN_DIRECTIVE)) {
83                  request.addHeader(HTTP.CONN_DIRECTIVE, HTTP.CONN_KEEP_ALIVE);
84              }
85          }
86          if (route.getHopCount() == 2 && !route.isTunnelled()) {
87              if (!request.containsHeader(PROXY_CONN_DIRECTIVE)) {
88                  request.addHeader(PROXY_CONN_DIRECTIVE, HTTP.CONN_KEEP_ALIVE);
89              }
90          }
91      }
92  
93  }