1 /*
2 * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpConnectionManager.java,v 1.15 2003/01/28 04:40:20 jsdever Exp $
3 * $Revision: 1.15 $
4 * $Date: 2003/01/28 04:40:20 $
5 *
6 * ====================================================================
7 *
8 * The Apache Software License, Version 1.1
9 *
10 * Copyright (c) 1999-2003 The Apache Software Foundation. All rights
11 * reserved.
12 *
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
15 * are met:
16 *
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 *
20 * 2. Redistributions in binary form must reproduce the above copyright
21 * notice, this list of conditions and the following disclaimer in
22 * the documentation and/or other materials provided with the
23 * distribution.
24 *
25 * 3. The end-user documentation included with the redistribution, if
26 * any, must include the following acknowlegement:
27 * "This product includes software developed by the
28 * Apache Software Foundation (http://www.apache.org/)."
29 * Alternately, this acknowlegement may appear in the software itself,
30 * if and wherever such third-party acknowlegements normally appear.
31 *
32 * 4. The names "The Jakarta Project", "Commons", and "Apache Software
33 * Foundation" must not be used to endorse or promote products derived
34 * from this software without prior written permission. For written
35 * permission, please contact apache@apache.org.
36 *
37 * 5. Products derived from this software may not be called "Apache"
38 * nor may "Apache" appear in their names without prior written
39 * permission of the Apache Group.
40 *
41 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
42 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
43 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
44 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
45 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
46 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
47 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
48 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
49 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
50 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
51 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
52 * SUCH DAMAGE.
53 * ====================================================================
54 *
55 * This software consists of voluntary contributions made by many
56 * individuals on behalf of the Apache Software Foundation. For more
57 * information on the Apache Software Foundation, please see
58 * <http://www.apache.org/>.
59 *
60 * [Additional notices, if required by prior licensing conditions]
61 *
62 */
63
64 package org.apache.commons.httpclient;
65
66 /***
67 * An interface for classes that manage HttpConnections.
68 *
69 * @see org.apache.commons.httpclient.HttpConnection
70 * @see org.apache.commons.httpclient.HttpClient#HttpClient(HttpConnectionManager)
71 *
72 * @author Unascribed
73 * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
74 *
75 * @since 2.0
76 */
77 public interface HttpConnectionManager {
78
79 /***
80 * Gets an HttpConnection for a given host configuration. If a connection is
81 * not available this method will block until one is.
82 *
83 * The connection manager should be registered with any HttpConnection that
84 * is created.
85 *
86 * @param hostConfiguration the host configuration to use to configure the
87 * connection
88 *
89 * @return an HttpConnection for the given configuration
90 *
91 * @see HttpConnection#setHttpConnectionManager(HttpConnectionManager)
92 */
93 HttpConnection getConnection(HostConfiguration hostConfiguration);
94
95 /***
96 * Gets an HttpConnection for a given host configuration. If a connection is
97 * not available, this method will block for at most the specified number of
98 * milliseconds or until a connection becomes available.
99 *
100 * The connection manager should be registered with any HttpConnection that
101 * is created.
102 *
103 * @param hostConfiguration the host configuration to use to configure the
104 * connection
105 * @param timeout - the time (in milliseconds) to wait for a connection to
106 * become available, 0 to specify an infinite timeout
107 *
108 * @return an HttpConnection for the given configuraiton
109 *
110 * @throws HttpException if no connection becomes available before the
111 * timeout expires
112 *
113 * @see HttpConnection#setHttpConnectionManager(HttpConnectionManager)
114 */
115 HttpConnection getConnection(HostConfiguration hostConfiguration, long timeout)
116 throws HttpException;
117
118 /***
119 * Releases the given HttpConnection for use by other requests.
120 *
121 * @param conn - The HttpConnection to make available.
122 */
123 void releaseConnection(HttpConnection conn);
124 }
This page was automatically generated by Maven