org.rhq.enterprise.server.plugin.pc.content

Class ContentServerPluginManager

java.lang.Object

org.rhq.enterprise.server.plugin.pc.ServerPluginManager

org.rhq.enterprise.server.plugin.pc.content.ContentServerPluginManager

public class ContentServerPluginManager
extends ServerPluginManager

This loads in all content source server plugins that can be found and will maintain the complete set of metadata found in all plugin descriptors from all loaded plugins. You can obtain a loaded plugin's environment, including its classloader, from this object as well.

Author:

John Mazzitelli

Constructor Summary

Constructors

Constructor and Description
ContentServerPluginManager(ContentServerPluginContainer pc)

Method Summary

Methods

Modifier and Type	Method and Description
ContentSourcePluginMetadataManager	getMetadataManager() An object that can be used to process and store all metadata from all content plugins.
ServerPluginEnvironment	getPluginEnvironment(org.rhq.core.domain.content.ContentSourceType type) Gets the plugin environment for the plugin responsible for managing the given content source type.
void	initialize() Initializes the plugin manager to prepare it to start loading plugins.
void	loadPlugin(ServerPluginEnvironment env, boolean enabled) Informs the plugin manager that a plugin with the given environment needs to be loaded.
void	shutdown() Shuts down this manager.
void	unloadPlugin(String pluginName) Informs the plugin manager that a plugin with the given name is to be unloaded.

Methods inherited from class org.rhq.enterprise.server.plugin.pc.ServerPluginManager

createServerPluginComponent, disablePlugin, enablePlugin, getLog, getParentPluginContainer, getPlugin, getPluginEnvironment, getPluginEnvironments, getServerPluginComponent, getServerPluginContext, instantiatePluginClass, isPluginEnabled, isPluginLoaded, loadPluginClass, rebuildServerPluginEnvironment, reloadPlugin, startPlugin, startPlugins, stopPlugin, stopPlugins, unloadPlugin

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentServerPluginManager

public ContentServerPluginManager(ContentServerPluginContainer pc)

Method Detail

initialize

public void initialize()
                throws Exception

Description copied from class: ServerPluginManager

Initializes the plugin manager to prepare it to start loading plugins.

Overrides:

initialize in class ServerPluginManager

Throws:

Exception - if failed to initialize

shutdown

public void shutdown()

Description copied from class: ServerPluginManager

Shuts down this manager. This should be called only after all of its plugins have been unloaded.

Overrides:

shutdown in class ServerPluginManager

getPluginEnvironment

public ServerPluginEnvironment getPluginEnvironment(org.rhq.core.domain.content.ContentSourceType type)

Gets the plugin environment for the plugin responsible for managing the given content source type.

Parameters:

type -

Returns:

plugin environment

getMetadataManager

public ContentSourcePluginMetadataManager getMetadataManager()

An object that can be used to process and store all metadata from all content plugins. This object will contain all the metadata found in all loaded content plugins.

Returns:

object to retrieve plugin metadata from

loadPlugin

public void loadPlugin(ServerPluginEnvironment env,
              boolean enabled)
                throws Exception

Description copied from class: ServerPluginManager

Informs the plugin manager that a plugin with the given environment needs to be loaded. Once this method returns, the plugin's components are ready to be created and used, unless enabled is false, in which case the plugin will not be initialized.

Overrides:

loadPlugin in class ServerPluginManager

Parameters:

env - the environment of the plugin to be loaded

enabled - true if the plugin should be initialized; false if the plugin's existence should be noted but it should not be initialized or started

Throws:

Exception - if the plugin manager cannot load the plugin or deems the plugin invalid. Typically, this method will not throw an exception unless enabled is true - loading a disabled plugin is trivial and should not fail or throw an exception.

unloadPlugin

public void unloadPlugin(String pluginName)
                  throws Exception

Description copied from class: ServerPluginManager

Informs the plugin manager that a plugin with the given name is to be unloaded. The component's shutdown method will be called.

Overrides:

unloadPlugin in class ServerPluginManager

Parameters:

pluginName - the name of the plugin to be unloaded

Throws:

Exception - if the plugin manager cannot unload the plugin