org.rhq.enterprise.server.resource.metadata

Interface PluginManagerLocal

All Superinterfaces:

PluginManagerRemote

All Known Implementing Classes:

PluginManagerBean

public interface PluginManagerLocal
extends PluginManagerRemote

Method Summary

Methods

Modifier and Type	Method and Description
void	acknowledgeDeletedPluginsBy(int serverId) The provided server acknowledges the deletion of all plugins marked as deleted by calling this method.
List<org.rhq.core.domain.plugin.Plugin>	findAllDeletedPlugins() Do not use this method directly.
List<org.rhq.core.domain.plugin.Plugin>	getAllPluginsById(List<Integer> pluginIds) Returns a list of plugins with the specified ids.
List<org.rhq.core.domain.plugin.CannedGroupExpression>	getCannedGroupExpressions()
List<org.rhq.core.domain.plugin.Plugin>	getInstalledPlugins() Returns the list of all plugins deployed in the server.
org.rhq.core.domain.plugin.Plugin	getPlugin(String name) Given the plugin name, will return that plugin.
File	getPluginDropboxDirectory() Returns the directory where plugins can be dropped for inclusion into the system.
List<org.rhq.core.domain.plugin.Plugin>	getPlugins() Deprecated. the deleted plugins will disappear from the database on their own accord when it's safe to do so.
List<org.rhq.core.domain.plugin.Plugin>	getPluginsByResourceTypeAndCategory(String resourceTypeName, org.rhq.core.domain.resource.ResourceCategory resourceCategory)
List<PluginStats>	getPluginStats(List<Integer> pluginIds)
boolean	installPluginJar(org.rhq.core.domain.plugin.Plugin newPlugin, PluginDescriptor pluginDescriptor, File pluginFile) Exists only for transactional boundary reasons.
boolean	isReadyForPurge(org.rhq.core.domain.plugin.Plugin plugin) Not to be used outside of PurgePluginsJob.
void	markPluginsDeleted(org.rhq.core.domain.auth.Subject subject, List<org.rhq.core.domain.plugin.Plugin> plugins) Not to be called outside of the PluginManagerBean implementation.
void	purgePlugins(List<org.rhq.core.domain.plugin.Plugin> plugins) Permanently deletes the plugins from the database.
void	registerPlugin(org.rhq.core.domain.plugin.Plugin plugin, PluginDescriptor metadata, File pluginFile, boolean forceUpdate) For server-side registration of plugin archives.
void	setPluginEnabledFlag(org.rhq.core.domain.auth.Subject subject, int pluginId, boolean enabled) Sets if a plugin is enabled or not.

Methods inherited from interface org.rhq.enterprise.server.resource.metadata.PluginManagerRemote

deletePlugins, deployUsingBytes, deployUsingContentHandle, disablePlugins, enablePlugins, findPluginsByCriteria, isPluginUpdateOnAgentsFinished, schedulePluginUpdateOnAgents, update

Method Detail

getPlugin

org.rhq.core.domain.plugin.Plugin getPlugin(String name)

Given the plugin name, will return that plugin. The name is defined in the plugin descriptor.

Parameters:

name - of plugin as defined in plugin descriptor.

Returns:

the plugin, or null if the plugin does not exist.

getPlugins

@Deprecated
List<org.rhq.core.domain.plugin.Plugin> getPlugins()

Deprecated. the deleted plugins will disappear from the database on their own accord when it's safe to do so.

Returns:

A list of all plugins deployed in the server, including deleted plugins

See Also:

use getInstalledPlugins method instead

getInstalledPlugins

List<org.rhq.core.domain.plugin.Plugin> getInstalledPlugins()

Returns the list of all plugins deployed in the server.

Returns:

list of plugins deployed

findAllDeletedPlugins

List<org.rhq.core.domain.plugin.Plugin> findAllDeletedPlugins()

Do not use this method directly. It is a support method for AgentPluginScanner and PurgePluginsJob.

Returns:

All plugins that have been marked deleted.

getAllPluginsById

List<org.rhq.core.domain.plugin.Plugin> getAllPluginsById(List<Integer> pluginIds)

Returns a list of plugins with the specified ids. Both installed and deleted plugins will be included in the results.

Parameters:

pluginIds - The ids of the plugins to fetch

Returns:

A list of plugins with the specified ids

getPluginsByResourceTypeAndCategory

List<org.rhq.core.domain.plugin.Plugin> getPluginsByResourceTypeAndCategory(String resourceTypeName,
                                                                          org.rhq.core.domain.resource.ResourceCategory resourceCategory)

getPluginStats

List<PluginStats> getPluginStats(List<Integer> pluginIds)

markPluginsDeleted

void markPluginsDeleted(org.rhq.core.domain.auth.Subject subject,
                      List<org.rhq.core.domain.plugin.Plugin> plugins)
                        throws Exception

Not to be called outside of the PluginManagerBean implementation. Used for transaction demarcation.

Throws:

Exception

isReadyForPurge

boolean isReadyForPurge(org.rhq.core.domain.plugin.Plugin plugin)

Not to be used outside of PurgePluginsJob. You can just use the PluginManagerRemote.deletePlugins(org.rhq.core.domain.auth.Subject, java.util.List) method and it will take care of the rest.

Parameters:

plugin - The plugin to check

Returns:

true if the plugin can be purged, false otherwise. A plugin can only be purged when all resource types defined by the plugin have already been purged.

purgePlugins

void purgePlugins(List<org.rhq.core.domain.plugin.Plugin> plugins)

Permanently deletes the plugins from the database. This method assumes that the plugins are already in the deleted state. This method is not intended for general use. It is called from PurgePluginsJob.

Parameters:

plugins - The plugins to remove from the database.

setPluginEnabledFlag

void setPluginEnabledFlag(org.rhq.core.domain.auth.Subject subject,
                        int pluginId,
                        boolean enabled)
                          throws Exception

Sets if a plugin is enabled or not.

Throws:

Exception

registerPlugin

void registerPlugin(org.rhq.core.domain.plugin.Plugin plugin,
                  PluginDescriptor metadata,
                  File pluginFile,
                  boolean forceUpdate)
                    throws Exception

For server-side registration of plugin archives. At server startup or as new plugins are runtime deployed the jar will have its descriptor read and parsed and the metadata for the plugin will be updated in the db. If you provide a non-null pluginFile, and the plugin is deemed to be new or updated, the content of the file will be streamed to the database. Note that if you provide a non-null file, you must ensure its MD5 matches that of the file (i.e. this method will not attempt to recompute the file's MD5, it will assume the caller has already done that and provided the proper MD5 in plugin).

NOTE ** This call will register the plugin in a new transaction.

Parameters:

plugin - The plugin object being deployed

metadata - The plugin descriptor file

pluginFile - the actual plugin file whose content will be stored in the database (will be ignored if null)

forceUpdate - if true, the plugin's types will be updated, even if the plugin hasn't changed since

Throws:

Exception

installPluginJar

boolean installPluginJar(org.rhq.core.domain.plugin.Plugin newPlugin,
                       PluginDescriptor pluginDescriptor,
                       File pluginFile)
                         throws Exception

Exists only for transactional boundary reasons. Not for general consumption.

Throws:

Exception

getPluginDropboxDirectory

File getPluginDropboxDirectory()

Returns the directory where plugins can be dropped for inclusion into the system.

Returns:

directory where the plugin dropbox is located

acknowledgeDeletedPluginsBy

void acknowledgeDeletedPluginsBy(int serverId)

The provided server acknowledges the deletion of all plugins marked as deleted by calling this method. Once all the servers in the HA cloud acknowledge the deletion of a plugin and the plugin is made purgable (after its resource types are deleted, etc) it will be automatically purged from the database.

This method is not meant for "public" consumption and is only called from AgentPluginScanner.

Parameters:

serverId - the id of the server that wants to acknowledge that it has seen the deleted plugins

getCannedGroupExpressions

List<org.rhq.core.domain.plugin.CannedGroupExpression> getCannedGroupExpressions()