public abstract class HttpMethodBase extends Object implements org.apache.commons.httpclient.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
Constructor and Description |
---|
HttpMethodBase()
No-arg constructor.
|
HttpMethodBase(String uri)
Constructor specifying a URI.
|
Modifier and Type | Method and Description |
---|---|
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(org.apache.commons.httpclient.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(org.apache.commons.httpclient.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()
|
protected void |
checkUsed()
|
int |
execute(HttpState state,
HttpConnection conn)
Executes this method using the specified
HttpConnection and
HttpState . |
protected void |
fakeResponse(org.apache.commons.httpclient.StatusLine statusline,
org.apache.commons.httpclient.HeaderGroup responseheaders,
InputStream responseStream)
This method is a dirty hack intended to work around
current (2.0) design flaw that prevents the user from
obtaining correct status code, headers and response body from the
preceding HTTP CONNECT method.
|
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(org.apache.commons.httpclient.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
|
org.apache.commons.httpclient.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.
|
org.apache.commons.httpclient.auth.AuthState |
getHostAuthState()
Returns the target host
authentication state |
org.apache.commons.httpclient.HostConfiguration |
getHostConfiguration()
Deprecated.
no longer applicable
|
org.apache.commons.httpclient.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".
|
org.apache.commons.httpclient.params.HttpMethodParams |
getParams()
Returns
HTTP protocol parameters associated with this method. |
String |
getPath()
Gets the path of this HTTP method.
|
String |
getProxyAuthenticationRealm()
Deprecated.
use #getProxyAuthState()
|
org.apache.commons.httpclient.auth.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.
|
org.apache.commons.httpclient.Header |
getRequestHeader(String headerName)
Returns the specified request header.
|
protected org.apache.commons.httpclient.HeaderGroup |
getRequestHeaderGroup()
Gets the
header group storing the request headers. |
org.apache.commons.httpclient.Header[] |
getRequestHeaders()
Returns an array of the requests headers that the HTTP method currently has
|
org.apache.commons.httpclient.Header[] |
getRequestHeaders(String headerName) |
byte[] |
getResponseBody()
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 |
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.
|
org.apache.commons.httpclient.Header |
getResponseFooter(String footerName)
Gets the response footer associated with the given name.
|
org.apache.commons.httpclient.Header[] |
getResponseFooters()
Returns an array of the response footers that the HTTP method currently has
in the order in which they were read.
|
org.apache.commons.httpclient.Header |
getResponseHeader(String headerName)
Gets the response header associated with the given name.
|
protected org.apache.commons.httpclient.HeaderGroup |
getResponseHeaderGroup()
Gets the
header group storing the response headers. |
org.apache.commons.httpclient.Header[] |
getResponseHeaders()
Returns an array of the response headers that the HTTP method currently has
in the order in which they were read.
|
org.apache.commons.httpclient.Header[] |
getResponseHeaders(String headerName) |
protected InputStream |
getResponseStream()
Returns a stream from which the body of the current response may be read.
|
protected org.apache.commons.httpclient.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.
|
org.apache.commons.httpclient.StatusLine |
getStatusLine()
Provides access to the response status line.
|
String |
getStatusText()
Returns the status text (or "reason phrase") associated with the latest
response.
|
org.apache.commons.httpclient.URI |
getURI()
Returns the URI of the HTTP method
|
boolean |
hasBeenUsed()
|
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 |
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)
|
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(org.apache.commons.httpclient.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(org.apache.commons.httpclient.HostConfiguration hostconfig)
Deprecated.
no longer applicable
|
void |
setHttp11(boolean http11)
Deprecated.
Use
HttpMethodParams.setVersion(HttpVersion) |
void |
setMethodRetryHandler(org.apache.commons.httpclient.MethodRetryHandler handler)
Deprecated.
use
HttpMethodParams |
void |
setParams(org.apache.commons.httpclient.params.HttpMethodParams params)
Assigns
HTTP protocol parameters for this method. |
void |
setPath(String path)
Sets the path of the HTTP method.
|
void |
setQueryString(org.apache.commons.httpclient.NameValuePair[] params)
Sets the query string of this HTTP method.
|
void |
setQueryString(String queryString)
Sets the query string of this HTTP method.
|
void |
setRequestHeader(org.apache.commons.httpclient.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(org.apache.commons.httpclient.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 . |
public HttpMethodBase()
public HttpMethodBase(String uri) throws IllegalArgumentException, IllegalStateException
uri
- either an absolute or relative URI. The URI is expected
to be URL-encodedIllegalArgumentException
- when URI is invalidIllegalStateException
- when protocol of the absolute URI is not recognisedpublic abstract String getName()
getName
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.URI getURI() throws org.apache.commons.httpclient.URIException
getURI
in interface org.apache.commons.httpclient.HttpMethod
URIException
- If the URI cannot be created.HttpMethod.getURI()
public void setURI(org.apache.commons.httpclient.URI uri) throws org.apache.commons.httpclient.URIException
setURI
in interface org.apache.commons.httpclient.HttpMethod
uri
- URI to be setURIException
- if a URI cannot be setpublic void setFollowRedirects(boolean followRedirects)
setFollowRedirects
in interface org.apache.commons.httpclient.HttpMethod
followRedirects
- true if the method will automatically follow redirects,
false otherwise.public boolean getFollowRedirects()
getFollowRedirects
in interface org.apache.commons.httpclient.HttpMethod
public void setHttp11(boolean http11)
HttpMethodParams.setVersion(HttpVersion)
http11
- true to use HTTP/1.1, false to use 1.0public boolean getDoAuthentication()
getDoAuthentication
in interface org.apache.commons.httpclient.HttpMethod
public void setDoAuthentication(boolean doAuthentication)
setDoAuthentication
in interface org.apache.commons.httpclient.HttpMethod
doAuthentication
- true to process authentication challenges
authomatically, false otherwise.public boolean isHttp11()
HttpMethodParams.getVersion()
public void setPath(String path)
setPath
in interface org.apache.commons.httpclient.HttpMethod
path
- the path of the HTTP method. The path is expected
to be URL-encodedpublic void addRequestHeader(org.apache.commons.httpclient.Header header)
addRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
header
- the header to add to the requestpublic void addResponseFooter(org.apache.commons.httpclient.Header footer)
addResponseFooter
in interface org.apache.commons.httpclient.HttpMethod
footer
- The footer to add.public String getPath()
getPath
in interface org.apache.commons.httpclient.HttpMethod
public void setQueryString(String queryString)
setQueryString
in interface org.apache.commons.httpclient.HttpMethod
queryString
- the query stringEncodingUtil.formUrlEncode(NameValuePair[], String)
public void setQueryString(org.apache.commons.httpclient.NameValuePair[] params)
setQueryString
in interface org.apache.commons.httpclient.HttpMethod
params
- an array of NameValuePair
s to add as query string
parameters. The name/value pairs will be automcatically
URL encodedEncodingUtil.formUrlEncode(NameValuePair[], String)
,
setQueryString(String)
public String getQueryString()
getQueryString
in interface org.apache.commons.httpclient.HttpMethod
public void setRequestHeader(String headerName, String headerValue)
setRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
headerName
- the header's nameheaderValue
- the header's valuepublic void setRequestHeader(org.apache.commons.httpclient.Header header)
setRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
header
- the headerpublic org.apache.commons.httpclient.Header getRequestHeader(String headerName)
getRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
headerName
- The name of the header to be returned.public org.apache.commons.httpclient.Header[] getRequestHeaders()
getRequestHeaders
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.Header[] getRequestHeaders(String headerName)
getRequestHeaders
in interface org.apache.commons.httpclient.HttpMethod
HttpMethod.getRequestHeaders(java.lang.String)
protected org.apache.commons.httpclient.HeaderGroup getRequestHeaderGroup()
header group
storing the request headers.protected org.apache.commons.httpclient.HeaderGroup getResponseTrailerHeaderGroup()
header group
storing the response trailer headers
as per RFC 2616 section 3.6.1.protected org.apache.commons.httpclient.HeaderGroup getResponseHeaderGroup()
header group
storing the response headers.public org.apache.commons.httpclient.Header[] getResponseHeaders(String headerName)
getResponseHeaders
in interface org.apache.commons.httpclient.HttpMethod
HttpMethod.getResponseHeaders(java.lang.String)
public int getStatusCode()
getStatusCode
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.StatusLine getStatusLine()
getStatusLine
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.Header[] getResponseHeaders()
getResponseHeaders
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.Header getResponseHeader(String headerName)
getResponseHeader
in interface org.apache.commons.httpclient.HttpMethod
headerName
- the header name to matchpublic long getResponseContentLength()
Return -1 when the content-length is unknown.
public byte[] getResponseBody() throws IOException
getResponseBody
in interface org.apache.commons.httpclient.HttpMethod
IOException
- If an I/O (transport) problem occurs while obtaining the
response body.public InputStream getResponseBodyAsStream() throws IOException
InputStream
.
If response body is not available, returns nullgetResponseBodyAsStream
in interface org.apache.commons.httpclient.HttpMethod
IOException
- If an I/O (transport) problem occurs while obtaining the
response body.public String getResponseBodyAsString() throws IOException
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.getResponseBodyAsString
in interface org.apache.commons.httpclient.HttpMethod
IOException
- If an I/O (transport) problem occurs while obtaining the
response body.public org.apache.commons.httpclient.Header[] getResponseFooters()
getResponseFooters
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.Header getResponseFooter(String footerName)
getResponseFooter
in interface org.apache.commons.httpclient.HttpMethod
footerName
- the footer name to matchprotected void setResponseStream(InputStream responseStream)
responseStream
- The new response stream.protected InputStream getResponseStream()
responseBodyConsumed
has been called, or if the stream returned by a previous call has been closed,
null
will be returned.public String getStatusText()
getStatusText
in interface org.apache.commons.httpclient.HttpMethod
public void setStrictMode(boolean strictMode)
HttpParams.setParameter(String, Object)
to exercise a more granular control over HTTP protocol strictness.setStrictMode
in interface org.apache.commons.httpclient.HttpMethod
strictMode
- true for strict mode, false otherwisepublic boolean isStrictMode()
HttpParams.setParameter(String, Object)
to exercise a more granular control over HTTP protocol strictness.isStrictMode
in interface org.apache.commons.httpclient.HttpMethod
public void addRequestHeader(String headerName, String headerValue)
addRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
headerName
- the header's nameheaderValue
- the header's valueprotected boolean isConnectionCloseForced()
true
if the connection must be closedprotected void setConnectionCloseForced(boolean b)
true
in abnormal
circumstances, such as HTTP protocol violations.b
- true
if the connection must be closed, false
otherwise.protected boolean shouldCloseConnection(HttpConnection conn)
conn
- the connection in questionpublic int execute(HttpState state, HttpConnection conn) throws org.apache.commons.httpclient.HttpException, IOException
HttpConnection
and
HttpState
.execute
in interface org.apache.commons.httpclient.HttpMethod
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.IOException
- if an I/O (transport) error occursHttpException
- if a protocol exception occurs.public void abort()
abort
in interface org.apache.commons.httpclient.HttpMethod
public boolean hasBeenUsed()
hasBeenUsed
in interface org.apache.commons.httpclient.HttpMethod
public void recycle()
recycle
in interface org.apache.commons.httpclient.HttpMethod
releaseConnection()
public void releaseConnection()
releaseConnection
in interface org.apache.commons.httpclient.HttpMethod
public void removeRequestHeader(String headerName)
removeRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
headerName
- the header namepublic void removeRequestHeader(org.apache.commons.httpclient.Header header)
removeRequestHeader
in interface org.apache.commons.httpclient.HttpMethod
header
- the headerpublic boolean validate()
validate
in interface org.apache.commons.httpclient.HttpMethod
protected void addCookieRequestHeader(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
cookie
s
that match the given host, port and path.state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void addHostRequestHeader(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void addProxyConnectionHeader(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void addRequestHeaders(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
header
s
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.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void addUserAgentRequestHeader(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void checkNotUsed() throws IllegalStateException
IllegalStateException
- if the method has been used and not
recycledprotected void checkUsed() throws IllegalStateException
IllegalStateException
- if not usedprotected static String generateRequestLine(HttpConnection connection, String name, String requestPath, String query, String version)
connection
- the connection
used to execute
this HTTP methodname
- the method name generate a request forrequestPath
- the path string for the requestquery
- the query string for the requestversion
- the protocol version to use (e.g. HTTP/1.0)protected void processResponseBody(HttpState state, HttpConnection conn)
readResponseBody(HttpState,HttpConnection)
and can be overridden by
sub-classes in order to provide custom body processing.
This implementation does nothing.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodreadResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
readResponseBody(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void processResponseHeaders(HttpState state, HttpConnection conn)
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
.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodreadResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
readResponseHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void processStatusLine(HttpState state, HttpConnection conn)
readStatusLine(HttpState,HttpConnection)
and can be overridden by
sub-classes in order to provide custom response status line processing.state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodreadResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
readStatusLine(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void readResponse(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
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.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void readResponseBody(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
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.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
processResponseBody(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void readResponseHeaders(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
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)
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
processResponseHeaders(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
protected void readStatusLine(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
HttpConnection
, setting my
status code
and status
text
.
Subclasses may want to override this method to to customize the processing.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.StatusLine
protected void writeRequest(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.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.
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.)
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected boolean writeRequestBody(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
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.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.protected void writeRequestHeaders(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
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.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)
,
getRequestHeaders()
protected void writeRequestLine(HttpState state, HttpConnection conn) throws IOException, org.apache.commons.httpclient.HttpException
connection
.
Subclasses may want to override this method to to customize the processing.
state
- the state
information associated with this methodconn
- the connection
used to execute
this HTTP methodIOException
- 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.generateRequestLine(org.apache.commons.httpclient.HttpConnection, java.lang.String, java.lang.String, java.lang.String, java.lang.String)
public org.apache.commons.httpclient.params.HttpMethodParams getParams()
HTTP protocol parameters
associated with this method.getParams
in interface org.apache.commons.httpclient.HttpMethod
public void setParams(org.apache.commons.httpclient.params.HttpMethodParams params)
HTTP protocol parameters
for this method.setParams
in interface org.apache.commons.httpclient.HttpMethod
HttpMethodParams
public org.apache.commons.httpclient.HttpVersion getEffectiveVersion()
public String getProxyAuthenticationRealm()
public String getAuthenticationRealm()
protected String getContentCharSet(org.apache.commons.httpclient.Header contentheader)
contentheader
- The content header.public String getRequestCharSet()
public String getResponseCharSet()
public int getRecoverableExceptionCount()
protected void responseBodyConsumed()
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.
public org.apache.commons.httpclient.HostConfiguration getHostConfiguration()
host configuration
.getHostConfiguration
in interface org.apache.commons.httpclient.HttpMethod
public void setHostConfiguration(org.apache.commons.httpclient.HostConfiguration hostconfig)
host configuration
.hostconfig
- The hostConfiguration to setpublic org.apache.commons.httpclient.MethodRetryHandler getMethodRetryHandler()
HttpMethodParams
retry handler
for this HTTP methodpublic void setMethodRetryHandler(org.apache.commons.httpclient.MethodRetryHandler handler)
HttpMethodParams
retry handler
for this HTTP methodhandler
- the methodRetryHandler to use when this method executedprotected void fakeResponse(org.apache.commons.httpclient.StatusLine statusline, org.apache.commons.httpclient.HeaderGroup responseheaders, InputStream responseStream)
public org.apache.commons.httpclient.auth.AuthState getHostAuthState()
authentication state
getHostAuthState
in interface org.apache.commons.httpclient.HttpMethod
public org.apache.commons.httpclient.auth.AuthState getProxyAuthState()
authentication state
getProxyAuthState
in interface org.apache.commons.httpclient.HttpMethod
public boolean isAborted()
public boolean isRequestSent()
isRequestSent
in interface org.apache.commons.httpclient.HttpMethod
Copyright © 2003-2014 Internet Archive. All Rights Reserved.