org.apache.commons.httpclient.methods

Class HeadMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.commons.httpclient.methods.HeadMethod

All Implemented Interfaces:

HttpMethod

Deprecated.

Jakarta Commons HttpClient 3.x is deprecated in the Jenkins project. It is not recommended to use it in any new code. Instead, use HTTP client API plugins as a dependency in your code. E.g. Apache HttpComponents Client API 4.x Plugin or Async HTTP Client Plugin.

@Deprecated
public class HeadMethod
extends HttpMethodBase

Implements the HTTP HEAD method.

The HTTP HEAD method is defined in section 9.4 of RFC2616:

The HEAD method is identical to GET except that the server MUST NOT return a message-body in the response. The metainformation contained in the HTTP headers in response to a HEAD request SHOULD be identical to the information sent in response to a GET request. This method can be used for obtaining metainformation about the entity implied by the request without transferring the entity-body itself. This method is often used for testing hypertext links for validity, accessibility, and recent modification.

Since:

1.0

Version:

$Revision: 480424 $

Author:

Remy Maucherat, Mike Bowler, Jeff Dever, oleg Kalnichevski

Field Summary

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

effectiveVersion, statusLine

Constructor Summary

Constructors

Constructor and Description
HeadMethod() Deprecated. No-arg constructor.
HeadMethod(String uri) Deprecated. Constructor specifying a URI.

Method Summary

Modifier and Type	Method and Description
int	getBodyCheckTimeout() Deprecated. Use HttpMethodParams
String	getName() Deprecated. Returns "HEAD".
protected void	readResponseBody(HttpState state, HttpConnection conn) Deprecated. Overrides HttpMethodBase method to not read a response body, despite the presence of a Content-Length or Transfer-Encoding header.
void	recycle() Deprecated. no longer supported and will be removed in the future version of HttpClient
void	setBodyCheckTimeout(int timeout) Deprecated. Use HttpMethodParams

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeadMethod

public HeadMethod()

Deprecated.

No-arg constructor.

Since:

1.0

HeadMethod

public HeadMethod(String uri)

Deprecated.

Constructor specifying a URI.

Parameters:

uri - either an absolute or relative URI

Since:

1.0

Method Detail

getName

public String getName()

Deprecated.

Returns "HEAD".

Specified by:

getName in interface HttpMethod

Specified by:

getName in class HttpMethodBase

Returns:

"HEAD"

Since:

2.0

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

Overrides:

recycle in class HttpMethodBase

Since:

1.0

See Also:

HttpMethodBase.releaseConnection()

readResponseBody

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

Deprecated.

Overrides HttpMethodBase method to not read a response body, despite the presence of a Content-Length or Transfer-Encoding header.

Overrides:

readResponseBody in class HttpMethodBase

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.

Since:

2.0

See Also:

HttpMethodBase.readResponse(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection), HttpMethodBase.processResponseBody(org.apache.commons.httpclient.HttpState, org.apache.commons.httpclient.HttpConnection)

getBodyCheckTimeout

public int getBodyCheckTimeout()

Deprecated. Use HttpMethodParams

Returns non-compliant response body check timeout.

Returns:

The period of time in milliseconds to wait for a response body from a non-compliant server. -1 returned when non-compliant response body check is disabled

See Also:

HttpMethodBase.getParams(), HttpMethodParams, HttpMethodParams.HEAD_BODY_CHECK_TIMEOUT

setBodyCheckTimeout

public void setBodyCheckTimeout(int timeout)

Deprecated. Use HttpMethodParams

Sets non-compliant response body check timeout.

Parameters:

timeout - The period of time in milliseconds to wait for a response body from a non-compliant server. -1 can be used to disable non-compliant response body check

See Also:

HttpMethodBase.getParams(), HttpMethodParams, HttpMethodParams.HEAD_BODY_CHECK_TIMEOUT