Class BundlesServlet
- java.lang.Object
-
- javax.servlet.GenericServlet
-
- javax.servlet.http.HttpServlet
-
- org.apache.felix.webconsole.AbstractWebConsolePlugin
-
- org.apache.felix.webconsole.SimpleWebConsolePlugin
-
- org.apache.felix.webconsole.internal.core.BundlesServlet
-
- All Implemented Interfaces:
Serializable
,javax.servlet.Servlet
,javax.servlet.ServletConfig
,ConfigurationPrinter
,org.apache.felix.webconsole.internal.OsgiManagerPlugin
public class BundlesServlet extends SimpleWebConsolePlugin implements org.apache.felix.webconsole.internal.OsgiManagerPlugin, ConfigurationPrinter
TheBundlesServlet
provides the bundles plugins, used to display the list of bundles, installed on the framework. It also adds ability to control the lifecycle of the bundles, like start, stop, uninstall, install.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static String
NAME
the label of the bundles plugin - used by other plugins to reference to plugin details-
Fields inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
ATTR_FILEUPLOAD, ATTR_FILEUPLOAD_REPO, GET_RESOURCE_METHOD_NAME
-
Fields inherited from interface org.apache.felix.webconsole.ConfigurationPrinter
MODE_ALWAYS, MODE_TXT, MODE_WEB, MODE_ZIP, PROPERTY_MODES, SERVICE
-
-
Constructor Summary
Constructors Constructor Description BundlesServlet()
Default constructor
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
activate(org.osgi.framework.BundleContext bundleContext)
This method is called from the Felix Web Console to ensure the AbstractWebConsolePlugin is correctly setup.void
deactivate()
This method will close all service trackers, created bySimpleWebConsolePlugin.getService(String)
method.protected void
doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
Renders the web console page for the request.protected void
doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp)
void
printConfiguration(PrintWriter pw)
Prints the configuration report to the givenprintWriter
.protected void
renderContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
This method is used to render the content of the plug-in.-
Methods inherited from class org.apache.felix.webconsole.SimpleWebConsolePlugin
getCategory, getCssReferences, getLabel, getResource, getService, getServletName, getTitle, register, unregister
-
Methods inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
endResponse, getBrandingPlugin, getBundle, getBundleContext, getParameter, getResourceProvider, isHtmlRequest, log, log, readTemplateFile, renderMenu, renderTopNavigation, sendRedirect, setBrandingPlugin, setLogLevel, startResponse
-
Methods inherited from class javax.servlet.http.HttpServlet
doDelete, doHead, doOptions, 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
-
Methods inherited from interface org.apache.felix.webconsole.ConfigurationPrinter
getTitle
-
-
-
-
Field Detail
-
NAME
public static final String NAME
the label of the bundles plugin - used by other plugins to reference to plugin details- See Also:
- Constant Field Values
-
-
Method Detail
-
activate
public void activate(org.osgi.framework.BundleContext bundleContext)
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.- Specified by:
activate
in interfaceorg.apache.felix.webconsole.internal.OsgiManagerPlugin
- Overrides:
activate
in classSimpleWebConsolePlugin
- Parameters:
bundleContext
- the context of the plugin bundle- See Also:
AbstractWebConsolePlugin.activate(org.osgi.framework.BundleContext)
-
deactivate
public void deactivate()
Description copied from class:SimpleWebConsolePlugin
This method will close all service trackers, created bySimpleWebConsolePlugin.getService(String)
method. If you override this method, don't forget to call the super.- Specified by:
deactivate
in interfaceorg.apache.felix.webconsole.internal.OsgiManagerPlugin
- Overrides:
deactivate
in classSimpleWebConsolePlugin
- See Also:
SimpleWebConsolePlugin.deactivate()
-
printConfiguration
public void printConfiguration(PrintWriter pw)
Description copied from interface:ConfigurationPrinter
Prints the configuration report to the givenprintWriter
. Implementations are free to print whatever information they deem useful.- Specified by:
printConfiguration
in interfaceConfigurationPrinter
- Parameters:
pw
- where to write the configuration data. It might be flushed, but must not be closed.- See Also:
ConfigurationPrinter.printConfiguration(java.io.PrintWriter)
-
doGet
protected void doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws javax.servlet.ServletException, IOException
Description copied from class:AbstractWebConsolePlugin
Renders the web console page for the request. This consist of the following five parts called in order:- Send back a requested resource
AbstractWebConsolePlugin.startResponse(HttpServletRequest, HttpServletResponse)
AbstractWebConsolePlugin.renderTopNavigation(HttpServletRequest, PrintWriter)
AbstractWebConsolePlugin.renderContent(HttpServletRequest, HttpServletResponse)
AbstractWebConsolePlugin.endResponse(PrintWriter)
Note: If a resource is sent back for the request only the first step is executed. Otherwise the first step is a null-operation actually and the latter four steps are executed in order.
If the
AbstractWebConsolePlugin.isHtmlRequest(HttpServletRequest)
method returnsfalse
only theAbstractWebConsolePlugin.renderContent(HttpServletRequest, HttpServletResponse)
method is called.- Overrides:
doGet
in classAbstractWebConsolePlugin
- Throws:
javax.servlet.ServletException
IOException
- See Also:
AbstractWebConsolePlugin.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
-
doPost
protected void doPost(javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse resp) throws javax.servlet.ServletException, IOException
- Overrides:
doPost
in classjavax.servlet.http.HttpServlet
- Throws:
javax.servlet.ServletException
IOException
- See Also:
HttpServlet.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
-
renderContent
protected void renderContent(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) throws IOException
Description copied from class:AbstractWebConsolePlugin
This method is used to render the content of the plug-in. It is called internally from the Web Console.- Specified by:
renderContent
in classAbstractWebConsolePlugin
- Parameters:
request
- the HTTP request send from the userresponse
- the HTTP response object, where to render the plugin data.- Throws:
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)
-
-