org.apache.tools.ant.taskdefs.optional.j2ee
Class AbstractHotDeploymentTool
java.lang.Object
org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool
- HotDeploymentTool
public abstract class AbstractHotDeploymentTool
extends java.lang.Object
Abstract class to support vendor-specific hot deployment tools.
This class will validate boilerplate attributes.
Subclassing this class for a vendor specific tool involves the
following.
- Implement the
isActionValid()
method to insure the
action supplied as the "action" attribute of ServerDeploy is valid.
- Implement the
validateAttributes()
method to insure
all required attributes are supplied, and are in the correct format.
- Add a
add<TOOL>
method to the ServerDeploy
class. This method will be called when Ant encounters a
add<TOOL>
task nested in the
serverdeploy
task.
- Define the
deploy
method. This method should perform
whatever task it takes to hot-deploy the component. IE: spawn a JVM and
run class, exec a native executable, run Java code...
Path | createClasspath() - Add a classpath as a nested element.
|
abstract void | deploy() - Perform the actual deployment.
|
Path | getClasspath() - gets the classpath field.
|
String | getPassword() - Returns the password field.
|
String | getServer() - Returns the server field.
|
protected ServerDeploy | getTask() - Returns the task field, a ServerDeploy object.
|
String | getUserName() - Returns the userName field.
|
protected abstract boolean | isActionValid() - Determines if the "action" attribute defines a valid action.
|
void | setClasspath(Path classpath) - The classpath to be passed to the JVM running the tool;
optional depending upon the tool.
|
void | setPassword(String password) - The password of the user; optional.
|
void | setServer(String server) - The address or URL for the server where the component will be deployed.
|
void | setTask(ServerDeploy task) - Sets the parent task.
|
void | setUserName(String userName) - The user with privileges to deploy applications to the server; optional.
|
void | validateAttributes() - Validates the passed in attributes.
|
createClasspath
public Path createClasspath()
Add a classpath as a nested element.
- A Path object representing the classpath to be used.
deploy
public abstract void deploy()
throws BuildException
Perform the actual deployment.
It's up to the subclasses to implement the actual behavior.
- deploy in interface HotDeploymentTool
getClasspath
public Path getClasspath()
gets the classpath field.
- A Path representing the "classpath" attribute.
getPassword
public String getPassword()
Returns the password field.
- A String representing the "password" attribute.
getServer
public String getServer()
Returns the server field.
- A String representing the "server" attribute.
getTask
protected ServerDeploy getTask()
Returns the task field, a ServerDeploy object.
- An ServerDeploy representing the parent task.
getUserName
public String getUserName()
Returns the userName field.
- A String representing the "userName" attribute.
isActionValid
protected abstract 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.
Actions may by "deploy", "delete", etc... It all depends
on the tool.
- true if the "action" attribute is valid, false if not.
setClasspath
public void setClasspath(Path classpath)
The classpath to be passed to the JVM running the tool;
optional depending upon the tool.
The classpath may also be supplied as a nested element.
classpath
- A Path object representing the "classpath" attribute.
setPassword
public void setPassword(String password)
The password of the user; optional.
password
- A String representing the "password" attribute.
setServer
public void setServer(String server)
The address or URL for the server where the component will be deployed.
server
- A String representing the "server" attribute.
setUserName
public void setUserName(String userName)
The user with privileges to deploy applications to the server; optional.
userName
- A String representing the "userName" attribute.
validateAttributes
public void validateAttributes()
throws BuildException
Validates the passed in attributes.
Subclasses should chain to this super-method to insure
validation of boilerplate attributes.
Only the "action" attribute is required in the
base class. Subclasses should check attributes accordingly.
- validateAttributes in interface HotDeploymentTool