| <!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>BundleInfoProvider (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="BundleInfoProvider (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/BundleInfoProvider.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/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfoType.html" title="class in org.apache.felix.webconsole.bundleinfo"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/webconsole/bundleinfo/BundleInfoProvider.html" target="_top">Frames</a></li> |
| <li><a href="BundleInfoProvider.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.bundleinfo</div> |
| <h2 title="Interface BundleInfoProvider" class="title">Interface BundleInfoProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="strong">BundleInfoProvider</span></pre> |
| <div class="block">The bundle info provider allows the user to supply additional information |
| that will be used by the Web Console bundle plugin. |
| |
| The API allows the user to register a special service, that could bind a |
| custom, implementation-specific information to a bundle. |
| |
| A typical use-case for that API would be the Declarative Services, that could |
| provide information about the components provided by this bundle (and link to |
| the component plugin too). Another usage could be the ProSyst resource |
| manager, that would provide information about the memory and CPU usage of the |
| bundle.</div> |
| <dl><dt><span class="strong">Author:</span></dt> |
| <dd>Valentin Valchev</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="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo">BundleInfo</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfoProvider.html#NO_INFO">NO_INFO</a></strong></code> |
| <div class="block">This is just an utility - empty array, that could be returned when there |
| is no additional information for a specific bundle.</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="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo">BundleInfo</a>[]</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfoProvider.html#getBundleInfo(org.osgi.framework.Bundle, java.lang.String, java.util.Locale)">getBundleInfo</a></strong>(org.osgi.framework.Bundle bundle, |
| <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> webConsoleRoot, |
| <a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code> |
| <div class="block">Gets the associated bundle information with the specified bundle (by it's |
| ID) |
| |
| The Service may also be called outside through the new Inventory bundle |
| due to mapping the BundlesServlet to an InventoryPrinter and for example |
| calling it from a Gogo Shell.</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/bundleinfo/BundleInfoProvider.html#getName(java.util.Locale)">getName</a></strong>(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</code> |
| <div class="block">Gets the name of the bundle info provider as localized string.</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="NO_INFO"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>NO_INFO</h4> |
| <pre>static final <a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo">BundleInfo</a>[] NO_INFO</pre> |
| <div class="block">This is just an utility - empty array, that could be returned when there |
| is no additional information for a specific bundle.</div> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getName(java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getName</h4> |
| <pre><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> getName(<a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre> |
| <div class="block">Gets the name of the bundle info provider as localized string.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>locale</code> - the locale in which the name should be returned</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>the name of the bundle info provider.</dd></dl> |
| </li> |
| </ul> |
| <a name="getBundleInfo(org.osgi.framework.Bundle, java.lang.String, java.util.Locale)"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getBundleInfo</h4> |
| <pre><a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo">BundleInfo</a>[] getBundleInfo(org.osgi.framework.Bundle bundle, |
| <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> webConsoleRoot, |
| <a href="http://docs.oracle.com/javase/1.3/docs/api/java/util/Locale.html?is-external=true" title="class or interface in java.util">Locale</a> locale)</pre> |
| <div class="block">Gets the associated bundle information with the specified bundle (by it's |
| ID) |
| |
| The Service may also be called outside through the new Inventory bundle |
| due to mapping the BundlesServlet to an InventoryPrinter and for example |
| calling it from a Gogo Shell. In this case the <code>webConsoleRoot</code> |
| parameter will be null a <a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo"><code>BundleInfo</code></a> objects of type |
| <a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfoType.html#LINK"><code>BundleInfoType.LINK</code></a> must not be generated.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>bundle</code> - the bundle, for which additional information is requested.</dd><dd><code>webConsoleRoot</code> - the root alias of the web console itself or <code>null</code> |
| if this method is not called through the Web Console itself.</dd><dd><code>locale</code> - the locale in which the key-value pair should be returned.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>array of available <a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo"><code>BundleInfo</code></a> or empty array if none.</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/BundleInfoProvider.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/bundleinfo/BundleInfo.html" title="class in org.apache.felix.webconsole.bundleinfo"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/felix/webconsole/bundleinfo/BundleInfoType.html" title="class in org.apache.felix.webconsole.bundleinfo"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/felix/webconsole/bundleinfo/BundleInfoProvider.html" target="_top">Frames</a></li> |
| <li><a href="BundleInfoProvider.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> |
