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;
michael@0: 
michael@0: import ch.boye.httpclientandroidlib.protocol.HttpContext;
michael@0: 
michael@0: /**
michael@0:  * Interface for deciding whether a connection can be re-used for
michael@0:  * subsequent requests and should be kept alive.
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 ConnectionReuseStrategy {
michael@0: 
michael@0:     /**
michael@0:      * Decides whether a connection can be kept open after a request.
michael@0:      * If this method returns <code>false</code>, the caller MUST
michael@0:      * close the connection to correctly comply with the HTTP protocol.
michael@0:      * If it returns <code>true</code>, the caller SHOULD attempt to
michael@0:      * keep the connection open for reuse with another request.
michael@0:      * <br/>
michael@0:      * One can use the HTTP context to retrieve additional objects that
michael@0:      * may be relevant for the keep-alive strategy: the actual HTTP
michael@0:      * connection, the original HTTP request, target host if known,
michael@0:      * number of times the connection has been reused already and so on.
michael@0:      * <br/>
michael@0:      * If the connection is already closed, <code>false</code> is returned.
michael@0:      * The stale connection check MUST NOT be triggered by a
michael@0:      * connection reuse strategy.
michael@0:      *
michael@0:      * @param response
michael@0:      *          The last response received over that connection.
michael@0:      * @param context   the context in which the connection is being
michael@0:      *          used.
michael@0:      *
michael@0:      * @return <code>true</code> if the connection is allowed to be reused, or
michael@0:      *         <code>false</code> if it MUST NOT be reused
michael@0:      */
michael@0:     boolean keepAlive(HttpResponse response, HttpContext context);
michael@0: 
michael@0: }