org.archive.httpclient

Class HttpRecorderGetMethod

java.lang.Object

org.apache.commons.httpclient.HttpMethodBase

org.apache.commons.httpclient.methods.GetMethod

org.archive.httpclient.HttpRecorderGetMethod

All Implemented Interfaces:

org.apache.commons.httpclient.HttpMethod

public class HttpRecorderGetMethod
extends org.apache.commons.httpclient.methods.GetMethod

Override of GetMethod that marks the passed HttpRecorder w/ the transition from HTTP head to body and that forces a close on the http connection. The actions done in this subclass used to be done by copying org.apache.commons.HttpMethodBase, overlaying our version in place of the one that came w/ httpclient. Here is the patch of the difference between shipped httpclient code and our mods:

    -- -1338,6 +1346,12 --

        public void releaseConnection() {

   +        // HERITRIX always ants the streams closed.
   +        if (responseConnection != null)
   +        {
   +            responseConnection.close();
   +        }
   +
            if (responseStream != null) {
                try {
                    // FYI - this may indirectly invoke responseBodyConsumed.
   -- -1959,6 +1973,11 --
                        this.statusLine = null;
                    }
                }
   +            // HERITRIX mark transition from header to content.
   +            if (this.httpRecorder != null)
   +            {
   +                this.httpRecorder.markContentBegin();
   +            }
                readResponseBody(state, conn);
                processResponseBody(state, conn);
            } catch (IOException e) {
 

We're not supposed to have access to the underlying connection object; am only violating contract because see cases where httpclient is skipping out w/o cleaning up after itself.

Version:

$Revision$, $Date$

Author:

stack

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpRecorderMethod	httpRecorderMethod Instance of http recorder method.
protected static java.util.logging.Logger	logger

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

effectiveVersion, statusLine

Constructor Summary

Constructors

Constructor and Description
HttpRecorderGetMethod(java.lang.String uri, Recorder recorder)

Method Summary

Modifier and Type	Method and Description
protected void	addProxyConnectionHeader(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
int	execute(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection conn)
protected void	readResponseBody(org.apache.commons.httpclient.HttpState state, org.apache.commons.httpclient.HttpConnection connection)
void	setQueryString(java.lang.String queryString)
protected boolean	shouldCloseConnection(org.apache.commons.httpclient.HttpConnection conn)

Methods inherited from class org.apache.commons.httpclient.methods.GetMethod

getName, recycle

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

abort, addCookieRequestHeader, addHostRequestHeader, addRequestHeader, addRequestHeader, addRequestHeaders, addResponseFooter, addUserAgentRequestHeader, checkNotUsed, checkUsed, 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, setRequestHeader, setRequestHeader, setResponseStream, setStrictMode, setURI, validate, writeRequest, writeRequestBody, writeRequestHeaders, writeRequestLine

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static java.util.logging.Logger logger

httpRecorderMethod

protected HttpRecorderMethod httpRecorderMethod

Instance of http recorder method.

Constructor Detail

HttpRecorderGetMethod

public HttpRecorderGetMethod(java.lang.String uri,
                             Recorder recorder)

Method Detail

readResponseBody

protected void readResponseBody(org.apache.commons.httpclient.HttpState state,
                                org.apache.commons.httpclient.HttpConnection connection)
                         throws java.io.IOException,
                                org.apache.commons.httpclient.HttpException

Overrides:

readResponseBody in class org.apache.commons.httpclient.HttpMethodBase

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException

shouldCloseConnection

protected boolean shouldCloseConnection(org.apache.commons.httpclient.HttpConnection conn)

Overrides:

shouldCloseConnection in class org.apache.commons.httpclient.HttpMethodBase

execute

public int execute(org.apache.commons.httpclient.HttpState state,
                   org.apache.commons.httpclient.HttpConnection conn)
            throws org.apache.commons.httpclient.HttpException,
                   java.io.IOException

Specified by:

execute in interface org.apache.commons.httpclient.HttpMethod

Overrides:

execute in class org.apache.commons.httpclient.HttpMethodBase

Throws:

org.apache.commons.httpclient.HttpException

java.io.IOException

addProxyConnectionHeader

protected void addProxyConnectionHeader(org.apache.commons.httpclient.HttpState state,
                                        org.apache.commons.httpclient.HttpConnection conn)
                                 throws java.io.IOException,
                                        org.apache.commons.httpclient.HttpException

Overrides:

addProxyConnectionHeader in class org.apache.commons.httpclient.HttpMethodBase

Throws:

java.io.IOException

org.apache.commons.httpclient.HttpException

setQueryString

public void setQueryString(java.lang.String queryString)

Specified by:

setQueryString in interface org.apache.commons.httpclient.HttpMethod

Overrides:

setQueryString in class org.apache.commons.httpclient.HttpMethodBase