org.rhq.bundle.ant.type
Class DeploymentUnitType

java.lang.Object
  org.apache.tools.ant.ProjectComponent
      org.apache.tools.ant.types.DataType
          org.rhq.bundle.ant.type.AbstractBundleType
              org.rhq.bundle.ant.type.DeploymentUnitType

All Implemented Interfaces:

Cloneable

public class DeploymentUnitType
extends AbstractBundleType

An Ant task for deploying a bundle or previewing the deployment.

Author:

Ian Springer

Field Summary

Fields inherited from class org.apache.tools.ant.types.DataType

checked, ref

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

description, location, project

Constructor Summary

DeploymentUnitType()

Method Summary

void	addConfigured(ArchiveType archive)
void	addConfigured(FileType file)
void	addConfigured(IgnoreType ignore)
void	addConfigured(SystemServiceType systemService)
void	addConfigured(UrlArchiveType archive)
void	addConfigured(UrlFileType file)
Set<File>	getArchives()
Map<File,Boolean>	getArchivesExploded() Returns a map keyed on archive names whose values are either true or false, where true means the archive is to be deployed exploded and false means the archive should be deployed in compressed form.
Map<File,File>	getFiles() Returns a map of all raw files.
Map<File,String>	getLocalArchiveNames() Returns a map of all archive files.
Map<File,String>	getLocalFileNames() Returns a map of all raw files.
String	getManageRootDir()
String	getName()
String	getPostinstallTarget()
String	getPreinstallTarget()
void	init()
void	install(boolean revert, boolean clean)
void	setManageRootDir(String booleanString)
void	setName(String name)
void	setPostinstallTarget(String postinstallTarget)
void	setPreinstallTarget(String preinstallTarget)
void	start()
void	stop()
void	uninstall()
void	upgrade(boolean revert, boolean clean)

Methods inherited from class org.rhq.bundle.ant.type.AbstractBundleType

buildIncludePatternRegex, getPattern, getProject

Methods inherited from class org.apache.tools.ant.types.DataType

checkAttributesAllowed, checkChildrenAllowed, circularReference, clone, dieOnCircularReference, dieOnCircularReference, dieOnCircularReference, getCheckedRef, getCheckedRef, getCheckedRef, getCheckedRef, getDataTypeName, getRefid, invokeCircularReferenceCheck, isChecked, isReference, noChildrenAllowed, pushAndInvokeCircularReferenceCheck, setChecked, setRefid, tooManyAttributes, toString

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

getDescription, getLocation, log, log, setDescription, setLocation, setProject

Methods inherited from class java.lang.Object

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

Constructor Detail

DeploymentUnitType

public DeploymentUnitType()

Method Detail

init

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

Throws:

org.apache.tools.ant.BuildException

install

public void install(boolean revert,
                    boolean clean)
             throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

start

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

Throws:

org.apache.tools.ant.BuildException

stop

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

Throws:

org.apache.tools.ant.BuildException

upgrade

public void upgrade(boolean revert,
                    boolean clean)
             throws org.apache.tools.ant.BuildException

Throws:

org.apache.tools.ant.BuildException

uninstall

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

Throws:

org.apache.tools.ant.BuildException

getName

public String getName()

setName

public void setName(String name)

getManageRootDir

public String getManageRootDir()

setManageRootDir

public void setManageRootDir(String booleanString)

getFiles

public Map<File,File> getFiles()

Returns a map of all raw files. The key is the full absolute path to the file as it does or would appear on the file system. The value is a path that is either absolute or relative - it is the destination where the file is to be placed when being deployed on the destination file system; if the value is relative, then it is relative to the root destination directory.

Returns:

map of raw files

getLocalFileNames

public Map<File,String> getLocalFileNames()

Returns a map of all raw files. The key is the full absolute path to the file as it does or would appear on the file system (the same key as the keys in map getFiles()). The value is a path relative to the file as it is found in the bundle distro (this is the "name" attribute of the "file" type tag).

Returns:

map of local file names

getArchives

public Set<File> getArchives()

getLocalArchiveNames

public Map<File,String> getLocalArchiveNames()

Returns a map of all archive files. The key is the full absolute path to the archive as it does or would appear on the file system (the same key as the keys in map getArchives()). The value is a path relative to the file as it is found in the bundle distro (this is the "name" attribute of the "archive" type tag).

Returns:

map of local file names

getArchivesExploded

public Map<File,Boolean> getArchivesExploded()

Returns a map keyed on archive names whose values are either true or false, where true means the archive is to be deployed exploded and false means the archive should be deployed in compressed form.

Returns:

map showing how an archive should be deployed in its final form

getPreinstallTarget

public String getPreinstallTarget()

setPreinstallTarget

public void setPreinstallTarget(String preinstallTarget)

getPostinstallTarget

public String getPostinstallTarget()

setPostinstallTarget

public void setPostinstallTarget(String postinstallTarget)

addConfigured

public void addConfigured(SystemServiceType systemService)

addConfigured

public void addConfigured(FileType file)

addConfigured

public void addConfigured(ArchiveType archive)

addConfigured

public void addConfigured(UrlFileType file)

addConfigured

public void addConfigured(UrlArchiveType archive)

addConfigured

public void addConfigured(IgnoreType ignore)