documentation/subprojects/apache-felix-inventory.html - felix-site-pub - Git at Google

 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <title>Apache Felix Inventory Printer :: Apache Felix</title>
     <link rel="canonical" href="https://felix.apache.org/documentation/subprojects/apache-felix-inventory.html">
     <meta name="generator" content="Antora 2.3.4">
     <link rel="stylesheet" href="../../_/css/site.css">
     <link rel="icon" href="../../_/img/favicon.png" type="image/x-icon">
   </head>
   <body class="article">
 <header class="header">
   <nav class="navbar">
     <div class="navbar-brand">
       <a class="navbar-item" href="https://felix.apache.org/index.html">
         <span>
           <img src="../../_/img/logo.png">
         </span>
       </a>
       <button class="navbar-burger" data-target="topbar-nav">
         <span></span>
         <span></span>
         <span></span>
       </button>
     </div>
     <div id="topbar-nav" class="navbar-menu">
       <div class="navbar-end">
         <a class="navbar-item" href="https://felix.apache.org/index.html">Home</a>
         <div class="navbar-item has-dropdown is-hoverable">
           <a class="navbar-link" href="#">Subprojects</a>
           <div class="navbar-dropdown">
             <a class="navbar-item" href="apache-felix-dependency-manager.html">Dependency Manager</a>
             <a class="navbar-item" href="apache-felix-event-admin.html">Event Admin</a>
             <a class="navbar-item" href="apache-felix-file-install.html">File Install</a>
             <a class="navbar-item" href="apache-felix-framework.html">Framework</a>
             <a class="navbar-item" href="apache-felix-gogo.html">Gogo Shell</a>
             <a class="navbar-item" href="apache-felix-healthchecks.html">Health Checks</a>
             <a class="navbar-item" href="apache-felix-inventory.html">Inventory</a>
             <a class="navbar-item" href="apache-felix-log.html">Log</a>
             <a class="navbar-item" href="apache-felix-logback.html">Logback</a>
             <a class="navbar-item" href="apache-felix-maven-bundle-plugin.html">Maven bundle plugin</a>
             <a class="navbar-item" href="apache-felix-maven-scr-plugin.html">Maven SCR plugin</a>
             <a class="navbar-item" href="apache-felix-metatype-service.html">Metatype Service</a>
             <a class="navbar-item" href="apache-felix-preferences-service.html">Preferences Service</a>
             <a class="navbar-item" href="apache-felix-remote-shell.html">Remote Shell</a>
             <a class="navbar-item" href="apache-felix-script-console-plugin.html">Script console plugin</a>
             <a class="navbar-item" href="apache-felix-shell.html">Lightweight shell</a>
             <a class="navbar-item" href="apache-felix-shell-tui.html">Shell TUI</a>
             <a class="navbar-item" href="apache-felix-web-console.html">Web Console</a>
           </div>
         </div>
         <div class="navbar-item">
           <span class="control">
             <a class="button is-primary" href="../downloads.html">Downloads</a>
           </span>
         </div>
       </div>
     </div>
   </nav>
 </header>
 <div class="body">
 <div class="nav-container" data-component="documentation" data-version="master">
   <aside class="nav">
     <div class="panels">
 <div class="nav-panel-menu is-active" data-panel="menu">
   <nav class="nav-menu">
     <h3 class="title"><a href="../index.html">Documentation</a></h3>
 <ul class="nav-list">
   <li class="nav-item" data-depth="0">
 <ul class="nav-list">
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../documentation.html">Documentation</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../downloads.html">Downloads</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../getting-started.html">Getting Started</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../news.html">News</a>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Community</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../community/project-info.html">Apache Felix Project Info</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../community/contributing.html">Contributing</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../community/projects-using-felix.html">Projects Using Felix</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Development</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/coding-standards.html">Coding Standards</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/dependencies-file-template.html">DEPENDENCIES file template</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/provisional-osgi-api-policy.html">Provisional OSGi API Policy</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/release-management-nexus.html">Release Management</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/site-how-to.html">Site How To</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../development/using-the-osgi-compliance-tests.html">Using the OSGi Compliance Tests</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../faqs.html">FAQS</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../faqs/apache-felix-bundle-plugin-faq.html">Apache Felix Bundle Plugin Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../faqs/apache-felix-scr-plugin-faq.html">Apache Felix SCR Plugin Frequently Asked Questions</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../subprojects.html">Subprojects</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="apache-felix-dependency-manager.html">Apache Felix Dependency Manager</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Guides</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/migrating-from-earlier-versions.html">Apache Felix Dependency Manager - Migrating from earlier versions</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/annotations.html">Dependency Manager - Annotations</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/background.html">Dependency Manager - Background</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/bundles-and-dependencies.html">Dependency Manager - Bundles and Dependencies</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/design-patterns.html">Dependency Manager - Design Patterns</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/development.html">Dependency Manager - Development</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/history.html">Dependency Manager - History</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/javadocs.html">Dependency Manager - JavaDocs</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/migrating-from-other-solutions.html">Dependency Manager - Migrating from other solutions.</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/performance-tuning.html">Dependency Manager - Performance Tuning</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/resources.html">Dependency Manager - Resource adapters</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/whatsnew.html">Dependency Manager - What&#8217;s new in version 4?</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/dm-lambda.html">Dependency Manager Lambda</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/guides/whatsnew-r15.html">What&#8217;s New in R15</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Reference</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-adapter.html">Dependency Manager - Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-aspect.html">Dependency Manager - Aspect</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-bundle-adapter.html">Dependency Manager - Bundle Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-bundle.html">Dependency Manager - Bundle Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/components.html">Dependency Manager - Components</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-configuration.html">Dependency Manager - Configuration Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dependencies.html">Dependency Manager - Dependencies</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/external-links.html">Dependency Manager - External Links</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-factory-configuration-adapter.html">Dependency Manager - Factory Configuration Adapter Service</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-resource-adapter.html">Dependency Manager - Resource Adapter</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-resource.html">Dependency Manager - Resource Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dependency-service.html">Dependency Manager - Service Dependency</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/service-scopes.html">Dependency Manager - Service Scopes</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/component-singleton.html">Dependency Manager - Singleton Component</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/thread-model.html">Dependency Manager - Thread Model</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/reference/dm-annotations.html">Dependency Manager Annotations</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Tutorials</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/tutorials/working-with-annotations.html">Dependency Manager - Annotations</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/tutorials/getting-started.html">Dependency Manager - Getting Started</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/tutorials/leveraging-the-shell.html">Dependency Manager - Leveraging the shell</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-dependency-manager/tutorials/sample-code.html">Dependency Manager sample projects</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-event-admin.html">Apache Felix Event Admin</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-file-install.html">Apache Felix File Install</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="apache-felix-framework.html">Apache Felix Framework</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-framework/apache-felix-framework-bundle-cache.html">Apache Felix Framework Bundle Cache</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-framework/apache-felix-framework-configuration-properties.html">Apache Felix Framework Configuration Properties</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-framework/apache-felix-framework-faq.html">Apache Felix Framework Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-framework/apache-felix-framework-launching-and-embedding.html">Apache Felix Framework Launching and Embedding</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-framework/apache-felix-framework-usage-documentation.html">Apache Felix Framework Usage Documentation</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-framework-security.html">Apache Felix Framework Security</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="apache-felix-gogo.html">Apache Felix Gogo</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-gogo/rfc-147-overview.html">RFC 147 Overview</a>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-healthchecks.html">Apache Felix Health Checks</a>
   </li>
   <li class="nav-item is-current-page" data-depth="2">
     <a class="nav-link" href="apache-felix-inventory.html">Apache Felix Inventory Printer</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-log.html">Apache Felix Log</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-logback.html">Apache Felix Logback</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-maven-bundle-plugin-bnd.html">Apache Felix Maven Bundle Plugin (BND)</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-metatype-service.html">Apache Felix Metatype Service</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-osgi-bundle-repository.html">Apache Felix OSGi Bundle Repository (OBR)</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-preferences-service.html">Apache Felix Preferences Service</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-remote-shell.html">Apache Felix Remote Shell</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-shell.html">Apache Felix Shell</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="apache-felix-shell-tui.html">Apache Felix Shell TUI</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="apache-felix-web-console.html">Apache Felix Web Console</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console.html">Extending the Apache Felix Web Console</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-web-console/web-console-restful-api.html">Web Console RESTful API</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="apache-felix-web-console/web-console-security-provider.html">Web Console Security Provider</a>
   </li>
   <li class="nav-item" data-depth="3">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">Extensions</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.html">Branding the Web Console</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.html">Providing Resources</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.html">Providing Web Console Plugins</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.html">Web Console Logging</a>
   </li>
   <li class="nav-item" data-depth="4">
     <a class="nav-link" href="apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.html">Web Console Output Templating</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <button class="nav-item-toggle"></button>
     <a class="nav-link" href="../tutorials-examples-and-presentations.html">Tutorials</a>
 <ul class="nav-list">
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-application-demonstration.html">Apache Felix Application Demonstration</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial.html">Apache Felix OSGi Tutorial</a>
   </li>
   <li class="nav-item" data-depth="2">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-faq.html">OSGi Frequently Asked Questions</a>
   </li>
   <li class="nav-item" data-depth="2">
     <button class="nav-item-toggle"></button>
     <span class="nav-text">OSGI Tutorial</span>
 <ul class="nav-list">
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-1.html">Apache Felix Tutorial Example 1 - Service Event Listener Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2.html">Apache Felix Tutorial Example 2</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-2b.html">Apache Felix Tutorial Example 2b</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-3.html">Apache Felix Tutorial Example 3</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-4.html">Apache Felix Tutorial Example 4</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-5.html">Apache Felix Tutorial Example 5</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-6.html">Example 6 - Spell Checker Service Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-7.html">Example 7 - Spell Checker Client Bundle</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-8.html">Example 8 - Spell Checker Service using Service Binder</a>
   </li>
   <li class="nav-item" data-depth="3">
     <a class="nav-link" href="../tutorials-examples-and-presentations/apache-felix-osgi-tutorial/apache-felix-tutorial-example-9.html">Example 9 - Spell Checker Service using Declarative Services</a>
   </li>
 </ul>
   </li>
 </ul>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../license.html">Apache License 2.0</a>
   </li>
   <li class="nav-item" data-depth="1">
     <a class="nav-link" href="../site-map.html">Site map</a>
   </li>
 </ul>
   </li>
 </ul>
   </nav>
 </div>
 <div class="nav-panel-explore" data-panel="explore">
   <div class="context">
     <span class="title">Documentation</span>
     <span class="version">master</span>
   </div>
   <ul class="components">
     <li class="component is-current">
       <span class="title">Documentation</span>
       <ul class="versions">
         <li class="version is-current is-latest">
           <a href="../index.html">master</a>
         </li>
       </ul>
     </li>
   </ul>
 </div>
     </div>
   </aside>
 </div>
 <main class="article">
 <div class="toolbar" role="navigation">
 <button class="nav-toggle"></button>
   <a href="../index.html" class="home-link"></a>
 <nav class="breadcrumbs" aria-label="breadcrumbs">
   <ul>
     <li><a href="../index.html">Documentation</a></li>
     <li><a href="../subprojects.html">Subprojects</a></li>
     <li><a href="apache-felix-inventory.html">Apache Felix Inventory Printer</a></li>
   </ul>
 </nav>
   <div class="edit-this-page"><a href="https://github.com/apache/felix-antora-site/edit/main/modules/ROOT/pages/subprojects/apache-felix-inventory.adoc">Edit this Page</a></div>
   </div>
   <div class="content">
 <article class="doc">
 <h1 class="page">Apache Felix Inventory Printer</h1>
 <div id="preamble">
 <div class="sectionbody">
 <div class="paragraph">
 <p>The Apache Felix Inventory Printer is a simple and extensible framework to retrieve inventory information about applications running in an OSGi Framework.
 Typical information includes currently installed bundles, their state, available configurations, framework properties, log files etc.</p>
 </div>
 <div class="paragraph">
 <p>Historically the Inventory Printer evolved from the Web Console Configuration Printer framework.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_introduction"><a class="anchor" href="#_introduction"></a>Introduction</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>When trying to find a problem or analyzing the system it would be nice to have a single place to go to and get available information.
 The Apache Felix inventory bundle tries to exactly fill this gap.</p>
 </div>
 <div class="paragraph">
 <p>Originally, the idea started within the Apache Felix WebConsole and it&#8217;s configuration printers - these pluggable printers allowed to view all available status information in a web browser or download this as zip file.
 While this already solves most use cases, tying this general functionality to a web console felt wrong, and that&#8217;s when the inventory module started.</p>
 </div>
 <div class="paragraph">
 <p>The current version of the inventory implementation, registers all available InventoryPrinters (see below) as plugins to the web console as this is still the number one use case.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_requirements"><a class="anchor" href="#_requirements"></a>Requirements</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>In and of itself the Apache Felix Inventory Printer module is independent of other modules.</p>
 </div>
 <div class="paragraph">
 <p>To actually get access to the output of Inventory Printer services, though, the Apache Felix Web Console must be installed.</p>
 </div>
 <div class="paragraph">
 <p>In the future <a href="#_integration_with_the_apache_felix_gogo_shell">Integration with the Apache Felix Gogo Shell</a> will also be provided in which case the Apache Felix Gogo Shell must be installed.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_inventory_printer_services"><a class="anchor" href="#_inventory_printer_services"></a>Inventory Printer Services</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Inventory Printer Services are registered as <code>org.apache.felix.inventory.InventoryPrinter</code> type OSGi services with the following service registration properties:</p>
 </div>
 <table class="tableblock frame-all grid-all stretch">
 <colgroup>
 <col style="width: 33.3333%;">
 <col style="width: 33.3333%;">
 <col style="width: 33.3334%;">
 </colgroup>
 <thead>
 <tr>
 <th class="tableblock halign-left valign-top">Property</th>
 <th class="tableblock halign-left valign-top">Default Value</th>
 <th class="tableblock halign-left valign-top">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.inventory.printer.name</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The unique name of the printer.
 If there are two or more services with the same name, the service with the highest ranking is used.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.inventory.printer.title</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The title displayed by tools when this printer is used.
 It should be descriptive but short.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.inventory.printer.format</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The property defining the supported rendering formats.
 The value of this property is either a string or a string array containing valid names of <a href="../_attachments/apidocs/inventory/1.0.0/org/apache/felix/inventory/Format.html"><code>Format</code></a>.
 If this property is missing or contains invalid values, the printer is ignored.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.inventory.printer.webconsole</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>true</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Optional property controlling whether the printer will be displayed in the web console.
 By default, a printer is displayed in the web console, unless this property is added with the value 'false'.
 The property value can either be a boolean or a string.</p></td>
 </tr>
 </tbody>
 </table>
 <div class="paragraph">
 <p>The first three properties are required for the Inventory Printer service to be accepted.
 Otherwise the service is ignored by the framework printing a message to the log.</p>
 </div>
 <div class="paragraph">
 <p>To prevent bundle resolution failure if the <code>InventoryPrinter</code> API is not available in the framework it is suggested to register the Inventory Printer services as service factories and dynamically import the API.
 See the question <a href="../tutorials-examples-and-presentations/apache-felix-osgi-faq.html#_how_to_provide_optional_services" class="page">How to provide optional services?</a> in the Apache Felix OSGi FAQ for more details.</p>
 </div>
 <div class="sect2">
 <h3 id="_example_inventory_printer_service"><a class="anchor" href="#_example_inventory_printer_service"></a>Example Inventory Printer Service</h3>
 <div class="listingblock">
 <div class="content">
 <pre class="highlightjs highlight"><code class="language-java hljs" data-lang="java"> @Component
  @Service
  @Properties({
      @Property(name = "felix.inventory.printer.name", value = "sample"),
      @Property(name = "felix.inventory.printer.title", value = "This is a Sample"),
      @Property(name = "felix.inventory.printer.format",
                value = { "TEXT", "HTML", "JSON" })
  })
  public class SampleInvetoryPrinter implements InventoryPrinter
  {
      public void print(PrintWriter printWriter, Format format, boolean isZip)
      {
          if (format == Format.JSON)
          {
              printWriter.print("{ \"key\": \"Sample Output\" }");
          }
          else if (format == Format.HTML)
          {
              printWriter.print("&lt;b&gt;Sample Output&lt;/b&gt;");
          }
          else
          {
              printWriter.print("Sample Output");
          }
      }
  }</code></pre>
 </div>
 </div>
 <div class="paragraph">
 <p>See also the <a href="../_attachments/apidocs/inventory/1.0.0/">API JavaDoc</a>.</p>
 </div>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_zip_attachment_provider"><a class="anchor" href="#_zip_attachment_provider"></a>ZIP Attachment Provider</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>If an Inventory Printer wants to provide additional contents to an Inventory ZIP File, it can implement the <a href="/apidocs/inventory/1.0.0/org/apache/felix/inventory/ZipAttachmentProvider.html">ZipAttachmentProvider</a> interface and provide additional files when the zip is created.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_configuration_printer_services"><a class="anchor" href="#_configuration_printer_services"></a>Configuration Printer Services</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>For backwards compatibility the Inventory Printer framework also supports legacy Apache Felix Web Console <code>ConfigurationPrinter</code> services.</p>
 </div>
 <div class="paragraph">
 <p>Configuration Printer services are wrapped in an <code>InventoryPrinter</code> adapter and re-registered as Inventory Printer services.
 Thus they are registered with the Web Console or the Gogo Shell as if the Configuration Printer would be an Inventory Printer.</p>
 </div>
 <div class="paragraph">
 <p>Configuration Printer Services are registered as <code>org.apache.felix.webconsole.ConfigurationPrinter</code> type OSGi services with the following service registration properties:</p>
 </div>
 <table class="tableblock frame-all grid-all stretch">
 <colgroup>
 <col style="width: 33.3333%;">
 <col style="width: 33.3333%;">
 <col style="width: 33.3334%;">
 </colgroup>
 <thead>
 <tr>
 <th class="tableblock halign-left valign-top">Property</th>
 <th class="tableblock halign-left valign-top">Default Value</th>
 <th class="tableblock halign-left valign-top">Description</th>
 </tr>
 </thead>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.webconsole.title</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The title under which to display the Configuration Printer</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.webconsole.configprinter.modes</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The Configuration Printer modes supported.
 This may be one or more of the values <code>web</code>, <code>zip</code>, or <code>txt</code>.
 Alternatively the value <code>always</code> my be used to indicate support for all modes.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>modes</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">&#8201;&#8212;&#8201;</p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Deprecated synonym for the <code>felix.webconsole.configprinter.modes</code> property.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>felix.webconsole.configprinter.web.unescaped</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>false</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">Property indicating whether output generated in <code>web</code> mode is HTML (<code>true</code>) or plain text to be escaped for web rendering (<code>false</code>).</p></td>
 </tr>
 </tbody>
 </table>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_integration_with_the_apache_felix_web_console"><a class="anchor" href="#_integration_with_the_apache_felix_web_console"></a>Integration with the Apache Felix Web Console</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>The Inventory Printer framework has first class integration with the Apache Felix Web Console.
 Each <code>InventoryPrinter</code> service is registered as a plugin in the <code>Inventory</code> category of the Web Console.</p>
 </div>
 <div class="paragraph">
 <p>To prevent an Invetory Printer from being registered in the Web Console, the <code>felix.inventory.printer.webconsole</code> service registration property must be set to <code>false</code>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_integration_with_the_apache_felix_gogo_shell"><a class="anchor" href="#_integration_with_the_apache_felix_gogo_shell"></a>Integration with the Apache Felix Gogo Shell</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Gogo Shell integration is not implemented in the first version of the Apache Felix Inventory Printer module.</p>
 </div>
 <div class="paragraph">
 <p>See the issue <a href="https://issues.apache.org/jira/browse/FELIX-4065">FELIX-4065 Provide Gogo Shell integration for InventoryPrinter services</a>.</p>
 </div>
 </div>
 </div>
 <div class="sect1">
 <h2 id="_issues"><a class="anchor" href="#_issues"></a>Issues</h2>
 <div class="sectionbody">
 <div class="paragraph">
 <p>Should you have any questions using the Inventory Printer, please send a note to one of our link:{{ refs.mailinglists.path }}[Mailing Lists].</p>
 </div>
 <div class="paragraph">
 <p>Please report any issues with the Inventory Printer in our issue tracking system (<a href="https://issues.apache.org/jira/browse/Felix">JIRA</a>) and be sure to report for the <em>Inventory</em> component.
 See our link:{{ refs.issue-tracking.path }}[Issue Tracking] page for more details.</p>
 </div>
 </div>
 </div>
 </article>
 <aside class="toc sidebar" data-title="Contents" data-levels="2">
   <div class="toc-menu"></div>
 </aside>
   </div>
 </main>
 </div>
 <footer class="footer">
   <p>Content licensed under AL2. UI licensed under MPL-2.0 with extensions licensed under AL2</p>
 </footer>
 <script src="../../_/js/site.js"></script>
 <script async src="../../_/js/vendor/highlight.js"></script>
   </body>
 </html>