View Javadoc

1   /*
2    * $Header: /home/jerenkrantz/tmp/commons/commons-convert/cvs/home/cvs/jakarta-commons//httpclient/src/java/org/apache/commons/httpclient/methods/PutMethod.java,v 1.26 2004/04/18 23:51:37 jsdever Exp $
3    * $Revision: 155418 $
4    * $Date: 2005-02-26 08:01:52 -0500 (Sat, 26 Feb 2005) $
5    *
6    * ====================================================================
7    *
8    *  Copyright 1999-2004 The Apache Software Foundation
9    *
10   *  Licensed under the Apache License, Version 2.0 (the "License");
11   *  you may not use this file except in compliance with the License.
12   *  You may obtain a copy of the License at
13   *
14   *      http://www.apache.org/licenses/LICENSE-2.0
15   *
16   *  Unless required by applicable law or agreed to in writing, software
17   *  distributed under the License is distributed on an "AS IS" BASIS,
18   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19   *  See the License for the specific language governing permissions and
20   *  limitations under the License.
21   * ====================================================================
22   *
23   * This software consists of voluntary contributions made by many
24   * individuals on behalf of the Apache Software Foundation.  For more
25   * information on the Apache Software Foundation, please see
26   * <http://www.apache.org/>.
27   *
28   */
29  
30  package org.apache.commons.httpclient.methods;
31  
32  /***
33   * Implements the HTTP PUT method.
34   * <p>
35   * The HTTP PUT method is defined in section 9.6 of 
36   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
37   * <blockquote>
38   * The PUT method requests that the enclosed entity be stored under the
39   * supplied Request-URI. If the Request-URI refers to an already
40   * existing resource, the enclosed entity SHOULD be considered as a
41   * modified version of the one residing on the origin server. 
42   * </blockquote>
43   * </p>
44   * 
45   * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
46   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
47   * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
48   * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
49   *
50   * @version $Revision: 155418 $
51   * @since 1.0
52   */
53  public class PutMethod extends EntityEnclosingMethod {
54  
55      // ----------------------------------------------------------- Constructors
56  
57      /***
58       * No-arg constructor.
59       *
60       * @since 1.0
61       */
62      public PutMethod() {
63          super();
64      }
65  
66  
67      /***
68       * Constructor specifying a URI.
69       *
70       * @param uri either an absolute or relative URI
71       *
72       * @since 1.0
73       */
74      public PutMethod(String uri) {
75          super(uri);
76      }
77  
78      // --------------------------------------------------------- Public Methods
79  
80      /***
81       * Return <tt>"PUT"</tt>.
82       * @return <tt>"PUT"</tt>
83       *
84       * @since 2.0
85       */
86      public String getName() {
87          return "PUT";
88      }
89  }