Package org.apache.felix.webconsole
Class SimpleWebConsolePlugin
- java.lang.Object
-
- javax.servlet.GenericServlet
-
- javax.servlet.http.HttpServlet
-
- org.apache.felix.webconsole.AbstractWebConsolePlugin
-
- org.apache.felix.webconsole.SimpleWebConsolePlugin
-
- All Implemented Interfaces:
Serializable
,javax.servlet.Servlet
,javax.servlet.ServletConfig
@Deprecated public abstract class SimpleWebConsolePlugin extends AbstractWebConsolePlugin
Deprecated.Either register a servlet using Servlet API 5 or useAbstractServlet
SimpleWebConsolePlugin is an utility class that provides default implementation of theAbstractWebConsolePlugin
and supports the following features:- Methods for (un)registering the web console plugin service
- Default implementation for resource loading
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
ATTR_FILEUPLOAD, ATTR_FILEUPLOAD_REPO, GET_RESOURCE_METHOD_NAME
-
-
Constructor Summary
Constructors Constructor Description SimpleWebConsolePlugin(String label, String title, String[] css)
Deprecated.Creates new Simple Web Console Plugin with the default category (null
)SimpleWebConsolePlugin(String label, String title, String category, String[] css)
Deprecated.Creates new Simple Web Console Plugin with the given category.
-
Method Summary
All Methods Instance 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 will close all service trackers, created bygetService(String)
method.String
getCategory()
Deprecated.This method should return category string which will be used to render the plugin in the navigation menu.protected String[]
getCssReferences()
Deprecated.Returns a list of CSS reference paths ornull
if no additional CSS files are provided by the plugin.String
getLabel()
Deprecated.Retrieves the label.protected URL
getResource(String path)
Deprecated.Called internally byAbstractWebConsolePlugin
to load resources.Object
getService(String serviceName)
Deprecated.Gets the service with the specified class name.String
getServletName()
Deprecated.Returns the title for this plugin as returned byAbstractWebConsolePlugin.getTitle()
String
getTitle()
Deprecated.Retrieves the title of the plug-in.SimpleWebConsolePlugin
register(org.osgi.framework.BundleContext bc)
Deprecated.This is an utility method.void
unregister()
Deprecated.An utility method that removes the service, registered by theregister(BundleContext)
method.-
Methods inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
doGet, endResponse, getBrandingPlugin, getBundle, getBundleContext, getParameter, getResourceProvider, getVariableResolver, isHtmlRequest, log, log, readTemplateFile, renderContent, renderMenu, renderTopNavigation, sendRedirect, setBrandingPlugin, setLogLevel, startResponse
-
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service
-
-
-
-
Constructor Detail
-
SimpleWebConsolePlugin
public SimpleWebConsolePlugin(String label, String title, String[] css)
Deprecated.Creates new Simple Web Console Plugin with the default category (null
)- Parameters:
label
- the front label. SeeAbstractWebConsolePlugin.getLabel()
title
- the plugin title . SeeAbstractWebConsolePlugin.getTitle()
css
- the additional plugin CSS. SeeAbstractWebConsolePlugin.getCssReferences()
-
SimpleWebConsolePlugin
public SimpleWebConsolePlugin(String label, String title, String category, String[] css)
Deprecated.Creates new Simple Web Console Plugin with the given category.- Parameters:
label
- the front label. SeeAbstractWebConsolePlugin.getLabel()
title
- the plugin title . SeeAbstractWebConsolePlugin.getTitle()
category
- the plugin's navigation category. SeeAbstractWebConsolePlugin.getCategory()
css
- the additional plugin CSS. SeeAbstractWebConsolePlugin.getCssReferences()
-
-
Method Detail
-
activate
public void activate(org.osgi.framework.BundleContext bundleContext)
Deprecated.Description copied from class:AbstractWebConsolePlugin
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.- Overrides:
activate
in classAbstractWebConsolePlugin
- Parameters:
bundleContext
- the context of the plugin bundle
-
getServletName
public String getServletName()
Deprecated.Description copied from class:AbstractWebConsolePlugin
Returns the title for this plugin as returned byAbstractWebConsolePlugin.getTitle()
- Specified by:
getServletName
in interfacejavax.servlet.ServletConfig
- Overrides:
getServletName
in classAbstractWebConsolePlugin
- See Also:
GenericServlet.getServletName()
-
getLabel
public final String getLabel()
Deprecated.Description copied from class:AbstractWebConsolePlugin
Retrieves the label. This is the last component in the servlet path. This method MUST be overridden, if theAbstractWebConsolePlugin()
constructor is used.- Specified by:
getLabel
in classAbstractWebConsolePlugin
- Returns:
- the label.
- See Also:
AbstractWebConsolePlugin.getLabel()
-
getTitle
public final String getTitle()
Deprecated.Description copied from class:AbstractWebConsolePlugin
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 theAbstractWebConsolePlugin()
constructor is used.- Specified by:
getTitle
in classAbstractWebConsolePlugin
- Returns:
- the plugin title.
- See Also:
AbstractWebConsolePlugin.getTitle()
-
getCategory
public String getCategory()
Deprecated.Description copied from class:AbstractWebConsolePlugin
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 definefelix.webconsole.category
OSGi property. Currently only single level categories are supported. So, this should be a simple String.- Overrides:
getCategory
in classAbstractWebConsolePlugin
- Returns:
- category
- See Also:
AbstractWebConsolePlugin.getCategory()
-
getCssReferences
protected final String[] getCssReferences()
Deprecated.Description copied from class:AbstractWebConsolePlugin
Returns a list of CSS reference paths ornull
if no additional CSS files are provided by the plugin.The result is an array of strings which are used as the value of the
href
attribute of the<link>
elements placed in the head section of the HTML generated. If the reference is a relative path, it is turned into an absolute path by prepending the value of theWebConsoleConstants.ATTR_APP_ROOT
request attribute.- Overrides:
getCssReferences
in classAbstractWebConsolePlugin
- 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()
-
getResource
protected URL getResource(String path)
Deprecated.Called internally byAbstractWebConsolePlugin
to load resources. This particular implementation depends on the label. As example, if the plugin is accessed as/system/console/abc
, and the plugin resources are accessed like/system/console/abc/res/logo.gif
, the code here will try load resource/res/logo.gif
from the bundle, providing the plugin.- Parameters:
path
- the path to read.- Returns:
- the URL of the resource or
null
if not found.
-
register
public final SimpleWebConsolePlugin register(org.osgi.framework.BundleContext bc)
Deprecated.This is an utility method. It is used to register the plugin service. Don't forget to call theunregister()
when the plugin is no longer needed.- Parameters:
bc
- the bundle context used for service registration.- Returns:
- self
-
unregister
public final void unregister()
Deprecated.An utility method that removes the service, registered by theregister(BundleContext)
method.
-
getService
public final Object getService(String serviceName)
Deprecated.Gets the service with the specified class name. Will create a newServiceTracker
if the service is not already got.- Parameters:
serviceName
- the service name to obtain- Returns:
- the service or
null
if missing.
-
deactivate
public void deactivate()
Deprecated.This method will close all service trackers, created bygetService(String)
method. If you override this method, don't forget to call the super.- Overrides:
deactivate
in classAbstractWebConsolePlugin
- See Also:
AbstractWebConsolePlugin.deactivate()
-
-