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

Class PluginResource

java.lang.Object

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

@Path("/plugins/{pluginId}")
public class PluginResource
extends Object

Represents the public files available in a plugin.

Author:

aaron

Field Summary

Fields

Modifier and Type	Field	Description
protected jakarta.servlet.http.HttpServletResponse	httpServletResponse
protected org.pentaho.platform.api.engine.IPluginManager	pluginManager
protected org.pentaho.platform.api.engine.IPluginManager	pluginMgr
protected File	systemFolder

Constructor Summary

Constructors

Constructor	Description
PluginResource()
PluginResource(jakarta.servlet.http.HttpServletResponse httpServletResponse)

Method Summary

Modifier and Type	Method	Description
protected InputStream	getCacheBackedStream(String pluginId, String path, boolean useCache)
jakarta.ws.rs.core.Response	readFile(String pluginId, String path)	Retrieve the file from the selected plugin.
jakarta.ws.rs.core.Response	readFile(String pluginId, String path, boolean changeResponseHeaders)	Retrieve the file from the selected plugin, optionally not affecting the current HTTP response headers.

Methods inherited from class java.lang.Object

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

Field Details

systemFolder

protected File systemFolder

pluginManager

protected org.pentaho.platform.api.engine.IPluginManager pluginManager

pluginMgr

protected org.pentaho.platform.api.engine.IPluginManager pluginMgr

httpServletResponse

@Context
protected jakarta.servlet.http.HttpServletResponse httpServletResponse

Constructor Details

PluginResource

public PluginResource()

PluginResource

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

Method Details

getCacheBackedStream

protected InputStream getCacheBackedStream(String pluginId,
 String path,
 boolean useCache)
                                    throws IOException

Throws:

IOException

readFile

@GET
@Path("/files/{path : .+}")
@Produces("*/*")
public jakarta.ws.rs.core.Response readFile(@PathParam("pluginId")
 String pluginId,
 @PathParam("path")
 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

readFile

public jakarta.ws.rs.core.Response readFile(String pluginId,
 String path,
 boolean changeResponseHeaders)
                                     throws IOException

Retrieve the file from the selected plugin, optionally not affecting the current HTTP response headers.

Parameters:

pluginId - The plugin id.

path - The file path.

changeResponseHeaders - Whether to change the HTTP response headers to reflect aspects such as cache control.

Returns:

The response containing the file content.

Throws:

IOException