1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/mobile/android/thirdparty/ch/boye/httpclientandroidlib/conn/ClientConnectionOperator.java Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,105 @@
1.4 +/*
1.5 + * ====================================================================
1.6 + * Licensed to the Apache Software Foundation (ASF) under one
1.7 + * or more contributor license agreements. See the NOTICE file
1.8 + * distributed with this work for additional information
1.9 + * regarding copyright ownership. The ASF licenses this file
1.10 + * to you under the Apache License, Version 2.0 (the
1.11 + * "License"); you may not use this file except in compliance
1.12 + * with the License. You may obtain a copy of the License at
1.13 + *
1.14 + * http://www.apache.org/licenses/LICENSE-2.0
1.15 + *
1.16 + * Unless required by applicable law or agreed to in writing,
1.17 + * software distributed under the License is distributed on an
1.18 + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
1.19 + * KIND, either express or implied. See the License for the
1.20 + * specific language governing permissions and limitations
1.21 + * under the License.
1.22 + * ====================================================================
1.23 + *
1.24 + * This software consists of voluntary contributions made by many
1.25 + * individuals on behalf of the Apache Software Foundation. For more
1.26 + * information on the Apache Software Foundation, please see
1.27 + * <http://www.apache.org/>.
1.28 + *
1.29 + */
1.30 +
1.31 +package ch.boye.httpclientandroidlib.conn;
1.32 +
1.33 +import java.io.IOException;
1.34 +import java.net.InetAddress;
1.35 +import java.net.Socket;
1.36 +
1.37 +import ch.boye.httpclientandroidlib.HttpHost;
1.38 +import ch.boye.httpclientandroidlib.conn.scheme.SchemeSocketFactory;
1.39 +import ch.boye.httpclientandroidlib.params.HttpParams;
1.40 +import ch.boye.httpclientandroidlib.protocol.HttpContext;
1.41 +
1.42 +/**
1.43 + * ClientConnectionOperator represents a strategy for creating
1.44 + * {@link OperatedClientConnection} instances and updating the underlying
1.45 + * {@link Socket} of those objects. Implementations will most likely make use
1.46 + * of {@link SchemeSocketFactory}s to create {@link Socket} instances.
1.47 + * <p>
1.48 + * The methods in this interface allow the creation of plain and layered
1.49 + * sockets. Creating a tunnelled connection through a proxy, however,
1.50 + * is not within the scope of the operator.
1.51 + * <p>
1.52 + * Implementations of this interface must be thread-safe. Access to shared
1.53 + * data must be synchronized as methods of this interface may be executed
1.54 + * from multiple threads.
1.55 + *
1.56 + * @since 4.0
1.57 + */
1.58 +public interface ClientConnectionOperator {
1.59 +
1.60 + /**
1.61 + * Creates a new connection that can be operated.
1.62 + *
1.63 + * @return a new, unopened connection for use with this operator
1.64 + */
1.65 + OperatedClientConnection createConnection();
1.66 +
1.67 + /**
1.68 + * Opens a connection to the given target host.
1.69 + *
1.70 + * @param conn the connection to open
1.71 + * @param target the target host to connect to
1.72 + * @param local the local address to route from, or
1.73 + * <code>null</code> for the default
1.74 + * @param context the context for the connection
1.75 + * @param params the parameters for the connection
1.76 + *
1.77 + * @throws IOException in case of a problem
1.78 + */
1.79 + void openConnection(OperatedClientConnection conn,
1.80 + HttpHost target,
1.81 + InetAddress local,
1.82 + HttpContext context,
1.83 + HttpParams params)
1.84 + throws IOException;
1.85 +
1.86 + /**
1.87 + * Updates a connection with a layered secure connection.
1.88 + * The typical use of this method is to update a tunnelled plain
1.89 + * connection (HTTP) to a secure TLS/SSL connection (HTTPS).
1.90 + *
1.91 + * @param conn the open connection to update
1.92 + * @param target the target host for the updated connection.
1.93 + * The connection must already be open or tunnelled
1.94 + * to the host and port, but the scheme of the target
1.95 + * will be used to create a layered connection.
1.96 + * @param context the context for the connection
1.97 + * @param params the parameters for the updated connection
1.98 + *
1.99 + * @throws IOException in case of a problem
1.100 + */
1.101 + void updateSecureConnection(OperatedClientConnection conn,
1.102 + HttpHost target,
1.103 + HttpContext context,
1.104 + HttpParams params)
1.105 + throws IOException;
1.106 +
1.107 +}
1.108 +
