Package org.apache.felix.webconsole

Class AbstractWebConsolePlugin

  • All Implemented Interfaces:
    java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig
    Direct Known Subclasses:
    SimpleWebConsolePlugin
    @Deprecated
public abstract class AbstractWebConsolePlugin
extends javax.servlet.http.HttpServlet
    Deprecated.
    Either register a servlet using Servlet API 5 or use AbstractServlet
    The Web Console can be extended by registering an OSGi service for the interface Servlet with the service property felix.webconsole.label set to the label (last segment in the URL) of the page. The respective service is called a Web Console Plugin or a plugin for short. To help rendering the response the Apache Felix Web Console bundle provides two options. One of the options is to extend the AbstractWebConsolePlugin overwriting the renderContent(HttpServletRequest, HttpServletResponse) method.
    See Also:
    Serialized Form

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ATTR_FILEUPLOAD
      Deprecated.
      Use the Servlet API for uploads
      static java.lang.String ATTR_FILEUPLOAD_REPO
      Deprecated.
      Use the Servlet API for uploads
      static java.lang.String GET_RESOURCE_METHOD_NAME
      Deprecated.
      Web Console Plugin typically consists of servlet and resources such as images, scripts or style sheets.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      void activate​(org.osgi.framework.BundleContext bundleContext)
      Deprecated.
      This method is called from the Felix Web Console to ensure the AbstractWebConsolePlugin is correctly setup.
      void deactivate()
      Deprecated.
      This method is called, by the Web Console to de-activate the plugin and release all used resources.
      static BrandingPlugin getBrandingPlugin()
      Deprecated. 
      org.osgi.framework.Bundle getBundle()
      Deprecated.
      Returns the Bundle pertaining to the bundle context with which this plugin has been activated.
      java.lang.String getCategory()
      Deprecated.
      This method should return category string which will be used to render the plugin in the navigation menu.
      abstract java.lang.String getLabel()
      Deprecated.
      Retrieves the label.
      static java.lang.String getParameter​(javax.servlet.http.HttpServletRequest request, java.lang.String name)
      Deprecated.
      Use the Servlet API for uploads
      java.lang.String getServletName()
      Deprecated.
      Returns the title for this plugin as returned by getTitle()
      abstract java.lang.String getTitle()
      Deprecated.
      Retrieves the title of the plug-in.
      RequestVariableResolver getVariableResolver​(javax.servlet.ServletRequest request)
      Deprecated.
      Returns the RequestVariableResolver for the given request.
      void log​(int level, java.lang.String message)
      Deprecated.
      Logs the message in the level
      void log​(int level, java.lang.String message, java.lang.Throwable t)
      Deprecated.
      Logs the message in the level
      static void setBrandingPlugin​(BrandingPlugin brandingPlugin)
      Deprecated. 
      static void setLogLevel​(int logLevel)
      Deprecated.
      Sets the log level to be applied for calls to the log(int, String) and log(int, String, Throwable) methods.

      • Methods inherited from class javax.servlet.http.HttpServlet

        service

      • Methods inherited from class javax.servlet.GenericServlet

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

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ATTR_FILEUPLOAD

        @Deprecated
public static final java.lang.String ATTR_FILEUPLOAD
        Deprecated.
        Use the Servlet API for uploads
        This attribute is not supported anymore
        See Also:
        Constant Field Values

      • ATTR_FILEUPLOAD_REPO

        @Deprecated
public static final java.lang.String ATTR_FILEUPLOAD_REPO
        Deprecated.
        Use the Servlet API for uploads
        This attribute is not supported anymore
        See Also:
        Constant Field Values

      • GET_RESOURCE_METHOD_NAME

        public static final java.lang.String GET_RESOURCE_METHOD_NAME
        Deprecated.
        Web Console Plugin typically consists of servlet and resources such as images, scripts or style sheets. To load resources, a Resource Provider is used. The resource provider is an object, that provides a method which name is specified by this constants and it is 'getResource'.
        See Also:
        getResourceProvider(), Constant Field Values

    • Constructor Detail

      • AbstractWebConsolePlugin

        public AbstractWebConsolePlugin()
        Deprecated.

    • Method Detail

      • getServletName

        public java.lang.String getServletName()
        Deprecated.
        Returns the title for this plugin as returned by getTitle()
        Specified by:
        getServletName in interface javax.servlet.ServletConfig
        Overrides:
        getServletName in class javax.servlet.GenericServlet
        See Also:
        GenericServlet.getServletName()

      • getCategory

        public java.lang.String getCategory()
        Deprecated.
        This method should return category string which will be used to render the plugin in the navigation menu. Default implementation returns null, which will result in the plugin link rendered as top level menu item. Concrete implementations wishing to be rendered as a sub-menu item under a category should override this method and return a string or define felix.webconsole.category OSGi property. Currently only single level categories are supported. So, this should be a simple String.
        Returns:
        category

      • activate

        public void activate​(org.osgi.framework.BundleContext bundleContext)
        Deprecated.
        This method is called from the Felix Web Console to ensure the AbstractWebConsolePlugin is correctly setup. It is called right after the Web Console receives notification for plugin registration.
        Parameters:
        bundleContext - the context of the plugin bundle

      • deactivate

        public void deactivate()
        Deprecated.
        This method is called, by the Web Console to de-activate the plugin and release all used resources.

      • getLabel

        public abstract java.lang.String getLabel()
        Deprecated.
        Retrieves the label. This is the last component in the servlet path. This method MUST be overridden, if the AbstractWebConsolePlugin() constructor is used.
        Returns:
        the label.

      • getTitle

        public abstract java.lang.String getTitle()
        Deprecated.
        Retrieves the title of the plug-in. It is displayed in the page header and is also included in the title of the HTML document. This method MUST be overridden, if the AbstractWebConsolePlugin() constructor is used.
        Returns:
        the plugin title.

      • getBundle

        public final org.osgi.framework.Bundle getBundle()
        Deprecated.
        Returns the Bundle pertaining to the bundle context with which this plugin has been activated. If the plugin has not be activated by calling the activate(BundleContext) method, this method returns null.
        Returns:
        the bundle or null if the plugin is not activated.

      • log

        public void log​(int level,
                java.lang.String message)
        Deprecated.
        Logs the message in the level
        Parameters:
        level - The log level at which to log the message
        message - The message to log

      • log

        public void log​(int level,
                java.lang.String message,
                java.lang.Throwable t)
        Deprecated.
        Logs the message in the level
        Parameters:
        level - The log level at which to log the message
        message - The message to log
        t - The Throwable to log with the message

      • getParameter

        @Deprecated
public static final java.lang.String getParameter​(javax.servlet.http.HttpServletRequest request,
                                                  java.lang.String name)
        Deprecated.
        Use the Servlet API for uploads
        Do not use this method anymore. Use the Servlet API for request parameter handling.
        Parameters:
        request - The request object
        name - The name of the parameter
        Returns:
        The parameter value or null if the parameter is not set

      • getBrandingPlugin

        @Deprecated
public static BrandingPlugin getBrandingPlugin()
        Deprecated.
        Returns the BrandingPlugin currently used for web console branding.
        Returns:
        the brandingPlugin

      • setBrandingPlugin

        @Deprecated
public static final void setBrandingPlugin​(BrandingPlugin brandingPlugin)
        Deprecated.
        Sets the BrandingPlugin to use globally by all extensions of this class for branding.

        Note: This method is intended to be used internally by the Web Console to update the branding plugin to use.

        Parameters:
        brandingPlugin - the brandingPlugin to set

      • setLogLevel

        public static final void setLogLevel​(int logLevel)
        Deprecated.
        Sets the log level to be applied for calls to the log(int, String) and log(int, String, Throwable) methods.

        Note: This method is intended to be used internally by the Web Console to update the log level according to the Web Console configuration.

        Parameters:
        logLevel - the maximum allowed log level. If message is logged with lower level it will not be forwarded to the logger.