org.apache.felix.webconsole.internal.misc
Class ConfigurationRender

java.lang.Object
  extended by javax.servlet.GenericServlet
      extended by javax.servlet.http.HttpServlet
          extended by org.apache.felix.webconsole.AbstractWebConsolePlugin
              extended by org.apache.felix.webconsole.SimpleWebConsolePlugin
                  extended by org.apache.felix.webconsole.internal.misc.ConfigurationRender
All Implemented Interfaces:
Serializable, Servlet, ServletConfig, OsgiManagerPlugin

public class ConfigurationRender
extends SimpleWebConsolePlugin
implements OsgiManagerPlugin

ConfigurationRender plugin renders the configuration status - a textual representation of the current framework status. The content itself is internally generated by the ConfigurationPrinter plugins.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
ATTR_FILEUPLOAD, GET_RESOURCE_METHOD_NAME
 
Constructor Summary
ConfigurationRender(ResourceBundleManager resourceBundleManager)
          Default constructor
 
Method Summary
 void deactivate()
          This method will close all service trackers, created by SimpleWebConsolePlugin.getService(String) method.
protected  void doGet(HttpServletRequest request, HttpServletResponse response)
          Renders the web console page for the request.
static void infoLine(PrintWriter pw, String indent, String label, Object value)
          Renders an info line - element in the framework configuration.
protected  void renderContent(HttpServletRequest request, HttpServletResponse response)
          This method is used to render the content of the plug-in.
 
Methods inherited from class org.apache.felix.webconsole.SimpleWebConsolePlugin
getCssReferences, getLabel, getResource, getService, getTitle, register, unregister
 
Methods inherited from class org.apache.felix.webconsole.AbstractWebConsolePlugin
activate, endResponse, getBrandingPlugin, getBundle, getBundleContext, getParameter, getResourceProvider, getServletName, isHtmlRequest, log, log, readTemplateFile, renderTopNavigation, sendRedirect, setBrandingPlugin, setLogLevel, startResponse
 
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
 
Methods inherited from interface org.apache.felix.webconsole.internal.OsgiManagerPlugin
activate
 

Constructor Detail

ConfigurationRender

public ConfigurationRender(ResourceBundleManager resourceBundleManager)
Default constructor

Method Detail

deactivate

public void deactivate()
Description copied from class: SimpleWebConsolePlugin
This method will close all service trackers, created by SimpleWebConsolePlugin.getService(String) method. If you override this method, don't forget to call the super.

Specified by:
deactivate in interface OsgiManagerPlugin
Overrides:
deactivate in class SimpleWebConsolePlugin
See Also:
SimpleWebConsolePlugin.deactivate()

doGet

protected final void doGet(HttpServletRequest request,
                           HttpServletResponse response)
                    throws 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:
  1. Send back a requested resource
  2. AbstractWebConsolePlugin.startResponse(HttpServletRequest, HttpServletResponse)
  3. AbstractWebConsolePlugin.renderTopNavigation(HttpServletRequest, PrintWriter)
  4. AbstractWebConsolePlugin.renderContent(HttpServletRequest, HttpServletResponse)
  5. 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.

Overrides:
doGet in class AbstractWebConsolePlugin
Parameters:
request - an HttpServletRequest object that contains the request the client has made of the servlet
response - an HttpServletResponse object that contains the response the servlet sends to the client
Throws:
ServletException - if the request for the GET could not be handled
IOException - if an input or output error is detected when the servlet handles the GET request
See Also:
AbstractWebConsolePlugin.doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

renderContent

protected final void renderContent(HttpServletRequest request,
                                   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 class AbstractWebConsolePlugin
Parameters:
request - the HTTP request send from the user
response - 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)

infoLine

public static final void infoLine(PrintWriter pw,
                                  String indent,
                                  String label,
                                  Object value)
Renders an info line - element in the framework configuration. The info line will look like:
 label = value
 
Optionally it can be indented by a specific string.

Parameters:
pw - the writer to print to
indent - indentation string
label - the label data
value - the data itself.


Copyright © 2013 The Apache Software Foundation. All Rights Reserved.