org.pentaho.platform.web.servlet

Class PluginDispatchServlet

java.lang.Object

org.pentaho.platform.web.servlet.PluginDispatchServlet

All Implemented Interfaces:

javax.servlet.Servlet

public class PluginDispatchServlet
extends Object
implements javax.servlet.Servlet

Dispatches requests to Servlets provided by BIServer plugins. To define a Servlet in a plugin, simply add a bean element for the Servlet class in the plugin.spring.xml file in your plugin root directory.

Author:

Aaron Phillips

Constructor Summary

Constructors

Constructor and Description
PluginDispatchServlet()

Method Summary

Modifier and Type	Method and Description
void	destroy()
String	getDispatchKey(javax.servlet.http.HttpServletRequest request) Returns the dispatch key for this request.
javax.servlet.ServletConfig	getServletConfig()
String	getServletInfo()
void	init(javax.servlet.ServletConfig config)
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse res)

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginDispatchServlet

public PluginDispatchServlet()

Method Detail

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

service

public void service(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse res)
             throws javax.servlet.ServletException,
                    IOException

Specified by:

service in interface javax.servlet.Servlet

Throws:

javax.servlet.ServletException

IOException

getDispatchKey

public String getDispatchKey(javax.servlet.http.HttpServletRequest request)

Returns the dispatch key for this request. This name is the part of the request path beyond the servlet base path. I.e. if the PluginDispatchServlet is mapped to the "/plugin" context in web.xml, then this method will return "myPlugin/myServlet" given a request to "http://localhost:8080/pentaho/plugin/myPlugin/myServlet".

Returns:

the part of the request url used to dispatch the request

init

public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Servlet

Throws:

javax.servlet.ServletException

getServletConfig

public javax.servlet.ServletConfig getServletConfig()

Specified by:

getServletConfig in interface javax.servlet.Servlet

getServletInfo

public String getServletInfo()

Specified by:

getServletInfo in interface javax.servlet.Servlet