org.rhq.core.pluginapi.bundle

Interface BundleManagerProvider

public interface BundleManagerProvider

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

Since:

3.0

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
void	auditDeployment(org.rhq.core.domain.bundle.BundleResourceDeployment deployment, String action, String info, org.rhq.core.domain.bundle.BundleResourceDeploymentHistory.Category category, org.rhq.core.domain.bundle.BundleResourceDeploymentHistory.Status status, String message, String attachment) Bundle plugins call back into this manager to add progressive auditing of a deployment.
List<org.rhq.core.domain.content.PackageVersion>	getAllBundleVersionPackageVersions(org.rhq.core.domain.bundle.BundleVersion bundleVersion) Bundle plugins call back into this manager to obtain the bundle files that belong to a given bundle version.
long	getFileContent(org.rhq.core.domain.content.PackageVersion packageVersion, OutputStream outputStream) Bundle plugins call back into this manager to obtain the bundle file content for the given package.
BundleHandoverResponse	handoverContent(org.rhq.core.domain.resource.Resource bundleTarget, BundleHandoverRequest handoverRequest) Requests participation of the bundle target resource component in the bundle deployment.

Method Detail

auditDeployment

void auditDeployment(org.rhq.core.domain.bundle.BundleResourceDeployment deployment,
                   String action,
                   String info,
                   org.rhq.core.domain.bundle.BundleResourceDeploymentHistory.Category category,
                   org.rhq.core.domain.bundle.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<org.rhq.core.domain.content.PackageVersion> getAllBundleVersionPackageVersions(org.rhq.core.domain.bundle.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(org.rhq.core.domain.content.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

handoverContent

BundleHandoverResponse handoverContent(org.rhq.core.domain.resource.Resource bundleTarget,
                                     BundleHandoverRequest handoverRequest)

Requests participation of the bundle target resource component in the bundle deployment.

Parameters:

bundleTarget - bundle target resource

handoverRequest - handover parameters and context

Returns:

a report object indicating success or failure

Since:

4.12