org.rhq.bundle.ant.task
Class BundleTask

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.Task
          org.rhq.bundle.ant.task.AbstractBundleTask
              org.rhq.bundle.ant.task.BundleTask

All Implemented Interfaces:

Cloneable

public class BundleTask
extends AbstractBundleTask

The rhq:bundle task defines the metadata needed to deploy, redeploy, or undeploy an RHQ bundle.

Author:

Ian Springer

Field Summary

Fields inherited from class org.apache.tools.ant.Task

target, taskName, taskType, wrapper

Fields inherited from class org.apache.tools.ant.ProjectComponent

location, project

Constructor Summary

BundleTask()

Method Summary

void	add(DeploymentUnitType deployment)
void	addConfigured(InputPropertyType inputProperty)
void	execute() The following Ant project properties must be defined with valid values prior to this method being invoked: rhq.deploy.id - the deployment's unique id (e.g.
Map<String,DeploymentUnitType>	getDeploymentUnits()
String	getDescription()
String	getName()
String	getVersion()
void	maybeConfigure()
void	setDescription(String description)
void	setName(String name)
void	setVersion(String version)
protected void	validateAttributes() Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.
protected void	validateTypes() Ensure we have a legal set of child types.

Methods inherited from class org.rhq.bundle.ant.task.AbstractBundleTask

getProject

Methods inherited from class org.apache.tools.ant.Task

bindToOwner, getOwningTarget, getRuntimeConfigurableWrapper, getTaskName, getTaskType, getWrapper, handleErrorFlush, handleErrorOutput, handleFlush, handleInput, handleOutput, init, isInvalid, log, log, log, log, perform, reconfigure, setOwningTarget, setRuntimeConfigurableWrapper, setTaskName, setTaskType

Methods inherited from class org.apache.tools.ant.ProjectComponent

clone, getLocation, setLocation, setProject

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BundleTask

public BundleTask()

Method Detail

maybeConfigure

public void maybeConfigure()
                    throws org.apache.tools.ant.BuildException

Overrides:

maybeConfigure in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException

execute

public void execute()
             throws org.apache.tools.ant.BuildException

The following Ant project properties must be defined with valid values prior to this method being invoked: rhq.deploy.id - the deployment's unique id (e.g. "10001") rhq.deploy.dir - the deployment install dir (e.g. "/opt/jbossas-petstore") rhq.deploy.phase - the deployment phase If the bundle recipe is being executed from the command line, the user must supply these properties, along with any input properties required by the bundle recipe.

Overrides:

execute in class org.apache.tools.ant.Task

Throws:

org.apache.tools.ant.BuildException - if an error occurs

getDescription

public String getDescription()

Overrides:

getDescription in class org.apache.tools.ant.ProjectComponent

setDescription

public void setDescription(String description)

Overrides:

setDescription in class org.apache.tools.ant.ProjectComponent

getName

public String getName()

setName

public void setName(String name)

getVersion

public String getVersion()

setVersion

public void setVersion(String version)

addConfigured

public void addConfigured(InputPropertyType inputProperty)

add

public void add(DeploymentUnitType deployment)

getDeploymentUnits

public Map<String,DeploymentUnitType> getDeploymentUnits()

validateAttributes

protected void validateAttributes()
                           throws org.apache.tools.ant.BuildException

Ensure we have a consistent and legal set of attributes, and set any internal flags necessary based on different combinations of attributes.

Throws:

org.apache.tools.ant.BuildException - if an error occurs

validateTypes

protected void validateTypes()
                      throws org.apache.tools.ant.BuildException

Ensure we have a legal set of child types.

Throws:

org.apache.tools.ant.BuildException - if an error occurs