HttpMethodBase (HttpClient 3.1 API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.httpclient
Class HttpMethodBase

java.lang.Object
  org.apache.commons.httpclient.HttpMethodBase

All Implemented Interfaces:: HttpMethod

Direct Known Subclasses:: ConnectMethod, DeleteMethod, ExpectContinueMethod, GetMethod, HeadMethod, OptionsMethod, TraceMethod

public abstract class HttpMethodBase
extends Object
implements HttpMethod
extends Object
implements HttpMethod

An abstract base implementation of HttpMethod.

At minimum, subclasses will need to override:

getName() to return the approriate name for this method

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

addRequestHeaders(HttpState,HttpConnection) to write those headers

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

processResponseHeaders(HttpState,HttpConnection) to handle those headers

Version:: $Revision: 1425331 $ $Date: 2012-12-22 18:29:41 +0000 (Sat, 22 Dec 2012) $
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

Field Summary
`protected HttpVersion`	`effectiveVersion` HTTP protocol version used for execution of this method.
`protected StatusLine`	`statusLine` The Status-Line from the response.

Constructor Summary
`HttpMethodBase()` No-arg constructor.
`HttpMethodBase(String uri)` Constructor specifying a URI.

Method Summary
`void`	`abort()` Aborts the execution of this method.
`protected void`	`addCookieRequestHeader(HttpState state, HttpConnection conn)` Generates `Cookie` request headers for those `cookie`s that match the given host, port and path.
`protected void`	`addHostRequestHeader(HttpState state, HttpConnection conn)` Generates `Host` request header, as long as no `Host` request header already exists.
`protected void`	`addProxyConnectionHeader(HttpState state, HttpConnection conn)` Generates `Proxy-Connection: Keep-Alive` request header when communicating via a proxy server.
`void`	`addRequestHeader(Header header)` Adds the specified request header, NOT overwriting any previous value.
`void`	`addRequestHeader(String headerName, String headerValue)` Adds the specified request header, NOT overwriting any previous value.
`protected void`	`addRequestHeaders(HttpState state, HttpConnection conn)` Generates all the required request `header`s to be submitted via the given `connection`.
`void`	`addResponseFooter(Header footer)` Use this method internally to add footers.
`protected void`	`addUserAgentRequestHeader(HttpState state, HttpConnection conn)` Generates default `User-Agent` request header, as long as no `User-Agent` request header already exists.
`protected void`	`checkNotUsed()` Throws an `IllegalStateException` if the HTTP method has been already `executed`, but not `recycled`.
`protected void`	`checkUsed()` Throws an `IllegalStateException` if the HTTP method has not been `executed` since last `recycle`.
`int`	`execute(HttpState state, HttpConnection conn)` Executes this method using the specified `HttpConnection` and `HttpState`.
`protected static String`	`generateRequestLine(HttpConnection connection, String name, String requestPath, String query, String version)` Generates HTTP request line according to the specified attributes.
`String`	`getAuthenticationRealm()` Deprecated. use #getHostAuthState()
`protected String`	`getContentCharSet(Header contentheader)` Returns the character set from the `Content-Type` header.
`boolean`	`getDoAuthentication()` Returns `true` if the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.), `false` otherwise
`HttpVersion`	`getEffectiveVersion()` Returns the HTTP version used with this method (may be `null` if undefined, that is, the method has not been executed)
`boolean`	`getFollowRedirects()` Returns `true` if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), `false` otherwise.
`AuthState`	`getHostAuthState()` Returns the target host `authentication state`
`HostConfiguration`	`getHostConfiguration()` Deprecated. no longer applicable
`MethodRetryHandler`	`getMethodRetryHandler()` Deprecated. use `HttpMethodParams`
`abstract String`	`getName()` Obtains the name of the HTTP method as used in the HTTP request line, for example `"GET"` or `"POST"`.
`HttpMethodParams`	`getParams()` Returns `HTTP protocol parameters` associated with this method.
`String`	`getPath()` Gets the path of this HTTP method.
`String`	`getProxyAuthenticationRealm()` Deprecated. use #getProxyAuthState()
`AuthState`	`getProxyAuthState()` Returns the proxy `authentication state`
`String`	`getQueryString()` Gets the query string of this HTTP method.
`int`	`getRecoverableExceptionCount()` Deprecated. no longer used Returns the number of "recoverable" exceptions thrown and handled, to allow for monitoring the quality of the connection.
`String`	`getRequestCharSet()` Returns the character encoding of the request from the `Content-Type` header.
`Header`	`getRequestHeader(String headerName)` Returns the specified request header.
`protected HeaderGroup`	`getRequestHeaderGroup()` 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)` Returns the request headers with the given name.
`byte[]`	`getResponseBody()` Returns the response body of the HTTP method, if any, as an array of bytes.
`byte[]`	`getResponseBody(int maxlen)` Returns the response body of the HTTP method, if any, as an array of bytes.
`InputStream`	`getResponseBodyAsStream()` Returns the response body of the HTTP method, if any, as an `InputStream`.
`String`	`getResponseBodyAsString()` Returns the response body of the HTTP method, if any, as a `String`.
`String`	`getResponseBodyAsString(int maxlen)` Returns the response body of the HTTP method, if any, as a `String`.
`String`	`getResponseCharSet()` Returns the character encoding of the response from the `Content-Type` header.
`long`	`getResponseContentLength()` Return the length (in bytes) of the response body, as specified in a `Content-Length` header.
`Header`	`getResponseFooter(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.
`Header`	`getResponseHeader(String headerName)` Gets the response header associated with the given name.
`protected HeaderGroup`	`getResponseHeaderGroup()` Gets the `header group` storing the response headers.
`Header[]`	`getResponseHeaders()` Returns an array of the response headers that the HTTP method currently has in the order in which they were read.
`Header[]`	`getResponseHeaders(String headerName)` Returns the response headers with the given name.
`protected InputStream`	`getResponseStream()` Returns a stream from which the body of the current response may be read.
`protected HeaderGroup`	`getResponseTrailerHeaderGroup()` Gets the `header group` storing the response trailer headers as per RFC 2616 section 3.6.1.
`int`	`getStatusCode()` Returns the response status code.
`StatusLine`	`getStatusLine()` Provides access to the response status line.
`String`	`getStatusText()` Returns the status text (or "reason phrase") associated with the latest response.
`URI`	`getURI()` Returns the URI of the HTTP method
`boolean`	`hasBeenUsed()` Returns `true` if the HTTP method has been already `executed`, but not `recycled`.
`boolean`	`isAborted()` Tests whether the execution of this method has been aborted
`protected boolean`	`isConnectionCloseForced()` Tests if the connection should be force-closed when no longer needed.
`boolean`	`isHttp11()` Deprecated. Use `HttpMethodParams.getVersion()`
`boolean`	`isRequestSent()` Returns `true` if the HTTP has been transmitted to the target server in its entirety, `false` otherwise.
`boolean`	`isStrictMode()` Deprecated. Use `HttpParams.setParameter(String, Object)` to exercise a more granular control over HTTP protocol strictness.
`protected void`	`processCookieHeaders(CookieSpec parser, Header[] headers, HttpState state, HttpConnection conn)` This method processes the specified cookie headers.
`protected void`	`processResponseBody(HttpState state, HttpConnection conn)` This method is invoked immediately after `readResponseBody(HttpState,HttpConnection)` and can be overridden by sub-classes in order to provide custom body processing.
`protected void`	`processResponseHeaders(HttpState state, HttpConnection conn)` This method is invoked immediately after `readResponseHeaders(HttpState,HttpConnection)` and can be overridden by sub-classes in order to provide custom response headers processing.
`protected void`	`processStatusLine(HttpState state, HttpConnection conn)` This method is invoked immediately after `readStatusLine(HttpState,HttpConnection)` and can be overridden by sub-classes in order to provide custom response status line processing.
`protected void`	`readResponse(HttpState state, HttpConnection conn)` Reads the response from the given `connection`.
`protected void`	`readResponseBody(HttpState state, HttpConnection conn)` Read the response body from the given `HttpConnection`.
`protected void`	`readResponseHeaders(HttpState state, HttpConnection conn)` Reads the response headers from the given `connection`.
`protected void`	`readStatusLine(HttpState state, HttpConnection conn)` Read the status line from the given `HttpConnection`, setting my `status code` and `status text`.
`void`	`recycle()` Deprecated. no longer supported and will be removed in the future version of HttpClient
`void`	`releaseConnection()` Releases the connection being used by this HTTP method.
`void`	`removeRequestHeader(Header header)` Removes the given request header.
`void`	`removeRequestHeader(String headerName)` Remove the request header associated with the given name.
`protected void`	`responseBodyConsumed()` A response has been consumed.
`protected void`	`setConnectionCloseForced(boolean b)` Sets whether or not the connection should be force-closed when no longer needed.
`void`	`setDoAuthentication(boolean doAuthentication)` Sets whether or not the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.)
`void`	`setFollowRedirects(boolean followRedirects)` Sets whether or not the HTTP method should automatically follow HTTP redirects (status code 302, etc.)
`void`	`setHostConfiguration(HostConfiguration hostconfig)` Deprecated. no longer applicable
`void`	`setHttp11(boolean http11)` Deprecated. Use `HttpMethodParams.setVersion(HttpVersion)`
`void`	`setMethodRetryHandler(MethodRetryHandler handler)` Deprecated. use `HttpMethodParams`
`void`	`setParams(HttpMethodParams params)` Assigns `HTTP protocol parameters` for this method.
`void`	`setPath(String path)` Sets the path of the HTTP method.
`void`	`setQueryString(NameValuePair[] params)` Sets the query string of this HTTP method.
`void`	`setQueryString(String queryString)` Sets the query string of this HTTP method.
`void`	`setRequestHeader(Header header)` Sets the specified request header, overwriting any previous value.
`void`	`setRequestHeader(String headerName, String headerValue)` Set the specified request header, overwriting any previous value.
`protected void`	`setResponseStream(InputStream responseStream)` Sets the response stream.
`void`	`setStrictMode(boolean strictMode)` Deprecated. Use `HttpParams.setParameter(String, Object)` to exercise a more granular control over HTTP protocol strictness.
`void`	`setURI(URI uri)` Sets the URI for this method.
`protected boolean`	`shouldCloseConnection(HttpConnection conn)` Tests if the connection should be closed after the method has been executed.
`boolean`	`validate()` Returns `true` the method is ready to execute, `false` otherwise.
`protected void`	`writeRequest(HttpState state, HttpConnection conn)` Sends the request via the given `connection`.
`protected boolean`	`writeRequestBody(HttpState state, HttpConnection conn)` Writes the request body to the given `connection`.
`protected void`	`writeRequestHeaders(HttpState state, HttpConnection conn)` Writes the request headers to the given `connection`.
`protected void`	`writeRequestLine(HttpState state, HttpConnection conn)` Writes the request line to the given `connection`.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

statusLine

protected StatusLine statusLine

The Status-Line from the response.

effectiveVersion

protected HttpVersion effectiveVersion

HTTP protocol version used for execution of this method.

Constructor Detail

HttpMethodBase

public HttpMethodBase()

No-arg constructor.

HttpMethodBase

public HttpMethodBase(String uri)
               throws IllegalArgumentException,
                      IllegalStateException

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

getName

public abstract String getName()

Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".

Specified by:: getName in interface HttpMethod

Returns:: the name of this method

getURI

public URI getURI()
           throws URIException

Returns the URI of the HTTP method

Specified by:: getURI in interface HttpMethod

Returns:: The URI
Throws:: URIException - If the URI cannot be created.
See Also:: HttpMethod.getURI()

setURI

public void setURI(URI uri)
            throws URIException

Sets the URI for this method.

Specified by:: setURI in interface HttpMethod

Parameters:: uri - URI to be set
Throws:: URIException - if a URI cannot be set
Since:: 3.0

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

Sets whether or not the HTTP method should automatically follow HTTP redirects (status code 302, etc.)

Specified by:: setFollowRedirects in interface HttpMethod

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

getFollowRedirects

public boolean getFollowRedirects()

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

Specified by:: getFollowRedirects in interface HttpMethod

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

setHttp11

public void setHttp11(boolean http11)

Deprecated. Use HttpMethodParams.setVersion(HttpVersion)

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

getDoAuthentication

public boolean getDoAuthentication()

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

Specified by:: getDoAuthentication in interface HttpMethod

Returns:: true if authentication challenges will be processed automatically, false otherwise.
Since:: 2.0
See Also:: HttpMethod.setDoAuthentication(boolean)

setDoAuthentication

public void setDoAuthentication(boolean doAuthentication)

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

Specified by:: setDoAuthentication in interface HttpMethod

Parameters:: doAuthentication - true to process authentication challenges authomatically, false otherwise.
Since:: 2.0
See Also:: HttpMethod.getDoAuthentication()

isHttp11

public boolean isHttp11()

Deprecated. Use HttpMethodParams.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

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).

Specified by:: setPath in interface HttpMethod

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

addRequestHeader

public void addRequestHeader(Header header)

Adds the specified request header, NOT overwriting any previous value. Note that header-name matching is case insensitive.

Specified by:: addRequestHeader in interface HttpMethod

Parameters:: header - the header to add to the request
See Also:: HttpMethod.addRequestHeader(String,String), HttpMethod.getRequestHeader(String), HttpMethod.removeRequestHeader(String)

addResponseFooter

public void addResponseFooter(Header footer)

Use this method internally to add footers.

Specified by:: addResponseFooter in interface HttpMethod

Parameters:: footer - The footer to add.

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.

Specified by:: getPath in interface HttpMethod

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

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.

Specified by:: setQueryString in interface HttpMethod

Parameters:: queryString - the query string
See Also:: EncodingUtil.formUrlEncode(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.

Specified by:: setQueryString in interface HttpMethod

Parameters:: params - an array of NameValuePairs to add as query string parameters. The name/value pairs will be automcatically URL encoded
See Also:: EncodingUtil.formUrlEncode(NameValuePair[], String), setQueryString(String)

getQueryString

public String getQueryString()

Gets the query string of this HTTP method.

Specified by:: getQueryString in interface HttpMethod

Returns:: The query string
See Also:: HttpMethod.setQueryString(NameValuePair[]), HttpMethod.setQueryString(String)

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.

Specified by:: setRequestHeader in interface HttpMethod

Parameters:: headerName - the header's name; headerValue - the header's value
See Also:: HttpMethod.setRequestHeader(Header), HttpMethod.getRequestHeader(String), HttpMethod.removeRequestHeader(String)

setRequestHeader

public void setRequestHeader(Header header)

Sets the specified request header, overwriting any previous value. Note that header-name matching is case insensitive.

Specified by:: setRequestHeader in interface HttpMethod

Parameters:: header - the header
See Also:: HttpMethod.setRequestHeader(String,String), HttpMethod.getRequestHeader(String), HttpMethod.removeRequestHeader(String)

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.

Specified by:: getRequestHeader in interface HttpMethod

Parameters:: headerName - The name of the header to be returned.
Returns:: The specified request header.
Since:: 3.0

getRequestHeaders

public Header[] getRequestHeaders()

Returns an array of the requests headers that the HTTP method currently has

Specified by:: getRequestHeaders in interface HttpMethod

Returns:: an array of my request headers.
See Also:: HttpMethod.addRequestHeader(Header), HttpMethod.addRequestHeader(String,String)

getRequestHeaders

public Header[] getRequestHeaders(String headerName)

Description copied from interface: HttpMethod

Returns the request headers with the given name. Note that header-name matching is case insensitive.

Specified by:: getRequestHeaders in interface HttpMethod

Parameters:: headerName - the name of the headers to be returned.
Returns:: an array of zero or more headers
See Also:: HttpMethod.getRequestHeaders(java.lang.String)

getRequestHeaderGroup

protected HeaderGroup getRequestHeaderGroup()

Gets the header group storing the request headers.

Returns:: a HeaderGroup
Since:: 2.0beta1

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

getResponseHeaderGroup

protected HeaderGroup getResponseHeaderGroup()

Gets the header group storing the response headers.

Returns:: a HeaderGroup
Since:: 2.0beta1

getResponseHeaders

public Header[] getResponseHeaders(String headerName)

Description copied from interface: HttpMethod

Returns the response headers with the given name. Note that header-name matching is case insensitive.

Specified by:: getResponseHeaders in interface HttpMethod

Parameters:: headerName - the name of the headers to be returned.
Returns:: an array of zero or more headers
Since:: 3.0
See Also:: HttpMethod.getResponseHeaders(java.lang.String)

getStatusCode

public int getStatusCode()

Returns the response status code.

Specified by:: getStatusCode in interface HttpMethod

Returns:: the status code associated with the latest response.

getStatusLine

public StatusLine getStatusLine()

Provides access to the response status line.

Specified by:: getStatusLine in interface HttpMethod

Returns:: the status line object from the latest response.
Since:: 2.0

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.

Specified by:: getResponseHeaders in interface HttpMethod

Returns:: an array of response headers.

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.

Specified by:: getResponseHeader in interface HttpMethod

Parameters:: headerName - the header name to match
Returns:: the matching header

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.

getResponseBody

public byte[] getResponseBody()
                       throws IOException

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. Buffers the response and this method can be called several times yielding the same result each time. 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.

Specified by:: getResponseBody in interface HttpMethod

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

getResponseBody

public byte[] getResponseBody(int maxlen)
                       throws IOException

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. Buffers the response and this method can be called several times yielding the same result each time. Note: This will cause the entire response body to be buffered in memory. This method is safe if the content length of the response is unknown, because the amount of memory used is limited.

If the response is large this method involves lots of array copying and many object allocations, which makes it unsuitable for high-performance / low-footprint applications. Those applications should use getResponseBodyAsStream().

Parameters:: maxlen - the maximum content length to accept (number of bytes).
Returns:: The response body.
Throws:: IOException - If an I/O (transport) problem occurs while obtaining the response body.

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()
                                    throws IOException

Returns the response body of the HTTP method, if any, as an InputStream. If response body is not available, returns null. If the response has been buffered this method returns a new stream object on every call. If the response has not been buffered the returned stream can only be read once.

Specified by:: getResponseBodyAsStream in interface HttpMethod

Returns:: The response body or null.
Throws:: IOException - If an I/O (transport) problem occurs while obtaining the response body.

getResponseBodyAsString

public String getResponseBodyAsString()
                               throws IOException

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. Buffers the response and this method can be called several times yielding the same result each time. 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.

Specified by:: getResponseBodyAsString in interface HttpMethod

Returns:: The response body or null.
Throws:: IOException - If an I/O (transport) problem occurs while obtaining the response body.

getResponseBodyAsString

public String getResponseBodyAsString(int maxlen)
                               throws IOException

Note: This will cause the entire response body to be buffered in memory. This method is safe if the content length of the response is unknown, because the amount of memory used is limited.

Parameters:: maxlen - the maximum content length to accept (number of bytes). Note that, depending on the encoding, this is not equal to the number of characters.
Returns:: The response body or null.
Throws:: IOException - If an I/O (transport) problem occurs while obtaining the response body.

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.

Specified by:: getResponseFooters in interface HttpMethod

Returns:: an array of footers

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.

Specified by:: getResponseFooter in interface HttpMethod

Parameters:: footerName - the footer name to match
Returns:: the matching footer

setResponseStream

protected void setResponseStream(InputStream responseStream)

Sets the response stream.

Parameters:: responseStream - The new response stream.

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

getStatusText

public String getStatusText()

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

Specified by:: getStatusText in interface HttpMethod

Returns:: The status text.

setStrictMode

public void setStrictMode(boolean strictMode)

Deprecated. Use HttpParams.setParameter(String, Object) 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.

Specified by:: setStrictMode in interface HttpMethod

Parameters:: strictMode - true for strict mode, false otherwise
See Also:: HttpMethod.isStrictMode()

isStrictMode

public boolean isStrictMode()

Deprecated. Use HttpParams.setParameter(String, Object) to exercise a more granular control over HTTP protocol strictness.

Description copied from interface: HttpMethod

Returns the value of the strict mode flag.

Specified by:: isStrictMode in interface HttpMethod

Returns:: false
See Also:: HttpMethod.setStrictMode(boolean)

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.

Specified by:: addRequestHeader in interface HttpMethod

Parameters:: headerName - the header's name; headerValue - the header's value
See Also:: HttpMethod.addRequestHeader(Header), HttpMethod.getRequestHeader(String), HttpMethod.removeRequestHeader(String)

isConnectionCloseForced

protected boolean isConnectionCloseForced()

Tests if the connection should be force-closed when no longer needed.

Returns:: true if the connection must be closed

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.

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.

execute

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

Executes this method using the specified HttpConnection and HttpState.

Specified by:: execute in interface HttpMethod

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.

abort

public void abort()

Aborts the execution of this method.

Specified by:: abort in interface HttpMethod

Since:: 3.0
See Also:: HttpMethod.execute(HttpState, HttpConnection)

hasBeenUsed

public boolean hasBeenUsed()

Returns true if the HTTP method has been already executed, but not recycled.

Specified by:: hasBeenUsed in interface HttpMethod

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

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.

Specified by:: recycle in interface HttpMethod

See Also:: releaseConnection()

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.

Specified by:: releaseConnection in interface HttpMethod

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.

Specified by:: removeRequestHeader in interface HttpMethod

Parameters:: headerName - the header name

removeRequestHeader

public void removeRequestHeader(Header header)

Removes the given request header.

Specified by:: removeRequestHeader in interface HttpMethod

Parameters:: header - the header

validate

public boolean validate()

Returns true the method is ready to execute, false otherwise.

Specified by:: validate in interface HttpMethod

Returns:: This implementation always returns true.

addCookieRequestHeader

protected void addCookieRequestHeader(HttpState state,
                                      HttpConnection conn)
                               throws IOException,
                                      HttpException

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)
                             throws IOException,
                                    HttpException

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)
                                 throws IOException,
                                        HttpException

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.

addRequestHeaders

protected void addRequestHeaders(HttpState state,
                                 HttpConnection conn)
                          throws IOException,
                                 HttpException

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:: writeRequestHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

addUserAgentRequestHeader

protected void addUserAgentRequestHeader(HttpState state,
                                         HttpConnection conn)
                                  throws IOException,
                                         HttpException

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 IllegalStateException

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 IllegalStateException

Throws an IllegalStateException if the HTTP method has not been executed since last recycle.

Throws:: IllegalStateException - if not used

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

processResponseBody

protected void processResponseBody(HttpState state,
                                   HttpConnection conn)

This method is invoked immediately after readResponseBody(HttpState,HttpConnection) 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:: readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), readResponseBody(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

processResponseHeaders

protected void processResponseHeaders(HttpState state,
                                      HttpConnection conn)

This method is invoked immediately after readResponseHeaders(HttpState,HttpConnection) 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:: readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), readResponseHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

processCookieHeaders

protected void processCookieHeaders(CookieSpec parser,
                                    Header[] headers,
                                    HttpState state,
                                    HttpConnection conn)

This method processes the specified cookie headers. It is invoked from within processResponseHeaders(HttpState,HttpConnection)

Parameters:: headers - cookie Headers to be processed; state - the state information associated with this HTTP method; conn - the connection used to execute this HTTP method

processStatusLine

protected void processStatusLine(HttpState state,
                                 HttpConnection conn)

This method is invoked immediately after readStatusLine(HttpState,HttpConnection) 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:: readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), readStatusLine(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

readResponse

protected void readResponse(HttpState state,
                            HttpConnection conn)
                     throws IOException,
                            HttpException

Reads the response from the given connection.

The response is processed as the following sequence of actions:

readStatusLine(HttpState,HttpConnection) is invoked to read the request line.
processStatusLine(HttpState,HttpConnection) is invoked, allowing the method to process the status line if desired.
readResponseHeaders(HttpState,HttpConnection) is invoked to read the associated headers.
processResponseHeaders(HttpState,HttpConnection) is invoked, allowing the method to process the headers if desired.
readResponseBody(HttpState,HttpConnection) is invoked to read the associated body (if any).
processResponseBody(HttpState,HttpConnection) 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)
                         throws IOException,
                                HttpException

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:: readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), processResponseBody(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

readResponseHeaders

protected void readResponseHeaders(HttpState state,
                                   HttpConnection conn)
                            throws IOException,
                                   HttpException

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:: readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), processResponseHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

readStatusLine

protected void readStatusLine(HttpState state,
                              HttpConnection conn)
                       throws IOException,
                              HttpException

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

writeRequest

protected void writeRequest(HttpState state,
                            HttpConnection conn)
                     throws IOException,
                            HttpException

Sends the request via the given connection.

The request is written as the following sequence of actions:

writeRequestLine(HttpState, HttpConnection) is invoked to write the request line.
writeRequestHeaders(HttpState, HttpConnection) is invoked to write the associated headers.
\r\n is sent to close the head part of the request.
writeRequestBody(HttpState, HttpConnection) 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)
                            throws IOException,
                                   HttpException

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)
                            throws IOException,
                                   HttpException

Writes the request headers to the given connection.

This implementation invokes addRequestHeaders(HttpState,HttpConnection), 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:: addRequestHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), getRequestHeaders()

writeRequestLine

protected void writeRequestLine(HttpState state,
                                HttpConnection conn)
                         throws IOException,
                                HttpException

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:: generateRequestLine(org.apache.commons.httpclient.HttpConnection, java.lang.String, java.lang.String, java.lang.String, java.lang.String)

getParams

public HttpMethodParams getParams()

Returns HTTP protocol parameters associated with this method.

Specified by:: getParams in interface HttpMethod

Returns:: HTTP parameters.
Since:: 3.0
See Also:: HttpMethodParams

setParams

public void setParams(HttpMethodParams params)

Assigns HTTP protocol parameters for this method.

Specified by:: setParams in interface HttpMethod

Since:: 3.0
See Also:: HttpMethodParams

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

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

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.

getRequestCharSet

public String getRequestCharSet()

Returns the character encoding of the request from the Content-Type header.

Returns:: String The character set.

getResponseCharSet

public String getResponseCharSet()

Returns the character encoding of the response from the Content-Type header.

Returns:: String The character set.

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.

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.

getHostConfiguration

public HostConfiguration getHostConfiguration()

Deprecated. no longer applicable

Returns the host configuration.

Specified by:: getHostConfiguration in interface HttpMethod

Returns:: the host configuration

setHostConfiguration

public void setHostConfiguration(HostConfiguration hostconfig)

Deprecated. no longer applicable

Sets the host configuration.

Parameters:: hostconfig - The hostConfiguration to set

getMethodRetryHandler

public MethodRetryHandler getMethodRetryHandler()

Deprecated. use HttpMethodParams

Returns the retry handler for this HTTP method

Returns:: the methodRetryHandler

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

getHostAuthState

public AuthState getHostAuthState()

Returns the target host authentication state

Specified by:: getHostAuthState in interface HttpMethod

Returns:: host authentication state
Since:: 3.0

getProxyAuthState

public AuthState getProxyAuthState()

Returns the proxy authentication state

Specified by:: getProxyAuthState in interface HttpMethod

Returns:: host authentication state
Since:: 3.0

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

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.

Specified by:: isRequestSent in interface HttpMethod

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

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.commons.httpclient Class HttpMethodBase

statusLine

effectiveVersion

HttpMethodBase

HttpMethodBase

getName

getURI

setURI

setFollowRedirects

getFollowRedirects

setHttp11

getDoAuthentication

setDoAuthentication

isHttp11

setPath

addRequestHeader

addResponseFooter

getPath

setQueryString

setQueryString

getQueryString

setRequestHeader

setRequestHeader

getRequestHeader

getRequestHeaders

getRequestHeaders

getRequestHeaderGroup

getResponseTrailerHeaderGroup

getResponseHeaderGroup

getResponseHeaders

getStatusCode

getStatusLine

getResponseHeaders

getResponseHeader

getResponseContentLength

getResponseBody

getResponseBody

getResponseBodyAsStream

getResponseBodyAsString

getResponseBodyAsString

getResponseFooters

getResponseFooter

setResponseStream

getResponseStream

getStatusText

setStrictMode

isStrictMode

addRequestHeader

isConnectionCloseForced

setConnectionCloseForced

shouldCloseConnection

execute

abort

hasBeenUsed

recycle

releaseConnection

removeRequestHeader

removeRequestHeader

validate

addCookieRequestHeader

addHostRequestHeader

addProxyConnectionHeader

addRequestHeaders

addUserAgentRequestHeader

checkNotUsed

checkUsed

generateRequestLine

processResponseBody

processResponseHeaders

processCookieHeaders

processStatusLine

readResponse

readResponseBody

readResponseHeaders

readStatusLine

writeRequest

writeRequestBody

writeRequestHeaders

writeRequestLine

getParams

org.apache.commons.httpclient
Class HttpMethodBase