org.apache.commons.httpclient
Class HttpClient

java.lang.Object
  org.apache.commons.httpclient.HttpClient

public class HttpClient
extends Object

An HTTP "user-agent", containing an HTTP state and one or more HTTP connections, to which HTTP methods can be applied.

Version:

$Revision: 354155 $ $Date: 2005-12-05 21:18:10 +0100 (Mo, 05 Dez 2005) $

Author:

Remy Maucherat, Rodney Waldhoff, Sean C. Sullivan, dIon Gillard, Ortwin Gl?ck, Michael Becke, Mike Bowler, Sam Maloney, Laura Werner, Oleg Kalnichevski

Constructor Summary

HttpClient()
Creates an instance of HttpClient using default parameter set.

HttpClient(HttpClientParams params)
Creates an instance of HttpClient using the given parameter set.

HttpClient(HttpClientParams params, HttpConnectionManager httpConnectionManager)
Creates an instance of HttpClient with a user specified parameter set and HTTP connection manager.

HttpClient(HttpConnectionManager httpConnectionManager)
Creates an instance of HttpClient with a user specified HTTP connection manager.

Method Summary

int	executeMethod(HostConfiguration hostConfiguration, HttpMethod method) Executes the given HTTP method using custom host configuration.
int	executeMethod(HostConfiguration hostconfig, HttpMethod method, HttpState state) Executes the given HTTP method using the given custom host configuration with the given custom HTTP state.
int	executeMethod(HttpMethod method) Executes the given HTTP method.
HostConfiguration	getHostConfiguration() Returns the host configuration associated with the HttpClient.
HttpConnectionManager	getHttpConnectionManager() Returns the HTTP connection manager associated with the HttpClient.
HttpClientParams	getParams() Returns HTTP protocol parameters associated with this HttpClient.
HttpState	getState() Returns HTTP state associated with the HttpClient.
void	setHostConfiguration(HostConfiguration hostConfiguration) Assigns the host configuration to use with the HttpClient.
void	setHttpConnectionManager(HttpConnectionManager httpConnectionManager) Assigns the HTTP connection manager to use with the HttpClient.
void	setParams(HttpClientParams params) Assigns HTTP protocol parameters for this HttpClient.
void	setState(HttpState state) Assigns HTTP state for the HttpClient.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HttpClient

public HttpClient()

Creates an instance of HttpClient using default parameter set.

See Also:

HttpClientParams

HttpClient

public HttpClient(HttpClientParams params)

Creates an instance of HttpClient using the given parameter set.

Parameters:

params - The parameters to use.

Since:

3.0

See Also:

HttpClientParams

HttpClient

public HttpClient(HttpClientParams params,
                  HttpConnectionManager httpConnectionManager)

Creates an instance of HttpClient with a user specified parameter set and HTTP connection manager.

Parameters:

params - The parameters to use.

httpConnectionManager - The connection manager to use.

Since:

3.0

HttpClient

public HttpClient(HttpConnectionManager httpConnectionManager)

Creates an instance of HttpClient with a user specified HTTP connection manager.

Parameters:

httpConnectionManager - The connection manager to use.

Since:

2.0

Method Detail

getState

public HttpState getState()

Returns HTTP state associated with the HttpClient.

Returns:

the shared client state

See Also:

setState(HttpState)

setState

public void setState(HttpState state)

Assigns HTTP state for the HttpClient.

Parameters:

state - the new HTTP state for the client

See Also:

getState()

executeMethod

public int executeMethod(HttpMethod method)
                  throws IOException,
                         HttpException

Executes the given HTTP method.

Parameters:

method - the HTTP method to execute.

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.

executeMethod

public int executeMethod(HostConfiguration hostConfiguration,
                         HttpMethod method)
                  throws IOException,
                         HttpException

Executes the given HTTP method using custom host configuration.

Parameters:

hostConfiguration - The host configuration to use.

method - the HTTP method to execute.

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.

Since:

2.0

executeMethod

public int executeMethod(HostConfiguration hostconfig,
                         HttpMethod method,
                         HttpState state)
                  throws IOException,
                         HttpException

Executes the given HTTP method using the given custom host configuration with the given custom HTTP state.

Parameters:

hostconfig - The host configuration to use.

method - the HTTP method to execute.

state - the HTTP state to use when executing the method. If null, the state returned by getState() will be used instead.

Returns:

the method's response code

Throws:

IOException - If an I/O (transport) error occurs. Some transport exceptions can be recovered from.

HttpException - If a protocol exception occurs. Usually protocol exceptions cannot be recovered from.

Since:

2.0

getHostConfiguration

public HostConfiguration getHostConfiguration()

Returns the host configuration associated with the HttpClient.

Returns:

host configuration

Since:

2.0

setHostConfiguration

public void setHostConfiguration(HostConfiguration hostConfiguration)

Assigns the host configuration to use with the HttpClient.

Parameters:

hostConfiguration - The host configuration to set

Since:

2.0

getHttpConnectionManager

public HttpConnectionManager getHttpConnectionManager()

Returns the HTTP connection manager associated with the HttpClient.

Returns:

HTTP connection manager

Since:

2.0

setHttpConnectionManager

public void setHttpConnectionManager(HttpConnectionManager httpConnectionManager)

Assigns the HTTP connection manager to use with the HttpClient.

Parameters:

httpConnectionManager - The HTTP connection manager to set

Since:

2.0

getParams

public HttpClientParams getParams()

Returns HTTP protocol parameters associated with this HttpClient.

Returns:

currently params set

Since:

3.0

See Also:

HttpClientParams

setParams

public void setParams(HttpClientParams params)

Assigns HTTP protocol parameters for this HttpClient.

Parameters:

params - params to set. Cannot be null

Since:

3.0

See Also:

HttpClientParams