org.apache.commons.httpclient.methods

Class HeadMethod

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

Constructor Summary
HeadMethod()
No-arg constructor.
HeadMethod(String uri)
Constructor specifying a URI.
Method Summary
intgetBodyCheckTimeout()
Returns non-compliant response body check timeout.
StringgetName()
Returns "HEAD".
protected voidreadResponseBody(HttpState state, HttpConnection conn)
Overrides HttpMethodBase method to not read a response body, despite the presence of a Content-Length or Transfer-Encoding header.
voidrecycle()
Recycles the HTTP method so that it can be used again.
voidsetBodyCheckTimeout(int timeout)
Sets non-compliant response body check timeout.

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

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: HeadMethod HttpMethodParams HEAD_BODY_CHECK_TIMEOUT

getName

public String getName()
Returns "HEAD".

Returns: "HEAD"

Since: 2.0

readResponseBody

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.

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: HeadMethod HeadMethod

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.

Since: 1.0

See Also:

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: HeadMethod HttpMethodParams HEAD_BODY_CHECK_TIMEOUT

Copyright (c) 1999-2005 - Apache Software Foundation