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 POST method.
36   * <p>
37   * The HTTP POST method is defined in section 9.5 of
38   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
39   * </p>
40   * <blockquote>
41   * The POST method is used to request that the origin server accept the entity
42   * enclosed in the request as a new subordinate of the resource identified by
43   * the Request-URI in the Request-Line. POST is designed to allow a uniform
44   * method to cover the following functions:
45   * <ul>
46   *   <li>Annotation of existing resources</li>
47   *   <li>Posting a message to a bulletin board, newsgroup, mailing list, or
48   *     similar group of articles</li>
49   *   <li>Providing a block of data, such as the result of submitting a form,
50   *     to a data-handling process</li>
51   *   <li>Extending a database through an append operation</li>
52   * </ul>
53   * </blockquote>
54   *
55   * @since 4.0
56   */
57  @NotThreadSafe
58  public class HttpPost extends HttpEntityEnclosingRequestBase {
59  
60      public final static String METHOD_NAME = "POST";
61  
62      public HttpPost() {
63          super();
64      }
65  
66      public HttpPost(final URI uri) {
67          super();
68          setURI(uri);
69      }
70  
71      /**
72       * @throws IllegalArgumentException if the uri is invalid.
73       */
74      public HttpPost(final String uri) {
75          super();
76          setURI(URI.create(uri));
77      }
78  
79      @Override
80      public String getMethod() {
81          return METHOD_NAME;
82      }
83  
84  }