Control Plugins

Topics marked with * relate to HQ Enterprise-only features.

The ControlPlugin defines control actions and implements the doAction() method used to control resources. Like the Measurement Plugin, the method of control is left entirely to the plugin. Support classes are provided to assist with certain types of control:

JDBC
JMX
Script Execution
Windows Service Manager

Following are some examples of collection methods used by various plugins:

Collection Method	Plugins that Use It
JMX	JBoss, WebLogic, WebSphere
JDBC	Mysql, PostgreSQL
Script Execution	Apache, Tomcat
Windows Service Manager	IIS, Apache, Tomcat

Feedback is welcome. Click Add Comment at the bottom of the page.

Properties

Property	Use
BACKGROUND_COMMAND	background.sh command silently fails when running
DEFAULT_PROGRAM	default control program

Script Execution

Script Execution Plugin

...
<server name="Zope"
          version="2.x">
...
<!-- Use this helper class -->
 <plugin type="control"
            class="org.hyperic.hq.product.ScriptControlPlugin"/>
...

<!-- default script, visible and configurable in UI -->
<property name="DEFAULT_PROGRAM" value="zopectl"/>
...

<!-- Actions visible in UI-->
 <actions include="start,restart,stop,kill,status,test"/>

...
</server>

Windows Service Manager

Code snippet with the required code to run Control Actions on a Windows Service.
Always specify the platform (platform="Win32") if you use a common plugin for Unix/Windows platforms.

Windows Service Manager Control Actions


<!-- Use this helper class for your Control Actions -->
<plugin type="control"
platform="Win32"
        class="org.hyperic.hq.product.Win32ControlPlugin"/>

<!-- Actions are only valid on Windows platforms -->
<actions platform="Win32"
include="start,stop,restart"/>

<!-- Specify service name as a configurable option and setting the default value-->
<config type="control" platform="Win32">
<option name="service_name"
default="Apache2"
description="Apache Service Name"/>

ControlPlugin.doAction Method

Control actions are defined in the Plugin XML Descriptor. Server and Service resources can include an <actions> tag that will define the control actions that resource supports. Multiple control actions can be defined by separating the actions with a comma. For example:

Defining Control Actions

<actions include="start,stop,restart"/>

These actions are passed into doAction as a String argument. The plugin can then act accordingly. Each resource that supports control will have its own ControlPlugin instance. Configuration parameters defined within the Plugin XML Descriptor <config> tags can be retrieved using the ControlPlugin.getConfig method.

An example using a JBoss JMS Destination, which uses JMX for its control actions:

hq-plugin.xml

<!-- ObjectName properties used in the control plugins -->
  <property name="JMSQueue"
	    value="jboss.mq.destination:service=Queue,name=%jms.destination%"/>

  ...
  <service name="JMS Destination">
    <config>
      <option name="jms.destination"
                description="JMS Destination"
                default=""/>
    </config>

    <actions include="removeAllMessages"/>
    ...
  </service>
  ...

JBossJMSControlPlugin.java

public class JBossJMSControlPlugin extends ControlPlugin {

    public void doAction(String action) throws PluginException {

        // ObjectName to invoke the method on
        String oName = getProperty("JMSQueue"); //From hq-plugin.xml

        try {
            ... // Get a reference to the MBeanServer
            mBeanServer.invoke(oName, action, new Object[0], new String[0]);
            ...
        } catch (Exception e) {
            throw new PluginException("Unable to invoke method '" +
                                      action + "'", e);
        }
    }
}

Control Plugin

Control Plugins

Script Execution

Windows Service Manager

ControlPlugin.doAction Method

Return to the Plugin Development Center.

Labels

Comments (5)

Shrinidhi Shastri says:

Mirko Pluhar says:

Shrinidhi Shastri says:

Mirko Pluhar says:

BJ Chippindale says: