|
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 ch.boye.httpclientandroidlib.protocol; |
|
29 |
|
30 import java.io.IOException; |
|
31 |
|
32 import ch.boye.httpclientandroidlib.HttpException; |
|
33 import ch.boye.httpclientandroidlib.HttpRequest; |
|
34 import ch.boye.httpclientandroidlib.HttpRequestInterceptor; |
|
35 import ch.boye.httpclientandroidlib.params.HttpProtocolParams; |
|
36 |
|
37 /** |
|
38 * RequestUserAgent is responsible for adding <code>User-Agent</code> header. |
|
39 * This interceptor is recommended for client side protocol processors. |
|
40 * <p> |
|
41 * The following parameters can be used to customize the behavior of this |
|
42 * class: |
|
43 * <ul> |
|
44 * <li>{@link ch.boye.httpclientandroidlib.params.CoreProtocolPNames#USER_AGENT}</li> |
|
45 * </ul> |
|
46 * |
|
47 * @since 4.0 |
|
48 */ |
|
49 public class RequestUserAgent implements HttpRequestInterceptor { |
|
50 |
|
51 public RequestUserAgent() { |
|
52 super(); |
|
53 } |
|
54 |
|
55 public void process(final HttpRequest request, final HttpContext context) |
|
56 throws HttpException, IOException { |
|
57 if (request == null) { |
|
58 throw new IllegalArgumentException("HTTP request may not be null"); |
|
59 } |
|
60 if (!request.containsHeader(HTTP.USER_AGENT)) { |
|
61 String useragent = HttpProtocolParams.getUserAgent(request.getParams()); |
|
62 if (useragent != null) { |
|
63 request.addHeader(HTTP.USER_AGENT, useragent); |
|
64 } |
|
65 } |
|
66 } |
|
67 |
|
68 } |