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.hc.client5.http.protocol;
29
30 import java.io.IOException;
31 import java.util.Collection;
32
33 import org.apache.hc.core5.annotation.Contract;
34 import org.apache.hc.core5.annotation.ThreadingBehavior;
35 import org.apache.hc.core5.http.EntityDetails;
36 import org.apache.hc.core5.http.Header;
37 import org.apache.hc.core5.http.HttpException;
38 import org.apache.hc.core5.http.HttpRequest;
39 import org.apache.hc.core5.http.HttpRequestInterceptor;
40 import org.apache.hc.core5.http.Method;
41 import org.apache.hc.core5.http.protocol.HttpContext;
42 import org.apache.hc.core5.util.Args;
43
44 /**
45 * Request interceptor that adds default request headers.
46 *
47 * @since 4.0
48 */
49 @Contract(threading = ThreadingBehavior.STATELESS)
50 public class RequestDefaultHeaders implements HttpRequestInterceptor {
51
52 /**
53 * Singleton instance.
54 *
55 * @since 5.2
56 */
57 public static final RequestDefaultHeaders INSTANCE = new RequestDefaultHeaders();
58
59 private final Collection<? extends Header> defaultHeaders;
60
61 /**
62 * @since 4.3
63 */
64 public RequestDefaultHeaders(final Collection<? extends Header> defaultHeaders) {
65 super();
66 this.defaultHeaders = defaultHeaders;
67 }
68
69 public RequestDefaultHeaders() {
70 this(null);
71 }
72
73 @Override
74 public void process(final HttpRequest request, final EntityDetails entity, final HttpContext context)
75 throws HttpException, IOException {
76 Args.notNull(request, "HTTP request");
77
78 final String method = request.getMethod();
79 if (Method.CONNECT.isSame(method)) {
80 return;
81 }
82
83 if (this.defaultHeaders != null) {
84 for (final Header defHeader : this.defaultHeaders) {
85 if(!request.containsHeader(defHeader.getName())) {
86 request.addHeader(defHeader);
87 }
88 }
89 }
90 }
91
92 }