/*
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 1999 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution, if
 *    any, must include the following acknowlegement:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowlegement may appear in the software itself,
 *    if and wherever such third-party acknowlegements normally appear.
 *
 * 4. The names "The Jakarta Project", "Tomcat", and "Apache Software
 *    Foundation" must not be used to endorse or promote products derived
 *    from this software without prior written permission. For written
 *    permission, please contact apache@apache.org.
 *
 * 5. Products derived from this software may not be called "Apache"
 *    nor may "Apache" appear in their names without prior written
 *    permission of the Apache Group.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.tools.ant.taskdefs.optional;

import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;

import java.io.IOException;


/**
 * Sample Exec implementation using <code>Execute</code>, <code>Commandline</code>,
 * <code>ExecuteStramHandler</code> and <code>ExecuteWatchdog</code>.
 *
 * @author thomas.haas@softwired-inc.com
 */
public class OExec extends Task {

    private final static String OUTPUT_LOG = "LOG";
    private final static String OUTPUT_PIPE = "PIPE";

    private Integer timeout = null;
    private Integer successvalue = new Integer(0);
    private Commandline cmdl = new Commandline();
    private String outputtype = OUTPUT_LOG;

    public void setTimeout(String value) {
        timeout = Integer.getInteger(value);
    }

    public void setSuccessvalue(String value) {
        successvalue = Integer.getInteger(value);
    }

    public void setOutputtype(String value) {
        outputtype = value;
    }

    public void setExecutable(String value) {
        cmdl.setExecutable(value);
    }

    public Commandline createCommandline() {
        return cmdl;
    }

    public void execute() throws BuildException {
        try {
            final Execute exe = new Execute(createHandler(), createWatchdog());
            exe.setCommandline(cmdl.getCommandline());
            evalExitValue(exe.execute());
        } catch (IOException e) {
            throw new BuildException("Execute failed: " + e);
        }
    }


    protected ExecuteStreamHandler createHandler() throws BuildException {
        if (OUTPUT_PIPE.equals(outputtype)) {
            return new LogStreamHandler(project,
                "exec", Project.MSG_INFO, "error", Project.MSG_INFO);
        } else if (OUTPUT_LOG.equals(outputtype)) {
            return new PumpStreamHandler();
        } else {
            throw new BuildException("Unknown outputtype: " + outputtype);
        }
    }

    protected ExecuteWatchdog createWatchdog() throws BuildException {
        if (timeout == null) return null;
        return new ExecuteWatchdog(timeout.intValue());
    }

    protected void evalExitValue(int value) throws BuildException {
        if (successvalue != null && value != successvalue.intValue()) {
            throw new BuildException("Execute failed with exitValue=" + value);
        }
    }


}