The Tor Browser / file comparison

comparison: mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/scheme/SchemeSocketFactory.java

mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/scheme/SchemeSocketFactory.java

branch
TOR_BUG_3246
changeset 4
fc2d59ddac77
equal deleted inserted replaced
-1:000000000000 0:0069c4e9be9a
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
28 package ch.boye.httpclientandroidlib.conn.scheme;
29
30 import java.io.IOException;
31 import java.net.InetSocketAddress;
32 import java.net.Socket;
33 import java.net.UnknownHostException;
34
35 import ch.boye.httpclientandroidlib.conn.ConnectTimeoutException;
36 import ch.boye.httpclientandroidlib.params.HttpParams;
37
38 /**
39 * A factory for creating, initializing and connecting sockets. The factory encapsulates the logic
40 * for establishing a socket connection.
41 *
42 * @since 4.1
43 */
44 public interface SchemeSocketFactory {
45
46 /**
47 * Creates a new, unconnected socket. The socket should subsequently be passed to
48 * {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}.
49 *
50 * @param params Optional {@link HttpParams parameters}. In most cases these parameters
51 * will not be required and will have no effect, as usually socket
52 * initialization should take place in the
53 * {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams)}
54 * method. However, in rare cases one may want to pass additional parameters
55 * to this method in order to create a customized {@link Socket} instance,
56 * for instance bound to a SOCKS proxy server.
57 *
58 * @return a new socket
59 *
60 * @throws IOException if an I/O error occurs while creating the socket
61 */
62 Socket createSocket(HttpParams params) throws IOException;
63
64 /**
65 * Connects a socket to the target host with the given remote address.
66 *
67 * @param sock the socket to connect, as obtained from
68 * {@link #createSocket(HttpParams) createSocket}.
69 * <code>null</code> indicates that a new socket
70 * should be created and connected.
71 * @param remoteAddress the remote address to connect to
72 * @param localAddress the local address to bind the socket to, or
73 * <code>null</code> for any
74 * @param params additional {@link HttpParams parameters} for connecting
75 *
76 * @return the connected socket. The returned object may be different
77 * from the <code>sock</code> argument if this factory supports
78 * a layered protocol.
79 *
80 * @throws IOException if an I/O error occurs
81 * @throws UnknownHostException if the IP address of the target host
82 * can not be determined
83 * @throws ConnectTimeoutException if the socket cannot be connected
84 * within the time limit defined in the <code>params</code>
85 */
86 Socket connectSocket(
87 Socket sock,
88 InetSocketAddress remoteAddress,
89 InetSocketAddress localAddress,
90 HttpParams params) throws IOException, UnknownHostException, ConnectTimeoutException;
91
92 /**
93 * Checks whether a socket provides a secure connection. The socket must be
94 * {@link #connectSocket(Socket, InetSocketAddress, InetSocketAddress, HttpParams) connected}
95 * by this factory. The factory will <i>not</i> perform I/O operations in this method.
96 * <p>
97 * As a rule of thumb, plain sockets are not secure and TLS/SSL sockets are secure. However,
98 * there may be application specific deviations. For example, a plain socket to a host in the
99 * same intranet ("trusted zone") could be considered secure. On the other hand, a TLS/SSL
100 * socket could be considered insecure based on the cipher suite chosen for the connection.
101 *
102 * @param sock the connected socket to check
103 *
104 * @return <code>true</code> if the connection of the socket
105 * should be considered secure, or
106 * <code>false</code> if it should not
107 *
108 * @throws IllegalArgumentException
109 * if the argument is invalid, for example because it is
110 * not a connected socket or was created by a different
111 * socket factory.
112 * Note that socket factories are <i>not</i> required to
113 * check these conditions, they may simply return a default
114 * value when called with an invalid socket argument.
115 */
116 boolean isSecure(Socket sock) throws IllegalArgumentException;
117
118 }

Mercurial Repository: The Tor Browser

Europalab SCM Repository Server

mercurial