Clover coverage report - Ant Coverage
Coverage timestamp: Tue Apr 8 2003 20:43:55 EST
file stats: LOC: 173   Methods: 9
NCLOC: 43   Classes: 1
 
 Source file Conditionals Statements Methods TOTAL
GenericHotDeploymentTool.java 0% 0% 0% 0%
 1   
 /*
 2   
  * The Apache Software License, Version 1.1
 3   
  *
 4   
  * Copyright (c) 2002 The Apache Software Foundation.  All rights
 5   
  * reserved.
 6   
  *
 7   
  * Redistribution and use in source and binary forms, with or without
 8   
  * modification, are permitted provided that the following conditions
 9   
  * are met:
 10   
  *
 11   
  * 1. Redistributions of source code must retain the above copyright
 12   
  *    notice, this list of conditions and the following disclaimer.
 13   
  *
 14   
  * 2. Redistributions in binary form must reproduce the above copyright
 15   
  *    notice, this list of conditions and the following disclaimer in
 16   
  *    the documentation and/or other materials provided with the
 17   
  *    distribution.
 18   
  *
 19   
  * 3. The end-user documentation included with the redistribution, if
 20   
  *    any, must include the following acknowlegement:
 21   
  *       "This product includes software developed by the
 22   
  *        Apache Software Foundation (http://www.apache.org/)."
 23   
  *    Alternately, this acknowlegement may appear in the software itself,
 24   
  *    if and wherever such third-party acknowlegements normally appear.
 25   
  *
 26   
  * 4. The names "Ant" and "Apache Software
 27   
  *    Foundation" must not be used to endorse or promote products derived
 28   
  *    from this software without prior written permission. For written
 29   
  *    permission, please contact apache@apache.org.
 30   
  *
 31   
  * 5. Products derived from this software may not be called "Apache"
 32   
  *    nor may "Apache" appear in their names without prior written
 33   
  *    permission of the Apache Group.
 34   
  *
 35   
  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 36   
  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 37   
  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 38   
  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 39   
  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 40   
  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 41   
  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 42   
  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 43   
  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 44   
  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 45   
  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 46   
  * SUCH DAMAGE.
 47   
  * ====================================================================
 48   
  *
 49   
  * This software consists of voluntary contributions made by many
 50   
  * individuals on behalf of the Apache Software Foundation.  For more
 51   
  * information on the Apache Software Foundation, please see
 52   
  * <http://www.apache.org/>.
 53   
  */
 54   
 
 55   
 package org.apache.tools.ant.taskdefs.optional.j2ee;
 56   
 
 57   
 import org.apache.tools.ant.BuildException;
 58   
 import org.apache.tools.ant.taskdefs.Java;
 59   
 import org.apache.tools.ant.types.Commandline;
 60   
 
 61   
 /**
 62   
  *  A generic tool for J2EE server hot deployment.
 63   
  *  <p>The simple implementation spawns a JVM with the supplied
 64   
  *  class name, jvm args, and arguments.
 65   
  *
 66   
  *  @author Christopher A. Longo - cal@cloud9.net
 67   
  *
 68   
  *  @see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
 69   
  *  @see org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
 70   
  *  @see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
 71   
  */
 72   
 public class GenericHotDeploymentTool extends AbstractHotDeploymentTool {
 73   
     /** A Java task used to run the deployment tool **/
 74   
     private Java java;
 75   
 
 76   
     /** The fully qualified class name of the deployment tool **/
 77   
     private String className;
 78   
 
 79   
     /** List of valid actions **/
 80   
     private static final String[] VALID_ACTIONS = { ACTION_DEPLOY };
 81   
 
 82   
     /**
 83   
      *  Add a nested argument element to hand to the deployment tool; optional.
 84   
      *  @return A Commandline.Argument object representing the
 85   
      *  command line argument being passed when the deployment
 86   
      *  tool is run.  IE: "-user=mark", "-password=venture"...
 87   
      */
 88  0
     public Commandline.Argument createArg() {
 89  0
         return java.createArg();
 90   
     }
 91   
 
 92   
     /**
 93   
      *  Add a nested argment element to hand to the JVM running the
 94   
      *  deployment tool.
 95   
      *  Creates a nested arg element.
 96   
      *  @return A Commandline.Argument object representing the
 97   
      *  JVM command line argument being passed when the deployment
 98   
      *  tool is run.  IE: "-ms64m", "-mx128m"...
 99   
      */
 100  0
     public Commandline.Argument createJvmarg() {
 101  0
         return java.createJvmarg();
 102   
     }
 103   
 
 104   
     /**
 105   
      *  Determines if the "action" attribute defines a valid action.
 106   
      *  <p>Subclasses should determine if the action passed in is
 107   
      *  supported by the vendor's deployment tool.
 108   
      *  For this generic implementation, the only valid action is "deploy"
 109   
      *  @return true if the "action" attribute is valid, false if not.
 110   
      */
 111  0
     protected boolean isActionValid() {
 112  0
         return (getTask().getAction().equals(VALID_ACTIONS[0]));
 113   
     }
 114   
 
 115   
     /**
 116   
      *  Sets the parent task.
 117   
      *  @param task An ServerDeploy object representing the parent task.
 118   
      *  @ant.attribute ignored="true"
 119   
      */
 120  0
     public void setTask(ServerDeploy task) {
 121  0
         super.setTask(task);
 122  0
         java = (Java) task.getProject().createTask("java");
 123   
     }
 124   
 
 125   
     /**
 126   
      *  Perform the actual deployment.
 127   
      *  For this generic implementation, a JVM is spawned using the
 128   
      *  supplied classpath, classname, JVM args, and command line arguments.
 129   
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
 130   
      */
 131  0
     public void deploy() throws BuildException {
 132  0
         java.setClassname(className);
 133  0
         java.setClasspath(getClasspath());
 134  0
         java.setFork(true);
 135  0
         java.setFailonerror(true);
 136  0
         java.execute();
 137   
     }
 138   
 
 139   
     /**
 140   
      *  Validates the passed in attributes.
 141   
      *  Ensures the className and arguments attribute have been set.
 142   
      *  @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
 143   
      */
 144  0
     public void validateAttributes() throws BuildException {
 145  0
         super.validateAttributes();
 146   
 
 147  0
         if (className == null)
 148  0
             throw new BuildException("The classname attribute must be set");
 149   
     }
 150   
 
 151   
     /**
 152   
      *  The name of the class to execute to perfom
 153   
      *  deployment; required. 
 154   
      *  Example: "com.foobar.tools.deploy.DeployTool"
 155   
      *  @param className The fully qualified class name of the class
 156   
      *  to perform deployment.
 157   
      */
 158  0
     public void setClassName(String className) {
 159  0
         this.className = className;
 160   
     }
 161   
     
 162   
     /**
 163   
      *
 164   
      */
 165  0
     public Java getJava() {
 166  0
         return java;
 167   
     }
 168   
     
 169  0
     public String getClassName() {
 170  0
         return className;
 171   
     }
 172   
 }
 173