001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027package org.apache.http.conn.params;
028
029/**
030 * Parameter names for connection routing.
031 *
032 * @since 4.0
033 *
034 * @deprecated (4.3) use {@link org.apache.http.client.config.RequestConfig}.
035 */
036@Deprecated
037public interface ConnRoutePNames {
038
039    /**
040     * Parameter for the default proxy.
041     * The default value will be used by some
042     * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
043     * implementations, in particular the default implementation.
044     * <p>
045     * This parameter expects a value of type {@link org.apache.http.HttpHost}.
046     * </p>
047     */
048    public static final String DEFAULT_PROXY = "http.route.default-proxy";
049
050    /**
051     * Parameter for the local address.
052     * On machines with multiple network interfaces, this parameter
053     * can be used to select the network interface from which the
054     * connection originates.
055     * It will be interpreted by the standard
056     * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
057     * implementations, in particular the default implementation.
058     * <p>
059     * This parameter expects a value of type {@link java.net.InetAddress}.
060     * </p>
061     */
062    public static final String LOCAL_ADDRESS = "http.route.local-address";
063
064    /**
065     * Parameter for an forced route.
066     * The forced route will be interpreted by the standard
067     * {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
068     * implementations.
069     * Instead of computing a route, the given forced route will be
070     * returned, even if it points to the wrong target host.
071     * <p>
072     * This parameter expects a value of type
073     * {@link org.apache.http.conn.routing.HttpRoute HttpRoute}.
074     * </p>
075     */
076    public static final String FORCED_ROUTE = "http.route.forced-route";
077
078}
079