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 PATCH method.
36   * <p>
37   * The HTTP PATCH method is defined in <a
38   * href="http://tools.ietf.org/html/rfc5789">RF5789</a>:
39   * </p>
40   * <blockquote> The PATCH
41   * method requests that a set of changes described in the request entity be
42   * applied to the resource identified by the Request- URI. Differs from the PUT
43   * method in the way the server processes the enclosed entity to modify the
44   * resource identified by the Request-URI. In a PUT request, the enclosed entity
45   * origin server, and the client is requesting that the stored version be
46   * replaced. With PATCH, however, the enclosed entity contains a set of
47   * instructions describing how a resource currently residing on the origin
48   * server should be modified to produce a new version.
49   * </blockquote>
50   *
51   * @since 4.2
52   */
53  @NotThreadSafe
54  public class HttpPatch extends HttpEntityEnclosingRequestBase {
55  
56      public final static String METHOD_NAME = "PATCH";
57  
58      public HttpPatch() {
59          super();
60      }
61  
62      public HttpPatch(final URI uri) {
63          super();
64          setURI(uri);
65      }
66  
67      public HttpPatch(final String uri) {
68          super();
69          setURI(URI.create(uri));
70      }
71  
72      @Override
73      public String getMethod() {
74          return METHOD_NAME;
75      }
76  
77  }