| <!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:08:52 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>AbstractWebConsolePlugin (Apache Felix Web Management Console 2.0.4 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 2.0.4 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="../../../../org/apache/felix/webconsole/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/Action.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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/7/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/7/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> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">AbstractWebConsolePlugin</span> |
| extends javax.servlet.http.HttpServlet</pre> |
| <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"> </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/7/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 containig 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/7/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> </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"> </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> </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"> </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 bundleContext)</code> </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> </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 request, |
| javax.servlet.http.HttpServletResponse 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/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> pw)</code> </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> </td> |
| </tr> |
| <tr class="rowColor"> |
| <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> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/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/7/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> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/7/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 request, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/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/7/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/7/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> </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 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>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 req, |
| javax.servlet.http.HttpServletResponse res)</code> </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 request, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> pw)</code> </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 request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> redirectUrl)</code> |
| <div class="block">Utility method to handle relative redirects.</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> brandingPlugin)</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/7/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 request, |
| javax.servlet.http.HttpServletResponse response)</code> </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 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 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 java.lang.<a href="http://docs.oracle.com/javase/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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/7/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 <a href="http://docs.oracle.com/javase/7/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 containig 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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> GET_RESOURCE_METHOD_NAME</pre> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><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 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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> 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> in interface <code>javax.servlet.ServletConfig</code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>getServletName</code> in class <code>javax.servlet.GenericServlet</code></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 void doGet(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws javax.servlet.ServletException, |
| <a href="http://docs.oracle.com/javase/7/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.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code>doGet</code> in class <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/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="isHtmlRequest(javax.servlet.http.HttpServletRequest)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isHtmlRequest</h4> |
| <pre>protected boolean isHtmlRequest(javax.servlet.http.HttpServletRequest 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> but has been overwritten in the |
| <code>WebConsolePluginAdapter</code> for the plugins.</div> |
| </li> |
| </ul> |
| <a name="activate(org.osgi.framework.BundleContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>activate</h4> |
| <pre>public void activate(org.osgi.framework.BundleContext bundleContext)</pre> |
| </li> |
| </ul> |
| <a name="deactivate()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>deactivate</h4> |
| <pre>public void deactivate()</pre> |
| </li> |
| </ul> |
| <a name="getTitle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTitle</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getTitle()</pre> |
| </li> |
| </ul> |
| <a name="getLabel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabel</h4> |
| <pre>public abstract <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getLabel()</pre> |
| </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 void renderContent(javax.servlet.http.HttpServletRequest req, |
| javax.servlet.http.HttpServletResponse res) |
| throws javax.servlet.ServletException, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code>javax.servlet.ServletException</code></dd> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getCssReferences()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCssReferences</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>[] 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><link></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 org.osgi.framework.BundleContext getBundleContext()</pre> |
| </li> |
| </ul> |
| <a name="getResourceProvider()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResourceProvider</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> 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="startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>startResponse</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> startResponse(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <dl><dt><span class="strong">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></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 void renderTopNavigation(javax.servlet.http.HttpServletRequest request, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> pw)</pre> |
| </li> |
| </ul> |
| <a name="endResponse(java.io.PrintWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>endResponse</h4> |
| <pre>protected void endResponse(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true" title="class or interface in java.io">PrintWriter</a> pw)</pre> |
| </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 <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getParameter(javax.servlet.http.HttpServletRequest request, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> |
| </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 void sendRedirect(javax.servlet.http.HttpServletRequest request, |
| javax.servlet.http.HttpServletResponse response, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> redirectUrl) |
| throws <a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></pre> |
| <div class="block">Utility method to handle relative redirects. |
| Some app 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">Throws:</span></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</a></code></dd></dl> |
| </li> |
| </ul> |
| <a name="getBrandingPlugin()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getBrandingPlugin</h4> |
| <pre>public static <a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a> getBrandingPlugin()</pre> |
| <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="blockListLast"> |
| <li class="blockList"> |
| <h4>setBrandingPlugin</h4> |
| <pre>public static void setBrandingPlugin(<a href="../../../../org/apache/felix/webconsole/BrandingPlugin.html" title="interface in org.apache.felix.webconsole">BrandingPlugin</a> brandingPlugin)</pre> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>brandingPlugin</code> - the brandingPlugin to set</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="../../../../org/apache/felix/webconsole/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/Action.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: </li> |
| <li>Nested | </li> |
| <li><a href="#field_summary">Field</a> | </li> |
| <li><a href="#constructor_summary">Constr</a> | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li><a href="#constructor_detail">Constr</a> | </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 © 2006–2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |
