org.apache.tools.ant.taskdefs.optional.j2ee

Class GenericHotDeploymentTool

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

Method Summary
Commandline.ArgumentcreateArg()
Add a nested argument element to hand to the deployment tool; optional.
Commandline.ArgumentcreateJvmarg()
Add a nested argment element to hand to the JVM running the deployment tool.
voiddeploy()
Perform the actual deployment.
StringgetClassName()
Get the classname attribute.
JavagetJava()
get the java attribute.
protected booleanisActionValid()
Determines if the "action" attribute defines a valid action.
voidsetClassName(String className)
The name of the class to execute to perfom deployment; required.
voidsetTask(ServerDeploy task)
Sets the parent task.
voidvalidateAttributes()
Validates the passed in attributes.

Method Detail

createArg

public 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"...

createJvmarg

public Commandline.Argument createJvmarg()
Add a nested argment 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"...

deploy

public void deploy()
Perform the actual deployment. For this generic implementation, a JVM is spawned using the supplied classpath, classname, JVM args, and command line arguments.

Throws: org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.

getClassName

public String getClassName()
Get the classname attribute.

Returns: the classname value.

getJava

public Java getJava()
get the java attribute.

Returns: the java attribute.

isActionValid

protected 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"

Returns: true if the "action" attribute is valid, false if not.

setClassName

public void setClassName(String className)
The name of the class to execute to perfom deployment; required. Example: "com.foobar.tools.deploy.DeployTool"

Parameters: className The fully qualified class name of the class to perform deployment.

setTask

public void setTask(ServerDeploy task)
Sets the parent task.

Parameters: task An ServerDeploy object representing the parent task.

UNKNOWN: ignored="true"

validateAttributes

public void validateAttributes()
Validates the passed in attributes. Ensures the className and arguments attribute have been set.

Throws: org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.