org.apache.felix.webconsole.internal
Class WebConsolePluginAdapter

java.lang.Object
  javax.servlet.GenericServlet
      javax.servlet.http.HttpServlet
          org.apache.felix.webconsole.AbstractWebConsolePlugin
              org.apache.felix.webconsole.internal.WebConsolePluginAdapter

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public class WebConsolePluginAdapter
extends AbstractWebConsolePlugin

The WebConsolePluginAdapter is an adapter to the AbstractWebConsolePlugin for regular servlets registered with the WebConsoleConstants.PLUGIN_TITLE service attribute.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin

ATTR_FILEUPLOAD, GET_RESOURCE_METHOD_NAME

Constructor Summary

WebConsolePluginAdapter(java.lang.String label, javax.servlet.Servlet plugin, org.osgi.framework.ServiceReference serviceReference)
Creates a new wrapper for a Web Console Plugin

Method Summary

void	destroy() Destroys this servlet as well as the plugin servlet.
protected java.lang.String[]	getCssReferences() Returns the CSS references from the felix.webconsole.css service registration property of the plugin.
java.lang.String	getLabel() Returns the label of this plugin page as defined in the constructor.
protected java.lang.Object	getResourceProvider() Returns the registered plugin class to be able to call the getResource() method on that object for this plugin to provide additional resources.
java.lang.String	getTitle() Returns the title of this plugin page as defined by the WebConsoleConstants.PLUGIN_TITLE service registration attribute which is exposed as the servlet name in the servlet configuration.
void	init(javax.servlet.ServletConfig config) Initializes this servlet as well as the plugin servlet.
protected boolean	isHtmlRequest(javax.servlet.http.HttpServletRequest request) Detects whether this request is intended to have the headers and footers of this plugin be rendered or not.
protected void	renderContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res) Call the plugin servlet's service method to render the content of this page.
void	service(javax.servlet.ServletRequest req, javax.servlet.ServletResponse resp) Directly refer to the plugin's service method unless the request method is GET in which case we defer the call into the service method until the abstract web console plugin calls the renderContent(HttpServletRequest, HttpServletResponse) method.

Methods inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin

activate, deactivate, doGet, endResponse, getBrandingPlugin, getBundle, getBundleContext, getParameter, getServletName, log, log, readTemplateFile, renderTopNavigation, sendRedirect, setBrandingPlugin, setLogLevel, startResponse

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service

Methods inherited from class javax.servlet.GenericServlet

getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

WebConsolePluginAdapter

public WebConsolePluginAdapter(java.lang.String label,
                               javax.servlet.Servlet plugin,
                               org.osgi.framework.ServiceReference serviceReference)

Creates a new wrapper for a Web Console Plugin

Parameters:

label - the label

plugin - the plugin itself

serviceReference - reference to the plugin

Method Detail

getLabel

public java.lang.String getLabel()

Returns the label of this plugin page as defined in the constructor.

Specified by:

getLabel in class AbstractWebConsolePlugin

Returns:

the label.

See Also:

AbstractWebConsolePlugin.getLabel()

getTitle

public java.lang.String getTitle()

Returns the title of this plugin page as defined by the WebConsoleConstants.PLUGIN_TITLE service registration attribute which is exposed as the servlet name in the servlet configuration.

Specified by:

getTitle in class AbstractWebConsolePlugin

Returns:

the plugin title.

See Also:

AbstractWebConsolePlugin.getTitle()

getCssReferences

protected java.lang.String[] getCssReferences()

Returns the CSS references from the felix.webconsole.css service registration property of the plugin.

Overrides:

getCssReferences in class AbstractWebConsolePlugin

Returns:

The list of additional CSS files to reference in the head section or null if no such CSS files are required.

See Also:

AbstractWebConsolePlugin.getCssReferences()

renderContent

protected void renderContent(javax.servlet.http.HttpServletRequest req,
                             javax.servlet.http.HttpServletResponse res)
                      throws javax.servlet.ServletException,
                             java.io.IOException

Call the plugin servlet's service method to render the content of this page.

Specified by:

renderContent in class AbstractWebConsolePlugin

Parameters:

req - the HTTP request send from the user

res - the HTTP response object, where to render the plugin data.

Throws:

javax.servlet.ServletException - if the request for the GET could not be handled

java.io.IOException - if an input or output error is detected when the servlet handles the request

See Also:

AbstractWebConsolePlugin.renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

getResourceProvider

protected java.lang.Object getResourceProvider()

Returns the registered plugin class to be able to call the getResource() method on that object for this plugin to provide additional resources.

Overrides:

getResourceProvider in class AbstractWebConsolePlugin

Returns:

The resource provider object or null if no resources will be provided by this plugin.

See Also:

AbstractWebConsolePlugin.getResourceProvider()

init

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

Initializes this servlet as well as the plugin servlet.

Specified by:

init in interface javax.servlet.Servlet

Overrides:

init in class javax.servlet.GenericServlet

Throws:

javax.servlet.ServletException

See Also:

GenericServlet.init(javax.servlet.ServletConfig)

isHtmlRequest

protected boolean isHtmlRequest(javax.servlet.http.HttpServletRequest request)

Detects whether this request is intended to have the headers and footers of this plugin be rendered or not. The decision is taken based on whether and what extension the request URI has: If the request URI has no extension or the the extension is .html, the request is assumed to be rendered with header and footer. Otherwise the headers and footers are omitted and the renderContent(HttpServletRequest, HttpServletResponse) method is called without any decorations and without setting any response headers.

Overrides:

isHtmlRequest in class AbstractWebConsolePlugin

Parameters:

request - the original request passed from the HTTP server

Returns:

true if the page should have headers and footers rendered

See Also:

AbstractWebConsolePlugin.isHtmlRequest(javax.servlet.http.HttpServletRequest)

service

public void service(javax.servlet.ServletRequest req,
                    javax.servlet.ServletResponse resp)
             throws javax.servlet.ServletException,
                    java.io.IOException

Directly refer to the plugin's service method unless the request method is GET in which case we defer the call into the service method until the abstract web console plugin calls the renderContent(HttpServletRequest, HttpServletResponse) method.

Specified by:

service in interface javax.servlet.Servlet

Overrides:

service in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

java.io.IOException

See Also:

HttpServlet.service(javax.servlet.ServletRequest, javax.servlet.ServletResponse)

destroy

public void destroy()

Destroys this servlet as well as the plugin servlet.

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet

See Also:

GenericServlet.destroy()