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

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: 155418 $

Author:

Remy Maucherat, Mike Bowler, Jeff Dever, oleg Kalnichevski

Constructor Summary

HeadMethod()
No-arg constructor.

HeadMethod(String uri)
Constructor specifying a URI.

Method Summary

String	getName() Returns "HEAD".
protected void	readResponseBody(HttpState state, HttpConnection conn) Overrides HttpMethodBase method to not read a response body, despite the presence of a Content-Length or Transfer-Encoding header.

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

abort, addCookieRequestHeader, addHostRequestHeader, addProxyConnectionHeader, addRequestHeader, addRequestHeader, addRequestHeader, addRequestHeaders, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, execute, generateRequestLine, getContentCharSet, getDoAuthentication, getEffectiveVersion, getFollowRedirects, getHostAuthState, getParams, getPath, getProxyAuthState, getQueryString, getRequestCharSet, getRequestHeader, getRequestHeaderGroup, getRequestHeaders, getRequestHeaders, getResponseBody, getResponseBodyAsStream, getResponseBodyAsString, getResponseCharSet, getResponseContentLength, getResponseFooter, getResponseFooters, getResponseHeader, getResponseHeaderGroup, getResponseHeaders, getResponseHeaders, getResponseStream, getResponseTrailerHeaderGroup, getStatusCode, getStatusLine, getStatusText, getURI, hasBeenUsed, isAborted, isConnectionCloseForced, isRequestSent, processResponseBody, processResponseHeaders, processStatusLine, readResponse, readResponseHeaders, readStatusLine, releaseConnection, removeRequestHeader, removeRequestHeader, responseBodyConsumed, setConnectionCloseForced, setDoAuthentication, setFilters, setFollowRedirects, setLogWire, setParams, setPath, setQueryString, setQueryString, setRequestHeader, setRequestHeader, setResponseStream, 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()

No-arg constructor.

Since:

1.0

HeadMethod

public HeadMethod(String uri)

Constructor specifying a URI.

Parameters:

uri - either an absolute or relative URI

Since:

1.0

Method Detail

getName

public String getName()

Returns "HEAD".

Specified by:

getName in interface HttpMethod

Specified by:

getName in class HttpMethodBase

Returns:

"HEAD"

Since:

2.0

readResponseBody

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

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:

readResponseBody(HttpState, HttpConnection)