/*
* The Apache Software License, Version 1.1
*
* Copyright (c) 2001-2002 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", "Ant", 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.ccm;
import org.apache.tools.ant.BuildException;
import org.apache.tools.ant.Project;
import org.apache.tools.ant.Task;
import org.apache.tools.ant.taskdefs.Execute;
import org.apache.tools.ant.taskdefs.ExecuteStreamHandler;
import org.apache.tools.ant.taskdefs.LogStreamHandler;
import org.apache.tools.ant.types.Commandline;
/**
* A base class for creating tasks for executing commands on Continuus 5.1.
* <p>
* The class extends the task as it operates by executing the ccm.exe program
* supplied with Continuus/Synergy. By default the task expects the ccm executable to be
* in the path,
* you can override this be specifying the ccmdir attribute.
* </p>
*
* @author Benoit Moussaud benoit.moussaud@criltelecom.com
*/
public abstract class Continuus extends Task {
private String ccmDir = "";
private String ccmAction = "";
/**
* Get the value of ccmAction.
* @return value of ccmAction.
*/
public String getCcmAction() {
return ccmAction;
}
/**
* Set the value of ccmAction.
* @param v Value to assign to ccmAction.
* @ant.attribute ignore="true"
*/
public void setCcmAction(String v) {
this.ccmAction = v;
}
/**
* Set the directory where the ccm executable is located.
*
* @param dir the directory containing the ccm executable
*/
public final void setCcmDir(String dir) {
ccmDir = project.translatePath(dir);
}
/**
* Builds and returns the command string to execute ccm
* @return String containing path to the executable
*/
protected final String getCcmCommand() {
String toReturn = ccmDir;
if (!toReturn.equals("") && !toReturn.endsWith("/")) {
toReturn += "/";
}
toReturn += CCM_EXE;
return toReturn;
}
protected int run(Commandline cmd, ExecuteStreamHandler handler) {
try {
Execute exe = new Execute(handler);
exe.setAntRun(getProject());
exe.setWorkingDirectory(getProject().getBaseDir());
exe.setCommandline(cmd.getCommandline());
return exe.execute();
} catch (java.io.IOException e) {
throw new BuildException(e, location);
}
}
protected int run(Commandline cmd) {
return run(cmd, new LogStreamHandler(this, Project.MSG_VERBOSE, Project.MSG_WARN));
}
/**
* Constant for the thing to execute
*/
private static final String CCM_EXE = "ccm";
/**
* The 'CreateTask' command
*/
public static final String COMMAND_CREATE_TASK = "create_task";
/**
* The 'Checkout' command
*/
public static final String COMMAND_CHECKOUT = "co";
/**
* The 'Checkin' command
*/
public static final String COMMAND_CHECKIN = "ci";
/**
* The 'Reconfigure' command
*/
public static final String COMMAND_RECONFIGURE = "reconfigure";
/**
* The 'Reconfigure' command
*/
public static final String COMMAND_DEFAULT_TASK = "default_task";
}