/*
* $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpClient.java,v 1.76.2.3 2004/02/04 02:14:32 mbecke Exp $
* $Revision: 1.76.2.3 $
* $Date: 2004/02/04 02:14:32 $
*
* ====================================================================
*
* 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 apache@apache.org.
*
* 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
* .
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.commons.httpclient;
import java.io.IOException;
import java.net.URL;
import java.security.Security;
import java.security.Provider;
import org.apache.commons.httpclient.protocol.Protocol;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
*
* An HTTP "user-agent", containing an {@link HttpState HTTP state} and
* one or more {@link HttpConnection HTTP connections}, to which
* {@link HttpMethod HTTP methods} can be applied.
*
* @author Remy Maucherat
* @author Rodney Waldhoff
* @author Sean C. Sullivan
* @author dIon Gillard
* @author Ortwin Glück
* @author Michael Becke
* @author Mike Bowler
* @author Sam Maloney
* @author Laura Werner
* @author Oleg Kalnichevski
*
* @version $Revision: 1.76.2.3 $ $Date: 2004/02/04 02:14:32 $
*/
public class HttpClient {
// -------------------------------------------------------------- Constants
/** Log object for this class. */
private static final Log LOG = LogFactory.getLog(HttpClient.class);
static {
if (LOG.isDebugEnabled()) {
try {
LOG.debug("Java version: " + System.getProperty("java.version"));
LOG.debug("Java vendor: " + System.getProperty("java.vendor"));
LOG.debug("Java class path: " + System.getProperty("java.class.path"));
LOG.debug("Operating system name: " + System.getProperty("os.name"));
LOG.debug("Operating system architecture: " + System.getProperty("os.arch"));
LOG.debug("Operating system version: " + System.getProperty("os.version"));
Provider[] providers = Security.getProviders();
for (int i = 0; i < providers.length; i++) {
Provider provider = providers[i];
LOG.debug(provider.getName() + " " + provider.getVersion()
+ ": " + provider.getInfo());
}
} catch(SecurityException ignore) {
}
}
}
// ----------------------------------------------------------- Constructors
/**
* Creates an instance of HttpClient using a
* {@link SimpleHttpConnectionManager simple HTTP connection manager}.
*
* @see SimpleHttpConnectionManager
*/
public HttpClient() {
this(new SimpleHttpConnectionManager());
}
/**
* Creates an instance of HttpClient with a user specified connection manager.
* @param httpConnectionManager The {@link HttpConnectionManager connection manager}
* to use.
*
* @since 2.0
*/
public HttpClient(HttpConnectionManager httpConnectionManager) {
if (httpConnectionManager == null) {
throw new IllegalArgumentException("httpConnectionManager cannot be null");
}
this.state = new HttpState();
this.httpConnectionManager = httpConnectionManager;
this.hostConfiguration = new HostConfiguration();
}
// ----------------------------------------------------- Instance Variables
/**
* The {@link HttpConnectionManager connection manager} being used to manage
* connections for this HttpClient
*/
private HttpConnectionManager httpConnectionManager;
/**
* The {@link HttpState HTTP state} associated with this HttpClient.
*/
private HttpState state;
/**
* The timout in milliseconds when waiting for a connection from the
* {@link HttpConnectionManager connection manager}
*/
private long httpConnectionTimeout = 0;
/**
* The socket timeout in milliseconds.
*/
private int timeoutInMilliseconds = 0;
/**
* The connection timeout in milliseconds.
*/
private int connectionTimeout = 0;
/**
* The {@link HostConfiguration host configuration} associated with
* the HttpClient
*/
private HostConfiguration hostConfiguration;
/**
* True if strict mode is enabled.
*/
private boolean strictMode = false;
// ------------------------------------------------------------- Properties
/**
* Returns {@link HttpState HTTP state} associated with the HttpClient.
*
* @see #setState(HttpState)
* @return the shared client state
*/
public synchronized HttpState getState() {
return state;
}
/**
* Assigns {@link HttpState HTTP state} for the HttpClient.
*
* @see #getState()
* @param state the new {@link HttpState HTTP state} for the client
*/
public synchronized void setState(HttpState state) {
this.state = state;
}
/**
* Defines how strictly the method follows the HTTP protocol specification
* (see RFC 2616 and other relevant RFCs).
*
* In the strict mode the method precisely
* implements the requirements of the specification, whereas in non-strict mode
* it attempts to mimic the exact behaviour of commonly used HTTP agents,
* which many HTTP servers expect.
*
* @param strictMode true for strict mode, false otherwise
*
* @see #isStrictMode()
*/
public synchronized void setStrictMode(boolean strictMode) {
this.strictMode = strictMode;
}
/**
* Returns the value of the strict mode flag.
*
* @return true if strict mode is enabled, false otherwise
*
* @see #setStrictMode(boolean)
*/
public synchronized boolean isStrictMode() {
return strictMode;
}
/**
* Sets the socket timeout (SO_TIMEOUT) in milliseconds which is the
* timeout for waiting for data. A timeout value of zero is interpreted as an
* infinite timeout.
*
* @param newTimeoutInMilliseconds Timeout in milliseconds
*/
public synchronized void setTimeout(int newTimeoutInMilliseconds) {
this.timeoutInMilliseconds = newTimeoutInMilliseconds;
}
/**
* Sets the timeout in milliseconds used when retrieving an
* {@link HttpConnection HTTP connection} from the
* {@link HttpConnectionManager HTTP connection manager}.
*
* @param timeout the timeout in milliseconds
*
* @see HttpConnectionManager#getConnection(HostConfiguration, long)
*/
public synchronized void setHttpConnectionFactoryTimeout(long timeout) {
this.httpConnectionTimeout = timeout;
}
/**
* Sets the timeout until a connection is etablished. A timeout value of
* zero means the timeout is not used. The default value is zero.
*
* @param newTimeoutInMilliseconds Timeout in milliseconds.
*
* @see HttpConnection#setConnectionTimeout(int)
*/
public synchronized void setConnectionTimeout(int newTimeoutInMilliseconds) {
this.connectionTimeout = newTimeoutInMilliseconds;
}
// --------------------------------------------------------- Public Methods
/**
* Sets the host, port and default protocol (http) to be used when executing a
* method.
*
* @param host the host to connect to
* @param port the port to connect to
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(String host, int port) {
LOG.trace("enter HttpClient.startSession(String, int)");
startSession(host, port, false);
}
/**
* Sets the host, port and protocol to be used when executing a method.
*
* @param host the host to connect to
* @param port the port to connect to
* @param https when true, create an HTTPS session
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(String host, int port, boolean https) {
LOG.trace("enter HttpClient.startSession(String, int, boolean)");
if (LOG.isDebugEnabled()) {
LOG.debug("HttpClient.startSession(String,int,boolean): Host:"
+ host + " Port:" + port + " HTTPS:" + https);
}
this.hostConfiguration.setHost(host, port, https ? "https" : "http");
}
/**
* Sets the host, port, default protocol (http) and credentials to be used when
* executing a method.
*
* @param host the host to connect to
* @param port the port to connect to
* @param creds the default credentials to use
*
* @see #getHostConfiguration()
* @see #getState()
* @see #startSession(String, int, Credentials, boolean)
*
* @deprecated use {@link HostConfiguration} and {@link HttpState}
*/
public void startSession(String host, int port, Credentials creds) {
LOG.trace("enter HttpClient.startSession(String, int, Credentials)");
startSession(host, port, creds, false);
}
/**
* Sets the host, port, protocol and credentials to be used when executing a
* method.
*
* @param host the host to connect to
* @param port the port to connect to
* @param creds the default credentials to use
* @param https when true, create an HTTPS session
*
* @see #getHostConfiguration()
* @see #getState()
*
* @deprecated use {@link HostConfiguration} and {@link HttpState}
*/
public void startSession(String host, int port, Credentials creds, boolean https) {
LOG.trace("enter HttpClient.startSession(String, int, Credentials, boolean)");
if (LOG.isDebugEnabled()) {
LOG.debug(
"Starting HttpClient session"
+ " Host:" + host
+ " Port:" + port + " Credentials:" + creds
+ " HTTPS:" + https);
}
getState().setCredentials(null, creds);
this.hostConfiguration.setHost(
host,
port,
https ? "https" : "http"
);
}
/**
* Sets the host, port, protocol and credentials to be used when executing a
* method using the server specified by the scheme, userinfo, host and port
* of the given uri.
*
* Note that the path component is not utilized.
*
* @param uri an HttpURL or HttpsURL instance; the
* {@link URI URI} from which the scheme, userinfo, host and port of the
* session are determined
*
* @throws IllegalStateException not enough information to process
* @throws URIException If the URI is bad.
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(URI uri)
throws URIException, IllegalStateException {
LOG.trace("enter HttpClient.startSession(URI)");
String scheme = uri.getScheme();
if (scheme == null) { // it may a URI instance or abs_path
LOG.error("no scheme to start a session");
throw new IllegalStateException("no scheme to start a session");
}
Protocol protocol = Protocol.getProtocol(scheme);
String userinfo = uri.getUserinfo();
if (userinfo != null) {
getState().setCredentials(null,
new UsernamePasswordCredentials(userinfo));
}
String host = uri.getHost();
if (host == null || host.length() == 0) {
LOG.error("no host to start a session");
throw new IllegalStateException("no host to start a session");
}
int port = uri.getPort();
if (port == -1) { // neither HttpURL or HttpsURL instance
LOG.error("HttpURL or HttpsURL instance required");
throw new IllegalStateException
("HttpURL or HttpsURL instance required");
}
this.hostConfiguration.setHost(host, null, port, protocol);
}
/**
* Sets the host, port and protocol to be used when executing a method.
*
* Note that everything but the protocol, host and port of the
* given url is ignored.
*
* @param url the {@link URL URL} from which the protocol, host, and port of
* the session are determined
*
* @exception IllegalArgumentException if the protocol is not http or https
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(URL url) throws IllegalArgumentException {
LOG.trace("enter HttpClient.startSession(String, int, Credentials, boolean)");
int port = url.getPort();
Protocol protocol = Protocol.getProtocol(url.getProtocol());
hostConfiguration.setHost(url.getHost(), null, port, protocol);
}
/**
* Sets the host, port, protocol and credentials to be used when executing a
* method.
*
* Note that everything but the protocol, host and port of the
* given url is ignored.
*
* @param url the {@link URL URL} from which the protocol, host, and port of
* the session are determined
* @param creds the default credentials to use
*
* @exception IllegalArgumentException if the protocol is not http or https
*
* @see #getHostConfiguration()
* @see #getState()
*
* @deprecated use {@link HostConfiguration} and {@link HttpState}
*/
public void startSession(URL url, Credentials creds)
throws IllegalArgumentException {
LOG.trace("enter HttpClient.startSession(URL, Credentials)");
getState().setCredentials(null, creds);
startSession(url);
}
/**
* Sets the host, port, protocol(http) and proxy to be used when executing a
* method.
*
* @param host the host to connect to
* @param port the port to connect to
* @param proxyhost the proxy host to connect via
* @param proxyport the proxy port to connect via
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(String host, int port, String proxyhost, int proxyport) {
LOG.trace("enter HttpClient.startSession(String, int, String, int)");
startSession(host, port, proxyhost, proxyport, false);
}
/**
* Sets the host, port, protocol and proxy to be used when executing a
* method.
*
* @param host the host to connect to
* @param port the port to connect to
* @param proxyhost the proxy host to connect via
* @param proxyport the proxy port to connect via
* @param secure whether or not to connect using HTTPS
*
* @see #getHostConfiguration()
*
* @deprecated use {@link HostConfiguration}
*/
public void startSession(String host, int port,
String proxyhost, int proxyport, boolean secure) {
LOG.trace("enter HttpClient.startSession("
+ "String, int, String, int, boolean)");
this.hostConfiguration.setHost (host, port, secure ? "https" : "http");
this.hostConfiguration.setProxy(proxyhost, proxyport);
}
/**
* Executes the given {@link HttpMethod HTTP method}.
*
* @param method the {@link HttpMethod HTTP method} to execute.
* @return the method's response code
*
* @throws IOException If an I/O (transport) error occurs. Some transport exceptions
* can be recovered from.
* @throws HttpException If a protocol exception occurs. Usually protocol exceptions
* cannot be recovered from.
*/
public int executeMethod(HttpMethod method)
throws IOException, HttpException {
LOG.trace("enter HttpClient.executeMethod(HttpMethod)");
// execute this method and use its host configuration, if it has one
return executeMethod(
method.getHostConfiguration() != null
? method.getHostConfiguration()
: getHostConfiguration(),
method,
null
);
}
/**
* Executes the given {@link HttpMethod HTTP method} using custom
* {@link HostConfiguration host configuration}.
*
* @param hostConfiguration The {@link HostConfiguration host configuration} to use.
* @param method the {@link HttpMethod HTTP method} to execute.
* @return the method's response code
*
* @throws IOException If an I/O (transport) error occurs. Some transport exceptions
* can be recovered from.
* @throws HttpException If a protocol exception occurs. Usually protocol exceptions
* cannot be recovered from.
* @since 2.0
*/
public int executeMethod(HostConfiguration hostConfiguration, HttpMethod method)
throws IOException, HttpException {
LOG.trace("enter HttpClient.executeMethod(HostConfiguration,HttpMethod)");
return executeMethod(hostConfiguration, method, null);
}
/**
* Executes the given {@link HttpMethod HTTP method} using the given custom
* {@link HostConfiguration host configuration} with the given custom
* {@link HttpState HTTP state}.
*
* @param hostConfiguration The {@link HostConfiguration host configuration} to use.
* @param method the {@link HttpMethod HTTP method} to execute.
* @param state the {@link HttpState HTTP state} to use when executing the method.
* If null, the state returned by {@link #getState} will be used instead.
*
* @return the method's response code
*
* @throws IOException If an I/O (transport) error occurs. Some transport exceptions
* can be recovered from.
* @throws HttpException If a protocol exception occurs. Usually protocol exceptions
* cannot be recovered from.
* @since 2.0
*/
public int executeMethod(HostConfiguration hostConfiguration,
HttpMethod method, HttpState state)
throws IOException, HttpException {
LOG.trace("enter HttpClient.executeMethod(HostConfiguration,HttpMethod,HttpState)");
if (method == null) {
throw new IllegalArgumentException("HttpMethod parameter may not be null");
}
int soTimeout = 0;
boolean strictMode = false;
int connectionTimeout = 0;
long httpConnectionTimeout = 0;
HostConfiguration defaultHostConfiguration = null;
/* access all synchronized data in a single block, this will keeps us
* from accessing data asynchronously as well having to regain the lock
* for each item.
*/
synchronized (this) {
soTimeout = this.timeoutInMilliseconds;
strictMode = this.strictMode;
connectionTimeout = this.connectionTimeout;
httpConnectionTimeout = this.httpConnectionTimeout;
if (state == null) {
state = getState();
}
defaultHostConfiguration = getHostConfiguration();
}
HostConfiguration methodConfiguration
= new HostConfiguration(hostConfiguration);
if (hostConfiguration != defaultHostConfiguration) {
// we may need to apply some defaults
if (!methodConfiguration.isHostSet()) {
methodConfiguration.setHost(
defaultHostConfiguration.getHost(),
defaultHostConfiguration.getVirtualHost(),
defaultHostConfiguration.getPort(),
defaultHostConfiguration.getProtocol()
);
}
if (!methodConfiguration.isProxySet()
&& defaultHostConfiguration.isProxySet()) {
methodConfiguration.setProxy(
defaultHostConfiguration.getProxyHost(),
defaultHostConfiguration.getProxyPort()
);
}
if (methodConfiguration.getLocalAddress() == null
&& defaultHostConfiguration.getLocalAddress() != null) {
methodConfiguration.setLocalAddress(defaultHostConfiguration.getLocalAddress());
}
}
HttpConnectionManager connmanager = this.httpConnectionManager;
if (state.getHttpConnectionManager() != null) {
connmanager = state.getHttpConnectionManager();
}
HttpConnection connection = connmanager.getConnection(
methodConfiguration,
httpConnectionTimeout
);
try {
// Catch all possible exceptions to make sure to release the
// connection, as although the user may call
// Method->releaseConnection(), the method doesn't know about the
// connection until HttpMethod.execute() is called.
method.setStrictMode(strictMode);
connection.setSoTimeout(soTimeout);
if (!connection.isOpen()) {
connection.setConnectionTimeout(connectionTimeout);
connection.open();
if (connection.isProxied() && connection.isSecure()) {
method = new ConnectMethod(method);
}
}
} catch (IOException e) {
connection.releaseConnection();
throw e;
} catch (RuntimeException e) {
connection.releaseConnection();
throw e;
}
return method.execute(state, connection);
}
/**
* @deprecated this method has no effect. {@link HttpMethod#releaseConnection()}
* should be used to release resources after a HttpMethod has been executed.
*
* @see HttpMethod#releaseConnection()
*/
public void endSession() throws IOException {
}
/**
* Returns the host that the client is accessing.
*
* @return The host that the client is accessing, or null if
* the session has not been started via startSession.
*/
public String getHost() {
return hostConfiguration.getHost();
}
/**
* Returns the port that the client is accessing.
*
* @return The port that the client is accessing, or -1 if the session
* has not been started via startSession().
*/
public int getPort() {
return hostConfiguration.getPort();
}
/**
* Returns the {@link HostConfiguration host configuration} associated with the
* HttpClient.
*
* @return {@link HostConfiguration host configuration}
*
* @since 2.0
*/
public synchronized HostConfiguration getHostConfiguration() {
return hostConfiguration;
}
/**
* Assigns the {@link HostConfiguration host configuration} to use with the
* HttpClient.
*
* @param hostConfiguration The {@link HostConfiguration host configuration} to set
*
* @since 2.0
*/
public synchronized void setHostConfiguration(HostConfiguration hostConfiguration) {
this.hostConfiguration = hostConfiguration;
}
/**
* Returns the {@link HttpConnectionManager HTTP connection manager} associated
* with the HttpClient.
*
* @return {@link HttpConnectionManager HTTP connection manager}
*
* @since 2.0
*/
public synchronized HttpConnectionManager getHttpConnectionManager() {
return httpConnectionManager;
}
/**
* Assigns the {@link HttpConnectionManager HTTP connection manager} to use with
* the HttpClient.
*
* @param httpConnectionManager The {@link HttpConnectionManager HTTP connection manager}
* to set
*
* @since 2.0
*/
public synchronized void setHttpConnectionManager(
HttpConnectionManager httpConnectionManager
) {
this.httpConnectionManager = httpConnectionManager;
}
}
