View Javadoc

1   /*
2    * $Header: /home/cvs/jakarta-commons/httpclient/src/java/org/apache/commons/httpclient/methods/PutMethod.java,v 1.23.2.2 2004/02/22 18:21:15 olegk Exp $
3    * $Revision: 1.23.2.2 $
4    * $Date: 2004/02/22 18:21:15 $
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   * [Additional notices, if required by prior licensing conditions]
29   *
30   */
31  
32  package org.apache.commons.httpclient.methods;
33  
34  /***
35   * Implements the HTTP PUT method.
36   * <p>
37   * The HTTP PUT method is defined in section 9.6 of 
38   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
39   * <blockquote>
40   * The PUT method requests that the enclosed entity be stored under the
41   * supplied Request-URI. If the Request-URI refers to an already
42   * existing resource, the enclosed entity SHOULD be considered as a
43   * modified version of the one residing on the origin server. 
44   * </blockquote>
45   * </p>
46   * 
47   * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
48   * @author <a href="mailto:mbowler@GargoyleSoftware.com">Mike Bowler</a>
49   * @author <a href="mailto:oleg@ural.ru">Oleg Kalnichevski</a>
50   * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
51   *
52   * @version $Revision: 1.23.2.2 $
53   * @since 1.0
54   */
55  public class PutMethod extends EntityEnclosingMethod {
56  
57      // ----------------------------------------------------------- Constructors
58  
59      /***
60       * No-arg constructor.
61       *
62       * @since 1.0
63       */
64      public PutMethod() {
65          super();
66      }
67  
68  
69      /***
70       * Constructor specifying a URI.
71       *
72       * @param uri either an absolute or relative URI
73       *
74       * @since 1.0
75       */
76      public PutMethod(String uri) {
77          super(uri);
78      }
79  
80      // --------------------------------------------------------- Public Methods
81  
82      /***
83       * Return <tt>"PUT"</tt>.
84       * @return <tt>"PUT"</tt>
85       *
86       * @since 2.0
87       */
88      public String getName() {
89          return "PUT";
90      }
91  }