View Javadoc

1   /*
2    * $HeadURL: https://svn.apache.org/repos/asf/httpcomponents/oac.hc3x/trunk/src/java/org/apache/commons/httpclient/methods/DeleteMethod.java $
3    * $Revision: 1425331 $
4    * $Date: 2012-12-22 19:29:41 +0100 (Sat, 22 Dec 2012) $
5    *
6    * ====================================================================
7    *
8    *  Licensed to the Apache Software Foundation (ASF) under one or more
9    *  contributor license agreements.  See the NOTICE file distributed with
10   *  this work for additional information regarding copyright ownership.
11   *  The ASF licenses this file to You under the Apache License, Version 2.0
12   *  (the "License"); you may not use this file except in compliance with
13   *  the License.  You may obtain a copy of the License at
14   *
15   *      http://www.apache.org/licenses/LICENSE-2.0
16   *
17   *  Unless required by applicable law or agreed to in writing, software
18   *  distributed under the License is distributed on an "AS IS" BASIS,
19   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20   *  See the License for the specific language governing permissions and
21   *  limitations under the License.
22   * ====================================================================
23   *
24   * This software consists of voluntary contributions made by many
25   * individuals on behalf of the Apache Software Foundation.  For more
26   * information on the Apache Software Foundation, please see
27   * <http://www.apache.org/>.
28   *
29   */
30  
31  package org.apache.commons.httpclient.methods;
32  
33  import org.apache.commons.httpclient.HttpMethodBase;
34  
35  
36  /***
37   * Implements the HTTP DELETE method.
38   * <p>
39   * The HTTP DELETE method is defined in section 9.7 of 
40   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
41   * <blockquote>
42   * The DELETE method requests that the origin server delete the resource
43   * identified by the Request-URI. This method MAY be overridden by human
44   * intervention (or other means) on the origin server.
45   * </blockquote>
46   * </p>
47   *
48   * @author <a href="mailto:remm@apache.org">Remy Maucherat</a>
49   * @author <a href="mailto:bcholmes@apache.org">B.C. Holmes</a>
50   * @author <a href="mailto:jsdever@apache.org">Jeff Dever</a>
51   *
52   * @version $Revision: 1425331 $
53   * @since 1.0
54   */
55  public class DeleteMethod
56      extends HttpMethodBase {
57  
58  
59      // ----------------------------------------------------------- Constructors
60  
61  
62      /***
63       * No-arg constructor.
64       *
65       * @since 1.0
66       */
67      public DeleteMethod() {
68      }
69  
70  
71      /***
72       * Constructor specifying a URI.
73       *
74       * @param uri either an absolute or relative URI
75       *
76       * @since 1.0
77       */
78      public DeleteMethod(String uri) {
79          super(uri);
80      }
81  
82  
83      // ----------------------------------------------------- HttpMethod Methods
84  
85      /***
86       * Returns <tt>"DELETE"</tt>.
87       * @return <tt>"DELETE"</tt>
88       *
89       * @since 2.0
90       */
91      public String getName() {
92          return "DELETE";
93      }
94  
95  
96  }