/*
 * @(#)Head.java
 *
 * Summary: Simulates a browser posting a form to CGI via HEAD.
 *
 * Copyright: (c) 1998-2010 Roedy Green, Canadian Mind Products, http://mindprod.com
 *
 * Licence: This software may be copied and used freely for any purpose but military.
 *          http://mindprod.com/contact/nonmil.html
 *
 * Requires: JDK 1.5+
 *
 * Created with: IntelliJ IDEA IDE.
 *
 * Version History:
 *  2.0 2009-02-20 - major refactoring. separate setParms and setPostParms. new send method. Post can have both types of parm.
 *  2.1 2010-02-07 - new methods Post.setBody Http.setRequestProperties.
 */
package com.mindprod.http;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.URISyntaxException;
import java.net.URL;

/**
 * Simulates a browser posting a form to CGI via HEAD.
 * <p/>
 * It does not read any data. It is used for link checking where the server accepts HEAD requests.
 * If the server might ignore HEAD requests, use Probe instead.
 *
 * @author Roedy Green, Canadian Mind Products
 * @version 2.1 2010-02-07 - new methods Post.setBody Http.setRequestProperties.
 * @since 1998
 */
@SuppressWarnings( { "WeakerAccess" } )
public final class Head extends Http
    {
    // -------------------------- PUBLIC INSTANCE  METHODS --------------------------

    /**
     * constructor
     */
    public Head()
        {
        }

    /**
     * Check if URL is working
     * Send a form full of data to the CGI host using HEAD.
     *
     * @param url complete URL including get parms pre-encoded.
     *            only http: protocol is supported.
     *
     * @return responseCode
     */
    @SuppressWarnings( { "UnusedAssignment", "MethodNamesDifferingOnlyByCase" } )
    public int send( URL url )
        {
        try
            {
            // defaults
            responseCode = DEFAULT_RESPONSE_CODE;
            responseMessage = DEFAULT_RESPONSE_MESSAGE;

            // O P E N

            final HttpURLConnection urlc = ( HttpURLConnection ) url.openConnection();
            urlc.setAllowUserInteraction( false );
            urlc.setDoInput( true );
            urlc.setDoOutput( false );// nothing beyond original request
            urlc.setUseCaches( false );
            urlc.setRequestMethod( "HEAD" );
            setStandardProperties( urlc );
            urlc.connect();

            // getResponseCode will block until the server responds.
            // save responseCode for later retrieval
            responseCode = urlc.getResponseCode();
            responseMessage = urlc.getResponseMessage();
            urlc.disconnect();
            return responseCode;
            }
        catch ( ClassCastException e )
            {
            // was not an http: url
            return responseCode;
            }
        catch ( IOException e )
            {
            return responseCode;
            }
        }// end probe

    /**
     * Check if URL is working
     * Send a form full of data to the CGI host using HEAD.
     * You must have done a setParms first.
     *
     * @param host   host name of the website, Should be form:"mindprod.com", no lead http://.
     * @param port   -1 if default, 8081 for local echoserver.
     * @param action action of form, page on website. Usually has a lead /.
     *
     * @return responseCode
     */
    @SuppressWarnings( { "UnusedAssignment", "MethodNamesDifferingOnlyByCase" } )
    public int send( String host, int port, String action )
        {
        try
            {
            // defaults
            responseCode = DEFAULT_RESPONSE_CODE;
            responseMessage = DEFAULT_RESPONSE_MESSAGE;

            // O P E N

            // URL will encode target and parms.
            URL url = new URI( "http",
                    null,
                    host,
                    port,
                    action,
                    null,
                    null ).toURL();
            url = new URL( url.toString() + getEncodedParms( "UTF-8" ) );
            return send( url );
            }
        catch ( URISyntaxException e )
            {
            return responseCode;
            }
        catch ( IOException e )
            {
            return responseCode;
            }
        }// end probe
    }