Page History

...

• felix.webconsole.appRoot – This request attribute of type String provides the absolute path of the Web Console root. This path consists of the servlet context path (from <code>ServletRequest.getContextPath()</code>) and the Web Console servlet path (from HttpServletRequest.getServletPath(), /system/console by default). This attribute can be used to provide absolute links to resources (images, CSS, scripts, etc.) or other plugins. This request attribute is available to client side JavaScript as the global appRoot variable.
• felix.webconsole.pluginRoot – This request attribute of type String provides the absolute path of the current plugin. This path consists of the servlet context path (from <code>ServletRequest.getContextPath()</code>), the Web Console servlet path (from HttpServletRequest.getServletPath(), /system/console by default) and the plugin label. This attribute can be used to provide absolute links to the plugin itself. This request attribute is available to client side JavaScript as the global pluginRoot variable.
• felix.webconsole.labelMap – This request attribute of type Map provides a mapping of labels to page titles of registered console plugins. This map may be used to render a navigation of the console plugins such as the AbstractWebConsolePlugin.renderTopNavigation method does. The keys and values of the map are of type String.

...

• renderContext(HttpServletRequest, HttpServletResponse) – Calls the service(HttpServletRequest, HttpServletResponse) method of the plugin to render the actual contents of the plugin.
• getLabel() – Returns the value of the felix.webconsole.label service registration property of the plugin.
• getTitle() – Returns the value of the felix.webconsole.title service registration property of the plugin.
• getCssReferences() – Returns the values of the felix.webconsole.css service registration property of the plugin.
• service(ServletRequest, ServletResponse) – If the request method is GET the service(ServletRequest, ServletResponse) method of the AbstractWebConsolePlugin is called which ultimately calls the renderContent service method. For all other requests, the service(ServletRequest, ServletResponse) method of the plugin is called directly to have the plugin handle any non-GET requests directly.

Please note, that sometimes it is not desirable to have the AbstractWebConsolePlugin render the header and footer of the response. For this reason, the AbstractWebConsolePlugin only renders the header and footer if the request to such a wrapped plugin either has no extension or if the extension is .html. For any other extension, e.g. .txt or .json, the header and footer is not rendered and the service method of the plugin is directly called.

It is suggested that plugins extend from the javax.servlet.http.HttpServlet class and implement the appropriate doXxx(HttpServletRequest, HttpServletResponse) methods such as doGet and doPost. In addition, unless non-GET requests are handled through AJAX calls, it is suggested that non-GET requests return a redirect after processing the request.