michael@0: /*
michael@0:  * ====================================================================
michael@0:  * Licensed to the Apache Software Foundation (ASF) under one
michael@0:  * or more contributor license agreements.  See the NOTICE file
michael@0:  * distributed with this work for additional information
michael@0:  * regarding copyright ownership.  The ASF licenses this file
michael@0:  * to you under the Apache License, Version 2.0 (the
michael@0:  * "License"); you may not use this file except in compliance
michael@0:  * with the License.  You may obtain a copy of the License at
michael@0:  *
michael@0:  *   http://www.apache.org/licenses/LICENSE-2.0
michael@0:  *
michael@0:  * Unless required by applicable law or agreed to in writing,
michael@0:  * software distributed under the License is distributed on an
michael@0:  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
michael@0:  * KIND, either express or implied.  See the License for the
michael@0:  * specific language governing permissions and limitations
michael@0:  * under the License.
michael@0:  * ====================================================================
michael@0:  *
michael@0:  * This software consists of voluntary contributions made by many
michael@0:  * individuals on behalf of the Apache Software Foundation.  For more
michael@0:  * information on the Apache Software Foundation, please see
michael@0:  * <http://www.apache.org/>.
michael@0:  *
michael@0:  */
michael@0: 
michael@0: package ch.boye.httpclientandroidlib.conn;
michael@0: 
michael@0: import java.io.IOException;
michael@0: import java.net.InetAddress;
michael@0: import java.net.Socket;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.HttpHost;
michael@0: import ch.boye.httpclientandroidlib.conn.scheme.SchemeSocketFactory;
michael@0: import ch.boye.httpclientandroidlib.params.HttpParams;
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * ClientConnectionOperator represents a strategy for creating
michael@0:  * {@link OperatedClientConnection} instances and updating the underlying
michael@0:  * {@link Socket} of those objects. Implementations will most likely make use
michael@0:  * of {@link SchemeSocketFactory}s to create {@link Socket} instances.
michael@0:  * <p>
michael@0:  * The methods in this interface allow the creation of plain and layered
michael@0:  * sockets. Creating a tunnelled connection through a proxy, however,
michael@0:  * is not within the scope of the operator.
michael@0:  * <p>
michael@0:  * Implementations of this interface must be thread-safe. Access to shared
michael@0:  * data must be synchronized as methods of this interface may be executed
michael@0:  * from multiple threads.
michael@0:  *
michael@0:  * @since 4.0
michael@0:  */
michael@0: public interface ClientConnectionOperator {
michael@0: 
michael@0:     /**
michael@0:      * Creates a new connection that can be operated.
michael@0:      *
michael@0:      * @return  a new, unopened connection for use with this operator
michael@0:      */
michael@0:     OperatedClientConnection createConnection();
michael@0: 
michael@0:     /**
michael@0:      * Opens a connection to the given target host.
michael@0:      *
michael@0:      * @param conn      the connection to open
michael@0:      * @param target    the target host to connect to
michael@0:      * @param local     the local address to route from, or
michael@0:      *                  <code>null</code> for the default
michael@0:      * @param context   the context for the connection
michael@0:      * @param params    the parameters for the connection
michael@0:      *
michael@0:      * @throws IOException      in case of a problem
michael@0:      */
michael@0:     void openConnection(OperatedClientConnection conn,
michael@0:                         HttpHost target,
michael@0:                         InetAddress local,
michael@0:                         HttpContext context,
michael@0:                         HttpParams params)
michael@0:         throws IOException;
michael@0: 
michael@0:     /**
michael@0:      * Updates a connection with a layered secure connection.
michael@0:      * The typical use of this method is to update a tunnelled plain
michael@0:      * connection (HTTP) to a secure TLS/SSL connection (HTTPS).
michael@0:      *
michael@0:      * @param conn      the open connection to update
michael@0:      * @param target    the target host for the updated connection.
michael@0:      *                  The connection must already be open or tunnelled
michael@0:      *                  to the host and port, but the scheme of the target
michael@0:      *                  will be used to create a layered connection.
michael@0:      * @param context   the context for the connection
michael@0:      * @param params    the parameters for the updated connection
michael@0:      *
michael@0:      * @throws IOException      in case of a problem
michael@0:      */
michael@0:     void updateSecureConnection(OperatedClientConnection conn,
michael@0:                                 HttpHost target,
michael@0:                                 HttpContext context,
michael@0:                                 HttpParams params)
michael@0:         throws IOException;
michael@0: 
michael@0: }
michael@0: