1 /*
2 * ====================================================================
3 *
4 * Licensed to the Apache Software Foundation (ASF) under one or more
5 * contributor license agreements. See the NOTICE file distributed with
6 * this work for additional information regarding copyright ownership.
7 * The ASF licenses this file to You under the Apache License, Version 2.0
8 * (the "License"); you may not use this file except in compliance with
9 * 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, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 * ====================================================================
19 *
20 * This software consists of voluntary contributions made by many
21 * individuals on behalf of the Apache Software Foundation. For more
22 * information on the Apache Software Foundation, please see
23 * <http://www.apache.org/>.
24 *
25 */
26
27 package org.apache.http.conn.params;
28
29 /**
30 * Parameter names for connection routing.
31 *
32 * @since 4.0
33 */
34 public interface ConnRoutePNames {
35
36 /**
37 * Parameter for the default proxy.
38 * The default value will be used by some
39 * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
40 * implementations, in particular the default implementation.
41 * <p>
42 * This parameter expects a value of type {@link org.apache.http.HttpHost}.
43 * </p>
44 */
45 public static final String DEFAULT_PROXY = "http.route.default-proxy";
46
47 /**
48 * Parameter for the local address.
49 * On machines with multiple network interfaces, this parameter
50 * can be used to select the network interface from which the
51 * connection originates.
52 * It will be interpreted by the standard
53 * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
54 * implementations, in particular the default implementation.
55 * <p>
56 * This parameter expects a value of type {@link java.net.InetAddress}.
57 * </p>
58 */
59 public static final String LOCAL_ADDRESS = "http.route.local-address";
60
61 /**
62 * Parameter for an forced route.
63 * The forced route will be interpreted by the standard
64 * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
65 * implementations.
66 * Instead of computing a route, the given forced route will be
67 * returned, even if it points to the wrong target host.
68 * <p>
69 * This parameter expects a value of type
70 * {@link org.apache.http.conn.routing.HttpRoute HttpRoute}.
71 * </p>
72 */
73 public static final String FORCED_ROUTE = "http.route.forced-route";
74
75 }
76