org.rhq.enterprise.server.plugin.pc.bundle

Interface BundleServerPluginFacet

public interface BundleServerPluginFacet

All bundle server plugins must implement this facet.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
RecipeParseResults	parseRecipe(String recipe) The server side plugin is being given a recipe which must be parsed.
BundleDistributionInfo	processBundleDistributionFile(File distributionFile) The server side plugin is being given an bundle distribution file that must be procssed.

Method Detail

parseRecipe

RecipeParseResults parseRecipe(String recipe)
                               throws UnknownRecipeException,
                                      Exception

The server side plugin is being given a recipe which must be parsed. The results of the parse are to be returned.

Parameters:

recipe - the content of the recipe to be parsed

Returns:

the information gleened from the recipe after being parsed

Throws:

UnknownRecipeException - if the recipe is not understood by the plugin (i.e. it is a recipe that some other bundle plugin probably can process)

Exception - if the recipe could not be successfully parsed - this exception usually means the recipe type is known to the plugin but it just had some error that caused it to fail to parse successfully

processBundleDistributionFile

BundleDistributionInfo processBundleDistributionFile(File distributionFile)
                                                     throws UnknownRecipeException,
                                                            Exception

The server side plugin is being given an bundle distribution file that must be procssed. The results of the processing are to be returned. An bundle distribution file is a zip file that contains a recipe and 0, 1 or more bundle files.

Parameters:

distributionFile -

Returns:

the information gleened by cracking open the bundle distribution file and examining its contents

Throws:

UnknownRecipeException - if the recipe in the distribution file is not understood by the plugin (i.e. the distribution file can probably be processed by some other bundle plugin).

Exception - if the bundle distribution file could not be successfully processed - this exception usually means the distribution file is of a known type to the plugin but it just had some error that caused it to fail to be processed successfully.