org.apache.felix.webconsole

Class AbstractWebConsolePlugin

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.apache.felix.webconsole.AbstractWebConsolePlugin

All Implemented Interfaces:

Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

public abstract class AbstractWebConsolePlugin
extends javax.servlet.http.HttpServlet

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTR_FILEUPLOAD The name of the request attribute containig the map of FileItems from the POST request

Constructor Summary

Constructors

Constructor and Description
AbstractWebConsolePlugin()

Method Summary

Methods

Modifier and Type	Method and Description
void	activate(org.osgi.framework.BundleContext bundleContext)
void	deactivate()
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Renders the web console page for the request.
protected void	endResponse(PrintWriter pw)
protected org.osgi.framework.BundleContext	getBundleContext()
abstract String	getLabel()
static String	getParameter(javax.servlet.http.HttpServletRequest request, String name)
String	getServletName() Returns the title for this plugin as returned by getTitle()
abstract String	getTitle()
protected abstract void	renderContent(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
protected void	renderTopNavigation(javax.servlet.http.HttpServletRequest request, PrintWriter pw)
protected PrintWriter	startResponse(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, 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

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

Field Detail

ATTR_FILEUPLOAD

public static final String ATTR_FILEUPLOAD

The name of the request attribute containig the map of FileItems from the POST request

See Also:

Constant Field Values

Constructor Detail

AbstractWebConsolePlugin

public AbstractWebConsolePlugin()

Method Detail

getServletName

public String getServletName()

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

doGet

protected void doGet(javax.servlet.http.HttpServletRequest request,
         javax.servlet.http.HttpServletResponse response)
              throws javax.servlet.ServletException,
                     IOException

Renders the web console page for the request. This consist of the following four parts called in order:

1. startResponse(HttpServletRequest, HttpServletResponse)
2. renderTopNavigation(HttpServletRequest, PrintWriter)
3. renderContent(HttpServletRequest, HttpServletResponse)
4. endResponse(PrintWriter)

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

javax.servlet.ServletException

IOException

activate

public void activate(org.osgi.framework.BundleContext bundleContext)

deactivate

public void deactivate()

getTitle

public abstract String getTitle()

getLabel

public abstract String getLabel()

renderContent

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

Throws:

javax.servlet.ServletException

IOException

getBundleContext

protected org.osgi.framework.BundleContext getBundleContext()

startResponse

protected PrintWriter startResponse(javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response)
                             throws IOException

Throws:

IOException

renderTopNavigation

protected void renderTopNavigation(javax.servlet.http.HttpServletRequest request,
                       PrintWriter pw)

endResponse

protected void endResponse(PrintWriter pw)

getParameter

public static String getParameter(javax.servlet.http.HttpServletRequest request,
                  String name)