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

Class ServerDeploy

public class ServerDeploy extends Task

Controls hot deployment tools for J2EE servers. This class is used as a framework for the creation of vendor specific hot deployment tools.

See Also: HotDeploymentTool AbstractHotDeploymentTool GenericHotDeploymentTool WebLogicHotDeploymentTool

Method Summary
voidaddGeneric(GenericHotDeploymentTool tool)
Creates a generic deployment tool.
voidaddJonas(JonasHotDeploymentTool tool)
Creates a JOnAS deployment tool, for deployment to JOnAS servers.
voidaddWeblogic(WebLogicHotDeploymentTool tool)
Creates a WebLogic deployment tool, for deployment to WebLogic servers.
voidexecute()
Execute the task.
StringgetAction()
Returns the action field.
FilegetSource()
Returns the source field (the path/filename of the component to be deployed.
voidsetAction(String action)
The action to be performed, usually "deploy"; required.
voidsetSource(File source)
The filename of the component to be deployed; optional depending upon the tool and the action.

Method Detail

addGeneric

public void addGeneric(GenericHotDeploymentTool tool)
Creates a generic deployment tool.

Ant calls this method on creation to handle embedded "generic" elements in the ServerDeploy task.

Parameters: tool An instance of GenericHotDeployment tool, passed in by Ant.

addJonas

public void addJonas(JonasHotDeploymentTool tool)
Creates a JOnAS deployment tool, for deployment to JOnAS servers.

Ant calls this method on creation to handle embedded "jonas" elements in the ServerDeploy task.

Parameters: tool An instance of JonasHotDeployment tool, passed in by Ant.

addWeblogic

public void addWeblogic(WebLogicHotDeploymentTool tool)
Creates a WebLogic deployment tool, for deployment to WebLogic servers.

Ant calls this method on creation to handle embedded "weblogic" elements in the ServerDeploy task.

Parameters: tool An instance of WebLogicHotDeployment tool, passed in by Ant.

execute

public void execute()
Execute the task.

This method calls the deploy() method on each of the vendor-specific tools in the vendorTools collection. This performs the actual process of deployment on each tool.

Throws: org.apache.tools.ant.BuildException if the attributes are invalid or incomplete, or a failure occurs in the deployment process.

getAction

public String getAction()
Returns the action field.

Returns: A string representing the "action" attribute.

getSource

public File getSource()
Returns the source field (the path/filename of the component to be deployed.

Returns: A File object representing the "source" attribute.

setAction

public void setAction(String action)
The action to be performed, usually "deploy"; required. Some tools support additional actions, such as "delete", "list", "undeploy", "update"...

Parameters: action A String representing the "action" attribute.

setSource

public void setSource(File source)
The filename of the component to be deployed; optional depending upon the tool and the action.

Parameters: source String representing the "source" attribute.

Copyright