Home | History | Annotate | Download | only in routing
      1 <html>
      2 <head>
      3 <!--
      4 /*
      5  * $HeadURL: http://svn.apache.org/repos/asf/httpcomponents/httpclient/trunk/module-client/src/main/java/org/apache/http/conn/routing/package.html $
      6  * $Revision: 613656 $
      7  * $Date: 2008-01-20 11:06:56 -0800 (Sun, 20 Jan 2008) $
      8  *
      9  * ====================================================================
     10  * Licensed to the Apache Software Foundation (ASF) under one
     11  * or more contributor license agreements.  See the NOTICE file
     12  * distributed with this work for additional information
     13  * regarding copyright ownership.  The ASF licenses this file
     14  * to you under the Apache License, Version 2.0 (the
     15  * "License"); you may not use this file except in compliance
     16  * with the License.  You may obtain a copy of the License at
     17  *
     18  *   http://www.apache.org/licenses/LICENSE-2.0
     19  *
     20  * Unless required by applicable law or agreed to in writing,
     21  * software distributed under the License is distributed on an
     22  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
     23  * KIND, either express or implied.  See the License for the
     24  * specific language governing permissions and limitations
     25  * under the License.
     26  * ====================================================================
     27  *
     28  * This software consists of voluntary contributions made by many
     29  * individuals on behalf of the Apache Software Foundation.  For more
     30  * information on the Apache Software Foundation, please see
     31  * <http://www.apache.org/>.
     32  *
     33  */
     34 -->
     35 </head>
     36 <body>
     37 The client-side route representation and tracking API, part of <i>HttpConn</i>.
     38 
     39 <p>
     40 An {@link org.apache.http.conn.routing.HttpRoute HttpRoute}
     41 is the path along which a request has to be sent to the server.
     42 The route starts at a local network address and may pass
     43 through one or more proxies before reaching the target.
     44 Routes through proxies can be tunnelled, and a layered protocol (TLS/SSL)
     45 might be put on top of the tunnel.
     46 The {@link org.apache.http.conn.routing.RouteTracker RouteTracker}
     47 helps in tracking the steps for establishing a route, while an
     48 {@link org.apache.http.conn.routing.HttpRouteDirector HttpRouteDirector}
     49 determines the next step to take.
     50 </p>
     51 
     52 
     53 <p>
     54 The {@link org.apache.http.conn.routing.HttpRoutePlanner HttpRoutePlanner}
     55 is responsible for determining a route to a given target host.
     56 Implementations must know about proxies to use, and about exemptions
     57 for hosts that should be contacted directly without a proxy.
     58 </p>
     59 
     60 
     61 </body>
     62 </html>
     63