Apache Ant 1.10.14 · org.apache.tools.ant.taskdefs.optional.j2ee.AbstractHotDeploymentTool

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

Modifier and Type	Field and Description
private Path	classpath The classpath passed to the JVM on execution.
private String	password The password for the deployment server.
private String	server The address of the deployment server
private ServerDeploy	task The parent task
private String	userName The username for the deployment server.

Constructor Summary

Access	Constructor and Description
public	AbstractHotDeploymentTool()

Method Summary

Modifier and Type	Method and Description
public Path	Returns: A Path object representing the classpath to be used. createClasspath() Add a classpath as a nested element.
public Path	Returns: A Path representing the "classpath" attribute. getClasspath() gets the classpath field.
public String	Returns: A String representing the "password" attribute. getPassword() Returns the password field.
public String	Returns: A String representing the "server" attribute. getServer() Returns the server field.
protected ServerDeploy	Returns: An ServerDeploy representing the parent task. getTask() Returns the task field, a ServerDeploy object.
public String	Returns: A String representing the "userName" attribute. getUserName() Returns the userName field.
protected abstract boolean	Returns: true if the "action" attribute is valid, false if not. isActionValid() Determines if the "action" attribute defines a valid action.
public void	setClasspath(Path A Path object representing the "classpath" attribute. classpath) The classpath to be passed to the JVM running the tool; optional depending upon the tool.
public void	setPassword(String A String representing the "password" attribute. password) The password of the user; optional.
public void	setServer(String A String representing the "server" attribute. server) The address or URL for the server where the component will be deployed.
public void	setTask(ServerDeploy a ServerDeploy object representing the parent task. task) Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.setTask. Sets the parent task.
public void	setUserName(String A String representing the "userName" attribute. userName) The user with privileges to deploy applications to the server; optional.
public void	validateAttributes() Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.validateAttributes. Validates the passed in attributes.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

classpath	back to summary
private Path classpath The classpath passed to the JVM on execution.

password	back to summary
private String password The password for the deployment server.

server	back to summary
private String server The address of the deployment server

task	back to summary
private ServerDeploy task The parent task

userName	back to summary
private String userName The username for the deployment server.

Constructor Detail

AbstractHotDeploymentTool	back to summary
public AbstractHotDeploymentTool()

Method Detail

createClasspath	back to summary
public Path createClasspath() Add a classpath as a nested element. Returns:Path A Path object representing the classpath to be used.

createClasspath

back to summary

public Path createClasspath()

Add a classpath as a nested element.

Returns:Path: A Path object representing the classpath to be used.

getClasspath	back to summary
public Path getClasspath() gets the classpath field. Returns:Path A Path representing the "classpath" attribute.

getClasspath

back to summary

public Path getClasspath()

gets the classpath field.

Returns:Path: A Path representing the "classpath" attribute.

getPassword	back to summary
public String getPassword() Returns the password field. Returns:String A String representing the "password" attribute.

getPassword

back to summary

public String getPassword()

Returns the password field.

Returns:String: A String representing the "password" attribute.

getServer	back to summary
public String getServer() Returns the server field. Returns:String A String representing the "server" attribute.

getServer

back to summary

public String getServer()

Returns the server field.

Returns:String: A String representing the "server" attribute.

getTask	back to summary
protected ServerDeploy getTask() Returns the task field, a ServerDeploy object. Returns:ServerDeploy An ServerDeploy representing the parent task.

getTask

back to summary

protected ServerDeploy getTask()

Returns the task field, a ServerDeploy object.

Returns:ServerDeploy: An ServerDeploy representing the parent task.

getUserName	back to summary
public String getUserName() Returns the userName field. Returns:String A String representing the "userName" attribute.

getUserName

back to summary

public String getUserName()

Returns the userName field.

Returns:String: A String representing the "userName" attribute.

isActionValid	back to summary
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. Returns:boolean true if the "action" attribute is valid, false if not.

isActionValid

back to summary

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.

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

setClasspath	back to summary
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. Parameters classpath:Path A Path object representing the "classpath" attribute.

setClasspath

back to summary

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.

Parameters

classpath:Path: A Path object representing the "classpath" attribute.

setPassword	back to summary
public void setPassword(String password) The password of the user; optional. Parameters password:String A String representing the "password" attribute.

setPassword

back to summary

public void setPassword(String password)

The password of the user; optional.

Parameters

password:String: A String representing the "password" attribute.

setServer	back to summary
public void setServer(String server) The address or URL for the server where the component will be deployed. Parameters server:String A String representing the "server" attribute.

setServer

back to summary

public void setServer(String server)

The address or URL for the server where the component will be deployed.

Parameters

server:String: A String representing the "server" attribute.

setTask	back to summary
public void setTask(ServerDeploy task) Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.setTask. Sets the parent task. Parameters task:ServerDeploy a ServerDeploy object representing the parent task. Annotations @Override

setTask

back to summary

public void setTask(ServerDeploy task)

Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.setTask.

Sets the parent task.

Parameters

task:ServerDeploy: a ServerDeploy object representing the parent task.

Annotations

@Override

setUserName	back to summary
public void setUserName(String userName) The user with privileges to deploy applications to the server; optional. Parameters userName:String A String representing the "userName" attribute.

setUserName

back to summary

public void setUserName(String userName)

The user with privileges to deploy applications to the server; optional.

Parameters

userName:String: A String representing the "userName" attribute.

validateAttributes	back to summary
public void validateAttributes() throws BuildException Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.validateAttributes. 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. Annotations @Override Exceptions BuildException: if the attributes are invalid or incomplete.

validateAttributes

back to summary

public void validateAttributes() throws BuildException

Implements org.apache.tools.ant.taskdefs.optional.j2ee.HotDeploymentTool.validateAttributes.

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.

Annotations

@Override

Exceptions

BuildException:: if the attributes are invalid or incomplete.

public abstract Class AbstractHotDeploymentTool

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail