| <!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>SimpleWebConsolePlugin (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="SimpleWebConsolePlugin (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/SimpleWebConsolePlugin.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><a href="../../../../org/apache/felix/webconsole/ModeAwareConfigurationPrinter.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/VariableResolver.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/SimpleWebConsolePlugin.html" target="_top">Frames</a></li> |
| <li><a href="SimpleWebConsolePlugin.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="#fields_inherited_from_class_org.apache.felix.webconsole.AbstractWebConsolePlugin">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>Field | </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 SimpleWebConsolePlugin" class="title">Class SimpleWebConsolePlugin</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><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">org.apache.felix.webconsole.AbstractWebConsolePlugin</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.felix.webconsole.SimpleWebConsolePlugin</li> |
| </ul> |
| </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> |
| <hr> |
| <br> |
| <pre>public abstract class <span class="strong">SimpleWebConsolePlugin</span> |
| extends <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></pre> |
| <div class="block">SimpleWebConsolePlugin is an utility class that provides default |
| implementation of the <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a> and supports the |
| following features: |
| <ul> |
| <li>Methods for (un)registering the web console plugin service</li> |
| <li>Default implementation for resource loading</li> |
| </ul></div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../serialized-form.html#org.apache.felix.webconsole.SimpleWebConsolePlugin">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> |
| <ul class="blockList"> |
| <li class="blockList"><a name="fields_inherited_from_class_org.apache.felix.webconsole.AbstractWebConsolePlugin"> |
| <!-- --> |
| </a> |
| <h3>Fields inherited from class org.apache.felix.webconsole.<a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></h3> |
| <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#ATTR_FILEUPLOAD">ATTR_FILEUPLOAD</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#GET_RESOURCE_METHOD_NAME">GET_RESOURCE_METHOD_NAME</a></code></li> |
| </ul> |
| </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/SimpleWebConsolePlugin.html#SimpleWebConsolePlugin(java.lang.String, java.lang.String, java.lang.String[])">SimpleWebConsolePlugin</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> label, |
| <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> title, |
| <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>[] css)</code> |
| <div class="block">Creates new Simple Web Console Plugin with the default category |
| (<code>null</code>)</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colOne"><code><strong><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#SimpleWebConsolePlugin(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])">SimpleWebConsolePlugin</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> label, |
| <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> title, |
| <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> category, |
| <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>[] css)</code> |
| <div class="block">Creates new Simple Web Console Plugin with the given category.</div> |
| </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/SimpleWebConsolePlugin.html#deactivate()">deactivate</a></strong>()</code> |
| <div class="block">This method will close all service trackers, created by |
| <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#getService(java.lang.String)"><code>getService(String)</code></a> method.</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/SimpleWebConsolePlugin.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/SimpleWebConsolePlugin.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><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/SimpleWebConsolePlugin.html#getLabel()">getLabel</a></strong>()</code> |
| <div class="block">Retrieves the label.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#getResource(java.lang.String)">getResource</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> path)</code> |
| <div class="block">Called internally by <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a> to load resources.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><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/SimpleWebConsolePlugin.html#getService(java.lang.String)">getService</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> serviceName)</code> |
| <div class="block">Gets the service with the specified class name.</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/SimpleWebConsolePlugin.html#getTitle()">getTitle</a></strong>()</code> |
| <div class="block">Retrieves the title of the plug-in.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html" title="class in org.apache.felix.webconsole">SimpleWebConsolePlugin</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#register(org.osgi.framework.BundleContext)">register</a></strong>(org.osgi.framework.BundleContext bc)</code> |
| <div class="block">This is an utility method.</div> |
| </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#unregister()">unregister</a></strong>()</code> |
| <div class="block">An utility method that removes the service, registered by the |
| <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#register(org.osgi.framework.BundleContext)"><code>register(BundleContext)</code></a> method.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_org.apache.felix.webconsole.AbstractWebConsolePlugin"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.felix.webconsole.<a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></h3> |
| <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#activate(org.osgi.framework.BundleContext)">activate</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#doGet(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">doGet</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#endResponse(java.io.PrintWriter)">endResponse</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBrandingPlugin()">getBrandingPlugin</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundle()">getBundle</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getBundleContext()">getBundleContext</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getParameter(javax.servlet.http.HttpServletRequest, java.lang.String)">getParameter</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getResourceProvider()">getResourceProvider</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getServletName()">getServletName</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#isHtmlRequest(javax.servlet.http.HttpServletRequest)">isHtmlRequest</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String)">log</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#log(int, java.lang.String, java.lang.Throwable)">log</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#readTemplateFile(java.lang.String)">readTemplateFile</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderContent(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">renderContent</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderMenu(java.util.Map, java.lang.String, java.io.PrintWriter)">renderMenu</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)">renderTopNavigation</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#sendRedirect(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse, java.lang.String)">sendRedirect</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#setBrandingPlugin(org.apache.felix.webconsole.BrandingPlugin)">setBrandingPlugin</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#setLogLevel(int)">setLogLevel</a>, <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#startResponse(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)">startResponse</a></code></li> |
| </ul> |
| <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/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"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor_detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="SimpleWebConsolePlugin(java.lang.String, java.lang.String, java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SimpleWebConsolePlugin</h4> |
| <pre>public SimpleWebConsolePlugin(<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> label, |
| <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> title, |
| <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>[] css)</pre> |
| <div class="block">Creates new Simple Web Console Plugin with the default category |
| (<code>null</code>)</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the front label. See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()"><code>AbstractWebConsolePlugin.getLabel()</code></a></dd><dd><code>title</code> - the plugin title . See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()"><code>AbstractWebConsolePlugin.getTitle()</code></a></dd><dd><code>css</code> - the additional plugin CSS. See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()"><code>AbstractWebConsolePlugin.getCssReferences()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="SimpleWebConsolePlugin(java.lang.String, java.lang.String, java.lang.String, java.lang.String[])"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>SimpleWebConsolePlugin</h4> |
| <pre>public SimpleWebConsolePlugin(<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> label, |
| <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> title, |
| <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> category, |
| <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>[] css)</pre> |
| <div class="block">Creates new Simple Web Console Plugin with the given category.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>label</code> - the front label. See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()"><code>AbstractWebConsolePlugin.getLabel()</code></a></dd><dd><code>title</code> - the plugin title . See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()"><code>AbstractWebConsolePlugin.getTitle()</code></a></dd><dd><code>category</code> - the plugin's navigation category. See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCategory()"><code>AbstractWebConsolePlugin.getCategory()</code></a></dd><dd><code>css</code> - the additional plugin CSS. See |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()"><code>AbstractWebConsolePlugin.getCssReferences()</code></a></dd></dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getLabel()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getLabel</h4> |
| <pre>public final <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> getLabel()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()">AbstractWebConsolePlugin</a></code></strong></div> |
| <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.AbstractWebConsolePlugin()</code></a> |
| constructor is used.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()">getLabel</a></code> in class <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the label.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getLabel()"><code>AbstractWebConsolePlugin.getLabel()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getTitle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTitle</h4> |
| <pre>public final <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> getTitle()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()">AbstractWebConsolePlugin</a></code></strong></div> |
| <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.AbstractWebConsolePlugin()</code></a> |
| constructor is used.</div> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()">getTitle</a></code> in class <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the plugin title.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getTitle()"><code>AbstractWebConsolePlugin.getTitle()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCategory()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCategory</h4> |
| <pre>public <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> getCategory()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCategory()">AbstractWebConsolePlugin</a></code></strong></div> |
| <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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCategory()">getCategory</a></code> in class <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></code></dd> |
| <dt><span class="strong">Returns:</span></dt><dd>category</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCategory()"><code>AbstractWebConsolePlugin.getCategory()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getCssReferences()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCssReferences</h4> |
| <pre>protected final <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>[] getCssReferences()</pre> |
| <div class="block"><strong>Description copied from class: <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()">AbstractWebConsolePlugin</a></code></strong></div> |
| <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><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()">getCssReferences</a></code> in class <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></code></dd> |
| <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><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()"><code>AbstractWebConsolePlugin.getCssReferences()</code></a></dd></dl> |
| </li> |
| </ul> |
| <a name="getResource(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getResource</h4> |
| <pre>protected <a href="http://docs.oracle.com/javase/1.3/docs/api/java/net/URL.html?is-external=true" title="class or interface in java.net">URL</a> getResource(<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> path)</pre> |
| <div class="block">Called internally by <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a> to load resources. |
| |
| This particular implementation depends on the label. As example, if the |
| plugin is accessed as <code>/system/console/abc</code>, and the plugin |
| resources are accessed like <code>/system/console/abc/res/logo.gif</code>, |
| the code here will try load resource <code>/res/logo.gif</code> from the |
| bundle, providing the plugin.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>path</code> - the path to read.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the URL of the resource or <code>null</code> if not found.</dd></dl> |
| </li> |
| </ul> |
| <a name="register(org.osgi.framework.BundleContext)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>register</h4> |
| <pre>public final <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html" title="class in org.apache.felix.webconsole">SimpleWebConsolePlugin</a> register(org.osgi.framework.BundleContext bc)</pre> |
| <div class="block">This is an utility method. It is used to register the plugin service. Don't |
| forget to call the <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#unregister()"><code>unregister()</code></a> when the plugin is no longer |
| needed.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bc</code> - the bundle context used for service registration.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>self</dd></dl> |
| </li> |
| </ul> |
| <a name="unregister()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>unregister</h4> |
| <pre>public final void unregister()</pre> |
| <div class="block">An utility method that removes the service, registered by the |
| <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#register(org.osgi.framework.BundleContext)"><code>register(BundleContext)</code></a> method.</div> |
| </li> |
| </ul> |
| <a name="getService(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getService</h4> |
| <pre>public final <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> getService(<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> serviceName)</pre> |
| <div class="block">Gets the service with the specified class name. Will create a new |
| <code>ServiceTracker</code> if the service is not already got.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>serviceName</code> - the service name to obtain</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the service or <code>null</code> if missing.</dd></dl> |
| </li> |
| </ul> |
| <a name="deactivate()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>deactivate</h4> |
| <pre>public void deactivate()</pre> |
| <div class="block">This method will close all service trackers, created by |
| <a href="../../../../org/apache/felix/webconsole/SimpleWebConsolePlugin.html#getService(java.lang.String)"><code>getService(String)</code></a> method. If you override this method, don't |
| forget to call the super.</div> |
| <dl> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#deactivate()">deactivate</a></code> in class <code><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole">AbstractWebConsolePlugin</a></code></dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#deactivate()"><code>AbstractWebConsolePlugin.deactivate()</code></a></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/SimpleWebConsolePlugin.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><a href="../../../../org/apache/felix/webconsole/ModeAwareConfigurationPrinter.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/VariableResolver.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/SimpleWebConsolePlugin.html" target="_top">Frames</a></li> |
| <li><a href="SimpleWebConsolePlugin.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="#fields_inherited_from_class_org.apache.felix.webconsole.AbstractWebConsolePlugin">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>Field | </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> |
