org.apache.commons.httpclient
public class ProxyClient extends Object
java.net.Socket sockets
for communicating through HTTP proxies
via the HTTP CONNECT method. This is primarily needed for non-HTTP protocols that wish to
communicate via an HTTP proxy.
Since: 3.0
Version: $Revision: 480424 $
Nested Class Summary | |
---|---|
static class | ProxyClient.ConnectResponse
Contains the method used to execute the connect along with the created socket. |
Constructor Summary | |
---|---|
ProxyClient()
Creates an instance of ProxyClient using default parameter set .
| |
ProxyClient(HttpClientParams params)
Creates an instance of ProxyClient using the given
parameter set .
|
Method Summary | |
---|---|
ProxyClient.ConnectResponse | connect()
Creates a socket that is connected, via the HTTP CONNECT method, to a proxy.
|
HostConfiguration | getHostConfiguration()
Returns the host configuration associated with the
ProxyClient.
|
HttpClientParams | getParams()
Returns HTTP protocol parameters associated with this ProxyClient.
|
HttpState | getState()
Returns HTTP state associated with the ProxyClient.
|
void | setHostConfiguration(HostConfiguration hostConfiguration)
Assigns the host configuration to use with the
ProxyClient.
|
void | setParams(HttpClientParams params)
Assigns HTTP protocol parameters for this ProxyClient.
|
void | setState(HttpState state)
Assigns HTTP state for the ProxyClient.
|
parameter set
.
See Also: HttpClientParams
parameter set
.
Parameters: params The parameters
to use.
See Also: HttpClientParams
Even though HTTP CONNECT proxying is generally used for HTTPS tunneling, the returned socket will not have been wrapped in an SSL socket.
Both the proxy and destination hosts must be set via the
host configuration
prior to calling this method.
Returns: the connect response
Throws: IOException HttpException
See Also: getHostConfiguration
host configuration
associated with the
ProxyClient.
Returns: host configuration
HTTP protocol parameters
associated with this ProxyClient.
See Also: HttpClientParams
HTTP state
associated with the ProxyClient.
Returns: the shared client state
See Also: setState
host configuration
to use with the
ProxyClient.
Parameters: hostConfiguration The host configuration
to set
HTTP protocol parameters
for this ProxyClient.
See Also: HttpClientParams
HTTP state
for the ProxyClient.
Parameters: state the new HTTP state
for the client
See Also: getState