org.apache.commons.httpclient

Class ConnectMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.commons.httpclient.ConnectMethod

All Implemented Interfaces:

HttpMethod

public class ConnectMethod
extends HttpMethodBase

Establishes a tunneled HTTP connection via the CONNECT method.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME the name of this method

Constructor Summary

Constructors

Constructor and Description
ConnectMethod() Deprecated. use #ConnectMethod(HttpHost); Create a connect method.
ConnectMethod(HostConfiguration targethost) Create a connect method.
ConnectMethod(HttpMethod method) Deprecated. the wrapped method is no longer used Create a connect method wrapping the existing method

Method Summary

Modifier and Type	Method and Description
int	execute(HttpState state, HttpConnection conn) Execute this method and create a tunneled HttpConnection.
String	getName() Provide the name of this method.
String	getPath() Gets the path of this HTTP method.
URI	getURI() Returns the URI of the HTTP method

Methods inherited from class org.apache.commons.httpclient.HttpMethodBase

abort, addRequestHeader, addRequestHeader, addResponseFooter, getAuthenticationRealm, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getProxyAuthenticationRealm, getProxyAuthState, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaders, getResponseHeaders, getStatusCode, getStatusLine, getStatusText, hasBeenUsed, isAborted, isHttp11, isRequestSent, isStrictMode, recycle, releaseConnection, removeRequestHeader, removeRequestHeader, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setStrictMode, setURI, validate

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

the name of this method

See Also:

Constant Field Values

Constructor Detail

ConnectMethod

public ConnectMethod()

Deprecated. use #ConnectMethod(HttpHost); Create a connect method.

Since:

3.0

ConnectMethod

public ConnectMethod(HttpMethod method)

Deprecated. the wrapped method is no longer used Create a connect method wrapping the existing method

Parameters:

method - the method to execute after connecting to the server

ConnectMethod

public ConnectMethod(HostConfiguration targethost)

Create a connect method.

Since:

3.0

Method Detail

getName

public String getName()

Provide the name of this method.

Specified by:

getName in interface HttpMethod

Specified by:

getName in class HttpMethodBase

Returns:

the String "CONNECT"

getPath

public String getPath()

Description copied from class: HttpMethodBase

Gets the path of this HTTP method. Calling this method after the request has been executed will return the actual path, following any redirects automatically handled by this HTTP method.

Specified by:

getPath in interface HttpMethod

Overrides:

getPath in class HttpMethodBase

Returns:

the path to request or "/" if the path is blank.

getURI

public URI getURI()
           throws URIException

Description copied from class: HttpMethodBase

Returns the URI of the HTTP method

Specified by:

getURI in interface HttpMethod

Overrides:

getURI in class HttpMethodBase

Returns:

The URI

Throws:

URIException - If the URI cannot be created.

See Also:

HttpMethod.getURI()

execute

public int execute(HttpState state,
                   HttpConnection conn)
            throws IOException,
                   HttpException

Execute this method and create a tunneled HttpConnection. If the method is successful (i.e. the status is a 2xx) tunnelCreated() will be called on the connection.

Specified by:

execute in interface HttpMethod

Overrides:

execute in class HttpMethodBase

Parameters:

state - the current http state

conn - the connection to write to

Returns:

the http status code from execution

Throws:

HttpException - when an error occurs writing the headers

IOException - when an error occurs writing the headers

See Also:

HttpConnection.tunnelCreated()