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 HEAD method.
36   * <p>
37   * The HTTP HEAD method is defined in section 9.4 of
38   * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
39   * <blockquote>
40   * The HEAD method is identical to GET except that the server MUST NOT
41   * return a message-body in the response. The metainformation contained
42   * in the HTTP headers in response to a HEAD request SHOULD be identical
43   * to the information sent in response to a GET request. This method can
44   * be used for obtaining metainformation about the entity implied by the
45   * request without transferring the entity-body itself. This method is
46   * often used for testing hypertext links for validity, accessibility,
47   * and recent modification.
48   * </blockquote>
49   * </p>
50   *
51   * @since 4.0
52   */
53  @NotThreadSafe
54  public class HttpHead extends HttpRequestBase {
55  
56      public final static String METHOD_NAME = "HEAD";
57  
58      public HttpHead() {
59          super();
60      }
61  
62      public HttpHead(final URI uri) {
63          super();
64          setURI(uri);
65      }
66  
67      /**
68       * @throws IllegalArgumentException if the uri is invalid.
69       */
70      public HttpHead(final String uri) {
71          super();
72          setURI(URI.create(uri));
73      }
74  
75      @Override
76      public String getMethod() {
77          return METHOD_NAME;
78      }
79  
80  }