org.rhq.bundle.ant

Class AntLauncher

java.lang.Object

org.rhq.bundle.ant.AntLauncher

public class AntLauncher
extends Object

This object enables you to invoke an Ant script within the running VM. You can fully run the script or you can ask that the script just be parsed and validated but no tasks executed.

Author:

John Mazzitelli, Ian Springer

Constructor Summary

Constructors

Constructor and Description
AntLauncher() Deprecated. since 4.9.0. You can keep using this constructor but be aware that it might change behavior in some future version of RHQ. It will NOT be removed though.
AntLauncher(boolean requireExplicitCompliance)

Method Summary

Methods

Modifier and Type	Method and Description
BundleAntProject	executeBundleDeployFile(File buildFile, Properties buildProperties, List<org.apache.tools.ant.BuildListener> buildListeners) Executes the specified bundle deploy Ant build file (i.e.
BundleAntProject	parseBundleDeployFile(File buildFile, Properties buildProperties)

Methods inherited from class java.lang.Object

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

Constructor Detail

AntLauncher

@Deprecated
public AntLauncher()

Deprecated. since 4.9.0. You can keep using this constructor but be aware that it might change behavior in some future version of RHQ. It will NOT be removed though.

For backwards compatibility reasons, this calls AntLauncher(false). Note that this might change in the future, because we are requiring the explicit declaration of the destination directory's compliance mode starting with RHQ 4.9.0.

Nevertheless this constructor is behaving as it was before RHQ 4.9.0 so that users of it aren't surprised by its behavior.

AntLauncher

public AntLauncher(boolean requireExplicitCompliance)

Parameters:

requireExplicitCompliance - whether or not to enforce the presence of compliance attribute in the deployment unit definitions. Before RHQ 4.9.0 a similar deprecated attribute called manageRootDir was optional and defaulted to true. Since RHQ 4.9.0 we require the user to explicitly specify the compliance of the destination directory. But to keep backwards compatibility with the older bundle recipes already deployed on the agents, we make this behavior optional.

Since:

4.9.0

Method Detail

executeBundleDeployFile

public BundleAntProject executeBundleDeployFile(File buildFile,
                                       Properties buildProperties,
                                       List<org.apache.tools.ant.BuildListener> buildListeners)
                                         throws InvalidBuildFileException

Executes the specified bundle deploy Ant build file (i.e. rhq-deploy.xml).

Parameters:

buildFile - the path to the build file (i.e. rhq-deploy.xml)

buildProperties - the properties to pass into Ant

buildListeners - a list of build listeners (provide callback methods for targetExecuted, taskExecuted, etc.)

Returns:

the bundle Ant project containing information about the specified build file

Throws:

InvalidBuildFileException - if the build file is invalid

parseBundleDeployFile

public BundleAntProject parseBundleDeployFile(File buildFile,
                                     Properties buildProperties)
                                       throws InvalidBuildFileException

Throws:

InvalidBuildFileException