| <!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>WebConsoleConstants (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="WebConsoleConstants (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/WebConsoleConstants.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/DefaultBrandingPlugin.html" title="class in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/WebConsoleConstants.html" target="_top">Frames</a></li> |
| <li><a href="WebConsoleConstants.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>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</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="Interface WebConsoleConstants" class="title">Interface WebConsoleConstants</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">WebConsoleConstants</span></pre> |
| </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/WebConsoleConstants.html#ATTR_APP_ROOT">ATTR_APP_ROOT</a></strong></code> |
| <div class="block">The name of the request attribute providing the absolute path of the |
| Web Console root (value is "felix.webconsole.appRoot").</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/WebConsoleConstants.html#ATTR_LABEL_MAP">ATTR_LABEL_MAP</a></strong></code> |
| <div class="block">The name of the request attribute providing a mapping of labels to page |
| titles of registered console plugins (value is "felix.webconsole.labelMap").</div> |
| </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/WebConsoleConstants.html#ATTR_PLUGIN_ROOT">ATTR_PLUGIN_ROOT</a></strong></code> |
| <div class="block">The name of the request attribute providing the absolute path of the |
| current plugin (value is "felix.webconsole.pluginRoot").</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/WebConsoleConstants.html#PLUGIN_CSS_REFERENCES">PLUGIN_CSS_REFERENCES</a></strong></code> |
| <div class="block">The name of the service registration properties providing references |
| to addition CSS files that should be loaded when rendering the header |
| for a registered plugin.</div> |
| </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/WebConsoleConstants.html#PLUGIN_LABEL">PLUGIN_LABEL</a></strong></code> |
| <div class="block">The URI address label under which the OSGi Manager plugin is called by |
| the OSGi Manager (value is "felix.webconsole.label").</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/WebConsoleConstants.html#PLUGIN_TITLE">PLUGIN_TITLE</a></strong></code> |
| <div class="block">The title under which the OSGi Manager plugin is called by |
| the OSGi Manager (value is "felix.webconsole.label").</div> |
| </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/WebConsoleConstants.html#SERVICE_NAME">SERVICE_NAME</a></strong></code> |
| <div class="block">The name of the service to register as to be used as a "plugin" for |
| the OSGi Manager (value is "javax.servlet.Servlet").</div> |
| </td> |
| </tr> |
| </table> |
| </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="SERVICE_NAME"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE_NAME</h4> |
| <pre>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> SERVICE_NAME</pre> |
| <div class="block">The name of the service to register as to be used as a "plugin" for |
| the OSGi Manager (value is "javax.servlet.Servlet").</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.SERVICE_NAME">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PLUGIN_LABEL"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PLUGIN_LABEL</h4> |
| <pre>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> PLUGIN_LABEL</pre> |
| <div class="block">The URI address label under which the OSGi Manager plugin is called by |
| the OSGi Manager (value is "felix.webconsole.label"). |
| <p> |
| This service registration property must be set to a single non-empty |
| String value. Otherwise the <a href="../../../../org/apache/felix/webconsole/WebConsoleConstants.html#SERVICE_NAME"><code>Servlet</code></a> services will |
| be ignored by the Felix Web Console and not be used as a plugin.</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.PLUGIN_LABEL">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PLUGIN_TITLE"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PLUGIN_TITLE</h4> |
| <pre>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> PLUGIN_TITLE</pre> |
| <div class="block">The title under which the OSGi Manager plugin is called by |
| the OSGi Manager (value is "felix.webconsole.label"). |
| <p> |
| For <a href="../../../../org/apache/felix/webconsole/WebConsoleConstants.html#SERVICE_NAME"><code>Servlet</code></a> services not extending the |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a> this property is required for the |
| service to be used as a plugin. Otherwise the service is just ignored |
| by the Felix Web Console.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.PLUGIN_TITLE">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PLUGIN_CSS_REFERENCES"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>PLUGIN_CSS_REFERENCES</h4> |
| <pre>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> PLUGIN_CSS_REFERENCES</pre> |
| <div class="block">The name of the service registration properties providing references |
| to addition CSS files that should be loaded when rendering the header |
| for a registered plugin. |
| <p> |
| This property is expected to be a single string value, array of string |
| values or a Collection (or Vector) of string values. |
| <p> |
| This service registration property is only used for plugins registered |
| as <a href="../../../../org/apache/felix/webconsole/WebConsoleConstants.html#SERVICE_NAME"><code>SERVICE_NAME</code></a> services which do not extend the |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a>. Extensions of the |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html" title="class in org.apache.felix.webconsole"><code>AbstractWebConsolePlugin</code></a> should overwrite the |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#getCssReferences()"><code>AbstractWebConsolePlugin.getCssReferences()</code></a> method to provide |
| additional CSS resources.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.PLUGIN_CSS_REFERENCES">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ATTR_APP_ROOT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ATTR_APP_ROOT</h4> |
| <pre>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_APP_ROOT</pre> |
| <div class="block">The name of the request attribute providing the absolute path of the |
| Web Console root (value is "felix.webconsole.appRoot"). This consists of |
| the servlet context path (from <code>HttpServletRequest.getContextPath()</code>) |
| and the Web Console servlet path (from |
| <code>HttpServletRequest.getServletPath()</code>, |
| <code>/system/console</code> by default). |
| <p> |
| The type of this request attribute is <code>String</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.ATTR_APP_ROOT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ATTR_PLUGIN_ROOT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>ATTR_PLUGIN_ROOT</h4> |
| <pre>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_PLUGIN_ROOT</pre> |
| <div class="block">The name of the request attribute providing the absolute path of the |
| current plugin (value is "felix.webconsole.pluginRoot"). This consists of |
| the servlet context path (from <code>ServletRequest.getContextPath()</code>), |
| the configured path of the web console root (<code>/system/console</code> |
| by default) and the plugin label <a href="../../../../org/apache/felix/webconsole/WebConsoleConstants.html#PLUGIN_LABEL"><code>PLUGIN_LABEL</code></a>. |
| <p> |
| The type of this request attribute is <code>String</code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>1.2.12</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.ATTR_PLUGIN_ROOT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="ATTR_LABEL_MAP"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>ATTR_LABEL_MAP</h4> |
| <pre>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_LABEL_MAP</pre> |
| <div class="block">The name of the request attribute providing a mapping of labels to page |
| titles of registered console plugins (value is "felix.webconsole.labelMap"). |
| This map may be used to render a navigation of the console plugins as the |
| <a href="../../../../org/apache/felix/webconsole/AbstractWebConsolePlugin.html#renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)"><code>AbstractWebConsolePlugin.renderTopNavigation(javax.servlet.http.HttpServletRequest, java.io.PrintWriter)</code></a> |
| method does. |
| <p> |
| The type of this request attribute is <code>Map<String, String></code>.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>2.0.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.WebConsoleConstants.ATTR_LABEL_MAP">Constant Field Values</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="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/WebConsoleConstants.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/DefaultBrandingPlugin.html" title="class in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../index.html?org/apache/felix/webconsole/WebConsoleConstants.html" target="_top">Frames</a></li> |
| <li><a href="WebConsoleConstants.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>Constr | </li> |
| <li>Method</li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li>Method</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> |
