mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionOperator.java@fc2d59ddac77 (annotated)
mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionOperator.java
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
| 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; |
| michael@0 | 29 | |
| michael@0 | 30 | import java.io.IOException; |
| michael@0 | 31 | import java.net.InetAddress; |
| michael@0 | 32 | import java.net.Socket; |
| michael@0 | 33 | |
| michael@0 | 34 | import ch.boye.httpclientandroidlib.HttpHost; |
| michael@0 | 35 | import ch.boye.httpclientandroidlib.conn.scheme.SchemeSocketFactory; |
| michael@0 | 36 | import ch.boye.httpclientandroidlib.params.HttpParams; |
| michael@0 | 37 | import ch.boye.httpclientandroidlib.protocol.HttpContext; |
| michael@0 | 38 | |
| michael@0 | 39 | /** |
| michael@0 | 40 | * ClientConnectionOperator represents a strategy for creating |
| michael@0 | 41 | * {@link OperatedClientConnection} instances and updating the underlying |
| michael@0 | 42 | * {@link Socket} of those objects. Implementations will most likely make use |
| michael@0 | 43 | * of {@link SchemeSocketFactory}s to create {@link Socket} instances. |
| michael@0 | 44 | * <p> |
| michael@0 | 45 | * The methods in this interface allow the creation of plain and layered |
| michael@0 | 46 | * sockets. Creating a tunnelled connection through a proxy, however, |
| michael@0 | 47 | * is not within the scope of the operator. |
| michael@0 | 48 | * <p> |
| michael@0 | 49 | * Implementations of this interface must be thread-safe. Access to shared |
| michael@0 | 50 | * data must be synchronized as methods of this interface may be executed |
| michael@0 | 51 | * from multiple threads. |
| michael@0 | 52 | * |
| michael@0 | 53 | * @since 4.0 |
| michael@0 | 54 | */ |
| michael@0 | 55 | public interface ClientConnectionOperator { |
| michael@0 | 56 | |
| michael@0 | 57 | /** |
| michael@0 | 58 | * Creates a new connection that can be operated. |
| michael@0 | 59 | * |
| michael@0 | 60 | * @return a new, unopened connection for use with this operator |
| michael@0 | 61 | */ |
| michael@0 | 62 | OperatedClientConnection createConnection(); |
| michael@0 | 63 | |
| michael@0 | 64 | /** |
| michael@0 | 65 | * Opens a connection to the given target host. |
| michael@0 | 66 | * |
| michael@0 | 67 | * @param conn the connection to open |
| michael@0 | 68 | * @param target the target host to connect to |
| michael@0 | 69 | * @param local the local address to route from, or |
| michael@0 | 70 | * <code>null</code> for the default |
| michael@0 | 71 | * @param context the context for the connection |
| michael@0 | 72 | * @param params the parameters for the connection |
| michael@0 | 73 | * |
| michael@0 | 74 | * @throws IOException in case of a problem |
| michael@0 | 75 | */ |
| michael@0 | 76 | void openConnection(OperatedClientConnection conn, |
| michael@0 | 77 | HttpHost target, |
| michael@0 | 78 | InetAddress local, |
| michael@0 | 79 | HttpContext context, |
| michael@0 | 80 | HttpParams params) |
| michael@0 | 81 | throws IOException; |
| michael@0 | 82 | |
| michael@0 | 83 | /** |
| michael@0 | 84 | * Updates a connection with a layered secure connection. |
| michael@0 | 85 | * The typical use of this method is to update a tunnelled plain |
| michael@0 | 86 | * connection (HTTP) to a secure TLS/SSL connection (HTTPS). |
| michael@0 | 87 | * |
| michael@0 | 88 | * @param conn the open connection to update |
| michael@0 | 89 | * @param target the target host for the updated connection. |
| michael@0 | 90 | * The connection must already be open or tunnelled |
| michael@0 | 91 | * to the host and port, but the scheme of the target |
| michael@0 | 92 | * will be used to create a layered connection. |
| michael@0 | 93 | * @param context the context for the connection |
| michael@0 | 94 | * @param params the parameters for the updated connection |
| michael@0 | 95 | * |
| michael@0 | 96 | * @throws IOException in case of a problem |
| michael@0 | 97 | */ |
| michael@0 | 98 | void updateSecureConnection(OperatedClientConnection conn, |
| michael@0 | 99 | HttpHost target, |
| michael@0 | 100 | HttpContext context, |
| michael@0 | 101 | HttpParams params) |
| michael@0 | 102 | throws IOException; |
| michael@0 | 103 | |
| michael@0 | 104 | } |
| michael@0 | 105 |
