Package org.apache.felix.webconsole.internal.servlet

Class Plugin

java.lang.Object

org.apache.felix.webconsole.internal.servlet.Plugin

All Implemented Interfaces:

Comparable<Plugin>, javax.servlet.ServletConfig

Direct Known Subclasses:

Plugin.InternalPlugin, Plugin.ServletPlugin

public abstract class Plugin
extends Object
implements javax.servlet.ServletConfig, Comparable<Plugin>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Plugin.InternalPlugin
static class	Plugin.ServletPlugin

Field Summary

Fields

Modifier and Type	Field	Description
protected String	category
protected String	title

Constructor Summary

Constructors

Constructor	Description
Plugin(org.apache.felix.webconsole.internal.servlet.PluginHolder holder, org.osgi.framework.ServiceReference<javax.servlet.Servlet> serviceReference, String label)

Method Summary

Modifier and Type	Method	Description
int	compareTo(Plugin other)
void	dispose()	Cleans up this plugin when it is not used any longer.
protected abstract AbstractWebConsolePlugin	doGetConsolePlugin()
protected abstract void	doUngetConsolePlugin(AbstractWebConsolePlugin consolePlugin)
org.osgi.framework.Bundle	getBundle()
String	getCategory()
AbstractWebConsolePlugin	getConsolePlugin()
protected org.apache.felix.webconsole.internal.servlet.PluginHolder	getHolder()
abstract String	getId()
String	getInitParameter(String name)
Enumeration<?>	getInitParameterNames()
String	getLabel()
org.osgi.framework.ServiceReference<javax.servlet.Servlet>	getServiceReference()
javax.servlet.ServletContext	getServletContext()
String	getServletName()
String	getTitle()
boolean	init()	Initialize everything including title and category
protected boolean	isEnabled()

Methods inherited from class java.lang.Object

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

Field Detail

title

protected volatile String title

category

protected volatile String category

Constructor Detail

Plugin

public Plugin(org.apache.felix.webconsole.internal.servlet.PluginHolder holder,
              org.osgi.framework.ServiceReference<javax.servlet.Servlet> serviceReference,
              String label)

Method Detail

getServiceReference

public org.osgi.framework.ServiceReference<javax.servlet.Servlet> getServiceReference()

getBundle

public org.osgi.framework.Bundle getBundle()

init

public boolean init()

Initialize everything including title and category

dispose

public void dispose()

Cleans up this plugin when it is not used any longer. This means destroying the plugin servlet and, if it was registered as an OSGi service, ungetting the service.

compareTo

public int compareTo(Plugin other)

Specified by:

compareTo in interface Comparable<Plugin>

getLabel

public String getLabel()

getHolder

protected org.apache.felix.webconsole.internal.servlet.PluginHolder getHolder()

getTitle

public String getTitle()

getCategory

public String getCategory()

getConsolePlugin

public AbstractWebConsolePlugin getConsolePlugin()

isEnabled

protected boolean isEnabled()

getId

public abstract String getId()

doGetConsolePlugin

protected abstract AbstractWebConsolePlugin doGetConsolePlugin()

doUngetConsolePlugin

protected abstract void doUngetConsolePlugin(AbstractWebConsolePlugin consolePlugin)

getInitParameter

public String getInitParameter(String name)

Specified by:

getInitParameter in interface javax.servlet.ServletConfig

getInitParameterNames

public Enumeration<?> getInitParameterNames()

Specified by:

getInitParameterNames in interface javax.servlet.ServletConfig

getServletContext

public javax.servlet.ServletContext getServletContext()

Specified by:

getServletContext in interface javax.servlet.ServletConfig

getServletName

public String getServletName()

Specified by:

getServletName in interface javax.servlet.ServletConfig