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 TRACE method.
36   * <p>
37   * The HTTP TRACE method is defined in section 9.6 of
38   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
39   * <blockquote>
40   *  The TRACE method is used to invoke a remote, application-layer loop-
41   *  back of the request message. The final recipient of the request
42   *  SHOULD reflect the message received back to the client as the
43   *  entity-body of a 200 (OK) response. The final recipient is either the
44   *  origin server or the first proxy or gateway to receive a Max-Forwards
45   *  value of zero (0) in the request (see section 14.31). A TRACE request
46   *  MUST NOT include an entity.
47   * </blockquote>
48   * </p>
49   *
50   * @since 4.0
51   */
52  @NotThreadSafe
53  public class HttpTrace extends HttpRequestBase {
54  
55      public final static String METHOD_NAME = "TRACE";
56  
57      public HttpTrace() {
58          super();
59      }
60  
61      public HttpTrace(final URI uri) {
62          super();
63          setURI(uri);
64      }
65  
66      /**
67       * @throws IllegalArgumentException if the uri is invalid.
68       */
69      public HttpTrace(final String uri) {
70          super();
71          setURI(URI.create(uri));
72      }
73  
74      @Override
75      public String getMethod() {
76          return METHOD_NAME;
77      }
78  
79  }