mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/routing/HttpRoutePlanner.java@6474c204b198 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/routing/HttpRoutePlanner.java
Wed, 31 Dec 2014 06:09:35 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 06:09:35 +0100
- changeset 0
- 6474c204b198
- permissions
- -rw-r--r--
Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.
| michael@0 | 1 | /* |
| michael@0 | 2 | * ==================================================================== |
| michael@0 | 3 | * Licensed to the Apache Software Foundation (ASF) under one |
| michael@0 | 4 | * or more contributor license agreements. See the NOTICE file |
| michael@0 | 5 | * distributed with this work for additional information |
| michael@0 | 6 | * regarding copyright ownership. The ASF licenses this file |
| michael@0 | 7 | * to you under the Apache License, Version 2.0 (the |
| michael@0 | 8 | * "License"); you may not use this file except in compliance |
| michael@0 | 9 | * with the License. You may obtain a copy of the License at |
| michael@0 | 10 | * |
| michael@0 | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
| michael@0 | 12 | * |
| michael@0 | 13 | * Unless required by applicable law or agreed to in writing, |
| michael@0 | 14 | * software distributed under the License is distributed on an |
| michael@0 | 15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| michael@0 | 16 | * KIND, either express or implied. See the License for the |
| michael@0 | 17 | * specific language governing permissions and limitations |
| michael@0 | 18 | * under the License. |
| michael@0 | 19 | * ==================================================================== |
| michael@0 | 20 | * |
| michael@0 | 21 | * This software consists of voluntary contributions made by many |
| michael@0 | 22 | * individuals on behalf of the Apache Software Foundation. For more |
| michael@0 | 23 | * information on the Apache Software Foundation, please see |
| michael@0 | 24 | * <http://www.apache.org/>. |
| michael@0 | 25 | * |
| michael@0 | 26 | */ |
| michael@0 | 27 | |
| michael@0 | 28 | package ch.boye.httpclientandroidlib.conn.routing; |
| michael@0 | 29 | |
| michael@0 | 30 | import ch.boye.httpclientandroidlib.HttpException; |
| michael@0 | 31 | import ch.boye.httpclientandroidlib.HttpHost; |
| michael@0 | 32 | import ch.boye.httpclientandroidlib.HttpRequest; |
| michael@0 | 33 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 34 | |
| michael@0 | 35 | /** |
| michael@0 | 36 | * Encapsulates logic to compute a {@link HttpRoute} to a target host. |
| michael@0 | 37 | * Implementations may for example be based on parameters, or on the |
| michael@0 | 38 | * standard Java system properties. |
| michael@0 | 39 | * <p> |
| michael@0 | 40 | * Implementations of this interface must be thread-safe. Access to shared |
| michael@0 | 41 | * data must be synchronized as methods of this interface may be executed |
| michael@0 | 42 | * from multiple threads. |
| michael@0 | 43 | * |
| michael@0 | 44 | * @since 4.0 |
| michael@0 | 45 | */ |
| michael@0 | 46 | public interface HttpRoutePlanner { |
| michael@0 | 47 | |
| michael@0 | 48 | /** |
| michael@0 | 49 | * Determines the route for a request. |
| michael@0 | 50 | * |
| michael@0 | 51 | * @param target the target host for the request. |
| michael@0 | 52 | * Implementations may accept <code>null</code> |
| michael@0 | 53 | * if they can still determine a route, for example |
| michael@0 | 54 | * to a default target or by inspecting the request. |
| michael@0 | 55 | * @param request the request to execute |
| michael@0 | 56 | * @param context the context to use for the subsequent execution. |
| michael@0 | 57 | * Implementations may accept <code>null</code>. |
| michael@0 | 58 | * |
| michael@0 | 59 | * @return the route that the request should take |
| michael@0 | 60 | * |
| michael@0 | 61 | * @throws HttpException in case of a problem |
| michael@0 | 62 | */ |
| michael@0 | 63 | public HttpRoute determineRoute(HttpHost target, |
| michael@0 | 64 | HttpRequest request, |
| michael@0 | 65 | HttpContext context) throws HttpException; |
| michael@0 | 66 | |
| michael@0 | 67 | } |
