org.rhq.enterprise.server.resource.metadata

Class PluginManagerBean

java.lang.Object

org.rhq.enterprise.server.resource.metadata.PluginManagerBean

All Implemented Interfaces:

PluginManagerLocal, PluginManagerRemote

public class PluginManagerBean
extends Object
implements PluginManagerLocal, PluginManagerRemote

Constructor Summary

Constructors

Constructor and Description
PluginManagerBean()

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.
void	deletePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) This method puts the plugin into a deleted state and removes the plugin JAR file from the file system and schedules its eventual deletion from the database, too.
List<org.rhq.core.domain.plugin.Plugin>	deployUsingBytes(org.rhq.core.domain.auth.Subject subject, String pluginJarName, byte[] pluginJarBytes) Deploys a new agent plugin to RHQ asynchronously.
List<org.rhq.core.domain.plugin.Plugin>	deployUsingContentHandle(org.rhq.core.domain.auth.Subject subject, String pluginJarName, String handle) Deploys a new agent plugin to RHQ asynchronously using the content handle pointing to a previously uploaded file.
void	disablePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Disables plugins by ID.
void	enablePlugins(org.rhq.core.domain.auth.Subject subject, List<Integer> pluginIds) Enables plugins by ID.
List<org.rhq.core.domain.plugin.Plugin>	findAllDeletedPlugins() Do not use this method directly.
org.rhq.core.domain.util.PageList<org.rhq.core.domain.plugin.Plugin>	findPluginsByCriteria(org.rhq.core.domain.auth.Subject subject, org.rhq.core.domain.criteria.PluginCriteria criteria) Returns a list of plugins by criteria.
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() gets canned expressions from all plugins by direct reading and parsing additional descriptors;
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()
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	isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject subject, String handle) Use this method to check whether given scheduled plugin update on agents finished.
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 pluginDescriptor, File pluginFile, boolean forceUpdate) For server-side registration of plugin archives.
String	schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject subject, long delayInMilliseconds) Instructs all the running and connected agents to update their plugins after a given delay.
void	setPluginEnabledFlag(org.rhq.core.domain.auth.Subject subject, int pluginId, boolean enabled) Sets if a plugin is enabled or not.
void	update(org.rhq.core.domain.auth.Subject subject) Updates the plugins that might have been changed on the filesystem of the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManagerBean

public PluginManagerBean()

Method Detail

getPlugin

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

Description copied from interface: PluginManagerLocal

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

Specified by:

getPlugin in interface PluginManagerLocal

Parameters:

name - of plugin as defined in plugin descriptor.

Returns:

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

isReadyForPurge

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

Description copied from interface: PluginManagerLocal

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.

Specified by:

isReadyForPurge in interface PluginManagerLocal

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

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

Description copied from interface: PluginManagerLocal

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.

Specified by:

purgePlugins in interface PluginManagerLocal

Parameters:

plugins - The plugins to remove from the database.

getPlugins

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

Specified by:

getPlugins in interface PluginManagerLocal

Returns:

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

See Also:

use getInstalledPlugins method instead

getInstalledPlugins

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

Description copied from interface: PluginManagerLocal

Returns the list of all plugins deployed in the server.

Specified by:

getInstalledPlugins in interface PluginManagerLocal

Returns:

list of plugins deployed

findAllDeletedPlugins

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

Description copied from interface: PluginManagerLocal

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

Specified by:

findAllDeletedPlugins in interface PluginManagerLocal

Returns:

All plugins that have been marked deleted.

getAllPluginsById

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

Description copied from interface: PluginManagerLocal

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

Specified by:

getAllPluginsById in interface PluginManagerLocal

Parameters:

pluginIds - The ids of the plugins to fetch

Returns:

A list of plugins with the specified ids

getPluginsByResourceTypeAndCategory

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

Specified by:

getPluginsByResourceTypeAndCategory in interface PluginManagerLocal

enablePlugins

public void enablePlugins(org.rhq.core.domain.auth.Subject subject,
                 List<Integer> pluginIds)
                   throws Exception

Description copied from interface: PluginManagerRemote

Enables plugins by ID.

Specified by:

enablePlugins in interface PluginManagerRemote

Throws:

Exception

disablePlugins

public void disablePlugins(org.rhq.core.domain.auth.Subject subject,
                  List<Integer> pluginIds)
                    throws Exception

Description copied from interface: PluginManagerRemote

Disables plugins by ID.

Specified by:

disablePlugins in interface PluginManagerRemote

Throws:

Exception

deletePlugins

public void deletePlugins(org.rhq.core.domain.auth.Subject subject,
                 List<Integer> pluginIds)
                   throws Exception

Description copied from interface: PluginManagerRemote

This method puts the plugin into a deleted state and removes the plugin JAR file from the file system and schedules its eventual deletion from the database, too.

Specified by:

deletePlugins in interface PluginManagerRemote

Parameters:

subject - The user performing the deletion

pluginIds - The ids of the plugins to be deleted

Throws:

Exception - if an error occurs

markPluginsDeleted

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

Description copied from interface: PluginManagerLocal

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

Specified by:

markPluginsDeleted in interface PluginManagerLocal

Throws:

Exception

getPluginStats

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

Specified by:

getPluginStats in interface PluginManagerLocal

setPluginEnabledFlag

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

Description copied from interface: PluginManagerLocal

Sets if a plugin is enabled or not.

Specified by:

setPluginEnabledFlag in interface PluginManagerLocal

Throws:

Exception

getPluginDropboxDirectory

public File getPluginDropboxDirectory()

Description copied from interface: PluginManagerLocal

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

Specified by:

getPluginDropboxDirectory in interface PluginManagerLocal

Returns:

directory where the plugin dropbox is located

registerPlugin

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

Description copied from interface: PluginManagerLocal

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.

Specified by:

registerPlugin in interface PluginManagerLocal

Parameters:

plugin - The plugin object being deployed

pluginDescriptor - 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

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

Description copied from interface: PluginManagerLocal

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

Specified by:

installPluginJar in interface PluginManagerLocal

Throws:

Exception

update

public void update(org.rhq.core.domain.auth.Subject subject)
            throws Exception

Description copied from interface: PluginManagerRemote

Updates the plugins that might have been changed on the filesystem of the server. This method will only return after the updates are complete.

Specified by:

update in interface PluginManagerRemote

Parameters:

subject - the authenticated user

Throws:

Exception

schedulePluginUpdateOnAgents

public String schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject subject,
                                  long delayInMilliseconds)
                                    throws Exception

Description copied from interface: PluginManagerRemote

Instructs all the running and connected agents to update their plugins after a given delay. Be aware that in case there was a plugin update, the plugin containers of the agents will be restarted and thus there will be a short period of time when the agent will not be collecting any metrics, etc.

Note that by nature this is an asynchronous operation and the update is not finished by the time it returns. You can use the provided handle to periodically query the PluginManagerRemote.isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject, String) method using the supplied handle.

Specified by:

schedulePluginUpdateOnAgents in interface PluginManagerRemote

Parameters:

subject - the authenticated user

delayInMilliseconds - the number of milliseconds to wait before running the update on the agents

Returns:

returns a handle that can be used to retrieve info about the execution of the update

Throws:

Exception

See Also:

PluginManagerRemote.isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject, String)

isPluginUpdateOnAgentsFinished

public boolean isPluginUpdateOnAgentsFinished(org.rhq.core.domain.auth.Subject subject,
                                     String handle)

Description copied from interface: PluginManagerRemote

Use this method to check whether given scheduled plugin update on agents finished.

This will return false until the update on all agents has truly finished.

Note that the schedule only updates the agents that are live at the time it is executed. The agents that will come live later will only update their plugins once they start and only if they are configured to do so (which is the default behavior). It is currently not possible to find out what versions of plugins agents use if they are NOT auto-updating themselves.

Specified by:

isPluginUpdateOnAgentsFinished in interface PluginManagerRemote

Parameters:

subject - the authenticated user

handle - the handle of the schedule

Returns:

true if the scheduled plugin update finished on all live agents, false if it has not finished yet.

See Also:

PluginManagerRemote.schedulePluginUpdateOnAgents(org.rhq.core.domain.auth.Subject, long)

deployUsingBytes

public List<org.rhq.core.domain.plugin.Plugin> deployUsingBytes(org.rhq.core.domain.auth.Subject subject,
                                                       String pluginJarName,
                                                       byte[] pluginJarBytes)
                                                         throws Exception

Description copied from interface: PluginManagerRemote

Deploys a new agent plugin to RHQ asynchronously. Note that the PluginManagerRemote.deployUsingContentHandle(org.rhq.core.domain.auth.Subject, String, String) method is the preferred way of doing this because it avoids having to keep the whole of the plugin jar in memory.

In another words, use this method with caution because it may require a large amount of memory.

This method returns after the plugin is deployed. Because there might be other plugins pending to be deployed in the filesystem, this operation might result in more than just the single requested plugin being deployed. This is why this method returns a list instead of a single plugin corresponding to the provided jar..

Specified by:

deployUsingBytes in interface PluginManagerRemote

Parameters:

subject - the authenticated user

pluginJarName - the name of the jar file which should be used to store the plugin on the filesystem

pluginJarBytes - the bytes of the plugin jar file

Throws:

Exception - on error

deployUsingContentHandle

public List<org.rhq.core.domain.plugin.Plugin> deployUsingContentHandle(org.rhq.core.domain.auth.Subject subject,
                                                               String pluginJarName,
                                                               String handle)
                                                                 throws Exception

Description copied from interface: PluginManagerRemote

Deploys a new agent plugin to RHQ asynchronously using the content handle pointing to a previously uploaded file.

This method returns after the plugin is deployed. Because there might be other plugins pending to be deployed in the filesystem, this operation might result in more than just the single requested plugin being deployed. This is why this method returns a list instead of a single plugin corresponding to the provided jar..

Specified by:

deployUsingContentHandle in interface PluginManagerRemote

Parameters:

subject - the authenticated user

pluginJarName - the name of the jar file which should be used to store the plugin on the filesystem

handle - the handle to the uploaded file

Throws:

Exception - on error

See Also:

ContentManagerRemote.createTemporaryContentHandle(), ContentManagerRemote.uploadContentFragment(String, byte[], int, int)

findPluginsByCriteria

public org.rhq.core.domain.util.PageList<org.rhq.core.domain.plugin.Plugin> findPluginsByCriteria(org.rhq.core.domain.auth.Subject subject,
                                                                                         org.rhq.core.domain.criteria.PluginCriteria criteria)

Description copied from interface: PluginManagerRemote

Returns a list of plugins by criteria.

Specified by:

findPluginsByCriteria in interface PluginManagerRemote

acknowledgeDeletedPluginsBy

public void acknowledgeDeletedPluginsBy(int serverId)

Description copied from interface: PluginManagerLocal

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.

Specified by:

acknowledgeDeletedPluginsBy in interface PluginManagerLocal

Parameters:

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

getCannedGroupExpressions

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

gets canned expressions from all plugins by direct reading and parsing additional descriptors;

Specified by:

getCannedGroupExpressions in interface PluginManagerLocal