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.http.HttpException;
33 import org.apache.http.HttpRequest;
34 import org.apache.http.annotation.Immutable;
35 import org.apache.http.auth.AUTH;
36 import org.apache.http.auth.AuthState;
37 import org.apache.http.conn.HttpRoutedConnection;
38 import org.apache.http.conn.routing.HttpRoute;
39 import org.apache.http.protocol.ExecutionContext;
40 import org.apache.http.protocol.HttpContext;
41
42 /**
43 * Generates authentication header for the proxy host, if required,
44 * based on the actual state of the HTTP authentication context.
45 *
46 * @since 4.0
47 */
48 @Immutable
49 public class RequestProxyAuthentication extends RequestAuthenticationBase {
50
51 public RequestProxyAuthentication() {
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 (context == null) {
61 throw new IllegalArgumentException("HTTP context may not be null");
62 }
63
64 if (request.containsHeader(AUTH.PROXY_AUTH_RESP)) {
65 return;
66 }
67
68 HttpRoutedConnection conn = (HttpRoutedConnection) context.getAttribute(
69 ExecutionContext.HTTP_CONNECTION);
70 if (conn == null) {
71 this.log.debug("HTTP connection not set in the context");
72 return;
73 }
74 HttpRoute route = conn.getRoute();
75 if (route.isTunnelled()) {
76 return;
77 }
78
79 // Obtain authentication state
80 AuthState authState = (AuthState) context.getAttribute(
81 ClientContext.PROXY_AUTH_STATE);
82 if (authState == null) {
83 this.log.debug("Proxy auth state not set in the context");
84 return;
85 }
86 if (this.log.isDebugEnabled()) {
87 this.log.debug("Proxy auth state: " + authState.getState());
88 }
89 process(authState, request, context);
90 }
91
92 }