org.apache.tools.ant.taskdefs.optional.j2ee
public abstract class AbstractHotDeploymentTool extends Object implements HotDeploymentTool
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...
See Also: HotDeploymentTool ServerDeploy
Method Summary | |
---|---|
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.
|
Returns: A Path object representing the classpath to be used.
Throws: org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.
Returns: A Path representing the "classpath" attribute.
Returns: A String representing the "password" attribute.
Returns: A String representing the "server" attribute.
Returns: An ServerDeploy representing the parent task.
Returns: A String representing the "userName" attribute.
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.
Returns: true if the "action" attribute is valid, false if not.
Parameters: classpath A Path object representing the "classpath" attribute.
Parameters: password A String representing the "password" attribute.
Parameters: server A String representing the "server" attribute.
Parameters: task a ServerDeploy object representing the parent task.
UNKNOWN: ignore="true"
Parameters: userName A String representing the "userName" attribute.
Only the "action" attribute is required in the base class. Subclasses should check attributes accordingly.
Throws: org.apache.tools.ant.BuildException if the attributes are invalid or incomplete.