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  import java.util.Collection;
32  
33  import org.apache.http.Header;
34  import org.apache.http.HttpException;
35  import org.apache.http.HttpRequest;
36  import org.apache.http.HttpRequestInterceptor;
37  import org.apache.http.annotation.Contract;
38  import org.apache.http.annotation.ThreadingBehavior;
39  import org.apache.http.client.params.ClientPNames;
40  import org.apache.http.protocol.HttpContext;
41  import org.apache.http.util.Args;
42  
43  /**
44   * Request interceptor that adds default request headers.
45   *
46   * @since 4.0
47   */
48  @SuppressWarnings("deprecation")
49  @Contract(threading = ThreadingBehavior.IMMUTABLE_CONDITIONAL)
50  public class RequestDefaultHeaders implements HttpRequestInterceptor {
51  
52      private final Collection<? extends Header> defaultHeaders;
53  
54      /**
55       * @since 4.3
56       */
57      public RequestDefaultHeaders(final Collection<? extends Header> defaultHeaders) {
58          super();
59          this.defaultHeaders = defaultHeaders;
60      }
61  
62      public RequestDefaultHeaders() {
63          this(null);
64      }
65  
66      @Override
67      public void process(final HttpRequest request, final HttpContext context)
68              throws HttpException, IOException {
69          Args.notNull(request, "HTTP request");
70  
71          final String method = request.getRequestLine().getMethod();
72          if (method.equalsIgnoreCase("CONNECT")) {
73              return;
74          }
75  
76          // Add default headers
77          @SuppressWarnings("unchecked")
78          Collection<? extends Header> defHeaders = (Collection<? extends Header>)
79              request.getParams().getParameter(ClientPNames.DEFAULT_HEADERS);
80          if (defHeaders == null) {
81              defHeaders = this.defaultHeaders;
82          }
83  
84          if (defHeaders != null) {
85              for (final Header defHeader : defHeaders) {
86                  request.addHeader(defHeader);
87              }
88          }
89      }
90  
91  }