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

Class WebLogicHotDeploymentTool

public class WebLogicHotDeploymentTool extends AbstractHotDeploymentTool implements HotDeploymentTool

An Ant wrapper task for the weblogic.deploy tool. This is used to hot-deploy J2EE applications to a running WebLogic server. This is not the same as creating the application archive. This task assumes the archive (EAR, JAR, or WAR) file has been assembled and is supplied as the "source" attribute.

In the end, this task assembles the commadline parameters and runs the weblogic.deploy tool in a seperate JVM.

See Also: HotDeploymentTool AbstractHotDeploymentTool ServerDeploy

Method Summary
protected StringBufferbuildArgsPrefix()
Builds the prefix arguments to pass to weblogic.deploy.
protected StringbuildDeployArgs()
Builds the arguments to pass to weblogic.deploy for deployment actions ("deploy" and "update").
protected StringbuildListArgs()
Builds the arguments to pass to weblogic.deploy for the list action
protected StringbuildUndeployArgs()
Builds the arguments to pass to weblogic.deploy for undeployment actions ("undeploy" and "delete").
voiddeploy()
Perform the actual deployment.
StringgetArguments()
Builds the arguments to pass to weblogic.deploy according to the supplied action.
protected booleanisActionValid()
Determines if the action supplied is valid.
voidsetApplication(String application)
The name of the application being deployed; required.
voidsetComponent(String component)
the component string for the deployment targets; optional.
voidsetDebug(boolean debug)
If set to true, additional information will be printed during the deployment process; optional.
voidvalidateAttributes()
Validates the passed in attributes.

Method Detail

buildArgsPrefix

protected StringBuffer buildArgsPrefix()
Builds the prefix arguments to pass to weblogic.deploy. These arguments are generic across all actions.

Returns: A StringBuffer containing the prefix arguments. The action-specific build methods will append to this StringBuffer.

buildDeployArgs

protected String buildDeployArgs()
Builds the arguments to pass to weblogic.deploy for deployment actions ("deploy" and "update").

Returns: A String containing the full argument string for weblogic.deploy.

buildListArgs

protected String buildListArgs()
Builds the arguments to pass to weblogic.deploy for the list action

Returns: A String containing the full argument string for weblogic.deploy.

buildUndeployArgs

protected String buildUndeployArgs()
Builds the arguments to pass to weblogic.deploy for undeployment actions ("undeploy" and "delete").

Returns: A String containing the full argument string for weblogic.deploy.

deploy

public void deploy()
Perform the actual deployment. For this implementation, a JVM is spawned and the weblogic.deploy tools is executed.

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

getArguments

public String getArguments()
Builds the arguments to pass to weblogic.deploy according to the supplied action.

Returns: A String containing the arguments for the weblogic.deploy tool.

Throws: BuildException if there is an error.

isActionValid

protected boolean isActionValid()
Determines if the action supplied is valid.

Valid actions are contained in the static array VALID_ACTIONS

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

setApplication

public void setApplication(String application)
The name of the application being deployed; required.

Parameters: application A String representing the application portion of the weblogic.deploy command line.

setComponent

public void setComponent(String component)
the component string for the deployment targets; optional. It is in the form <component>:<target1>,<target2>... Where component is the archive name (minus the .jar, .ear, .war extension). Targets are the servers where the components will be deployed

Parameters: component A String representing the value of the "-component" argument of the weblogic.deploy command line argument.

setDebug

public void setDebug(boolean debug)
If set to true, additional information will be printed during the deployment process; optional.

Parameters: debug A boolean representing weblogic.deploy "-debug" flag.

validateAttributes

public void validateAttributes()
Validates the passed in attributes.

The rules are:

  1. If action is "deploy" or "update" the "application" and "source" attributes must be supplied.
  2. If action is "delete" or "undeploy" the "application" attribute must be supplied.

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