org.apache.commons.httpclient

Class ConnectMethod

Implemented Interfaces:
HttpMethod

public class ConnectMethod
extends HttpMethodBase

Establishes a tunneled HTTP connection via the CONNECT method.
Since:
2.0

Field Summary

static String
NAME
the name of this method

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

effectiveVersion, statusLine

Constructor Summary

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

protected void
addCookieRequestHeader(HttpState state, HttpConnection conn)
This method does nothing.
protected void
addRequestHeaders(HttpState state, HttpConnection conn)
Populates the request headers map to with additional headers to be submitted to the given HttpConnection.
int
execute(HttpState state, HttpConnection conn)
Execute this method and create a tunneled HttpConnection.
String
getName()
Provide the name of this method.
String
getPath()
URI
getURI()
protected boolean
shouldCloseConnection(HttpConnection conn)
Returns true if the status code is anything other than SC_OK, false otherwise.
protected void
writeRequestLine(HttpState state, HttpConnection conn)
Special Connect request.

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

abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addRequestHeaders, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getName, getParams, getPath, getProxyAuthState, getProxyAuthenticationRealm, getQueryString, getRecoverableExceptionCount, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isHttp11, isRequestSent, isStrictMode, processCookieHeaders, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseBody, readResponseHeaders, readStatusLine, recycle, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFollowRedirects, setHostConfiguration, setHttp11, setMethodRetryHandler, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, shouldCloseConnection, validate, writeRequest, writeRequestBody, writeRequestHeaders, writeRequestLine

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME
the name of this method
Field Value:
"CONNECT"

Constructor Details

ConnectMethod

public ConnectMethod()

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

Since:
3.0

ConnectMethod

public ConnectMethod(HostConfiguration targethost)
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

Method Details

addCookieRequestHeader

protected void addCookieRequestHeader(HttpState state,
                                      HttpConnection conn)
            throws IOException,
                   HttpException
This method does nothing. CONNECT request is not supposed to contain Cookie request header.
Overrides:
addCookieRequestHeader in interface HttpMethodBase
Parameters:
state - current state of http requests
conn - the connection to use for I/O
Throws:
IOException - when errors occur reading or writing to/from the connection
HttpException - when a recoverable error occurs

addRequestHeaders

protected void addRequestHeaders(HttpState state,
                                 HttpConnection conn)
            throws IOException,
                   HttpException
Populates the request headers map to with additional headers to be submitted to the given HttpConnection.

This implementation adds User-Agent, Host, and Proxy-Authorization headers, when appropriate.

Overrides:
addRequestHeaders in interface HttpMethodBase
Parameters:
state - the client state
conn - the HttpConnection the headers will eventually be written to
Throws:
IOException - when an error occurs writing the request
HttpException - when a HTTP protocol error occurs
See Also:
ConnectMethod

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 interface 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

getName

public String getName()
Provide the name of this method.
Specified by:
getName in interface HttpMethod
Overrides:
getName in interface HttpMethodBase
Returns:
the String "CONNECT"

getPath

public String getPath()
Specified by:
getPath in interface HttpMethod
Overrides:
getPath in interface HttpMethodBase

getURI

public URI getURI()
            throws URIException
Specified by:
getURI in interface HttpMethod
Overrides:
getURI in interface HttpMethodBase

shouldCloseConnection

protected boolean shouldCloseConnection(HttpConnection conn)
Returns true if the status code is anything other than SC_OK, false otherwise.
Overrides:
shouldCloseConnection in interface HttpMethodBase
Returns:
true if the connection should be closed

writeRequestLine

protected void writeRequestLine(HttpState state,
                                HttpConnection conn)
            throws IOException,
                   HttpException
Special Connect request.
Overrides:
writeRequestLine in interface HttpMethodBase
Parameters:
state - the current http state
conn - the connection to write to
Throws:
IOException - when an error occurs writing the request
HttpException - when an error occurs writing the request