org.rhq.core.pluginapi.bundle
Interface BundleManagerProvider

public interface BundleManagerProvider

Provides bundle functionality that plugin components will need in order to process bundles.

Method Summary

void	auditDeployment(BundleResourceDeployment deployment, String action, String info, BundleResourceDeploymentHistory.Category category, BundleResourceDeploymentHistory.Status status, String message, String attachment) Bundle plugins call back into this manager to add progressive auditing of a deployment.
List<PackageVersion>	getAllBundleVersionPackageVersions(BundleVersion bundleVersion) Bundle plugins call back into this manager to obtain the bundle files that belong to a given bundle version.
long	getFileContent(PackageVersion packageVersion, OutputStream outputStream) Bundle plugins call back into this manager to obtain the bundle file content for the given package.

Method Detail

auditDeployment

void auditDeployment(BundleResourceDeployment deployment,
                     String action,
                     String info,
                     BundleResourceDeploymentHistory.Category category,
                     BundleResourceDeploymentHistory.Status status,
                     String message,
                     String attachment)
                     throws Exception

Bundle plugins call back into this manager to add progressive auditing of a deployment.

Parameters:

deployment - The resource deployment tracking this bundle deployment

action - The audit action, a short summary easily displayed (e.g "File Download")

info - Info about the action target, easily displayed (e.g. "myfile.zip")

category - A useful categorization of the audit, defaults to null

status - Optional, defaults to SUCCESS

message - Optional, verbose message being audited, failure message, etc

attachment - Optional, verbose data, such as full file text

Throws:

Exception

getAllBundleVersionPackageVersions

List<PackageVersion> getAllBundleVersionPackageVersions(BundleVersion bundleVersion)
                                                        throws Exception

Bundle plugins call back into this manager to obtain the bundle files that belong to a given bundle version.

Parameters:

bundleVersion - a bundle version

Returns:

the bundle files that are associated with the given bundle

Throws:

Exception - on failure

getFileContent

long getFileContent(PackageVersion packageVersion,
                    OutputStream outputStream)
                    throws Exception

Bundle plugins call back into this manager to obtain the bundle file content for the given package.

Parameters:

packageVersion - the package whose bits are to be downloaded

outputStream - where the package bits will get written to

Returns:

the size of the package version content that was downloaded and output

Throws:

Exception - on failure