commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ol...@apache.org
Subject cvs commit: jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods DeleteMethod.java EntityEnclosingMethod.java ExpectContinueMethod.java GetMethod.java HeadMethod.java MultipartPostMethod.java OptionsMethod.java PostMethod.java PutMethod.java TraceMethod.java
Date Sat, 09 Aug 2003 19:36:40 GMT
olegk       2003/08/09 12:36:40

  Modified:    httpclient/src/java/org/apache/commons/httpclient/methods
                        Tag: HTTPCLIENT_2_0_BRANCH DeleteMethod.java
                        EntityEnclosingMethod.java
                        ExpectContinueMethod.java GetMethod.java
                        HeadMethod.java MultipartPostMethod.java
                        OptionsMethod.java PostMethod.java PutMethod.java
                        TraceMethod.java
  Log:
  Another round of Javadoc clean-ups
  
  Contributed by Oleg Kalnichevski
  
  Revision  Changes    Path
  No                   revision
  
  
  No                   revision
  
  
  1.11.2.1  +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/DeleteMethod.java
  
  Index: DeleteMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/DeleteMethod.java,v
  retrieving revision 1.11
  retrieving revision 1.11.2.1
  diff -u -r1.11 -r1.11.2.1
  --- DeleteMethod.java	2 Feb 2003 04:30:13 -0000	1.11
  +++ DeleteMethod.java	9 Aug 2003 19:36:39 -0000	1.11.2.1
  @@ -67,7 +67,7 @@
   
   
   /**
  - * Implements the HTTP DELETE specification.
  + * Implements the HTTP DELETE method.
    * <p>
    * The HTTP DELETE method is defined in section 9.7 of 
    * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
  
  
  
  1.18.2.1  +40 -30    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/EntityEnclosingMethod.java
  
  Index: EntityEnclosingMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/EntityEnclosingMethod.java,v
  retrieving revision 1.18
  retrieving revision 1.18.2.1
  diff -u -r1.18 -r1.18.2.1
  --- EntityEnclosingMethod.java	19 Jun 2003 07:54:33 -0000	1.18
  +++ EntityEnclosingMethod.java	9 Aug 2003 19:36:39 -0000	1.18.2.1
  @@ -185,7 +185,7 @@
       /**
        * Returns <tt>true</tt> if there is a request body to be sent.
        * 
  -     * <P>This method must be overwritten by sub-classes that implement
  +     * <P>This method must be overridden by sub-classes that implement
        * alternative request content input methods
        * </p>
        * 
  @@ -203,7 +203,7 @@
       /**
        * Clears request body.
        * 
  -     * <p>This method must be overwritten by sub-classes that implement
  +     * <p>This method must be overridden by sub-classes that implement
        * alternative request content input methods.</p>
        * 
        * @since 2.0beta1
  @@ -219,7 +219,7 @@
       /**
        * Generates request body.   
        * 
  -     * <p>This method must be overwritten by sub-classes that implement
  +     * <p>This method must be overridden by sub-classes that implement
        * alternative request content input methods.</p>
        * 
        * @return request body as an array of bytes. If the request content 
  @@ -297,7 +297,7 @@
       }
   
       /**
  -     * Override method of {@link org.apache.commons.httpclient.HttpMethodBase}
  +     * Overrides method of {@link org.apache.commons.httpclient.HttpMethodBase}
        * to return the length of the request body.
        *
        * @return number of bytes in the request body
  @@ -318,16 +318,19 @@
       }
   
       /**
  -     * Adds a <tt>Content-Length</tt> or <tt>Transfer-Encoding: Chunked</tt>
  +     * Generates <tt>Content-Length</tt> or <tt>Transfer-Encoding: Chunked</tt>
        * request header, as long as no <tt>Content-Length</tt> request header
        * already exists.
  -     *
  -     * @param state current state of http requests
  -     * @param conn the connection to use for I/O
  -     *
  -     * @throws IOException when errors occur reading or writing to/from the
  -     *         connection
  -     * @throws HttpException when a recoverable error occurs
  +     * 
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        */
       protected void addContentLengthRequestHeader(HttpState state,
                                                    HttpConnection conn)
  @@ -358,10 +361,10 @@
       }
   
       /**
  -     * Gets the request body as a stream.
  +     * Returns the request body as a {@link java.io.InputStream}.
        * Calling this method will cause the content to be buffered.
        *
  -     * @return The request body {@link java.io.InputStream} if it has been set.
  +     * @return The request body as a {@link java.io.InputStream} if it has been set.
        */
       public InputStream getRequestBody() {
           LOG.trace("enter EntityEnclosingMethod.getRequestBody()");
  @@ -392,12 +395,12 @@
       }
   
       /**
  -     * Gets the request body as a String.
  +     * Returns the request body as a {@link java.lang.String}.
        * Calling this method will cause the content to be buffered.
        *
  -     * @return the request body as a string
  +     * @return the request body as a {@link java.lang.String}
        * 
  -     * @throws IOException when i/o errors occur reading the request
  +     * @throws IOException when i/o error occurs while reading the request
        */
       public String getRequestBodyAsString() throws IOException {
           LOG.trace("enter EntityEnclosingMethod.getRequestBodyAsString()");
  @@ -411,16 +414,19 @@
   
   
       /**
  -     * Override method of {@link org.apache.commons.httpclient.HttpMethodBase}
  -     * to write request parameters as the request body.  The input stream will
  -     * be truncated after the specified content length.
  +     * Writes the request body to the given {@link HttpConnection connection}.
        *
  -     * @param state the client state
  -     * @param conn the connection to write to
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
        *
        * @return <tt>true</tt>
  -     * @throws IOException when i/o errors occur reading the response
  -     * @throws HttpException when a protocol error occurs or state is invalid
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        */
       protected boolean writeRequestBody(HttpState state, HttpConnection conn)
       throws IOException, HttpException {
  @@ -496,8 +502,12 @@
       }
   
       /**
  -     * Override method of {@link org.apache.commons.httpclient.HttpMethodBase}
  -     * to clear my request body.
  +     * 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()
        */
       public void recycle() {
           LOG.trace("enter EntityEnclosingMethod.recycle()");
  
  
  
  1.5.2.2   +13 -9     jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/ExpectContinueMethod.java
  
  Index: ExpectContinueMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/ExpectContinueMethod.java,v
  retrieving revision 1.5.2.1
  retrieving revision 1.5.2.2
  diff -u -r1.5.2.1 -r1.5.2.2
  --- ExpectContinueMethod.java	26 Jul 2003 10:07:09 -0000	1.5.2.1
  +++ ExpectContinueMethod.java	9 Aug 2003 19:36:39 -0000	1.5.2.2
  @@ -216,14 +216,18 @@
       protected abstract boolean hasRequestContent();
   
       /**
  -     * Set the <tt>Expect</tt> header if it has not already been set, 
  +     * Sets the <tt>Expect</tt> header if it has not already been set, 
        * in addition to the "standard" set of headers.
        *
  -     * @param state the client state
  -     * @param conn the connection to write to
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
        *
  -     * @throws HttpException when a protocol error occurs or state is invalid
  -     * @throws IOException when i/o errors occur reading the response
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        */
       protected void addRequestHeaders(HttpState state, HttpConnection conn)
       throws IOException, HttpException {
  
  
  
  1.24.2.1  +25 -12    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/GetMethod.java
  
  Index: GetMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/GetMethod.java,v
  retrieving revision 1.24
  retrieving revision 1.24.2.1
  diff -u -r1.24 -r1.24.2.1
  --- GetMethod.java	29 Apr 2003 22:18:08 -0000	1.24
  +++ GetMethod.java	9 Aug 2003 19:36:39 -0000	1.24.2.1
  @@ -79,10 +79,10 @@
   import org.apache.commons.logging.LogFactory;
   
   /**
  - * Implements the HTTP GET specification.
  + * Implements the HTTP GET method.
    * <p>
  - * The HTTP GET method is defined in section 8.1 of
  - * <a href="http://www.ietf.org/rfc/rfc1945.txt">RFC1945</a>:
  + * The HTTP GET method is defined in section 9.3 of
  + * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
    * <blockquote>
    * The GET method means retrieve whatever information (in the form of an
    * entity) is identified by the Request-URI. If the Request-URI refers
  @@ -358,7 +358,12 @@
       }
   
       /**
  -     * Override recycle to reset redirects default.
  +     * 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()
        * 
        * @since 1.0
        */
  @@ -376,11 +381,19 @@
        * Overrides method in {@link HttpMethodBase} to write data to the
        * appropriate buffer.
        * 
  -     * @param state the shared http state
  -     * @param conn the connection to read data from
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
  +     *
  +     * @see #readResponse
  +     * @see #processResponseBody
        * 
  -     * @throws IOException when there are problems reading from the connection
  -     * @throws HttpException when a protocol error occurs or state is invalid
        * @since 2.0
        */
       protected void readResponseBody(HttpState state, HttpConnection conn)
  
  
  
  1.19.2.1  +25 -12    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/HeadMethod.java
  
  Index: HeadMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/HeadMethod.java,v
  retrieving revision 1.19
  retrieving revision 1.19.2.1
  diff -u -r1.19 -r1.19.2.1
  --- HeadMethod.java	12 May 2003 01:17:49 -0000	1.19
  +++ HeadMethod.java	9 Aug 2003 19:36:39 -0000	1.19.2.1
  @@ -73,10 +73,10 @@
   import org.apache.commons.logging.LogFactory;
   
   /**
  - * Implements the HTTP HEAD specification.
  + * Implements the HTTP HEAD method.
    * <p>
  - * The HTTP HEAD method is defined in section 8.2 of 
  - * <a href="http://www.ietf.org/rfc/rfc1945.txt">RFC1945</a>:
  + * The HTTP HEAD method is defined in section 9.4 of 
  + * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
    * <blockquote>
    * The HEAD method is identical to GET except that the server MUST NOT
    * return a message-body in the response. The metainformation contained
  @@ -142,7 +142,12 @@
       }
   
       /**
  -     * Override recycle to reset redirects default.
  +     * 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()
        * 
        * @since 1.0
        */
  @@ -156,10 +161,18 @@
        * body, despite the presence of a <tt>Content-Length</tt> or
        * <tt>Transfer-Encoding</tt> header.
        * 
  -     * @param state shared http state
  -     * @param conn the http connection to read from
  -     * 
  -     * @throws IOException when there's an error reading data
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
  +     *
  +     * @see #readResponse
  +     * @see #processResponseBody
        * 
        * @since 2.0
        */
  
  
  
  1.17.2.1  +58 -26    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/MultipartPostMethod.java
  
  Index: MultipartPostMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/MultipartPostMethod.java,v
  retrieving revision 1.17
  retrieving revision 1.17.2.1
  diff -u -r1.17 -r1.17.2.1
  --- MultipartPostMethod.java	7 Apr 2003 19:23:36 -0000	1.17
  +++ MultipartPostMethod.java	9 Aug 2003 19:36:39 -0000	1.17.2.1
  @@ -80,13 +80,29 @@
   import org.apache.commons.logging.LogFactory;
   
   /**
  - * POST Method for Multipart encoded forms.
  + * Implements the HTTP multipart POST method.
  + * <p>
  + * The HTTP multipart POST method is defined in section 3.3 of
  + * <a href="http://http://www.ietf.org/rfc/rfc1867.txt">RFC1867</a>:
  + * <blockquote>
  + * The media-type multipart/form-data follows the rules of all multipart
  + * MIME data streams as outlined in RFC 1521. The multipart/form-data contains 
  + * a series of parts. Each part is expected to contain a content-disposition 
  + * header where the value is "form-data" and a name attribute specifies 
  + * the field name within the form, e.g., 'content-disposition: form-data; 
  + * name="xxxxx"', where xxxxx is the field name corresponding to that field.
  + * Field names originally in non-ASCII character sets may be encoded using 
  + * the method outlined in RFC 1522.
  + * </blockquote>
  + * </p>
  + * <p>
    *
    * @author <a href="mailto:mattalbright@yahoo.com">Matthew Albright</a>
    * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
    * @author <a href="mailto:adrian@ephox.com">Adrian Sutton</a>
    * @author <a href="mailto:mdiggory@latte.harvard.edu">Mark Diggory</a>
    * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
  + * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
    *
    * @since 2.0
    */
  @@ -159,7 +175,8 @@
       }
   
       /**
  -     * Add a parameter
  +     * Adds a text field part
  +     * 
        * @param parameterName The name of the parameter.
        * @param parameterValue The value of the parameter.
        */
  @@ -170,7 +187,8 @@
       }
   
       /**
  -     * Add a parameter
  +     * Adds a binary file part
  +     * 
        * @param parameterName The name of the parameter
        * @param parameterFile The name of the file.
        * @throws FileNotFoundException If the file cannot be found.
  @@ -184,7 +202,7 @@
       }
   
       /**
  -     * Add a parameter.
  +     * Adds a binary file part with the given file name
        * 
        * @param parameterName The name of the parameter
        * @param fileName The file name
  @@ -200,7 +218,8 @@
       }
           
       /**
  -     * Adds another part to this post.
  +     * Adds a part.
  +     * 
        * @param part The part to add.
        */
       public void addPart (final Part part) {
  @@ -209,7 +228,7 @@
       }
   
       /**
  -     * Return all parts.
  +     * Returns all parts.
        * 
        * @return an array of containing all parts
        */
  @@ -217,16 +236,18 @@
           return (Part[]) parameters.toArray(new Part[parameters.size()]);
       }
       /**
  -     * Add content type header and set the <tt>Expect</tt> header 
  -     * if it has not already been set, in addition to the "standard"
  -     * set of headers
  -     * 
  -     * @param state the client state
  -     * @param conn the {@link HttpConnection} the headers will eventually be
  -     *        written to
  +     * Adds <tt>Content Type: multipart/form-data</tt> header in addition 
  +     * to the "standard" set of headers
        * 
  -     * @throws IOException when an error occurs writing the request
  -     * @throws HttpException when a HTTP protocol error occurs
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        */
       protected void addRequestHeaders(HttpState state, HttpConnection conn) 
       throws IOException, HttpException {
  @@ -245,14 +266,19 @@
       }
   
       /**
  -     * Write the request body.
  -     * 
  -     * @param state the client state
  -     * @param conn the connection to write to
  +     * Writes the request body to the given {@link HttpConnection connection}.
  +     *
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
        *
        * @return <tt>true</tt>
  -     * @throws IOException when i/o errors occur reading the response
  -     * @throws HttpException when a protocol error occurs or state is invalid
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        */
       protected boolean writeRequestBody(HttpState state, HttpConnection conn) 
       throws IOException, HttpException {
  @@ -267,7 +293,7 @@
        * <p>Return the length of the request body.</p>
        *
        * <p>Once this method has been invoked, the request parameters cannot be
  -     * altered until I am {@link #recycle recycled}.</p>
  +     * altered until the method is {@link #recycle recycled}.</p>
        * 
        * @return The request content length.
        */
  @@ -289,7 +315,13 @@
   
   
       /**
  -     * Clear my request body.
  +     * 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()
  +     * 
        */
       public void recycle() {
           LOG.trace("enter MultipartPostMethod.recycle()");
  
  
  
  1.12.2.1  +16 -8     jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/OptionsMethod.java
  
  Index: OptionsMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/OptionsMethod.java,v
  retrieving revision 1.12
  retrieving revision 1.12.2.1
  diff -u -r1.12 -r1.12.2.1
  --- OptionsMethod.java	2 Feb 2003 04:30:13 -0000	1.12
  +++ OptionsMethod.java	9 Aug 2003 19:36:39 -0000	1.12.2.1
  @@ -76,7 +76,7 @@
   
   
   /**
  - * Implements the HTTP OPTIONS specification.
  + * Implements the HTTP OPTIONS method.
    * <p>
    * The HTTP OPTIONS method is defined in section 9.2 of 
    * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
  @@ -179,9 +179,17 @@
       // ----------------------------------------------------- HttpMethod Methods
   
       /**
  -     * Process the response headers.
  -     * @param state The state.
  -     * @param conn The connection.
  +     * <p>
  +     * This implementation will parse the <tt>Allow</tt> header to obtain 
  +     * the set of methods supported by the resource identified by the Request-URI.
  +     * </p>
  +     *
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @see #readResponse
  +     * @see #readResponseHeaders
        * @since 2.0
        */
       protected void processResponseHeaders(HttpState state, HttpConnection conn) {
  
  
  
  1.45.2.2  +26 -21    jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/PostMethod.java
  
  Index: PostMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/PostMethod.java,v
  retrieving revision 1.45.2.1
  retrieving revision 1.45.2.2
  diff -u -r1.45.2.1 -r1.45.2.2
  --- PostMethod.java	15 Jul 2003 12:56:34 -0000	1.45.2.1
  +++ PostMethod.java	9 Aug 2003 19:36:39 -0000	1.45.2.2
  @@ -76,9 +76,9 @@
   import org.apache.commons.logging.LogFactory;
   
   /**
  - * Implements the HTTP POST specification.
  + * Implements the HTTP POST method.
    * <p>
  - * The HTTP POST method is defined in section 8.3 of
  + * The HTTP POST method is defined in section 9.5 of
    * <a href="http://www.ietf.org/rfc/rfc1945.txt">RFC1945</a>:
    * <blockquote>
    * The POST method is used to request that the origin server accept the entity
  @@ -219,7 +219,7 @@
       }
   
       /**
  -     * Generates request body.
  +     * Generates the request body.
        * 
        * <p>This method must be overwritten by sub-classes that implement
        * alternative request content input methods
  @@ -242,8 +242,8 @@
   
   
       /**
  -     * Set the value of parameter with parameterName to parameterValue. Does
  -     * not preserve the initial insertion order.
  +     * Sets the value of parameter with parameterName to parameterValue. This method
  +     * does not preserve the initial insertion order.
        *
        * @param parameterName name of the parameter
        * @param parameterValue value of the parameter
  @@ -314,7 +314,7 @@
       }
   
       /**
  -     * Add a new parameter to be used in the POST request body.
  +     * Adds a new parameter to be used in the POST request body.
        *
        * @param paramName The parameter name to add.
        * @param paramValue The parameter value to add.
  @@ -336,7 +336,7 @@
       }
   
       /**
  -     * Add a new parameter to be used in the POST request body.
  +     * Adds a new parameter to be used in the POST request body.
        *
        * @param param The parameter to add.
        *
  @@ -356,7 +356,7 @@
       }
   
       /**
  -     * Add an Array of parameters to be used in the POST request body. Logs a
  +     * Adds an array of parameters to be used in the POST request body. Logs a
        * warning if the parameters argument is null.
        *
        * @param parameters The array of parameters to add.
  @@ -453,7 +453,7 @@
       }
   
       /**
  -     * Set an Array of parameters to be used in the POST request body
  +     * Sets an array of parameters to be used in the POST request body
        *
        * @param parametersBody The array of parameters to add.
        *
  @@ -473,14 +473,19 @@
       }
   
       /**
  -     * Override method of {@link org.apache.commons.httpclient.HttpMethodBase}
  -     * to  also add <tt>Content-Type</tt> header when appropriate.
  -     *
  -     * @param state the client state
  -     * @param conn the {@link HttpConnection} the headers will eventually be
  -     *        written to
  -     * @throws IOException when an error occurs writing the request
  -     * @throws HttpException when a HTTP protocol error occurs
  +     * Adds <tt>Content Type: application/x-www-form-urlencoded</tt> header
in
  +     * addition to the "standard" set of headers, if no <tt>Content Type</tt>
  +     * header has been set by the user 
  +     * 
  +     * @param state the {@link HttpState state} information associated with this method
  +     * @param conn the {@link HttpConnection connection} used to execute
  +     *        this HTTP method
  +     *
  +     * @throws IOException if an I/O (transport) error occurs
  +     * @throws HttpException  if a protocol exception occurs.
  +     * @throws HttpRecoverableException if a recoverable transport error occurs. 
  +     *                    Usually this kind of exceptions can be recovered from by
  +     *                    retrying the HTTP method 
        *
        * @since 2.0
        */
  
  
  
  1.23.2.1  +5 -5      jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/PutMethod.java
  
  Index: PutMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/PutMethod.java,v
  retrieving revision 1.23
  retrieving revision 1.23.2.1
  diff -u -r1.23 -r1.23.2.1
  --- PutMethod.java	2 Feb 2003 04:30:13 -0000	1.23
  +++ PutMethod.java	9 Aug 2003 19:36:40 -0000	1.23.2.1
  @@ -64,7 +64,7 @@
   package org.apache.commons.httpclient.methods;
   
   /**
  - * Implements the HTTP PUT specification.
  + * Implements the HTTP PUT method.
    * <p>
    * The HTTP PUT method is defined in section 9.6 of 
    * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
  
  
  
  1.12.2.1  +10 -6     jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/TraceMethod.java
  
  Index: TraceMethod.java
  ===================================================================
  RCS file: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/TraceMethod.java,v
  retrieving revision 1.12
  retrieving revision 1.12.2.1
  diff -u -r1.12 -r1.12.2.1
  --- TraceMethod.java	19 Apr 2003 22:29:32 -0000	1.12
  +++ TraceMethod.java	9 Aug 2003 19:36:40 -0000	1.12.2.1
  @@ -66,7 +66,7 @@
   import org.apache.commons.httpclient.HttpMethodBase;
   
   /**
  - * Implements the HTTP TRACE specification.
  + * Implements the HTTP TRACE method.
    * <p>
    * The HTTP TRACE method is defined in section 9.6 of 
    * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
  @@ -121,8 +121,12 @@
       }
   
       /**
  +     * 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.
        * 
  -     * Override recycle to reset redirects default.
  +     * @see #releaseConnection()
        * 
        * @since 2.0
        * 
  
  
  

Mime
View raw message