Class GenericHotDeploymentTool
- java.lang.Object
- 
- org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
- 
- org.apache.tools.ant.taskdefs.optional.j2ee.GenericHotDeploymentTool
 
 
- 
- All Implemented Interfaces:
- HotDeploymentTool
 - Direct Known Subclasses:
- JonasHotDeploymentTool
 
 public class GenericHotDeploymentTool extends AbstractHotDeploymentTool A generic tool for J2EE server hot deployment.The simple implementation spawns a JVM with the supplied class name, jvm args, and arguments. - See Also:
- HotDeploymentTool,- AbstractHotDeploymentTool,- ServerDeploy
 
- 
- 
Field Summary- 
Fields inherited from interface org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentToolACTION_DELETE, ACTION_DEPLOY, ACTION_LIST, ACTION_UNDEPLOY, ACTION_UPDATE
 
- 
 - 
Constructor SummaryConstructors Constructor Description GenericHotDeploymentTool()
 - 
Method SummaryModifier and Type Method Description Commandline.ArgumentcreateArg()Add a nested argument element to hand to the deployment tool; optional.Commandline.ArgumentcreateJvmarg()Add a nested argument element to hand to the JVM running the deployment tool.voiddeploy()Perform the actual deployment.java.lang.StringgetClassName()Get the classname attribute.JavagetJava()get the java attribute.protected booleanisActionValid()Determines if the "action" attribute defines a valid action.voidsetClassName(java.lang.String className)The name of the class to execute to perform deployment; required.voidsetTask(ServerDeploy task)Sets the parent task.voidvalidateAttributes()Validates the passed in attributes.- 
Methods inherited from class org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentToolcreateClasspath, getClasspath, getPassword, getServer, getTask, getUserName, setClasspath, setPassword, setServer, setUserName
 
- 
 
- 
- 
- 
Method Detail- 
createArgpublic Commandline.Argument createArg() Add a nested argument element to hand to the deployment tool; optional.- Returns:
- A Commandline.Argument object representing the command line argument being passed when the deployment tool is run. IE: "-user=mark", "-password=venture"...
 
 - 
createJvmargpublic Commandline.Argument createJvmarg() Add a nested argument element to hand to the JVM running the deployment tool. Creates a nested arg element.- Returns:
- A Commandline.Argument object representing the JVM command line argument being passed when the deployment tool is run. IE: "-ms64m", "-mx128m"...
 
 - 
isActionValidprotected boolean isActionValid() Determines if the "action" attribute defines a valid action.Subclasses should determine if the action passed in is supported by the vendor's deployment tool. For this generic implementation, the only valid action is "deploy" - Specified by:
- isActionValidin class- AbstractHotDeploymentTool
- Returns:
- true if the "action" attribute is valid, false if not.
 
 - 
setTaskpublic void setTask(ServerDeploy task) Sets the parent task.- Specified by:
- setTaskin interface- HotDeploymentTool
- Overrides:
- setTaskin class- AbstractHotDeploymentTool
- Parameters:
- task- An ServerDeploy object representing the parent task.
 
 - 
deploypublic void deploy() throws BuildExceptionPerform the actual deployment. For this generic implementation, a JVM is spawned using the supplied classpath, classname, JVM args, and command line arguments.- Throws:
- BuildException- if the attributes are invalid or incomplete.
 
 - 
validateAttributespublic void validateAttributes() throws BuildExceptionValidates the passed in attributes. Ensures the className and arguments attribute have been set.- Specified by:
- validateAttributesin interface- HotDeploymentTool
- Overrides:
- validateAttributesin class- AbstractHotDeploymentTool
- Throws:
- BuildException- if the attributes are invalid or incomplete.
 
 - 
setClassNamepublic void setClassName(java.lang.String className) The name of the class to execute to perform deployment; required. Example: "com.foobar.tools.deploy.DeployTool"- Parameters:
- className- The fully qualified class name of the class to perform deployment.
 
 - 
getJavapublic Java getJava() get the java attribute.- Returns:
- the java attribute.
 
 - 
getClassNamepublic java.lang.String getClassName() Get the classname attribute.- Returns:
- the classname value.
 
 
- 
 
-