1/*
2 * $HeadURL: $
3 * $Revision: $
4 * $Date: $
5 *
6 * ====================================================================
7 * Licensed to the Apache Software Foundation (ASF) under one
8 * or more contributor license agreements.  See the NOTICE file
9 * distributed with this work for additional information
10 * regarding copyright ownership.  The ASF licenses this file
11 * to you under the Apache License, Version 2.0 (the
12 * "License"); you may not use this file except in compliance
13 * with the License.  You may obtain a copy of the License at
14 *
15 *   http://www.apache.org/licenses/LICENSE-2.0
16 *
17 * Unless required by applicable law or agreed to in writing,
18 * software distributed under the License is distributed on an
19 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
20 * KIND, either express or implied.  See the License for the
21 * specific language governing permissions and limitations
22 * under the License.
23 * ====================================================================
24 *
25 * This software consists of voluntary contributions made by many
26 * individuals on behalf of the Apache Software Foundation.  For more
27 * information on the Apache Software Foundation, please see
28 * <http://www.apache.org/>.
29 *
30 */
31package org.apache.http.conn;
32
33import org.apache.http.ConnectionReuseStrategy;
34import org.apache.http.HttpResponse;
35import org.apache.http.protocol.HttpContext;
36
37/**
38 * Interface for deciding how long a connection can remain
39 * idle before being reused.
40 *
41 * @author <a href="mailto:sberlin at gmail.com">Sam Berlin</a>
42 *
43 *
44 * @version $Revision: $
45 *
46 * @since 4.0
47 *
48 * @deprecated Please use {@link java.net.URL#openConnection} instead.
49 *     Please visit <a href="http://android-developers.blogspot.com/2011/09/androids-http-clients.html">this webpage</a>
50 *     for further details.
51 */
52@Deprecated
53public interface ConnectionKeepAliveStrategy {
54
55    /**
56     * Returns the duration of time which this connection can be safely kept
57     * idle. If the connection is left idle for longer than this period of time,
58     * it MUST not reused. A value of 0 or less may be returned to indicate that
59     * there is no suitable suggestion.
60     *
61     * When coupled with a {@link ConnectionReuseStrategy}, if
62     * {@link ConnectionReuseStrategy#keepAlive(HttpResponse, HttpContext)
63     * returns true, this allows you to control how long the reuse will last. If
64     * keepAlive returns false, this should have no meaningful impact
65     *
66     * @param response
67     *            The last response received over the connection.
68     * @param context
69     *            the context in which the connection is being used.
70     *
71     * @return the duration in ms for which it is safe to keep the connection
72     *         idle, or <=0 if no suggested duration.
73     */
74    long getKeepAliveDuration(HttpResponse response, HttpContext context);
75
76}
77