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