View Javadoc

1   /*
2    * ====================================================================
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *   http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing,
14   * software distributed under the License is distributed on an
15   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16   * KIND, either express or implied.  See the License for the
17   * specific language governing permissions and limitations
18   * under the License.
19   * ====================================================================
20   *
21   * This software consists of voluntary contributions made by many
22   * individuals on behalf of the Apache Software Foundation.  For more
23   * information on the Apache Software Foundation, please see
24   * <http://www.apache.org/>.
25   *
26   */
27  
28  package org.apache.http.client.methods;
29  
30  import java.net.URI;
31  
32  import org.apache.http.annotation.NotThreadSafe;
33  
34  /**
35   * 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   * </p>
40   * <blockquote>
41   * The PUT method requests that the enclosed entity be stored under the
42   * supplied Request-URI. If the Request-URI refers to an already
43   * existing resource, the enclosed entity SHOULD be considered as a
44   * modified version of the one residing on the origin server.
45   * </blockquote>
46   *
47   * @since 4.0
48   */
49  @NotThreadSafe
50  public class HttpPut extends HttpEntityEnclosingRequestBase {
51  
52      public final static String METHOD_NAME = "PUT";
53  
54      public HttpPut() {
55          super();
56      }
57  
58      public HttpPut(final URI uri) {
59          super();
60          setURI(uri);
61      }
62  
63      /**
64       * @throws IllegalArgumentException if the uri is invalid.
65       */
66      public HttpPut(final String uri) {
67          super();
68          setURI(URI.create(uri));
69      }
70  
71      @Override
72      public String getMethod() {
73          return METHOD_NAME;
74      }
75  
76  }