HttpMethod
public class ConnectMethod extends HttpMethodBase
Modifier and Type | Field | Description |
---|---|---|
static java.lang.String |
NAME |
the name of this method
|
effectiveVersion, statusLine
Constructor | 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
|
Modifier and Type | Method | Description |
---|---|---|
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.
|
java.lang.String |
getName() |
Provide the
name of this method. |
java.lang.String |
getPath() |
Gets the path of this HTTP method.
|
URI |
getURI() |
Returns the URI of the HTTP method
|
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.
|
abort, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, generateRequestLine, getAuthenticationRealm, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getHostConfiguration, getMethodRetryHandler, getParams, getProxyAuthenticationRealm, getProxyAuthState, 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, 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, validate, writeRequest, writeRequestBody, writeRequestHeaders
public static final java.lang.String NAME
public ConnectMethod()
public ConnectMethod(HttpMethod method)
method
- the method
to execute after connecting
to the serverpublic ConnectMethod(HostConfiguration targethost)
public java.lang.String getName()
name
of this method.getName
in interface HttpMethod
getName
in class HttpMethodBase
public java.lang.String getPath()
HttpMethodBase
getPath
in interface HttpMethod
getPath
in class HttpMethodBase
public URI getURI() throws URIException
HttpMethodBase
getURI
in interface HttpMethod
getURI
in class HttpMethodBase
URIException
- If the URI cannot be created.HttpMethod.getURI()
protected void addCookieRequestHeader(HttpState state, HttpConnection conn) throws java.io.IOException, HttpException
addCookieRequestHeader
in class HttpMethodBase
state
- current state of http requestsconn
- the connection to use for I/Ojava.io.IOException
- when errors occur reading or writing to/from the
connectionHttpException
- when a recoverable error occursHttpMethodBase.addCookieRequestHeader(HttpState, HttpConnection)
protected void addRequestHeaders(HttpState state, HttpConnection conn) throws java.io.IOException, HttpException
headers
to be submitted to the given HttpConnection
.
This implementation adds User-Agent, Host, and Proxy-Authorization headers, when appropriate.
addRequestHeaders
in class HttpMethodBase
state
- the client stateconn
- the HttpConnection
the headers will eventually be
written tojava.io.IOException
- when an error occurs writing the requestHttpException
- when a HTTP protocol error occursHttpMethodBase.writeRequestHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
public int execute(HttpState state, HttpConnection conn) throws java.io.IOException, HttpException
execute
in interface HttpMethod
execute
in class HttpMethodBase
state
- the current http stateconn
- the connection to write toHttpException
- when an error occurs writing the headersjava.io.IOException
- when an error occurs writing the headersHttpConnection.tunnelCreated()
protected void writeRequestLine(HttpState state, HttpConnection conn) throws java.io.IOException, HttpException
writeRequestLine
in class HttpMethodBase
state
- the current http stateconn
- the connection to write tojava.io.IOException
- when an error occurs writing the requestHttpException
- when an error occurs writing the requestHttpMethodBase.generateRequestLine(org.apache.commons.httpclient.HttpConnection, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
protected boolean shouldCloseConnection(HttpConnection conn)
true
if the status code is anything other than
SC_OK, false
otherwise.shouldCloseConnection
in class HttpMethodBase
conn
- the connection in questiontrue
if the connection should be closedHttpMethodBase.shouldCloseConnection(HttpConnection)
,
HttpStatus.SC_OK
Copyright (c) 1999-2005 - Apache Software Foundation