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