/*
* $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/HttpMethod.java,v 1.23.2.3 2003/08/12 02:39:41 mbecke Exp $
* $Revision: 1.23.2.3 $
* $Date: 2003/08/12 02:39:41 $
*
* ====================================================================
*
* The Apache Software License, Version 1.1
*
* Copyright (c) 1999-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
*
* 3. The end-user documentation included with the redistribution, if
* any, must include the following acknowlegement:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowlegement may appear in the software itself,
* if and wherever such third-party acknowlegements normally appear.
*
* 4. The names "The Jakarta Project", "Commons", and "Apache Software
* Foundation" must not be used to endorse or promote products derived
* from this software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache"
* nor may "Apache" appear in their names without prior written
* permission of the Apache Group.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
* ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
* ====================================================================
*
* This software consists of voluntary contributions made by many
* individuals on behalf of the Apache Software Foundation. For more
* information on the Apache Software Foundation, please see
* .
*
* [Additional notices, if required by prior licensing conditions]
*
*/
package org.apache.commons.httpclient;
import java.io.IOException;
import java.io.InputStream;
/**
*
* HttpMethod interface represents a request to be sent via a
* {@link HttpConnection HTTP connection} and a corresponding response.
*
* @author Remy Maucherat
* @author Rod Waldhoff
* @author Jeff Dever
* @author Mike Bowler
* @author Oleg Kalnichevski
*
* @version $Revision: 1.23.2.3 $ $Date: 2003/08/12 02:39:41 $
*
* @since 1.0
*/
public interface HttpMethod {
// ------------------------------------------- Property Setters and Getters
/**
* Obtains the name of the HTTP method as used in the HTTP request line,
* for example "GET" or "POST".
*
* @return the name of this method
*/
String getName();
/**
* Gets the host configuration for this method. The configuration specifies
* the server, port, protocol, and proxy server via which this method will
* send its HTTP request.
*
* @return the HostConfiguration or null if none is set
*/
HostConfiguration getHostConfiguration();
/**
* Sets the path of the HTTP method.
* It is responsibility of the caller to ensure that the path is
* properly encoded (URL safe).
*
* @param path The path of the HTTP method. The path is expected
* to be URL encoded.
*/
void setPath(String path);
/**
* Returns the path of the 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.
*
* @return the path of the HTTP method, in URL encoded form
*/
String getPath();
/**
* Returns the URI for this method. The URI will be absolute if the host
* configuration has been set and relative otherwise.
*
* @return the URI for this method
*
* @throws URIException if a URI cannot be constructed
*/
URI getURI() throws URIException;
/**
* Defines how strictly the method follows the HTTP protocol specification.
* (See RFC 2616 and other relevant RFCs.) In the strict mode the method 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.
*
* @param strictMode true for strict mode, false otherwise
*
* @see #isStrictMode()
*/
void setStrictMode(boolean strictMode);
/**
* Returns the value of the strict mode flag.
*
* @return true if strict mode is enabled, false otherwise
*
* @see #setStrictMode(boolean)
*/
boolean isStrictMode();
/**
* Sets the specified request header, overwriting any previous value.
* Note that header-name matching is case insensitive.
*
* @param headerName the header's name
* @param headerValue the header's value
*
* @see #setRequestHeader(Header)
* @see #getRequestHeader(String)
* @see #removeRequestHeader(String)
*/
void setRequestHeader(String headerName, String headerValue);
/**
* Sets the specified request header, overwriting any previous value.
* Note that header-name matching is case insensitive.
*
* @param header the header to be set
*
* @see #setRequestHeader(String,String)
* @see #getRequestHeader(String)
* @see #removeRequestHeader(String)
*/
void setRequestHeader(Header header);
/**
* Adds the specified request header, not overwriting any previous value.
* If the same header is added multiple times, perhaps with different values,
* multiple instances of that header will be sent in the HTTP request.
* Note that header-name matching is case insensitive.
*
* @param headerName the header's name
* @param headerValue the header's value
*
* @see #addRequestHeader(Header)
* @see #getRequestHeader(String)
* @see #removeRequestHeader(String)
*/
void addRequestHeader(String headerName, String headerValue);
/**
* Adds the specified request header, not overwriting any previous value.
* If the same header is added multiple times, perhaps with different values,
* multiple instances of that header will be sent in the HTTP request.
* Note that header-name matching is case insensitive.
*
* @param header the header
*
* @see #addRequestHeader(String,String)
* @see #getRequestHeader(String)
* @see #removeRequestHeader(String)
*/
void addRequestHeader(Header header);
/**
* Gets the request header with the given name.
* If there are multiple headers with the same name,
* there values will be combined with the ',' separator as specified by RFC2616.
* Note that header-name matching is case insensitive.
*
* @param headerName the header name
* @return the header
*/
Header getRequestHeader(String headerName);
/**
* Removes all request headers with the given name.
* Note that header-name matching is case insensitive.
*
* @param headerName the header name
*/
void removeRequestHeader(String headerName);
/**
* Returns true if the HTTP method should automatically follow HTTP redirects
* (status code 302, etc.), false otherwise.
*
* @return true if the method will automatically follow HTTP redirects,
* false otherwise
*/
boolean getFollowRedirects();
/**
* Sets whether or not the HTTP method should automatically follow HTTP redirects
* (status code 302, etc.)
*
* @param followRedirects true if the method will automatically follow redirects,
* false otherwise
*/
void setFollowRedirects(boolean followRedirects);
/**
* Sets the query string of the HTTP method.
* It is responsibility of the caller to ensure that the path is
* properly encoded (URL safe). The string must not include an initial '?' character.
*
* @param queryString the query to be used in the request, with no leading '?' character
*
* @see #getQueryString()
* @see #setQueryString(NameValuePair[])
*/
void setQueryString(String queryString);
/**
* Sets the query string of this HTTP method. The pairs are encoded as UTF-8 characters.
* To use a different charset the parameters can be encoded manually using EncodingUtil
* and set as a single String.
*
* @param params An array of NameValuePairs to use as the query string.
* The name/value pairs will be automatically URL encoded and should not
* have been encoded previously.
*
* @see #getQueryString()
* @see #setQueryString(String)
* @see org.apache.commons.httpclient.util.EncodingUtil#formUrlEncode(NameValuePair[], String)
*/
void setQueryString(NameValuePair[] params);
/**
* Returns the query string of this HTTP method.
*
* @return the query string in URL encoded form, without a leading '?'.
*
* @see #setQueryString(NameValuePair[])
* @see #setQueryString(String)
*/
String getQueryString();
/**
* Returns the current request headers for this HTTP method. The returned headers
* will be in the same order that they were added with addRequestHeader.
* If there are multiple request headers with the same name (e.g. Cookie),
* they will be returned as multiple entries in the array.
*
* @return an array containing all of the request headers
*
* @see #addRequestHeader(Header)
* @see #addRequestHeader(String,String)
*/
Header[] getRequestHeaders();
// ---------------------------------------------------------------- Queries
/**
* Returns true the method is ready to execute, false otherwise.
*
* @return true if the method is ready to execute, false otherwise.
*/
boolean validate();
/**
* Returns the status code associated with the latest response.
*
* @return The status code from the most recent execution of this method.
* If the method has not yet been executed, the result is undefined.
*/
int getStatusCode();
/**
* Returns the status text (or "reason phrase") associated with the latest
* response.
*
* @return The status text from the most recent execution of this method.
* If the method has not yet been executed, the result is undefined.
*/
String getStatusText();
/**
* Returns the response headers from the most recent execution of this request.
*
* @return A newly-created array containing all of the response headers,
* in the order in which they appeared in the response.
*/
Header[] getResponseHeaders();
/**
* Returns the specified response header. Note that header-name matching is
* case insensitive.
*
* @param headerName The name of the header to be returned.
*
* @return The specified response header. If the repsonse contained multiple
* instances of the header, its values will be combined using the ','
* separator as specified by RFC2616.
*/
Header getResponseHeader(String headerName);
/**
* Returns the response footers from the most recent execution of this request.
*
* @return an array containing the response footers in the order that they
* appeared in the response. If the response had no footers,
* an empty array will be returned.
*/
Header[] getResponseFooters();
/**
* Return the specified response footer. Note that footer-name matching is
* case insensitive.
*
* @param footerName The name of the footer.
* @return The response footer.
*/
Header getResponseFooter(String footerName);
/**
* Returns the response body of the HTTP method, if any, as an array of bytes.
* If the method has not yet been executed or the response has no body, null
* is returned. Note that this method does not propagate I/O exceptions.
* If an error occurs while reading the body, null will be returned.
*
* @return The response body, or null if the
* body is not available.
*/
byte[] getResponseBody();
/**
* Returns the response body of the HTTP method, if any, as a {@link String}.
* If response body is not available or cannot be read, null is returned.
* The raw bytes in the body are converted to a String using the
* character encoding specified in the response's Content-Type header, or
* ISO-8859-1 if the response did not specify a character set.
*
* Note that this method does not propagate I/O exceptions.
* If an error occurs while reading the body, null will be returned.
*
* @return The response body converted to a String, or null
* if the body is not available.
*/
String getResponseBodyAsString();
/**
* Returns the response body of the HTTP method, if any, as an InputStream.
* If the response had no body or the method has not yet been executed,
* null is returned. Additionally, null may be returned
* if {@link #releaseConnection} has been called or
* if this method was called previously and the resulting stream was closed.
*
* @return The response body, or null if it is not available
*
* @throws IOException if an I/O (transport) problem occurs
*/
InputStream getResponseBodyAsStream() throws IOException;
/**
* Returns true if the HTTP method has been already {@link #execute executed},
* but not {@link #recycle recycled}.
*
* @return true if the method has been executed, false otherwise
*/
boolean hasBeenUsed();
// --------------------------------------------------------- Action Methods
/**
* Executes this method using the specified HttpConnection and
* HttpState.
*
* @param state the {@link HttpState state} information to associate with this method
* @param connection the {@link HttpConnection connection} used to execute
* this HTTP method
*
* @throws IOException If an I/O (transport) error occurs. Some transport exceptions
* can be recovered from.
* @throws HttpException If a protocol exception occurs. Usually protocol exceptions
* cannot be recovered from.
*
* @return the integer status code if one was obtained, or -1
*/
int execute(HttpState state, HttpConnection connection)
throws HttpException, IOException;
/**
* 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.
*
* @see #releaseConnection()
*/
void recycle();
/**
* 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.
*
* After this method is called, {@link #getResponseBodyAsStream} will return
* null, and {@link #getResponseBody} and {@link #getResponseBodyAsString}
* may return null.
*/
void releaseConnection();
/**
* Add a footer to this method's response.
*
* Note: This method is for
* internal use only and should not be called by external clients.
*
* @param footer the footer to add
*
* @since 2.0
*/
void addResponseFooter(Header footer);
/**
* Returns the Status-Line from the most recent response for this method,
* or null if the method has not been executed.
*
* @return the status line, or null if the method has not been executed
*
* @since 2.0
*/
StatusLine getStatusLine();
/**
* Returns true if the HTTP method should automatically handle HTTP
* authentication challenges (status code 401, etc.), false otherwise
*
* @return true if authentication challenges will be processed
* automatically, false otherwise.
*
* @since 2.0
*
* @see #setDoAuthentication(boolean)
*/
boolean getDoAuthentication();
/**
* Sets whether or not the HTTP method should automatically handle HTTP
* authentication challenges (status code 401, etc.)
*
* @param doAuthentication true to process authentication challenges
* automatically, false otherwise.
*
* @since 2.0
*
* @see #getDoAuthentication()
*/
void setDoAuthentication(boolean doAuthentication);
}
