001/*
002 * ====================================================================
003 * Licensed to the Apache Software Foundation (ASF) under one
004 * or more contributor license agreements.  See the NOTICE file
005 * distributed with this work for additional information
006 * regarding copyright ownership.  The ASF licenses this file
007 * to you under the Apache License, Version 2.0 (the
008 * "License"); you may not use this file except in compliance
009 * with the License.  You may obtain a copy of the License at
010 *
011 *   http://www.apache.org/licenses/LICENSE-2.0
012 *
013 * Unless required by applicable law or agreed to in writing,
014 * software distributed under the License is distributed on an
015 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
016 * KIND, either express or implied.  See the License for the
017 * specific language governing permissions and limitations
018 * under the License.
019 * ====================================================================
020 *
021 * This software consists of voluntary contributions made by many
022 * individuals on behalf of the Apache Software Foundation.  For more
023 * information on the Apache Software Foundation, please see
024 * <http://www.apache.org/>.
025 *
026 */
027
028package org.apache.http.client.methods;
029
030import java.net.URI;
031
032/**
033 * HTTP HEAD method.
034 * <p>
035 * The HTTP HEAD method is defined in section 9.4 of
036 * <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC2616</a>:
037 * </p>
038 * <blockquote>
039 * The HEAD method is identical to GET except that the server MUST NOT
040 * return a message-body in the response. The metainformation contained
041 * in the HTTP headers in response to a HEAD request SHOULD be identical
042 * to the information sent in response to a GET request. This method can
043 * be used for obtaining metainformation about the entity implied by the
044 * request without transferring the entity-body itself. This method is
045 * often used for testing hypertext links for validity, accessibility,
046 * and recent modification.
047 * </blockquote>
048 *
049 * @since 4.0
050 */
051public class HttpHead extends HttpRequestBase {
052
053    public final static String METHOD_NAME = "HEAD";
054
055    public HttpHead() {
056        super();
057    }
058
059    public HttpHead(final URI uri) {
060        super();
061        setURI(uri);
062    }
063
064    /**
065     * @throws IllegalArgumentException if the uri is invalid.
066     */
067    public HttpHead(final String uri) {
068        super();
069        setURI(URI.create(uri));
070    }
071
072    @Override
073    public String getMethod() {
074        return METHOD_NAME;
075    }
076
077}