View Javadoc

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  package org.apache.http.conn.params;
28  
29  /**
30   * Parameter names for connection routing.
31   *
32   * @since 4.0
33   *
34   * @deprecated (4.3) use {@link org.apache.http.client.config.RequestConfig}.
35   */
36  @Deprecated
37  public interface ConnRoutePNames {
38  
39      /**
40       * Parameter for the default proxy.
41       * The default value will be used by some
42       * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
43       * implementations, in particular the default implementation.
44       * <p>
45       * This parameter expects a value of type {@link org.apache.http.HttpHost}.
46       * </p>
47       */
48      public static final String DEFAULT_PROXY = "http.route.default-proxy";
49  
50      /**
51       * Parameter for the local address.
52       * On machines with multiple network interfaces, this parameter
53       * can be used to select the network interface from which the
54       * connection originates.
55       * It will be interpreted by the standard
56       * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
57       * implementations, in particular the default implementation.
58       * <p>
59       * This parameter expects a value of type {@link java.net.InetAddress}.
60       * </p>
61       */
62      public static final String LOCAL_ADDRESS = "http.route.local-address";
63  
64      /**
65       * Parameter for an forced route.
66       * The forced route will be interpreted by the standard
67       * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
68       * implementations.
69       * Instead of computing a route, the given forced route will be
70       * returned, even if it points to the wrong target host.
71       * <p>
72       * This parameter expects a value of type
73       * {@link org.apache.http.conn.routing.HttpRoute HttpRoute}.
74       * </p>
75       */
76      public static final String FORCED_ROUTE = "http.route.forced-route";
77  
78  }
79