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

Class PluginResource

java.lang.Object

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

public class PluginResource
extends Object

Represents the public files available in a plugin.

Author:

aaron

Constructor Summary

Constructors

Constructor and Description
PluginResource()
PluginResource(javax.servlet.http.HttpServletResponse httpServletResponse)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	readFile(String pluginId, String path) Retrieve the file from the selected plugin.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginResource

public PluginResource()

PluginResource

public PluginResource(javax.servlet.http.HttpServletResponse httpServletResponse)

Method Detail

readFile

public javax.ws.rs.core.Response readFile(String pluginId,
                                          String path)
                                   throws IOException

Retrieve the file from the selected plugin. This file is a static file (i.e javascript, html, css etc)

Parameters:

pluginId - (Plugin ID of the selected Plugin)

path - (Path of the file being retrieved. This is a colon separated path to the plugin file. This is usually a static file like a javascript, image or html

Returns:

Throws:

IOException