org.rhq.core.pluginapi.bundle

Class BundlePurgeRequest

java.lang.Object

org.rhq.core.pluginapi.bundle.BundlePurgeRequest

All Implemented Interfaces:

Serializable

public class BundlePurgeRequest
extends Object
implements Serializable

A request to purge a bundle, essentially erasing the bundle files from the destination.

Since:

4.0

Author:

John Mazzitelli

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BundlePurgeRequest()

Method Summary

Methods

Modifier and Type	Method and Description
File	getAbsoluteDestinationDirectory() Deprecated. since 4.13, use getDestinationTarget() instead
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.
org.rhq.core.domain.bundle.BundleResourceDeployment	getLiveResourceDeployment() This is information about the last known live resource deployment - this is to be purged.
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.
void	setAbsoluteDestinationDirectory(File absoluteDestDir) Deprecated. since 4.13, use setDestinationTarget(java.net.URI) instead
void	setBundleManagerProvider(BundleManagerProvider provider)
void	setDestinationTarget(URI destinationTarget)
void	setLiveResourceDeployment(org.rhq.core.domain.bundle.BundleResourceDeployment resourceDeployment)
void	setReferencedConfiguration(org.rhq.core.domain.configuration.Configuration referencedConfiguration)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BundlePurgeRequest

public BundlePurgeRequest()

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.

Since:

4.1

setAbsoluteDestinationDirectory

@Deprecated
public void setAbsoluteDestinationDirectory(File absoluteDestDir)

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

Parameters:

absoluteDestDir -

Since:

4.1

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 locations (which are just generalized expressions that should form a valid URI), the URI will be processed from the templated destination location 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()

getLiveResourceDeployment

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

This is information about the last known live resource deployment - this is to be purged.

Returns:

information about the live resource deployment that is to be purged

setLiveResourceDeployment

public void setLiveResourceDeployment(org.rhq.core.domain.bundle.BundleResourceDeployment resourceDeployment)

getBundleManagerProvider

public BundleManagerProvider getBundleManagerProvider()

setBundleManagerProvider

public void setBundleManagerProvider(BundleManagerProvider provider)

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