org.rhq.core.pluginapi.bundle
Class BundleDeployRequest

java.lang.Object
  org.rhq.core.pluginapi.bundle.BundleDeployRequest

All Implemented Interfaces:

Serializable

public class BundleDeployRequest
extends Object
implements Serializable

A request to deploy a bundle.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

BundleDeployRequest()

Method Summary

File	getAbsoluteDestinationDirectory() Returns the full, absolute directory as found on the local machine's file system where the bundle should be deployed.
File	getBundleFilesLocation() This returns the location where the plugin container has downloaded the bundle files.
BundleManagerProvider	getBundleManagerProvider()
Map<PackageVersion,File>	getPackageVersionFiles() Maps all the package versions associated with the bundle and the locations where the package version contents can be found.
BundleResourceDeployment	getResourceDeployment()
boolean	isCleanDeployment()
boolean	isRevert()
void	setAbsoluteDestinationDirectory(File absoluteDestDir)
void	setBundleFilesLocation(File bundleFilesLocation)
void	setBundleManagerProvider(BundleManagerProvider provider)
void	setCleanDeployment(boolean isCleanDeployment)
void	setPackageVersionFiles(Map<PackageVersion,File> packageVersionFiles)
void	setResourceDeployment(BundleResourceDeployment resourceDeployment)
void	setRevert(boolean isRevert)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BundleDeployRequest

public BundleDeployRequest()

Method Detail

getAbsoluteDestinationDirectory

public File getAbsoluteDestinationDirectory()

Returns the full, absolute directory as found on the local machine's file system where the bundle should be deployed. This is the bundle destination's relative destination directory under the destination base directory.

setAbsoluteDestinationDirectory

public void setAbsoluteDestinationDirectory(File absoluteDestDir)

getBundleFilesLocation

public File getBundleFilesLocation()

This returns the location where the plugin container has downloaded the bundle files.

Returns:

the location where the bundle files have been downloaded

setBundleFilesLocation

public void setBundleFilesLocation(File bundleFilesLocation)

getPackageVersionFiles

public Map<PackageVersion,File> getPackageVersionFiles()

Maps all the package versions associated with the bundle and the locations where the package version contents can be found. These will all be located somewhere under the bundle files location.

Returns:

packages and their locations on the local file system

setPackageVersionFiles

public void setPackageVersionFiles(Map<PackageVersion,File> packageVersionFiles)

getResourceDeployment

public BundleResourceDeployment getResourceDeployment()

setResourceDeployment

public void setResourceDeployment(BundleResourceDeployment resourceDeployment)

getBundleManagerProvider

public BundleManagerProvider getBundleManagerProvider()

setBundleManagerProvider

public void setBundleManagerProvider(BundleManagerProvider provider)

isCleanDeployment

public boolean isCleanDeployment()

Returns:

flag to indicate if the deployment directory should have all of its files deleted prior to deploying the new files. All files in the deployment directory should be cleaned, including files/directories that are marked to be "ignored".

setCleanDeployment

public void setCleanDeployment(boolean isCleanDeployment)

isRevert

public boolean isRevert()

Returns:

flag to indicate if this bundle deployment request should revert a deployment back to a previous state. Reverting means that any files backed up from the last deployment are reverted to their original state.

setRevert

public void setRevert(boolean isRevert)

toString

public String toString()

Overrides:

toString in class Object