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

Author:

John Mazzitelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BundleDeployRequest()

Method Summary

Methods

Modifier and Type	Method and Description
File	getAbsoluteDestinationDirectory() Deprecated. since 4.13, use getDestinationTarget() instead.
File	getBundleFilesLocation() This returns the location where the plugin container has downloaded the bundle files.
BundleManagerProvider	getBundleManagerProvider()
URI	getDestinationTarget() For filesystem-bound bundle destinations, this URI will have the file scheme and will be the absolute directory as found on the local machine's file system where the bundle should be deployed.
Map<org.rhq.core.domain.content.PackageVersion,File>	getPackageVersionFiles() Maps all the package versions associated with the bundle and the locations where the package version contents can be found.
org.rhq.core.domain.configuration.Configuration	getReferencedConfiguration() The destination specification can pass over some info to the bundle handler by using references to configuration or metric data.
org.rhq.core.domain.bundle.BundleResourceDeployment	getResourceDeployment()
boolean	isCleanDeployment()
boolean	isRevert()
void	setAbsoluteDestinationDirectory(File absoluteDestDir) Deprecated. since 4.13, use setDestinationTarget(java.net.URI) instead.
void	setBundleFilesLocation(File bundleFilesLocation)
void	setBundleManagerProvider(BundleManagerProvider provider)
void	setCleanDeployment(boolean isCleanDeployment)
void	setDestinationTarget(URI destinationTarget)
void	setPackageVersionFiles(Map<org.rhq.core.domain.content.PackageVersion,File> packageVersionFiles)
void	setReferencedConfiguration(org.rhq.core.domain.configuration.Configuration referencedConfiguration)
void	setResourceDeployment(org.rhq.core.domain.bundle.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

@Deprecated
public File getAbsoluteDestinationDirectory()

Deprecated. since 4.13, use getDestinationTarget() instead.

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

@Deprecated
public void setAbsoluteDestinationDirectory(File absoluteDestDir)

Deprecated. since 4.13, use setDestinationTarget(java.net.URI) instead.

Parameters:

absoluteDestDir - the absolute directory where the bundle should be deployed

getDestinationTarget

public URI getDestinationTarget()

For filesystem-bound bundle destinations, this URI will have the file scheme and will be the absolute directory as found on the local machine's file system where the bundle should be deployed. In another words, for the filesystem-bound bundle destinations, this is the bundle destination's relative destination directory under the destination base directory.

For bundle destinations defined using the bundle definitions (which are just generalized expressions that should form a valid URI), the URI will be processed from the connection string expression provided in the bundle target of the resource's type.

Since:

4.13

setDestinationTarget

public void setDestinationTarget(URI destinationTarget)

Since:

4.13

See Also:

getDestinationTarget()

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<org.rhq.core.domain.content.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<org.rhq.core.domain.content.PackageVersion,File> packageVersionFiles)

getResourceDeployment

public org.rhq.core.domain.bundle.BundleResourceDeployment getResourceDeployment()

setResourceDeployment

public void setResourceDeployment(org.rhq.core.domain.bundle.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)

getReferencedConfiguration

public org.rhq.core.domain.configuration.Configuration getReferencedConfiguration()

The destination specification can pass over some info to the bundle handler by using references to configuration or metric data. A destination using this approach should usually be dedicated to a single bundle handler (as of now, there is no enforcement/validation in place that would ensure that only a bundle handler a destination spec is dedicated for will be used to install data to the destination).

Returns:

a configuration object containing data from the resource that is required by the bundle handler.

Since:

4.13

setReferencedConfiguration

public void setReferencedConfiguration(org.rhq.core.domain.configuration.Configuration referencedConfiguration)

Since:

4.13

See Also:

getReferencedConfiguration()

toString

public String toString()

Overrides:

toString in class Object