org.pentaho.platform.web.http.api.resources

Class PluginManagerResource

java.lang.Object

org.pentaho.platform.web.http.api.resources.PluginManagerResource

public class PluginManagerResource
extends Object

Constructor Summary

Constructors

Constructor and Description
PluginManagerResource()

Method Summary

Modifier and Type	Method and Description
List<Overlay>	getOverlays(String id) Retrieve the list of XUL overlays for the provided id
javax.ws.rs.core.Response	getPluginIds() Retrieve the list of registered plugin IDs
ArrayList<PluginPerspective>	getPluginPerpectives() Retrieve the list of plugin perspective in the platform
String	getPluginSetting(String pluginId, String settingName) Retrieve the plugins setting with a provided setting name.
javax.ws.rs.core.Response	getPluginSettings(String settingName) Retrieve the list of setting of a selected setting name from all registered plugins.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginManagerResource

public PluginManagerResource()

Method Detail

getOverlays

public List<Overlay> getOverlays(String id)

Retrieve the list of XUL overlays for the provided id

Parameters:

id -

Returns:

list of Overlay

getPluginPerpectives

public ArrayList<PluginPerspective> getPluginPerpectives()

Retrieve the list of plugin perspective in the platform

Returns:

list of PluginPerspective

getPluginIds

public javax.ws.rs.core.Response getPluginIds()

Retrieve the list of registered plugin IDs

Returns:

list of ids

getPluginSetting

public String getPluginSetting(String pluginId,
                               String settingName)

Retrieve the plugins setting with a provided setting name. This will search the plugins's settings.xml and return the selected setting

Parameters:

pluginId - (Plugin ID for the setting being searched)

settingName - (Setting name of a selected plugin)

Returns:

Value of the setting

getPluginSettings

public javax.ws.rs.core.Response getPluginSettings(String settingName)

Retrieve the list of setting of a selected setting name from all registered plugins.

Parameters:

settingName - (name of the plugin setting)

Returns:

list of Setting