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

Class PluginManagerResource

java.lang.Object

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

@Path("/plugin-manager/")
public class PluginManagerResource
extends Object

Constructor Summary

Constructors

Constructor	Description
PluginManagerResource()

Method Summary

Modifier and Type	Method	Description
OverlayWrapper	getOverlays(String id)	Retrieve the list of XUL overlays for the provided id
jakarta.ws.rs.core.Response	getPluginIds()	Retrieve the list of registered plugin IDs
PluginPerspectiveWrapper	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.
jakarta.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

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

Constructor Details

PluginManagerResource

public PluginManagerResource()

Method Details

getOverlays

@GET
@Path("/overlays")
@Produces("application/json")
public OverlayWrapper getOverlays(@QueryParam("id") @DefaultValue("")
 String id)

Retrieve the list of XUL overlays for the provided id

Parameters:

id -

Returns:

list of Overlay

getPluginPerpectives

@GET
@Path("/perspectives")
@Produces("application/json")
public PluginPerspectiveWrapper getPluginPerpectives()

Retrieve the list of plugin perspective in the platform

Returns:

list of PluginPerspective

getPluginIds

@GET
@Path("/ids")
@Produces("application/json")
public jakarta.ws.rs.core.Response getPluginIds()

Retrieve the list of registered plugin IDs

Returns:

list of ids

getPluginSetting

@GET
@Path("/{pluginId}/setting/{settingName}")
@Produces("application/json")
public String getPluginSetting(@PathParam("pluginId")
 String pluginId,
 @PathParam("settingName")
 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

@GET
@Path("/settings/{settingName}")
@Produces("application/json")
public jakarta.ws.rs.core.Response getPluginSettings(@PathParam("settingName")
 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