Package org.apache.commons.httpclient

Class HttpMethodBase

    • Field Detail

      • statusLine

        protected StatusLine statusLine
        The Status-Line from the response.

      • effectiveVersion

        protected HttpVersion effectiveVersion
        HTTP protocol version used for execution of this method.

    • Constructor Detail

      • HttpMethodBase

        public HttpMethodBase()
        No-arg constructor.

      • HttpMethodBase

        public HttpMethodBase​(String uri)
               throws IllegalArgumentException,
                      IllegalStateException
        Constructor specifying a URI. It is responsibility of the caller to ensure that URI elements (path & query parameters) are properly encoded (URL safe).
        Parameters:
        uri - either an absolute or relative URI. The URI is expected to be URL-encoded
        Throws:
        IllegalArgumentException - when URI is invalid
        IllegalStateException - when protocol of the absolute URI is not recognised

    • Method Detail

      • getName

        public abstract String getName()
        Obtains the name of the HTTP method as used in the HTTP request line, for example "GET" or "POST".
        Specified by:
        getName in interface HttpMethod
        Returns:
        the name of this method

      • setURI

        public void setURI​(URI uri)
            throws URIException
        Sets the URI for this method.
        Specified by:
        setURI in interface HttpMethod
        Parameters:
        uri - URI to be set
        Throws:
        URIException - if a URI cannot be set
        Since:
        3.0

      • setFollowRedirects

        public void setFollowRedirects​(boolean followRedirects)
        Sets whether or not the HTTP method should automatically follow HTTP redirects (status code 302, etc.)
        Specified by:
        setFollowRedirects in interface HttpMethod
        Parameters:
        followRedirects - true if the method will automatically follow redirects, false otherwise.

      • getFollowRedirects

        public boolean getFollowRedirects()
        Returns true if the HTTP method should automatically follow HTTP redirects (status code 302, etc.), false otherwise.
        Specified by:
        getFollowRedirects in interface HttpMethod
        Returns:
        true if the method will automatically follow HTTP redirects, false otherwise.

      • setHttp11

        public void setHttp11​(boolean http11)
        Deprecated.
        Use HttpMethodParams.setVersion(HttpVersion)
        Sets whether version 1.1 of the HTTP protocol should be used per default.
        Parameters:
        http11 - true to use HTTP/1.1, false to use 1.0

      • getDoAuthentication

        public boolean getDoAuthentication()
        Returns true if the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.), false otherwise
        Specified by:
        getDoAuthentication in interface HttpMethod
        Returns:
        true if authentication challenges will be processed automatically, false otherwise.
        Since:
        2.0
        See Also:
        HttpMethod.setDoAuthentication(boolean)

      • setDoAuthentication

        public void setDoAuthentication​(boolean doAuthentication)
        Sets whether or not the HTTP method should automatically handle HTTP authentication challenges (status code 401, etc.)
        Specified by:
        setDoAuthentication in interface HttpMethod
        Parameters:
        doAuthentication - true to process authentication challenges authomatically, false otherwise.
        Since:
        2.0
        See Also:
        HttpMethod.getDoAuthentication()

      • isHttp11

        public boolean isHttp11()
        Deprecated.
        Use HttpMethodParams.getVersion()
        Returns true if version 1.1 of the HTTP protocol should be used per default, false if version 1.0 should be used.
        Returns:
        true to use HTTP/1.1, false to use 1.0

      • setPath

        public void setPath​(String path)
        Sets the path of the HTTP method. It is responsibility of the caller to ensure that the path is properly encoded (URL safe).
        Specified by:
        setPath in interface HttpMethod
        Parameters:
        path - the path of the HTTP method. The path is expected to be URL-encoded

      • addResponseFooter

        public void addResponseFooter​(Header footer)
        Use this method internally to add footers.
        Specified by:
        addResponseFooter in interface HttpMethod
        Parameters:
        footer - The footer to add.

      • getPath

        public String getPath()
        Gets the path of this HTTP method. Calling this method after the request has been executed will return the actual path, following any redirects automatically handled by this HTTP method.
        Specified by:
        getPath in interface HttpMethod
        Returns:
        the path to request or "/" if the path is blank.

      • getRequestHeader

        public Header getRequestHeader​(String headerName)
        Returns the specified request header. Note that header-name matching is case insensitive. null will be returned if either headerName is null or there is no matching header for headerName.
        Specified by:
        getRequestHeader in interface HttpMethod
        Parameters:
        headerName - The name of the header to be returned.
        Returns:
        The specified request header.
        Since:
        3.0

      • getRequestHeaderGroup

        protected HeaderGroup getRequestHeaderGroup()
        Gets the header group storing the request headers.
        Returns:
        a HeaderGroup
        Since:
        2.0beta1

      • getResponseTrailerHeaderGroup

        protected HeaderGroup getResponseTrailerHeaderGroup()
        Gets the header group storing the response trailer headers as per RFC 2616 section 3.6.1.
        Returns:
        a HeaderGroup
        Since:
        2.0beta1

      • getResponseHeaderGroup

        protected HeaderGroup getResponseHeaderGroup()
        Gets the header group storing the response headers.
        Returns:
        a HeaderGroup
        Since:
        2.0beta1

      • getStatusCode

        public int getStatusCode()
        Returns the response status code.
        Specified by:
        getStatusCode in interface HttpMethod
        Returns:
        the status code associated with the latest response.

      • getStatusLine

        public StatusLine getStatusLine()
        Provides access to the response status line.
        Specified by:
        getStatusLine in interface HttpMethod
        Returns:
        the status line object from the latest response.
        Since:
        2.0

      • getResponseHeaders

        public Header[] getResponseHeaders()
        Returns an array of the response headers that the HTTP method currently has in the order in which they were read.
        Specified by:
        getResponseHeaders in interface HttpMethod
        Returns:
        an array of response headers.

      • getResponseHeader

        public Header getResponseHeader​(String headerName)
        Gets the response header associated with the given name. Header name matching is case insensitive. null will be returned if either headerName is null or there is no matching header for headerName.
        Specified by:
        getResponseHeader in interface HttpMethod
        Parameters:
        headerName - the header name to match
        Returns:
        the matching header

      • getResponseContentLength

        public long getResponseContentLength()
        Return the length (in bytes) of the response body, as specified in a Content-Length header.

        Return -1 when the content-length is unknown.

        Returns:
        content length, if Content-Length header is available. 0 indicates that the request has no body. If Content-Length header is not present, the method returns -1.

      • getResponseBody

        public byte[] getResponseBody()
                       throws IOException
        Returns the response body of the HTTP method, if any, as an array of bytes. If response body is not available or cannot be read, returns null. Buffers the response and this method can be called several times yielding the same result each time. 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.
        Specified by:
        getResponseBody in interface HttpMethod
        Returns:
        The response body.
        Throws:
        IOException - If an I/O (transport) problem occurs while obtaining the response body.

      • getResponseBody

        public byte[] getResponseBody​(int maxlen)
                       throws IOException
        Returns the response body of the HTTP method, if any, as an array of bytes. If response body is not available or cannot be read, returns null. Buffers the response and this method can be called several times yielding the same result each time. Note: This will cause the entire response body to be buffered in memory. This method is safe if the content length of the response is unknown, because the amount of memory used is limited.

        If the response is large this method involves lots of array copying and many object allocations, which makes it unsuitable for high-performance / low-footprint applications. Those applications should use getResponseBodyAsStream().

        Parameters:
        maxlen - the maximum content length to accept (number of bytes).
        Returns:
        The response body.
        Throws:
        IOException - If an I/O (transport) problem occurs while obtaining the response body.

      • getResponseBodyAsStream

        public InputStream getResponseBodyAsStream()
                                    throws IOException
        Returns the response body of the HTTP method, if any, as an InputStream. If response body is not available, returns null. If the response has been buffered this method returns a new stream object on every call. If the response has not been buffered the returned stream can only be read once.
        Specified by:
        getResponseBodyAsStream in interface HttpMethod
        Returns:
        The response body or null.
        Throws:
        IOException - If an I/O (transport) problem occurs while obtaining the response body.

      • getResponseBodyAsString

        public String getResponseBodyAsString()
                               throws IOException
        Returns the response body of the HTTP method, if any, as a 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. Buffers the response and this method can be called several times yielding the same result each time. 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.
        Specified by:
        getResponseBodyAsString in interface HttpMethod
        Returns:
        The response body or null.
        Throws:
        IOException - If an I/O (transport) problem occurs while obtaining the response body.

      • getResponseBodyAsString

        public String getResponseBodyAsString​(int maxlen)
                               throws IOException
        Returns the response body of the HTTP method, if any, as a 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. Buffers the response and this method can be called several times yielding the same result each time.

        Note: This will cause the entire response body to be buffered in memory. This method is safe if the content length of the response is unknown, because the amount of memory used is limited.

        If the response is large this method involves lots of array copying and many object allocations, which makes it unsuitable for high-performance / low-footprint applications. Those applications should use getResponseBodyAsStream().

        Parameters:
        maxlen - the maximum content length to accept (number of bytes). Note that, depending on the encoding, this is not equal to the number of characters.
        Returns:
        The response body or null.
        Throws:
        IOException - If an I/O (transport) problem occurs while obtaining the response body.

      • getResponseFooters

        public Header[] getResponseFooters()
        Returns an array of the response footers that the HTTP method currently has in the order in which they were read.
        Specified by:
        getResponseFooters in interface HttpMethod
        Returns:
        an array of footers

      • getResponseFooter

        public Header getResponseFooter​(String footerName)
        Gets the response footer associated with the given name. Footer name matching is case insensitive. null will be returned if either footerName is null or there is no matching footer for footerName or there are no footers available. If there are multiple footers with the same name, there values will be combined with the ',' separator as specified by RFC2616.
        Specified by:
        getResponseFooter in interface HttpMethod
        Parameters:
        footerName - the footer name to match
        Returns:
        the matching footer

      • setResponseStream

        protected void setResponseStream​(InputStream responseStream)
        Sets the response stream.
        Parameters:
        responseStream - The new response stream.

      • getResponseStream

        protected InputStream getResponseStream()
        Returns a stream from which the body of the current response may be read. If the method has not yet been executed, if responseBodyConsumed has been called, or if the stream returned by a previous call has been closed, null will be returned.
        Returns:
        the current response stream

      • getStatusText

        public String getStatusText()
        Returns the status text (or "reason phrase") associated with the latest response.
        Specified by:
        getStatusText in interface HttpMethod
        Returns:
        The status text.

      • setStrictMode

        public void setStrictMode​(boolean strictMode)
        Deprecated.
        Use HttpParams.setParameter(String, Object) to exercise a more granular control over HTTP protocol strictness.
        Defines how strictly HttpClient follows the HTTP protocol specification (RFC 2616 and other relevant RFCs). In the strict mode HttpClient precisely implements the requirements of the specification, whereas in non-strict mode it attempts to mimic the exact behaviour of commonly used HTTP agents, which many HTTP servers expect.
        Specified by:
        setStrictMode in interface HttpMethod
        Parameters:
        strictMode - true for strict mode, false otherwise
        See Also:
        HttpMethod.isStrictMode()

      • isConnectionCloseForced

        protected boolean isConnectionCloseForced()
        Tests if the connection should be force-closed when no longer needed.
        Returns:
        true if the connection must be closed

      • setConnectionCloseForced

        protected void setConnectionCloseForced​(boolean b)
        Sets whether or not the connection should be force-closed when no longer needed. This value should only be set to true in abnormal circumstances, such as HTTP protocol violations.
        Parameters:
        b - true if the connection must be closed, false otherwise.

      • shouldCloseConnection

        protected boolean shouldCloseConnection​(HttpConnection conn)
        Tests if the connection should be closed after the method has been executed. The connection will be left open when using HTTP/1.1 or if Connection: keep-alive header was sent.
        Parameters:
        conn - the connection in question
        Returns:
        boolean true if we should close the connection.

      • execute

        public int execute​(HttpState state,
                   HttpConnection conn)
            throws HttpException,
                   IOException
        Executes this method using the specified HttpConnection and HttpState.
        Specified by:
        execute in interface HttpMethod
        Parameters:
        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.
        Returns:
        the integer status code if one was obtained, or -1
        Throws:
        IOException - if an I/O (transport) error occurs
        HttpException - if a protocol exception occurs.

      • hasBeenUsed

        public boolean hasBeenUsed()
        Returns true if the HTTP method has been already executed, but not recycled.
        Specified by:
        hasBeenUsed in interface HttpMethod
        Returns:
        true if the method has been executed, false otherwise

      • 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
        See Also:
        releaseConnection()

      • releaseConnection

        public void releaseConnection()
        Releases the connection being used by this HTTP method. In particular the connection is used to read the response(if there is one) and will be held until the response has been read. If the connection can be reused by other HTTP methods it is NOT closed at this point.
        Specified by:
        releaseConnection in interface HttpMethod
        Since:
        2.0

      • removeRequestHeader

        public void removeRequestHeader​(String headerName)
        Remove the request header associated with the given name. Note that header-name matching is case insensitive.
        Specified by:
        removeRequestHeader in interface HttpMethod
        Parameters:
        headerName - the header name

      • removeRequestHeader

        public void removeRequestHeader​(Header header)
        Removes the given request header.
        Specified by:
        removeRequestHeader in interface HttpMethod
        Parameters:
        header - the header

      • validate

        public boolean validate()
        Returns true the method is ready to execute, false otherwise.
        Specified by:
        validate in interface HttpMethod
        Returns:
        This implementation always returns true.

      • addCookieRequestHeader

        protected void addCookieRequestHeader​(HttpState state,
                                      HttpConnection conn)
                               throws IOException,
                                      HttpException
        Generates Cookie request headers for those cookies that match the given host, port and path.
        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.

      • addHostRequestHeader

        protected void addHostRequestHeader​(HttpState state,
                                    HttpConnection conn)
                             throws IOException,
                                    HttpException
        Generates Host request header, as long as no Host request header already exists.
        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.

      • addProxyConnectionHeader

        protected void addProxyConnectionHeader​(HttpState state,
                                        HttpConnection conn)
                                 throws IOException,
                                        HttpException
        Generates Proxy-Connection: Keep-Alive request header when communicating via a proxy server.
        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.

      • addUserAgentRequestHeader

        protected void addUserAgentRequestHeader​(HttpState state,
                                         HttpConnection conn)
                                  throws IOException,
                                         HttpException
        Generates default User-Agent request header, as long as no User-Agent request header already exists.
        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.

      • generateRequestLine

        protected static String generateRequestLine​(HttpConnection connection,
                                            String name,
                                            String requestPath,
                                            String query,
                                            String version)
        Generates HTTP request line according to the specified attributes.
        Parameters:
        connection - the connection used to execute this HTTP method
        name - the method name generate a request for
        requestPath - the path string for the request
        query - the query string for the request
        version - the protocol version to use (e.g. HTTP/1.0)
        Returns:
        HTTP request line

      • writeRequestBody

        protected boolean writeRequestBody​(HttpState state,
                                   HttpConnection conn)
                            throws IOException,
                                   HttpException
        Writes the request body to the given 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.

        Parameters:
        state - the state information associated with this method
        conn - the connection used to execute this HTTP method
        Returns:
        true
        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.

      • getEffectiveVersion

        public HttpVersion getEffectiveVersion()
        Returns the HTTP version used with this method (may be null if undefined, that is, the method has not been executed)
        Returns:
        HTTP version.
        Since:
        3.0

      • getProxyAuthenticationRealm

        public String getProxyAuthenticationRealm()
        Deprecated.
        use #getProxyAuthState()
        Returns proxy authentication realm, if it has been used during authentication process. Otherwise returns null.
        Returns:
        proxy authentication realm

      • getAuthenticationRealm

        public String getAuthenticationRealm()
        Deprecated.
        use #getHostAuthState()
        Returns authentication realm, if it has been used during authentication process. Otherwise returns null.
        Returns:
        authentication realm

      • getContentCharSet

        protected String getContentCharSet​(Header contentheader)
        Returns the character set from the Content-Type header.
        Parameters:
        contentheader - The content header.
        Returns:
        String The character set.

      • getRequestCharSet

        public String getRequestCharSet()
        Returns the character encoding of the request from the Content-Type header.
        Returns:
        String The character set.

      • getResponseCharSet

        public String getResponseCharSet()
        Returns the character encoding of the response from the Content-Type header.
        Returns:
        String The character set.

      • getRecoverableExceptionCount

        public int getRecoverableExceptionCount()
        Deprecated.
        no longer used Returns the number of "recoverable" exceptions thrown and handled, to allow for monitoring the quality of the connection.
        Returns:
        The number of recoverable exceptions handled by the method.

      • responseBodyConsumed

        protected void responseBodyConsumed()
        A response has been consumed.

        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.

      • setHostConfiguration

        public void setHostConfiguration​(HostConfiguration hostconfig)
        Deprecated.
        no longer applicable
        Sets the host configuration.
        Parameters:
        hostconfig - The hostConfiguration to set

      • setMethodRetryHandler

        public void setMethodRetryHandler​(MethodRetryHandler handler)
        Deprecated.
        use HttpMethodParams
        Sets the retry handler for this HTTP method
        Parameters:
        handler - the methodRetryHandler to use when this method executed

      • isAborted

        public boolean isAborted()
        Tests whether the execution of this method has been aborted
        Returns:
        true if the execution of this method has been aborted, false otherwise
        Since:
        3.0

      • isRequestSent

        public boolean isRequestSent()
        Returns true if the HTTP has been transmitted to the target server in its entirety, false otherwise. This flag can be useful for recovery logic. If the request has not been transmitted in its entirety, it is safe to retry the failed method.
        Specified by:
        isRequestSent in interface HttpMethod
        Returns:
        true if the request has been sent, false otherwise