/*
* $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 $
* $Revision: 1.15 $
* $Date: 2003/01/28 04:40:20 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact [email protected].
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* <http://www.apache.org/>.
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.commons.httpclient;
/**
* An interface for classes that manage HttpConnections.
*
* @see org.apache.commons.httpclient.HttpConnection
* @see org.apache.commons.httpclient.HttpClient#HttpClient(HttpConnectionManager)
*
* @author Unascribed
* @author <a href="mailto:[email protected]">Mike Bowler</a>
*
* @since 2.0
*/
public interface HttpConnectionManager {
/**
* Gets an HttpConnection for a given host configuration. If a connection is
* not available this method will block until one is.
*
* The connection manager should be registered with any HttpConnection that
* is created.
*
* @param hostConfiguration the host configuration to use to configure the
* connection
*
* @return an HttpConnection for the given configuration
*
* @see HttpConnection#setHttpConnectionManager(HttpConnectionManager)
*/
HttpConnection getConnection(HostConfiguration hostConfiguration);
/**
* Gets an HttpConnection for a given host configuration. If a connection is
* not available, this method will block for at most the specified number of
* milliseconds or until a connection becomes available.
*
* The connection manager should be registered with any HttpConnection that
* is created.
*
* @param hostConfiguration the host configuration to use to configure the
* connection
* @param timeout - the time (in milliseconds) to wait for a connection to
* become available, 0 to specify an infinite timeout
*
* @return an HttpConnection for the given configuraiton
*
* @throws HttpException if no connection becomes available before the
* timeout expires
*
* @see HttpConnection#setHttpConnectionManager(HttpConnectionManager)
*/
HttpConnection getConnection(HostConfiguration hostConfiguration, long timeout)
throws HttpException;
/**
* Releases the given HttpConnection for use by other requests.
*
* @param conn - The HttpConnection to make available.
*/
void releaseConnection(HttpConnection conn);
}
|