| <!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:01 CEST 2013 --> |
| <meta http-equiv="Content-Type" content="text/html" charset="UTF-8"> |
| <title>ConfigurationPrinter (Apache Felix Web Management Console 3.0.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="ConfigurationPrinter (Apache Felix Web Management Console 3.0.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="../../../../org/apache/felix/webconsole/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/ConfigurationPrinter.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/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/DefaultBrandingPlugin.html" title="class 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/ConfigurationPrinter.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationPrinter.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><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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="Interface ConfigurationPrinter" class="title">Interface ConfigurationPrinter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Known Subinterfaces:</dt> |
| <dd><a href="../../../../org/apache/felix/webconsole/ModeAwareConfigurationPrinter.html" title="interface in org.apache.felix.webconsole">ModeAwareConfigurationPrinter</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">ConfigurationPrinter</span></pre> |
| <div class="block">The <code>ConfigurationPrinter</code> is a service interface to be used by |
| providers which want to hook into the display of the current configuration |
| of the OSGi framework. |
| A configuration printer is currently used in three modes: displayed in |
| a tab of the configuration web console plugin, included in a downloadable |
| zip of the configuration or a downloadable txt file. |
| With the <a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#PROPERTY_MODES"><code>PROPERTY_MODES</code></a> property this service can specify when |
| it should be included. The default mode is <a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#MODE_ALWAYS"><code>MODE_ALWAYS</code></a>.</div> |
| </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/ConfigurationPrinter.html#MODE_ALWAYS">MODE_ALWAYS</a></strong></code> |
| <div class="block">The default mode - this printer is used in the web console and the zip.</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/ConfigurationPrinter.html#MODE_TXT">MODE_TXT</a></strong></code> |
| <div class="block">The txt mode - this printer is used in the txt.</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/ConfigurationPrinter.html#MODE_WEB">MODE_WEB</a></strong></code> |
| <div class="block">The web mode - this printer is used in the web console.</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/ConfigurationPrinter.html#MODE_ZIP">MODE_ZIP</a></strong></code> |
| <div class="block">The zip mode - this printer is used in the zip.</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/ConfigurationPrinter.html#PROPERTY_MODES">PROPERTY_MODES</a></strong></code> |
| <div class="block">The optional service property specifying the modes of the printer.</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/ConfigurationPrinter.html#SERVICE">SERVICE</a></strong></code> |
| <div class="block">The service name under which services of this class must be registered |
| to be picked for inclusion in the configuration report.</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><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/ConfigurationPrinter.html#getTitle()">getTitle</a></strong>()</code> |
| <div class="block">Returns a human readable title string to be placed in front of the configuration |
| report generated by the <a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#printConfiguration(java.io.PrintWriter)"><code>printConfiguration(PrintWriter)</code></a> method.</div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><strong><a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#printConfiguration(java.io.PrintWriter)">printConfiguration</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> printWriter)</code> |
| <div class="block">Prints the configuration report to the given <code>printWriter</code>.</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"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>SERVICE</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</pre> |
| <div class="block">The service name under which services of this class must be registered |
| to be picked for inclusion in the configuration report.</div> |
| </li> |
| </ul> |
| <a name="MODE_ALWAYS"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MODE_ALWAYS</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> MODE_ALWAYS</pre> |
| <div class="block">The default mode - this printer is used in the web console and the zip.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.ConfigurationPrinter.MODE_ALWAYS">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MODE_WEB"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MODE_WEB</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> MODE_WEB</pre> |
| <div class="block">The web mode - this printer is used in the web console. |
| since 3.0</div> |
| <dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.ConfigurationPrinter.MODE_WEB">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MODE_ZIP"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MODE_ZIP</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> MODE_ZIP</pre> |
| <div class="block">The zip mode - this printer is used in the zip.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.ConfigurationPrinter.MODE_ZIP">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="MODE_TXT"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>MODE_TXT</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> MODE_TXT</pre> |
| <div class="block">The txt mode - this printer is used in the txt.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.ConfigurationPrinter.MODE_TXT">Constant Field Values</a></dd></dl> |
| </li> |
| </ul> |
| <a name="PROPERTY_MODES"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>PROPERTY_MODES</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> PROPERTY_MODES</pre> |
| <div class="block">The optional service property specifying the modes of the printer. |
| If this property is missing or contains an unknown value, the default |
| <a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#MODE_ALWAYS"><code>MODE_ALWAYS</code></a> is used. |
| The value of this property is either a single string or an |
| array of strings.</div> |
| <dl><dt><span class="strong">Since:</span></dt> |
| <dd>3.0</dd> |
| <dt><span class="strong">See Also:</span></dt><dd><a href="../../../../constant-values.html#org.apache.felix.webconsole.ConfigurationPrinter.PROPERTY_MODES">Constant Field Values</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="getTitle()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getTitle</h4> |
| <pre><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> |
| <div class="block">Returns a human readable title string to be placed in front of the configuration |
| report generated by the <a href="../../../../org/apache/felix/webconsole/ConfigurationPrinter.html#printConfiguration(java.io.PrintWriter)"><code>printConfiguration(PrintWriter)</code></a> method.</div> |
| <dl><dt><span class="strong">Returns:</span></dt><dd>the configuration title</dd></dl> |
| </li> |
| </ul> |
| <a name="printConfiguration(java.io.PrintWriter)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>printConfiguration</h4> |
| <pre>void printConfiguration(<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> printWriter)</pre> |
| <div class="block">Prints the configuration report to the given <code>printWriter</code>. |
| Implementations are free to print whatever information they deem useful.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>printWriter</code> - where to write the configuration data. It might be flushed, |
| but must not be closed.</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/ConfigurationPrinter.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/BrandingPlugin.html" title="interface in org.apache.felix.webconsole"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../org/apache/felix/webconsole/DefaultBrandingPlugin.html" title="class 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/ConfigurationPrinter.html" target="_top">Frames</a></li> |
| <li><a href="ConfigurationPrinter.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><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field_detail">Field</a> | </li> |
| <li>Constr | </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> |
