documentation/_attachments/apidocs/webconsole/4.2.0/org/apache/felix/webconsole/AbstractWebConsolePlugin.html - felix-site-pub - Git at Google

 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
 <!-- NewPage -->
 <html lang="de">
 <head>
 <!-- Generated by javadoc (version 1.7.0_25) on Mon Jul 01 12:09:30 CEST 2013 -->
 <meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
 <title>AbstractWebConsolePlugin (Apache Felix Web Management Console 4.2.0 API)</title>
 <meta name="date" content="2013-07-01">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 </head>
 <body>
 <script type="text/javascript"><!--
     if (location.href.indexOf('is-external=true') == -1) {
         parent.document.title="AbstractWebConsolePlugin (Apache Felix Web Management Console 4.2.0 API)";
     }
 //-->
 </script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="topNav"><a name="navbar_top">
 <!--   -->
 </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/AbstractWebConsolePlugin.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev Class</li>
 <li><a href="../../../../org/apache/felix/webconsole/AttachmentProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/felix/webconsole/AbstractWebConsolePlugin.html" target="_top">Frames</a></li>
 <li><a href="AbstractWebConsolePlugin.html" target="_top">No Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_top">
 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_top");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_detail">Method</a></li>
 </ul>
 </div>
 <a name="skip-navbar_top">
 <!--   -->
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="subTitle">org.apache.felix.webconsole</div>
 <h2 title="Class AbstractWebConsolePlugin" class="title">Class AbstractWebConsolePlugin</h2>
 </div>
 <div class="contentContainer">
 <ul class="inheritance">
 <li><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
 <li>javax.servlet.GenericServlet</li>
 <li>
 <ul class="inheritance">
 <li>javax.servlet.http.HttpServlet</li>
 <li>
 <ul class="inheritance">
 <li>org.apache.felix.webconsole.AbstractWebConsolePlugin</li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <div class="description">
 <ul class="blockList">
 <li class="blockList">
 <dl>
 <dt>All Implemented Interfaces:</dt>
 <dd><a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, javax.servlet.Servlet, javax.servlet.ServletConfig</dd>
 </dl>
 <dl>
 <dt>Direct Known Subclasses:</dt>
 <dd><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html" title="class in org.apache.felix.webconsole">SimpleWebConsolePlugin</a></dd>
 </dl>
 <hr>
 <br>
 <pre>public abstract class <span class="strong">AbstractWebConsolePlugin</span>
 extends javax.servlet.http.HttpServlet</pre>
 <div class="block">The Web Console can be extended by registering an OSGi service for the interface
  <code>Servlet</code> with the service property
  <code>felix.webconsole.label</code> set to the label (last segment in the URL)
  of the page. The respective service is called a Web Console Plugin or a plugin
  for short.

  To help rendering the response the Apache Felix Web Console bundle provides two
  options. One of the options is to extend the AbstractWebConsolePlugin overwriting
  the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>renderContent(HttpServletRequest, HttpServletResponse)</code></a> method.</div>
 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.felix.webconsole.AbstractWebConsolePlugin">Serialized Form</a></dd></dl>
 </li>
 </ul>
 </div>
 <div class="summary">
 <ul class="blockList">
 <li class="blockList">
 <!-- =========== FIELD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field_summary">
 <!--   -->
 </a>
 <h3>Field Summary</h3>
 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
 <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Field and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#ATTR_FILEUPLOAD">ATTR_FILEUPLOAD</a></strong></code>
 <div class="block">The name of the request attribute containing the map of FileItems from the POST request</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#GET_RESOURCE_METHOD_NAME">GET_RESOURCE_METHOD_NAME</a></strong></code>
 <div class="block">Web Console Plugin typically consists of servlet and resources such as images,
  scripts or style sheets.</div>
 </td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor_summary">
 <!--   -->
 </a>
 <h3>Constructor Summary</h3>
 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
 <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colOne" scope="col">Constructor and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colOne"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#AbstractWebConsolePlugin()">AbstractWebConsolePlugin</a></strong>()</code>&nbsp;</td>
 </tr>
 </table>
 </li>
 </ul>
 <!-- ========== METHOD SUMMARY =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method_summary">
 <!--   -->
 </a>
 <h3>Method Summary</h3>
 <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
 <caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
 <tr>
 <th class="colFirst" scope="col">Modifier and Type</th>
 <th class="colLast" scope="col">Method and Description</th>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#activate(org.osgi.framework.BundleContext)">activate</a></strong>(org.osgi.framework.BundleContext&nbsp;bundleContext)</code>
 <div class="block">This method is called from the Felix Web Console to ensure the
  AbstractWebConsolePlugin is correctly setup.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#deactivate()">deactivate</a></strong>()</code>
 <div class="block">This method is called, by the Web Console to de-activate the plugin and release
  all used resources.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doGet</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request,
      javax.servlet.http.HttpServletResponse&nbsp;response)</code>
 <div class="block">Renders the web console page for the request.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#endResponse(java.io.PrintWriter)">endResponse</a></strong>(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</code>
 <div class="block">This method is responsible for generating the footer of the page.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBrandingPlugin()">getBrandingPlugin</a></strong>()</code>
 <div class="block">Returns the <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><code>BrandingPlugin</code></a> currently used for web console
  branding.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>org.osgi.framework.Bundle</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundle()">getBundle</a></strong>()</code>
 <div class="block">Returns the <code>Bundle</code> pertaining to the
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundleContext()"><code>bundle context</code></a> with which this plugin has
  been activated.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected org.osgi.framework.BundleContext</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundleContext()">getBundleContext</a></strong>()</code>
 <div class="block">Returns the <code>BundleContext</code> with which this plugin has been
  activated.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCategory()">getCategory</a></strong>()</code>
 <div class="block">This method should return category string which will be used to render
  the plugin in the navigation menu.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()">getCssReferences</a></strong>()</code>
 <div class="block">Returns a list of CSS reference paths or <code>null</code> if no
  additional CSS files are provided by the plugin.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()">getLabel</a></strong>()</code>
 <div class="block">Retrieves the label.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getParameter(javax.servlet.http.HttpServletRequest, java.lang.String)">getParameter</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request,
             <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
 <div class="block"><strong>Deprecated.</strong>&nbsp;
 <div class="block"><i>use <a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html#getParameter(javax.servlet.http.HttpServletRequest, java.lang.String)"><code>WebConsoleUtil.getParameter(HttpServletRequest, String)</code></a></i></div>
 </div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getResourceProvider()">getResourceProvider</a></strong>()</code>
 <div class="block">Returns the object which might provide resources.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getServletName()">getServletName</a></strong>()</code>
 <div class="block">Returns the title for this plugin as returned by <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()"><code>getTitle()</code></a></div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>abstract <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()">getTitle</a></strong>()</code>
 <div class="block">Retrieves the title of the plug-in.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected boolean</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#isHtmlRequest(javax.servlet.http.HttpServletRequest)">isHtmlRequest</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request)</code>
 <div class="block">Detects whether this request is intended to have the headers and
  footers of this plugin be rendered or not.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String)">log</a></strong>(int&nbsp;level,
    <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</code>
 <div class="block">Calls the <code>ServletContext.log(String)</code> method if the
  configured log level is less than or equal to the given <code>level</code>.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String, java.lang.Throwable)">log</a></strong>(int&nbsp;level,
    <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
    <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</code>
 <div class="block">Calls the <code>ServletContext.log(String, Throwable)</code> method if
  the configured log level is less than or equal to the given
  <code>level</code>.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#readTemplateFile(java.lang.String)">readTemplateFile</a></strong>(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;templateFile)</code>
 <div class="block">Reads the <code>templateFile</code> as a resource through the class
  loader of this class converting the binary data into a string using
  UTF-8 encoding.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected abstract void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">renderContent</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;req,
              javax.servlet.http.HttpServletResponse&nbsp;res)</code>
 <div class="block">This method is used to render the content of the plug-in.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderMenu(java.util.Map, java.lang.String, java.io.PrintWriter)">renderMenu</a></strong>(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;menuMap,
           <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appRoot,
           <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</code>&nbsp;</td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)">renderTopNavigation</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request,
                    <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</code>
 <div class="block">This method is called to generate the top level links with the available plug-ins.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>protected void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)">sendRedirect</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request,
             javax.servlet.http.HttpServletResponse&nbsp;response,
             <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;redirectUrl)</code>
 <div class="block"><strong>Deprecated.</strong>&nbsp;
 <div class="block"><i>use <a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)"><code>WebConsoleUtil.sendRedirect(HttpServletRequest, HttpServletResponse, String)</code></a></i></div>
 </div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#setBrandingPlugin(org.apache.felix.webconsole.BrandingPlugin)">setBrandingPlugin</a></strong>(<a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a>&nbsp;brandingPlugin)</code>
 <div class="block">Sets the <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><code>BrandingPlugin</code></a> to use globally by all extensions of
  this class for branding.</div>
 </td>
 </tr>
 <tr class="rowColor">
 <td class="colFirst"><code>static void</code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#setLogLevel(int)">setLogLevel</a></strong>(int&nbsp;logLevel)</code>
 <div class="block">Sets the log level to be applied for calls to the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String)"><code>log(int, String)</code></a>
  and <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String, java.lang.Throwable)"><code>log(int, String, Throwable)</code></a> methods.</div>
 </td>
 </tr>
 <tr class="altColor">
 <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a></code></td>
 <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">startResponse</a></strong>(javax.servlet.http.HttpServletRequest&nbsp;request,
              javax.servlet.http.HttpServletResponse&nbsp;response)</code>
 <div class="block">This method is responsible for generating the top heading of the page.</div>
 </td>
 </tr>
 </table>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_javax.servlet.http.HttpServlet">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;javax.servlet.http.HttpServlet</h3>
 <code>doDelete, doHead, doOptions, doPost, doPut, doTrace, getLastModified, service, service</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_javax.servlet.GenericServlet">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;javax.servlet.GenericServlet</h3>
 <code>destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, init, init, log, log</code></li>
 </ul>
 <ul class="blockList">
 <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
 <!--   -->
 </a>
 <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
 <code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="details">
 <ul class="blockList">
 <li class="blockList">
 <!-- ============ FIELD DETAIL =========== -->
 <ul class="blockList">
 <li class="blockList"><a name="field_detail">
 <!--   -->
 </a>
 <h3>Field Detail</h3>
 <a name="ATTR_FILEUPLOAD">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>ATTR_FILEUPLOAD</h4>
 <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> ATTR_FILEUPLOAD</pre>
 <div class="block">The name of the request attribute containing the map of FileItems from the POST request</div>
 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.AbstractWebConsolePlugin.ATTR_FILEUPLOAD">Constant Field Values</a></dd></dl>
 </li>
 </ul>
 <a name="GET_RESOURCE_METHOD_NAME">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>GET_RESOURCE_METHOD_NAME</h4>
 <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> GET_RESOURCE_METHOD_NAME</pre>
 <div class="block">Web Console Plugin typically consists of servlet and resources such as images,
  scripts or style sheets.

  To load resources, a Resource Provider is used. The resource provider is an object,
  that provides a method which name is specified by this constants and it is
  'getResource'.</div>
 <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getResourceProvider()"><code>getResourceProvider()</code></a>,
 <a href="../../../../constant-values.html#org.apache.felix.webconsole.AbstractWebConsolePlugin.GET_RESOURCE_METHOD_NAME">Constant Field Values</a></dd></dl>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <ul class="blockList">
 <li class="blockList"><a name="constructor_detail">
 <!--   -->
 </a>
 <h3>Constructor Detail</h3>
 <a name="AbstractWebConsolePlugin()">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>AbstractWebConsolePlugin</h4>
 <pre>public&nbsp;AbstractWebConsolePlugin()</pre>
 </li>
 </ul>
 </li>
 </ul>
 <!-- ============ METHOD DETAIL ========== -->
 <ul class="blockList">
 <li class="blockList"><a name="method_detail">
 <!--   -->
 </a>
 <h3>Method Detail</h3>
 <a name="getServletName()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getServletName</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getServletName()</pre>
 <div class="block">Returns the title for this plugin as returned by <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()"><code>getTitle()</code></a></div>
 <dl>
 <dt><strong>Specified by:</strong></dt>
 <dd><code>getServletName</code>&nbsp;in interface&nbsp;<code>javax.servlet.ServletConfig</code></dd>
 <dt><strong>Overrides:</strong></dt>
 <dd><code>getServletName</code>&nbsp;in class&nbsp;<code>javax.servlet.GenericServlet</code></dd>
 <dt><span class="strong">See Also:</span></dt><dd><code>GenericServlet.getServletName()</code></dd></dl>
 </li>
 </ul>
 <a name="getCategory()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCategory</h4>
 <pre>public&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCategory()</pre>
 <div class="block">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 define
  <code>felix.webconsole.category</code> OSGi property. Currently only
  single level categories are supported. So, this should be a simple
  String.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>category</dd></dl>
 </li>
 </ul>
 <a name="doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>doGet</h4>
 <pre>protected&nbsp;void&nbsp;doGet(javax.servlet.http.HttpServletRequest&nbsp;request,
          javax.servlet.http.HttpServletResponse&nbsp;response)
               throws javax.servlet.ServletException,
                      <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
 <div class="block">Renders the web console page for the request. This consist of the
  following five parts called in order:
  <ol>
  <li>Send back a requested resource
  <li><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>startResponse(HttpServletRequest, HttpServletResponse)</code></a></li>
  <li><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)"><code>renderTopNavigation(HttpServletRequest, PrintWriter)</code></a></li>
  <li><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>renderContent(HttpServletRequest, HttpServletResponse)</code></a></li>
  <li><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#endResponse(java.io.PrintWriter)"><code>endResponse(PrintWriter)</code></a></li>
  </ol>
  <p>
  <b>Note</b>: 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.
  <p>
  If the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#isHtmlRequest(javax.servlet.http.HttpServletRequest)"><code>isHtmlRequest(HttpServletRequest)</code></a> method returns
  <code>false</code> only the
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>renderContent(HttpServletRequest, HttpServletResponse)</code></a> method is
  called.</div>
 <dl>
 <dt><strong>Overrides:</strong></dt>
 <dd><code>doGet</code>&nbsp;in class&nbsp;<code>javax.servlet.http.HttpServlet</code></dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code>javax.servlet.ServletException</code></dd>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd><dt><span class="strong">See Also:</span></dt><dd><code>HttpServlet.doGet(javax.servlet.http.HttpServletRequest,
       javax.servlet.http.HttpServletResponse)</code></dd></dl>
 </li>
 </ul>
 <a name="isHtmlRequest(javax.servlet.http.HttpServletRequest)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>isHtmlRequest</h4>
 <pre>protected&nbsp;boolean&nbsp;isHtmlRequest(javax.servlet.http.HttpServletRequest&nbsp;request)</pre>
 <div class="block">Detects whether this request is intended to have the headers and
  footers of this plugin be rendered or not. This method always returns
  <code>true</true> and may be overwritten by plugins to detect
  from the actual request, whether or not to render the header and
  footer.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the original request passed from the HTTP server</dd>
 <dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the page should have headers and footers rendered</dd></dl>
 </li>
 </ul>
 <a name="activate(org.osgi.framework.BundleContext)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>activate</h4>
 <pre>public&nbsp;void&nbsp;activate(org.osgi.framework.BundleContext&nbsp;bundleContext)</pre>
 <div class="block">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.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bundleContext</code> - the context of the plugin bundle</dd></dl>
 </li>
 </ul>
 <a name="deactivate()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>deactivate</h4>
 <pre>public&nbsp;void&nbsp;deactivate()</pre>
 <div class="block">This method is called, by the Web Console to de-activate the plugin and release
  all used resources.</div>
 </li>
 </ul>
 <a name="renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>renderContent</h4>
 <pre>protected abstract&nbsp;void&nbsp;renderContent(javax.servlet.http.HttpServletRequest&nbsp;req,
                  javax.servlet.http.HttpServletResponse&nbsp;res)
                                throws javax.servlet.ServletException,
                                       <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
 <div class="block">This method is used to render the content of the plug-in. It is called internally
  from the Web Console.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>req</code> - the HTTP request send from the user</dd><dd><code>res</code> - the HTTP response object, where to render the plugin data.</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - if an input or output error is
   detected when the servlet handles the request</dd>
 <dd><code>javax.servlet.ServletException</code> - if the request for the GET
   could not be handled</dd></dl>
 </li>
 </ul>
 <a name="getLabel()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getLabel</h4>
 <pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getLabel()</pre>
 <div class="block">Retrieves the label. This is the last component in the servlet path.

  This method MUST be overridden, if the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#AbstractWebConsolePlugin()"><code>AbstractWebConsolePlugin()</code></a>
  constructor is used.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the label.</dd></dl>
 </li>
 </ul>
 <a name="getTitle()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getTitle</h4>
 <pre>public abstract&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getTitle()</pre>
 <div class="block">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 the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#AbstractWebConsolePlugin()"><code>AbstractWebConsolePlugin()</code></a>
  constructor is used.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the plugin title.</dd></dl>
 </li>
 </ul>
 <a name="getCssReferences()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getCssReferences</h4>
 <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[]&nbsp;getCssReferences()</pre>
 <div class="block">Returns a list of CSS reference paths or <code>null</code> if no
  additional CSS files are provided by the plugin.
  <p>
  The result is an array of strings which are used as the value of
  the <code>href</code> attribute of the <code>&lt;link&gt;</code> 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 the <a href="../../../../org/apache/felix/webconsole/WebConsoleConstants.html#ATTR_APP_ROOT"><code>WebConsoleConstants.ATTR_APP_ROOT</code></a> request attribute.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>The list of additional CSS files to reference in the head
       section or <code>null</code> if no such CSS files are required.</dd></dl>
 </li>
 </ul>
 <a name="getBundleContext()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getBundleContext</h4>
 <pre>protected&nbsp;org.osgi.framework.BundleContext&nbsp;getBundleContext()</pre>
 <div class="block">Returns the <code>BundleContext</code> with which this plugin has been
  activated. If the plugin has not be activated by calling the
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#activate(org.osgi.framework.BundleContext)"><code>activate(BundleContext)</code></a> method, this method returns
  <code>null</code>.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the bundle context or <code>null</code> if the bundle is not activated.</dd></dl>
 </li>
 </ul>
 <a name="getBundle()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getBundle</h4>
 <pre>public final&nbsp;org.osgi.framework.Bundle&nbsp;getBundle()</pre>
 <div class="block">Returns the <code>Bundle</code> pertaining to the
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundleContext()"><code>bundle context</code></a> with which this plugin has
  been activated. If the plugin has not be activated by calling the
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#activate(org.osgi.framework.BundleContext)"><code>activate(BundleContext)</code></a> method, this method returns
  <code>null</code>.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the bundle or <code>null</code> if the plugin is not activated.</dd></dl>
 </li>
 </ul>
 <a name="getResourceProvider()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getResourceProvider</h4>
 <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;getResourceProvider()</pre>
 <div class="block">Returns the object which might provide resources. The class of this
  object is used to find the <code>getResource</code> method.
  <p>
  This method may be overwritten by extensions. This base class
  implementation returns this instance.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>The resource provider object or <code>null</code> if no
       resources will be provided by this plugin.</dd></dl>
 </li>
 </ul>
 <a name="log(int, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>log</h4>
 <pre>public&nbsp;void&nbsp;log(int&nbsp;level,
        <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message)</pre>
 <div class="block">Calls the <code>ServletContext.log(String)</code> method if the
  configured log level is less than or equal to the given <code>level</code>.
  <p>
  Note, that the <code>level</code> paramter is only used to decide whether
  the <code>GenericServlet.log(String)</code> method is called or not. The
  actual implementation of the <code>GenericServlet.log</code> method is
  outside of the control of this method.
  <p>
  If the servlet has not been initialized yet or has already been destroyed
  the message is printed to stderr.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - The log level at which to log the message</dd><dd><code>message</code> - The message to log</dd></dl>
 </li>
 </ul>
 <a name="log(int, java.lang.String, java.lang.Throwable)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>log</h4>
 <pre>public&nbsp;void&nbsp;log(int&nbsp;level,
        <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;message,
        <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/Throwable.html?is-external=true" title="class or interface in java.lang">Throwable</a>&nbsp;t)</pre>
 <div class="block">Calls the <code>ServletContext.log(String, Throwable)</code> method if
  the configured log level is less than or equal to the given
  <code>level</code>.
  <p>
  Note, that the <code>level</code> paramter is only used to decide whether
  the <code>GenericServlet.log(String, Throwable)</code> method is called
  or not. The actual implementation of the <code>GenericServlet.log</code>
  method is outside of the control of this method.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>level</code> - The log level at which to log the message</dd><dd><code>message</code> - The message to log</dd><dd><code>t</code> - The <code>Throwable</code> to log with the message</dd></dl>
 </li>
 </ul>
 <a name="startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>startResponse</h4>
 <pre>protected&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;startResponse(javax.servlet.http.HttpServletRequest&nbsp;request,
                         javax.servlet.http.HttpServletResponse&nbsp;response)
                              throws <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
 <div class="block">This method is responsible for generating the top heading of the page.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the HTTP request coming from the user</dd><dd><code>response</code> - the HTTP response, where data is rendered</dd>
 <dt><span class="strong">Returns:</span></dt><dd>the writer that was used for generating the response.</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - on I/O error</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#endResponse(java.io.PrintWriter)"><code>endResponse(PrintWriter)</code></a></dd></dl>
 </li>
 </ul>
 <a name="renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>renderTopNavigation</h4>
 <pre>protected&nbsp;void&nbsp;renderTopNavigation(javax.servlet.http.HttpServletRequest&nbsp;request,
                        <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</pre>
 <div class="block">This method is called to generate the top level links with the available plug-ins.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the HTTP request coming from the user</dd><dd><code>pw</code> - the writer, where the HTML data is rendered</dd></dl>
 </li>
 </ul>
 <a name="renderMenu(java.util.Map, java.lang.String, java.io.PrintWriter)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>renderMenu</h4>
 <pre>protected&nbsp;void&nbsp;renderMenu(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&nbsp;menuMap,
               <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;appRoot,
               <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</pre>
 </li>
 </ul>
 <a name="endResponse(java.io.PrintWriter)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>endResponse</h4>
 <pre>protected&nbsp;void&nbsp;endResponse(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a>&nbsp;pw)</pre>
 <div class="block">This method is responsible for generating the footer of the page.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>pw</code> - the writer, where the HTML data is rendered</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"><code>startResponse(HttpServletRequest, HttpServletResponse)</code></a></dd></dl>
 </li>
 </ul>
 <a name="getParameter(javax.servlet.http.HttpServletRequest, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getParameter</h4>
 <pre>public static final&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getParameter(javax.servlet.http.HttpServletRequest&nbsp;request,
                   <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html#getParameter(javax.servlet.http.HttpServletRequest, java.lang.String)"><code>WebConsoleUtil.getParameter(HttpServletRequest, String)</code></a></i></div>
 <div class="block">An utility method, that is used to filter out simple parameter from file
  parameter when multipart transfer encoding is used.

  This method processes the request and sets a request attribute
  <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#ATTR_FILEUPLOAD"><code>ATTR_FILEUPLOAD</code></a>. The attribute value is a <a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a>
  where the key is a String specifying the field name and the value
  is a <code>FileItem</code>.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the HTTP request coming from the user</dd><dd><code>name</code> - the name of the parameter</dd>
 <dt><span class="strong">Returns:</span></dt><dd>if not multipart transfer encoding is used - the value is the
   parameter value or <code>null</code> if not set. If multipart is used,
   and the specified parameter is field - then the value of the parameter
   is returned.</dd></dl>
 </li>
 </ul>
 <a name="sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>sendRedirect</h4>
 <pre>protected&nbsp;void&nbsp;sendRedirect(javax.servlet.http.HttpServletRequest&nbsp;request,
                 javax.servlet.http.HttpServletResponse&nbsp;response,
                 <a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;redirectUrl)
                      throws <a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre>
 <div class="block"><span class="strong">Deprecated.</span>&nbsp;<i>use <a href="../../../../org/apache/felix/webconsole/WebConsoleUtil.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)"><code>WebConsoleUtil.sendRedirect(HttpServletRequest, HttpServletResponse, String)</code></a></i></div>
 <div class="block">Utility method to handle relative redirects.
  Some application servers like Web Sphere handle relative redirects differently
  therefore we should make an absolute URL before invoking send redirect.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>request</code> - the HTTP request coming from the user</dd><dd><code>response</code> - the HTTP response, where data is rendered</dd><dd><code>redirectUrl</code> - the redirect URI.</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code> - If an input or output exception occurs</dd>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - If the response was committed or if a partial
   URL is given and cannot be converted into a valid URL</dd></dl>
 </li>
 </ul>
 <a name="getBrandingPlugin()">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>getBrandingPlugin</h4>
 <pre>public static&nbsp;<a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a>&nbsp;getBrandingPlugin()</pre>
 <div class="block">Returns the <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><code>BrandingPlugin</code></a> currently used for web console
  branding.</div>
 <dl><dt><span class="strong">Returns:</span></dt><dd>the brandingPlugin</dd></dl>
 </li>
 </ul>
 <a name="setBrandingPlugin(org.apache.felix.webconsole.BrandingPlugin)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setBrandingPlugin</h4>
 <pre>public static final&nbsp;void&nbsp;setBrandingPlugin(<a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a>&nbsp;brandingPlugin)</pre>
 <div class="block">Sets the <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><code>BrandingPlugin</code></a> to use globally by all extensions of
  this class for branding.
  <p>
  Note: This method is intended to be used internally by the Web Console
  to update the branding plugin to use.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>brandingPlugin</code> - the brandingPlugin to set</dd></dl>
 </li>
 </ul>
 <a name="setLogLevel(int)">
 <!--   -->
 </a>
 <ul class="blockList">
 <li class="blockList">
 <h4>setLogLevel</h4>
 <pre>public static final&nbsp;void&nbsp;setLogLevel(int&nbsp;logLevel)</pre>
 <div class="block">Sets the log level to be applied for calls to the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String)"><code>log(int, String)</code></a>
  and <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String, java.lang.Throwable)"><code>log(int, String, Throwable)</code></a> methods.
  <p>
  Note: This method is intended to be used internally by the Web Console
  to update the log level according to the Web Console configuration.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>logLevel</code> - the maximum allowed log level. If message is logged with
         lower level it will not be forwarded to the logger.</dd></dl>
 </li>
 </ul>
 <a name="readTemplateFile(java.lang.String)">
 <!--   -->
 </a>
 <ul class="blockListLast">
 <li class="blockList">
 <h4>readTemplateFile</h4>
 <pre>protected final&nbsp;<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;readTemplateFile(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;templateFile)</pre>
 <div class="block">Reads the <code>templateFile</code> as a resource through the class
  loader of this class converting the binary data into a string using
  UTF-8 encoding.
  <p>
  If the template file cannot read into a string and an exception is
  caused, the exception is logged and an empty string returned.</div>
 <dl><dt><span class="strong">Parameters:</span></dt><dd><code>templateFile</code> - The absolute path to the template file to read.</dd>
 <dt><span class="strong">Returns:</span></dt><dd>The contents of the template file as a string or and empty
       string if the template file fails to be read.</dd>
 <dt><span class="strong">Throws:</span></dt>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>templateFile</code> is
       <code>null</code></dd>
 <dd><code><a href="http://docs.oracle.com/javase/1.3/docs/api/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang">RuntimeException</a></code> - if an <code>IOException</code> is thrown reading
       the template file into a string. The exception provides the
       exception thrown as its cause.</dd></dl>
 </li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 </div>
 </div>
 <!-- ========= END OF CLASS DATA ========= -->
 <!-- ======= START OF BOTTOM NAVBAR ====== -->
 <div class="bottomNav"><a name="navbar_bottom">
 <!--   -->
 </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
 <!--   -->
 </a>
 <ul class="navList" title="Navigation">
 <li><a href="../../../../overview-summary.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="navBarCell1Rev">Class</li>
 <li><a href="class-use/AbstractWebConsolePlugin.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html">Help</a></li>
 </ul>
 </div>
 <div class="subNav">
 <ul class="navList">
 <li>Prev Class</li>
 <li><a href="../../../../org/apache/felix/webconsole/AttachmentProvider.html" title="interface in org.apache.felix.webconsole"><span class="strong">Next Class</span></a></li>
 </ul>
 <ul class="navList">
 <li><a href="../../../../index.html?org/apache/felix/webconsole/AbstractWebConsolePlugin.html" target="_top">Frames</a></li>
 <li><a href="AbstractWebConsolePlugin.html" target="_top">No Frames</a></li>
 </ul>
 <ul class="navList" id="allclasses_navbar_bottom">
 <li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
 </ul>
 <div>
 <script type="text/javascript"><!--
   allClassesLink = document.getElementById("allclasses_navbar_bottom");
   if(window==top) {
     allClassesLink.style.display = "block";
   }
   else {
     allClassesLink.style.display = "none";
   }
   //-->
 </script>
 </div>
 <div>
 <ul class="subNavList">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field_summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_summary">Method</a></li>
 </ul>
 <ul class="subNavList">
 <li>Detail:&nbsp;</li>
 <li><a href="#field_detail">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method_detail">Method</a></li>
 </ul>
 </div>
 <a name="skip-navbar_bottom">
 <!--   -->
 </a></div>
 <!-- ======== END OF BOTTOM NAVBAR ======= -->
 <p class="legalCopy"><small>Copyright &#169; 2006&#x2013;2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
 </body>
 </html>