org.apache.commons.httpclient

Class HttpMethodBase

public abstract class HttpMethodBase extends Object implements HttpMethod

An abstract base implementation of HttpMethod.

At minimum, subclasses will need to override:

When a method requires additional request headers, subclasses will typically want to override:

When a method expects specific response headers, subclasses may want to override:

Version: $Revision: 345322 $ $Date: 2005-11-17 15:20:08 -0500 (Thu, 17 Nov 2005) $

Author: Remy Maucherat Rodney Waldhoff Sean C. Sullivan dIon Gillard Jeff Dever Davanum Srinivas Ortwin Glueck Eric Johnson Michael Becke Oleg Kalnichevski Mike Bowler Gary Gregory Christian Kohlschuetter

Constructor Summary
HttpMethodBase()
No-arg constructor.
HttpMethodBase(String uri)
Constructor specifying a URI.
Method Summary
voidabort()
Aborts the execution of this method.
protected voidaddCookieRequestHeader(HttpState state, HttpConnection conn)
Generates Cookie request headers for those cookies that match the given host, port and path.
protected voidaddHostRequestHeader(HttpState state, HttpConnection conn)
Generates Host request header, as long as no Host request header already exists.
protected voidaddProxyConnectionHeader(HttpState state, HttpConnection conn)
Generates Proxy-Connection: Keep-Alive request header when communicating via a proxy server.
voidaddRequestHeader(Header header)
Adds the specified request header, NOT overwriting any previous value.
voidaddRequestHeader(String headerName, String headerValue)
Adds the specified request header, NOT overwriting any previous value.
protected voidaddRequestHeaders(HttpState state, HttpConnection conn)
Generates all the required request headers to be submitted via the given connection.
voidaddResponseFooter(Header footer)
Use this method internally to add footers.
protected voidaddUserAgentRequestHeader(HttpState state, HttpConnection conn)
Generates default User-Agent request header, as long as no User-Agent request header already exists.
protected voidcheckNotUsed()
Throws an IllegalStateException if the HTTP method has been already executed, but not recycled.
protected voidcheckUsed()
Throws an IllegalStateException if the HTTP method has not been executed since last recycle.
intexecute(HttpState state, HttpConnection conn)
Executes this method using the specified HttpConnection and HttpState.
protected static StringgenerateRequestLine(HttpConnection connection, String name, String requestPath, String query, String version)
Generates HTTP request line according to the specified attributes.
StringgetAuthenticationRealm()
Returns authentication realm, if it has been used during authentication process.
protected StringgetContentCharSet(Header contentheader)
Returns the character set from the Content-Type header.
booleangetDoAuthentication()
Returns true if the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.), false otherwise
HttpVersiongetEffectiveVersion()
Returns the HTTP version used with this method (may be null if undefined, that is, the method has not been executed)
booleangetFollowRedirects()
Returns true if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), false otherwise.
AuthStategetHostAuthState()
Returns the target host authentication state
HostConfigurationgetHostConfiguration()
Returns the host configuration.
MethodRetryHandlergetMethodRetryHandler()
Returns the retry handler for this HTTP method
abstract StringgetName()
Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".
HttpMethodParamsgetParams()
Returns HTTP protocol parameters associated with this method.
StringgetPath()
Gets the path of this HTTP method.
StringgetProxyAuthenticationRealm()
Returns proxy authentication realm, if it has been used during authentication process.
AuthStategetProxyAuthState()
Returns the proxy authentication state
StringgetQueryString()
Gets the query string of this HTTP method.
intgetRecoverableExceptionCount()
StringgetRequestCharSet()
Returns the character encoding of the request from the Content-Type header.
HeadergetRequestHeader(String headerName)
Returns the specified request header.
protected HeaderGroupgetRequestHeaderGroup()
Gets the header group storing the request headers.
Header[]getRequestHeaders()
Returns an array of the requests headers that the HTTP method currently has
Header[]getRequestHeaders(String headerName)
byte[]getResponseBody()
Returns the response body of the HTTP method, if any, as an array of bytes.
InputStreamgetResponseBodyAsStream()
Returns the response body of the HTTP method, if any, as an InputStream.
StringgetResponseBodyAsString()
Returns the response body of the HTTP method, if any, as a String.
StringgetResponseCharSet()
Returns the character encoding of the response from the Content-Type header.
longgetResponseContentLength()
Return the length (in bytes) of the response body, as specified in a Content-Length header.
HeadergetResponseFooter(String footerName)
Gets the response footer associated with the given name.
Header[]getResponseFooters()
Returns an array of the response footers that the HTTP method currently has in the order in which they were read.
HeadergetResponseHeader(String headerName)
Gets the response header associated with the given name.
protected HeaderGroupgetResponseHeaderGroup()
Gets the header group storing the response headers.
Header[]getResponseHeaders(String headerName)
Header[]getResponseHeaders()
Returns an array of the response headers that the HTTP method currently has in the order in which they were read.
protected InputStreamgetResponseStream()
Returns a stream from which the body of the current response may be read.
protected HeaderGroupgetResponseTrailerHeaderGroup()
Gets the header group storing the response trailer headers as per RFC 2616 section 3.6.1.
intgetStatusCode()
Returns the response status code.
StatusLinegetStatusLine()
Provides access to the response status line.
StringgetStatusText()
Returns the status text (or "reason phrase") associated with the latest response.
URIgetURI()
Returns the URI of the HTTP method
booleanhasBeenUsed()
Returns true if the HTTP method has been already executed, but not recycled.
booleanisAborted()
Tests whether the execution of this method has been aborted
protected booleanisConnectionCloseForced()
Tests if the connection should be force-closed when no longer needed.
booleanisHttp11()
Returns true if version 1.1 of the HTTP protocol should be used per default, false if version 1.0 should be used.
booleanisRequestSent()
Returns true if the HTTP has been transmitted to the target server in its entirety, false otherwise.
booleanisStrictMode()
protected voidprocessResponseBody(HttpState state, HttpConnection conn)
This method is invoked immediately after readResponseBody and can be overridden by sub-classes in order to provide custom body processing.
protected voidprocessResponseHeaders(HttpState state, HttpConnection conn)
This method is invoked immediately after readResponseHeaders and can be overridden by sub-classes in order to provide custom response headers processing.
protected voidprocessStatusLine(HttpState state, HttpConnection conn)
This method is invoked immediately after readStatusLine and can be overridden by sub-classes in order to provide custom response status line processing.
protected voidreadResponse(HttpState state, HttpConnection conn)
Reads the response from the given connection.
protected voidreadResponseBody(HttpState state, HttpConnection conn)
Read the response body from the given HttpConnection.
protected voidreadResponseHeaders(HttpState state, HttpConnection conn)
Reads the response headers from the given connection.
protected voidreadStatusLine(HttpState state, HttpConnection conn)
Read the status line from the given HttpConnection, setting my status code and status text.
voidrecycle()
Recycles the HTTP method so that it can be used again.
voidreleaseConnection()
Releases the connection being used by this HTTP method.
voidremoveRequestHeader(String headerName)
Remove the request header associated with the given name.
voidremoveRequestHeader(Header header)
Removes the given request header.
protected voidresponseBodyConsumed()
A response has been consumed.
protected voidsetConnectionCloseForced(boolean b)
Sets whether or not the connection should be force-closed when no longer needed.
voidsetDoAuthentication(boolean doAuthentication)
Sets whether or not the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.)
voidsetFollowRedirects(boolean followRedirects)
Sets whether or not the HTTP method should automatically follow HTTP redirects (status code 302, etc.)
voidsetHostConfiguration(HostConfiguration hostconfig)
voidsetHttp11(boolean http11)
Sets whether version 1.1 of the HTTP protocol should be used per default.
voidsetMethodRetryHandler(MethodRetryHandler handler)
Sets the retry handler for this HTTP method
voidsetParams(HttpMethodParams params)
Assigns HTTP protocol parameters for this method.
voidsetPath(String path)
Sets the path of the HTTP method.
voidsetQueryString(String queryString)
Sets the query string of this HTTP method.
voidsetQueryString(NameValuePair[] params)
Sets the query string of this HTTP method.
voidsetRequestHeader(String headerName, String headerValue)
Set the specified request header, overwriting any previous value.
voidsetRequestHeader(Header header)
Sets the specified request header, overwriting any previous value.
protected voidsetResponseStream(InputStream responseStream)
Sets the response stream.
voidsetStrictMode(boolean strictMode)
Defines how strictly HttpClient follows the HTTP protocol specification (RFC 2616 and other relevant RFCs).
voidsetURI(URI uri)
Sets the URI for this method.
protected booleanshouldCloseConnection(HttpConnection conn)
Tests if the connection should be closed after the method has been executed.
booleanvalidate()
Returns true the method is ready to execute, false otherwise.
protected voidwriteRequest(HttpState state, HttpConnection conn)

Sends the request via the given connection.

protected booleanwriteRequestBody(HttpState state, HttpConnection conn)
Writes the request body to the given connection.
protected voidwriteRequestHeaders(HttpState state, HttpConnection conn)
Writes the request headers to the given connection.
protected voidwriteRequestLine(HttpState state, HttpConnection conn)
Writes the request line to the given connection.

Constructor Detail

HttpMethodBase

public HttpMethodBase()
No-arg constructor.

HttpMethodBase

public HttpMethodBase(String uri)
Constructor specifying a URI. It is responsibility of the caller to ensure that URI elements (path & query parameters) are properly encoded (URL safe).

Parameters: uri either an absolute or relative URI. The URI is expected to be URL-encoded

Throws: IllegalArgumentException when URI is invalid IllegalStateException when protocol of the absolute URI is not recognised

Method Detail

abort

public void abort()
Aborts the execution of this method.

Since: 3.0

addCookieRequestHeader

protected void addCookieRequestHeader(HttpState state, HttpConnection conn)
Generates Cookie request headers for those cookies that match the given host, port and path.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

addHostRequestHeader

protected void addHostRequestHeader(HttpState state, HttpConnection conn)
Generates Host request header, as long as no Host request header already exists.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

addProxyConnectionHeader

protected void addProxyConnectionHeader(HttpState state, HttpConnection conn)
Generates Proxy-Connection: Keep-Alive request header when communicating via a proxy server.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

addRequestHeader

public void addRequestHeader(Header header)
Adds the specified request header, NOT overwriting any previous value. Note that header-name matching is case insensitive.

Parameters: header the header to add to the request

addRequestHeader

public void addRequestHeader(String headerName, String headerValue)
Adds the specified request header, NOT overwriting any previous value. Note that header-name matching is case insensitive.

Parameters: headerName the header's name headerValue the header's value

addRequestHeaders

protected void addRequestHeaders(HttpState state, HttpConnection conn)
Generates all the required request headers to be submitted via the given connection.

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

Subclasses may want to override this method to to add additional headers, and may choose to invoke this implementation (via super) to add the "standard" headers.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: HttpMethodBase

addResponseFooter

public void addResponseFooter(Header footer)
Use this method internally to add footers.

Parameters: footer The footer to add.

addUserAgentRequestHeader

protected void addUserAgentRequestHeader(HttpState state, HttpConnection conn)
Generates default User-Agent request header, as long as no User-Agent request header already exists.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

checkNotUsed

protected void checkNotUsed()
Throws an IllegalStateException if the HTTP method has been already executed, but not recycled.

Throws: IllegalStateException if the method has been used and not recycled

checkUsed

protected void checkUsed()
Throws an IllegalStateException if the HTTP method has not been executed since last recycle.

Throws: IllegalStateException if not used

execute

public int execute(HttpState state, HttpConnection conn)
Executes this method using the specified HttpConnection and HttpState.

Parameters: state state information to associate with this request. Must be non-null. conn the connection to used to execute this HTTP method. Must be non-null.

Returns: the integer status code if one was obtained, or -1

Throws: IOException if an I/O (transport) error occurs HttpException if a protocol exception occurs.

generateRequestLine

protected static String generateRequestLine(HttpConnection connection, String name, String requestPath, String query, String version)
Generates HTTP request line according to the specified attributes.

Parameters: connection the connection used to execute this HTTP method name the method name generate a request for requestPath the path string for the request query the query string for the request version the protocol version to use (e.g. HTTP/1.0)

Returns: HTTP request line

getAuthenticationRealm

public String getAuthenticationRealm()

Deprecated: use #getHostAuthState()

Returns authentication realm, if it has been used during authentication process. Otherwise returns null.

Returns: authentication realm

getContentCharSet

protected String getContentCharSet(Header contentheader)
Returns the character set from the Content-Type header.

Parameters: contentheader The content header.

Returns: String The character set.

getDoAuthentication

public boolean getDoAuthentication()
Returns true if the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.), false otherwise

Returns: true if authentication challenges will be processed automatically, false otherwise.

Since: 2.0

getEffectiveVersion

public HttpVersion getEffectiveVersion()
Returns the HTTP version used with this method (may be null if undefined, that is, the method has not been executed)

Returns: HTTP version.

Since: 3.0

getFollowRedirects

public boolean getFollowRedirects()
Returns true if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), false otherwise.

Returns: true if the method will automatically follow HTTP redirects, false otherwise.

getHostAuthState

public AuthState getHostAuthState()
Returns the target host authentication state

Returns: host authentication state

Since: 3.0

getHostConfiguration

public HostConfiguration getHostConfiguration()

Deprecated: no longer applicable

Returns the host configuration.

Returns: the host configuration

getMethodRetryHandler

public MethodRetryHandler getMethodRetryHandler()

Deprecated: use HttpMethodParams

Returns the retry handler for this HTTP method

Returns: the methodRetryHandler

getName

public abstract String getName()
Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".

Returns: the name of this method

getParams

public HttpMethodParams getParams()
Returns HTTP protocol parameters associated with this method.

Returns: HTTP parameters.

Since: 3.0

getPath

public String getPath()
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.

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

getProxyAuthenticationRealm

public String getProxyAuthenticationRealm()

Deprecated: use #getProxyAuthState()

Returns proxy authentication realm, if it has been used during authentication process. Otherwise returns null.

Returns: proxy authentication realm

getProxyAuthState

public AuthState getProxyAuthState()
Returns the proxy authentication state

Returns: host authentication state

Since: 3.0

getQueryString

public String getQueryString()
Gets the query string of this HTTP method.

Returns: The query string

getRecoverableExceptionCount

public int getRecoverableExceptionCount()

Deprecated: no longer used Returns the number of "recoverable" exceptions thrown and handled, to allow for monitoring the quality of the connection.

Returns: The number of recoverable exceptions handled by the method.

getRequestCharSet

public String getRequestCharSet()
Returns the character encoding of the request from the Content-Type header.

Returns: String The character set.

getRequestHeader

public Header getRequestHeader(String headerName)
Returns the specified request header. Note that header-name matching is case insensitive. null will be returned if either headerName is null or there is no matching header for headerName.

Parameters: headerName The name of the header to be returned.

Returns: The specified request header.

Since: 3.0

getRequestHeaderGroup

protected HeaderGroup getRequestHeaderGroup()
Gets the header group storing the request headers.

Returns: a HeaderGroup

Since: 2.0beta1

getRequestHeaders

public Header[] getRequestHeaders()
Returns an array of the requests headers that the HTTP method currently has

Returns: an array of my request headers.

getRequestHeaders

public Header[] getRequestHeaders(String headerName)

See Also: HttpMethod

getResponseBody

public byte[] getResponseBody()
Returns the response body of the HTTP method, if any, as an array of bytes. If response body is not available or cannot be read, returns null Note: This will cause the entire response body to be buffered in memory. A malicious server may easily exhaust all the VM memory. It is strongly recommended, to use getResponseAsStream if the content length of the response is unknown or resonably large.

Returns: The response body.

Throws: IOException If an I/O (transport) problem occurs while obtaining the response body.

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()
Returns the response body of the HTTP method, if any, as an InputStream. If response body is not available, returns null

Returns: The response body

Throws: IOException If an I/O (transport) problem occurs while obtaining the response body.

getResponseBodyAsString

public String getResponseBodyAsString()
Returns the response body of the HTTP method, if any, as a String. If response body is not available or cannot be read, returns null The string conversion on the data is done using the character encoding specified in Content-Type header. Note: This will cause the entire response body to be buffered in memory. A malicious server may easily exhaust all the VM memory. It is strongly recommended, to use getResponseAsStream if the content length of the response is unknown or resonably large.

Returns: The response body.

Throws: IOException If an I/O (transport) problem occurs while obtaining the response body.

getResponseCharSet

public String getResponseCharSet()
Returns the character encoding of the response from the Content-Type header.

Returns: String The character set.

getResponseContentLength

public long getResponseContentLength()
Return the length (in bytes) of the response body, as specified in a Content-Length header.

Return -1 when the content-length is unknown.

Returns: content length, if Content-Length header is available. 0 indicates that the request has no body. If Content-Length header is not present, the method returns -1.

getResponseFooter

public Header getResponseFooter(String footerName)
Gets the response footer associated with the given name. Footer name matching is case insensitive. null will be returned if either footerName is null or there is no matching footer for footerName or there are no footers available. If there are multiple footers with the same name, there values will be combined with the ',' separator as specified by RFC2616.

Parameters: footerName the footer name to match

Returns: the matching footer

getResponseFooters

public Header[] getResponseFooters()
Returns an array of the response footers that the HTTP method currently has in the order in which they were read.

Returns: an array of footers

getResponseHeader

public Header getResponseHeader(String headerName)
Gets the response header associated with the given name. Header name matching is case insensitive. null will be returned if either headerName is null or there is no matching header for headerName.

Parameters: headerName the header name to match

Returns: the matching header

getResponseHeaderGroup

protected HeaderGroup getResponseHeaderGroup()
Gets the header group storing the response headers.

Returns: a HeaderGroup

Since: 2.0beta1

getResponseHeaders

public Header[] getResponseHeaders(String headerName)

Since: 3.0

See Also:

getResponseHeaders

public Header[] getResponseHeaders()
Returns an array of the response headers that the HTTP method currently has in the order in which they were read.

Returns: an array of response headers.

getResponseStream

protected InputStream getResponseStream()
Returns a stream from which the body of the current response may be read. If the method has not yet been executed, if responseBodyConsumed has been called, or if the stream returned by a previous call has been closed, null will be returned.

Returns: the current response stream

getResponseTrailerHeaderGroup

protected HeaderGroup getResponseTrailerHeaderGroup()
Gets the header group storing the response trailer headers as per RFC 2616 section 3.6.1.

Returns: a HeaderGroup

Since: 2.0beta1

getStatusCode

public int getStatusCode()
Returns the response status code.

Returns: the status code associated with the latest response.

getStatusLine

public StatusLine getStatusLine()
Provides access to the response status line.

Returns: the status line object from the latest response.

Since: 2.0

getStatusText

public String getStatusText()
Returns the status text (or "reason phrase") associated with the latest response.

Returns: The status text.

getURI

public URI getURI()
Returns the URI of the HTTP method

Returns: The URI

Throws: URIException If the URI cannot be created.

See Also: getURI

hasBeenUsed

public boolean hasBeenUsed()
Returns true if the HTTP method has been already executed, but not recycled.

Returns: true if the method has been executed, false otherwise

isAborted

public boolean isAborted()
Tests whether the execution of this method has been aborted

Returns: true if the execution of this method has been aborted, false otherwise

Since: 3.0

isConnectionCloseForced

protected boolean isConnectionCloseForced()
Tests if the connection should be force-closed when no longer needed.

Returns: true if the connection must be closed

isHttp11

public boolean isHttp11()

Deprecated: Use getVersion

Returns true if version 1.1 of the HTTP protocol should be used per default, false if version 1.0 should be used.

Returns: true to use HTTP/1.1, false to use 1.0

isRequestSent

public boolean isRequestSent()
Returns true if the HTTP has been transmitted to the target server in its entirety, false otherwise. This flag can be useful for recovery logic. If the request has not been transmitted in its entirety, it is safe to retry the failed method.

Returns: true if the request has been sent, false otherwise

isStrictMode

public boolean isStrictMode()

Deprecated: Use HttpParams to exercise a more granular control over HTTP protocol strictness.

Returns: false

processResponseBody

protected void processResponseBody(HttpState state, HttpConnection conn)
This method is invoked immediately after readResponseBody and can be overridden by sub-classes in order to provide custom body processing.

This implementation does nothing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

See Also: HttpMethodBase HttpMethodBase

processResponseHeaders

protected void processResponseHeaders(HttpState state, HttpConnection conn)
This method is invoked immediately after readResponseHeaders and can be overridden by sub-classes in order to provide custom response headers processing.

This implementation will handle the Set-Cookie and Set-Cookie2 headers, if any, adding the relevant cookies to the given HttpState.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

See Also: HttpMethodBase HttpMethodBase

processStatusLine

protected void processStatusLine(HttpState state, HttpConnection conn)
This method is invoked immediately after readStatusLine and can be overridden by sub-classes in order to provide custom response status line processing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

See Also: HttpMethodBase HttpMethodBase

readResponse

protected void readResponse(HttpState state, HttpConnection conn)
Reads the response from the given connection.

The response is processed as the following sequence of actions:

  1. readStatusLine is invoked to read the request line.
  2. processStatusLine is invoked, allowing the method to process the status line if desired.
  3. readResponseHeaders is invoked to read the associated headers.
  4. processResponseHeaders is invoked, allowing the method to process the headers if desired.
  5. readResponseBody is invoked to read the associated body (if any).
  6. processResponseBody is invoked, allowing the method to process the response body if desired.
Subclasses may want to override one or more of the above methods to to customize the processing. (Or they may choose to override this method if dramatically different processing is required.)

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

readResponseBody

protected void readResponseBody(HttpState state, HttpConnection conn)
Read the response body from the given HttpConnection.

The current implementation wraps the socket level stream with an appropriate stream for the type of response (chunked, content-length, or auto-close). If there is no response body, the connection associated with the request will be returned to the connection manager.

Subclasses may want to override this method to to customize the processing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: HttpMethodBase HttpMethodBase

readResponseHeaders

protected void readResponseHeaders(HttpState state, HttpConnection conn)
Reads the response headers from the given connection.

Subclasses may want to override this method to to customize the processing.

"It must be possible to combine the multiple header fields into one "field-name: field-value" pair, without changing the semantics of the message, by appending each subsequent field-value to the first, each separated by a comma." - HTTP/1.0 (4.3)

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: HttpMethodBase HttpMethodBase

readStatusLine

protected void readStatusLine(HttpState state, HttpConnection conn)
Read the status line from the given HttpConnection, setting my status code and status text.

Subclasses may want to override this method to to customize the processing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: StatusLine

recycle

public void recycle()

Deprecated: no longer supported and will be removed in the future version of HttpClient

Recycles the HTTP method so that it can be used again. Note that all of the instance variables will be reset once this method has been called. This method will also release the connection being used by this HTTP method.

See Also:

releaseConnection

public void releaseConnection()
Releases the connection being used by this HTTP method. In particular the connection is used to read the response(if there is one) and will be held until the response has been read. If the connection can be reused by other HTTP methods it is NOT closed at this point.

Since: 2.0

removeRequestHeader

public void removeRequestHeader(String headerName)
Remove the request header associated with the given name. Note that header-name matching is case insensitive.

Parameters: headerName the header name

removeRequestHeader

public void removeRequestHeader(Header header)
Removes the given request header.

Parameters: header the header

responseBodyConsumed

protected void responseBodyConsumed()
A response has been consumed.

The default behavior for this class is to check to see if the connection should be closed, and close if need be, and to ensure that the connection is returned to the connection manager - if and only if we are not still inside the execute call.

setConnectionCloseForced

protected void setConnectionCloseForced(boolean b)
Sets whether or not the connection should be force-closed when no longer needed. This value should only be set to true in abnormal circumstances, such as HTTP protocol violations.

Parameters: b true if the connection must be closed, false otherwise.

setDoAuthentication

public void setDoAuthentication(boolean doAuthentication)
Sets whether or not the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.)

Parameters: doAuthentication true to process authentication challenges authomatically, false otherwise.

Since: 2.0

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)
Sets whether or not the HTTP method should automatically follow HTTP redirects (status code 302, etc.)

Parameters: followRedirects true if the method will automatically follow redirects, false otherwise.

setHostConfiguration

public void setHostConfiguration(HostConfiguration hostconfig)

Deprecated: no longer applicable

Sets the host configuration.

Parameters: hostconfig The hostConfiguration to set

setHttp11

public void setHttp11(boolean http11)

Deprecated: Use setVersion

Sets whether version 1.1 of the HTTP protocol should be used per default.

Parameters: http11 true to use HTTP/1.1, false to use 1.0

setMethodRetryHandler

public void setMethodRetryHandler(MethodRetryHandler handler)

Deprecated: use HttpMethodParams

Sets the retry handler for this HTTP method

Parameters: handler the methodRetryHandler to use when this method executed

setParams

public void setParams(HttpMethodParams params)
Assigns HTTP protocol parameters for this method.

Since: 3.0

See Also: HttpMethodParams

setPath

public void setPath(String path)
Sets the path of the HTTP method. It is responsibility of the caller to ensure that the path is properly encoded (URL safe).

Parameters: path the path of the HTTP method. The path is expected to be URL-encoded

setQueryString

public void setQueryString(String queryString)
Sets the query string of this HTTP method. The caller must ensure that the string is properly URL encoded. The query string should not start with the question mark character.

Parameters: queryString the query string

See Also: (NameValuePair[], String)

setQueryString

public void setQueryString(NameValuePair[] params)
Sets the query string of this HTTP method. The pairs are encoded as UTF-8 characters. To use a different charset the parameters can be encoded manually using EncodingUtil and set as a single String.

Parameters: params an array of NameValuePairs to add as query string parameters. The name/value pairs will be automcatically URL encoded

See Also: (NameValuePair[], String) setQueryString

setRequestHeader

public void setRequestHeader(String headerName, String headerValue)
Set the specified request header, overwriting any previous value. Note that header-name matching is case-insensitive.

Parameters: headerName the header's name headerValue the header's value

setRequestHeader

public void setRequestHeader(Header header)
Sets the specified request header, overwriting any previous value. Note that header-name matching is case insensitive.

Parameters: header the header

setResponseStream

protected void setResponseStream(InputStream responseStream)
Sets the response stream.

Parameters: responseStream The new response stream.

setStrictMode

public void setStrictMode(boolean strictMode)

Deprecated: Use HttpParams to exercise a more granular control over HTTP protocol strictness.

Defines how strictly HttpClient follows the HTTP protocol specification (RFC 2616 and other relevant RFCs). In the strict mode HttpClient precisely implements the requirements of the specification, whereas in non-strict mode it attempts to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect.

Parameters: strictMode true for strict mode, false otherwise

setURI

public void setURI(URI uri)
Sets the URI for this method.

Parameters: uri URI to be set

Throws: URIException if a URI cannot be set

Since: 3.0

shouldCloseConnection

protected boolean shouldCloseConnection(HttpConnection conn)
Tests if the connection should be closed after the method has been executed. The connection will be left open when using HTTP/1.1 or if Connection: keep-alive header was sent.

Parameters: conn the connection in question

Returns: boolean true if we should close the connection.

validate

public boolean validate()
Returns true the method is ready to execute, false otherwise.

Returns: This implementation always returns true.

writeRequest

protected void writeRequest(HttpState state, HttpConnection conn)

Sends the request via the given connection.

The request is written as the following sequence of actions:

  1. HttpMethodBase is invoked to write the request line.
  2. HttpMethodBase is invoked to write the associated headers.
  3. \r\n is sent to close the head part of the request.
  4. HttpMethodBase is invoked to write the body part of the request.

Subclasses may want to override one or more of the above methods to to customize the processing. (Or they may choose to override this method if dramatically different processing is required.)

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

writeRequestBody

protected boolean writeRequestBody(HttpState state, HttpConnection conn)
Writes the request body to the given connection.

This method should return true if the request body was actually sent (or is empty), or false if it could not be sent for some reason.

This implementation writes nothing and returns true.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

Returns: true

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.

writeRequestHeaders

protected void writeRequestHeaders(HttpState state, HttpConnection conn)
Writes the request headers to the given connection.

This implementation invokes addRequestHeaders, and then writes each header to the request stream.

Subclasses may want to override this method to to customize the processing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: HttpMethodBase HttpMethodBase

writeRequestLine

protected void writeRequestLine(HttpState state, HttpConnection conn)
Writes the request line to the given connection.

Subclasses may want to override this method to to customize the processing.

Parameters: state the state information associated with this method conn the connection used to execute this HTTP method

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.

See Also: HttpMethodBase

Copyright (c) 1999-2005 - Apache Software Foundation