Hyperic HQ Plugin API v. 2.5.dev

## net.hyperic.hq.product
Class ControlPluginManager

    java.lang.Object
      net.hyperic.hq.product.PluginManager
          net.hyperic.hq.product.ControlPluginManager

public class ControlPluginManager
extends PluginManager

Field Summary
`static java.lang.String[]` `BUILTIN_CMDS`

Fields inherited from class net.hyperic.hq.product.PluginManager
`log, plugins`

Constructor Summary
`ControlPluginManager()`
`ControlPluginManager(java.util.Properties props)`

Method Summary
`void` `addJob(java.lang.String name, java.lang.String jobId)`
`void` `createControlPlugin(java.lang.String name, java.lang.String type, ConfigResponse config)`
`void` `doAction(java.lang.String name, java.lang.String action)`
`java.util.List` `getActions(java.lang.String name)`
`java.lang.String` `getErrorStr(java.lang.String name)`
`java.lang.String` `getName()`
`java.lang.String` `getNextJob(java.lang.String name)`
`int` `getResult(java.lang.String name)`
`void` `removeControlPlugin(java.lang.String name)`
`void` `removeNextJob(java.lang.String name)`
`void` `updateControlPlugin(java.lang.String name, ConfigResponse config)`

Methods inherited from class net.hyperic.hq.product.PluginManager
`classNotFoundMessage, createPlugin, createPlugin, getConfigSchema, getParent, getPlatformPlugin, getPlatformPlugin, getPlatformPlugins, getPlatformPlugins, getPlugin, getPluginInfo, getPlugins, getPlugins, getProperties, getProperty, getProperty, init, isPropertyEnabled, isPropertyEnabled, mergeConfigSchema, registerPlugin, removePlugin, setPluginInfo, shutdown, updatePlugin`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

### BUILTIN_CMDS

    public static final java.lang.String[] BUILTIN_CMDS

Constructor Detail

### ControlPluginManager

    public ControlPluginManager()

### ControlPluginManager

    public ControlPluginManager(java.util.Properties props)

Method Detail

### getName

    public java.lang.String getName()

  Specified by:
    `getName` in class `PluginManager`

### createControlPlugin

    public void createControlPlugin(java.lang.String name,
                                    java.lang.String type,
                                    ConfigResponse config)
                             throws PluginNotFoundException,
                                    PluginExistsException,
                                    PluginException

  Throws:
    `PluginNotFoundException`
    `PluginExistsException`
    `PluginException`

### updateControlPlugin

    public void updateControlPlugin(java.lang.String name,
                                    ConfigResponse config)
                             throws PluginNotFoundException,
                                    PluginException

  Throws:
    `PluginNotFoundException`
    `PluginException`

### getActions

    public java.util.List getActions(java.lang.String name)
                              throws PluginNotFoundException

  Throws:
    `PluginNotFoundException`

### addJob

    public void addJob(java.lang.String name,
                       java.lang.String jobId)

### getNextJob

    public java.lang.String getNextJob(java.lang.String name)
                                throws java.util.NoSuchElementException

  Throws:
    `java.util.NoSuchElementException`

### removeNextJob

    public void removeNextJob(java.lang.String name)
                       throws java.util.NoSuchElementException

  Throws:
    `java.util.NoSuchElementException`

### doAction

    public void doAction(java.lang.String name,
                         java.lang.String action)
                  throws PluginNotFoundException,
                         PluginException

  Throws:
    `PluginNotFoundException`
    `PluginException`

### getResult

    public int getResult(java.lang.String name)
                  throws PluginNotFoundException

  Throws:
    `PluginNotFoundException`

### getErrorStr

    public java.lang.String getErrorStr(java.lang.String name)
                                 throws PluginNotFoundException

  Throws:
    `PluginNotFoundException`

### removeControlPlugin

    public void removeControlPlugin(java.lang.String name)
                             throws PluginException,
                                    PluginNotFoundException

  Throws:
    `PluginException`
    `PluginNotFoundException`

Hyperic HQ Plugin API v. 2.5.dev

Copyright © 2004-2005 Hyperic LLC support@hyperic.net, All Rights Reserved.