org.rhq.enterprise.server.plugin.pc

Interface ServerPluginComponent

public interface ServerPluginComponent

Performs global initialization and shutdown of a server side plugin. This provides a place for plugin developers to allocate global resources needed by all plugin components and a place to clean up those resources.

Author:

John Mazzitelli

Method Summary

Methods

Modifier and Type	Method and Description
void	initialize(ServerPluginContext context) When a plugin's container loads a plugin, this method will be called.
void	shutdown() When the plugin container shuts down and it unloads the plugin, this method will be called.
void	start() When a plugin container has been started (which occurs after all plugins are loaded), this method is called to inform the plugin is can begin performing work.
void	stop() When a plugin container has been stopped (but before it unloads plugins), this method is called to inform the plugin it should stop performing work and prepare to shutdown.

Method Detail

initialize

void initialize(ServerPluginContext context)
                throws Exception

When a plugin's container loads a plugin, this method will be called. When this is called, no other plugin components have been instantiated or invoked yet. This is merely called to notify the plugin that it is about to be placed into service and its components will soon be asked to perform work. If this method returns normally, the plugin is saying it is ready and able to start().

Parameters:

context - a context with information about the runtime plugin environment

Throws:

Exception - if the plugin finds that it should not be loaded, an exception should be thrown. If thrown, this plugin will not be started and will be considered disabled. If other plugins are dependent on this failed plugin, those other plugins will fail to operate correctly.

start

void start()

When a plugin container has been started (which occurs after all plugins are loaded), this method is called to inform the plugin is can begin performing work.

stop

void stop()

When a plugin container has been stopped (but before it unloads plugins), this method is called to inform the plugin it should stop performing work and prepare to shutdown.

shutdown

void shutdown()

When the plugin container shuts down and it unloads the plugin, this method will be called. This provides an opportunity for the plugin to clean up any global resources it has previously allocated. After this method is called, invocations of this plugin's discovery or resource components will no longer occur.