001: /*
002: * Licensed to the Apache Software Foundation (ASF) under one or more
003: * contributor license agreements. See the NOTICE file distributed with
004: * this work for additional information regarding copyright ownership.
005: * The ASF licenses this file to You under the Apache License, Version 2.0
006: * (the "License"); you may not use this file except in compliance with
007: * the License. You may obtain a copy of the License at
008: *
009: * http://www.apache.org/licenses/LICENSE-2.0
010: *
011: * Unless required by applicable law or agreed to in writing, software
012: * distributed under the License is distributed on an "AS IS" BASIS,
013: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014: * See the License for the specific language governing permissions and
015: * limitations under the License.
016: *
017: */
018:
019: package org.apache.tools.ant.taskdefs.optional.j2ee;
020:
021: import org.apache.tools.ant.BuildException;
022: import org.apache.tools.ant.taskdefs.Java;
023: import org.apache.tools.ant.types.Commandline;
024:
025: /**
026: * A generic tool for J2EE server hot deployment.
027: * <p>The simple implementation spawns a JVM with the supplied
028: * class name, jvm args, and arguments.
029: *
030: * @see org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool
031: * @see org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
032: * @see org.apache.tools.ant.taskdefs.optional.j2ee.ServerDeploy
033: */
034: public class GenericHotDeploymentTool extends AbstractHotDeploymentTool {
035: /** A Java task used to run the deployment tool **/
036: private Java java;
037:
038: /** The fully qualified class name of the deployment tool **/
039: private String className;
040:
041: /** List of valid actions **/
042: private static final String[] VALID_ACTIONS = { ACTION_DEPLOY };
043:
044: /**
045: * Add a nested argument element to hand to the deployment tool; optional.
046: * @return A Commandline.Argument object representing the
047: * command line argument being passed when the deployment
048: * tool is run. IE: "-user=mark", "-password=venture"...
049: */
050: public Commandline.Argument createArg() {
051: return java.createArg();
052: }
053:
054: /**
055: * Add a nested argment element to hand to the JVM running the
056: * deployment tool.
057: * Creates a nested arg element.
058: * @return A Commandline.Argument object representing the
059: * JVM command line argument being passed when the deployment
060: * tool is run. IE: "-ms64m", "-mx128m"...
061: */
062: public Commandline.Argument createJvmarg() {
063: return java.createJvmarg();
064: }
065:
066: /**
067: * Determines if the "action" attribute defines a valid action.
068: * <p>Subclasses should determine if the action passed in is
069: * supported by the vendor's deployment tool.
070: * For this generic implementation, the only valid action is "deploy"
071: * @return true if the "action" attribute is valid, false if not.
072: */
073: protected boolean isActionValid() {
074: return (getTask().getAction().equals(VALID_ACTIONS[0]));
075: }
076:
077: /**
078: * Sets the parent task.
079: * @param task An ServerDeploy object representing the parent task.
080: * @ant.attribute ignored="true"
081: */
082: public void setTask(ServerDeploy task) {
083: super .setTask(task);
084: java = new Java(task);
085: }
086:
087: /**
088: * Perform the actual deployment.
089: * For this generic implementation, a JVM is spawned using the
090: * supplied classpath, classname, JVM args, and command line arguments.
091: * @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
092: */
093: public void deploy() throws BuildException {
094: java.setClassname(className);
095: java.setClasspath(getClasspath());
096: java.setFork(true);
097: java.setFailonerror(true);
098: java.execute();
099: }
100:
101: /**
102: * Validates the passed in attributes.
103: * Ensures the className and arguments attribute have been set.
104: * @exception org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
105: */
106: public void validateAttributes() throws BuildException {
107: super .validateAttributes();
108:
109: if (className == null) {
110: throw new BuildException(
111: "The classname attribute must be set");
112: }
113: }
114:
115: /**
116: * The name of the class to execute to perfom
117: * deployment; required.
118: * Example: "com.foobar.tools.deploy.DeployTool"
119: * @param className The fully qualified class name of the class
120: * to perform deployment.
121: */
122: public void setClassName(String className) {
123: this .className = className;
124: }
125:
126: /**
127: * get the java attribute.
128: * @return the java attribute.
129: */
130: public Java getJava() {
131: return java;
132: }
133:
134: /**
135: * Get the classname attribute.
136: * @return the classname value.
137: */
138: public String getClassName() {
139: return className;
140: }
141: }
|