| <!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html><head> |
| |
| |
| |
| <title>Apache Felix - Configuration Handler</title> |
| <link rel="stylesheet" href="configuration-handler_files/site.css" type="text/css" media="all"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| </head><body> |
| <div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="configuration-handler_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="configuration-handler_files/apache.png" border="0"></a></div></div> |
| <div class="menu"> |
| <ul> |
| <li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li> |
| <li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li> |
| <li><span class="nobr"><a href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li> |
| <li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li> |
| <li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li> |
| <li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li> |
| <li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li> |
| <li><span class="nobr"><a href="http://www.apache.org/foundation/sponsorship.html" title="Visit page outside Confluence" rel="nofollow">sponsorship<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li> |
| <li><span class="nobr"><a href="http://www.apache.org/foundation/thanks.html" title="Visit page outside Confluence" rel="nofollow">sponsors<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span> |
| <!-- ApacheCon Ad --> |
| <iframe src="configuration-handler_files/button.html" style="border-width: 0pt; float: left;" scrolling="no" width="135" frameborder="0" height="135"></iframe> |
| <p style="height: 100px;"> |
| <!-- ApacheCon Ad --> |
| </p></li></ul> </div> |
| <div class="main"> |
| <table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr> |
| <td class="confluenceTd" valign="top" width="80%"> |
| <h1><a name="ConfigurationHandler-ConfigurationHandler"></a>Configuration Handler</h1> |
| |
| <p>The configuration handler aims to manage component configuration. |
| This handler allows the configuration and dynamic reconfiguration of |
| instances. A configuration is a set of couple (name, value). The name |
| can be a field name or a property name associated to a field or/and a |
| method.</p> |
| |
| <h2><a name="ConfigurationHandler-ConfigurablePropertyconfiguration"></a>Configurable Property configuration</h2> |
| |
| <p>To support configuration, the component type needs to declare which |
| properties are configurable. These properties are not necessarily |
| service property but can be internal component property.</p> |
| |
| |
| <h2><a name="ConfigurationHandler-Examples"></a>Examples</h2> |
| |
| <div class="code"><div class="codeContent"> |
| <pre class="code-xml"><span class="code-tag"><iPOJO></span> |
| <span class="code-tag"><Component className=<span class="code-quote">"fr.imag.adele.escoffier.hello.impl.HelloServiceImpl"</span>></span> |
| <span class="code-tag"><Provides></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"foo"</span> field=<span class="code-quote">"m_foo"</span>/></span> |
| <span class="code-tag"></Provides></span> |
| <span class="code-tag"><Properties propagation=<span class="code-quote">"false"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"foo"</span> field=<span class="code-quote">"m_foo"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"array"</span> method=<span class="code-quote">"updateArray"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"hello.language"</span> type=<span class="code-quote">"java.lang.String"</span>/></span> |
| <span class="code-tag"></Properties></span> |
| <span class="code-tag"></Component></span> |
| |
| <span class="code-tag"><instance component=<span class="code-quote">"fr.imag.adele.escoffier.hello.impl.HelloServiceImpl"</span> name=<span class="code-quote">"HelloService"</span>></span> |
| <span class="code-tag"><property name=<span class="code-quote">"foo"</span> value=<span class="code-quote">"bar"</span>/></span> |
| <span class="code-tag"><property name=<span class="code-quote">"array"</span> value=<span class="code-quote">"\{1, 2, 3}"</span>/></span> |
| <span class="code-tag"><property name=<span class="code-quote">"hello.language"</span> value=<span class="code-quote">"en"</span>/></span> |
| <span class="code-tag"></instance></span> |
| <span class="code-tag"></iPOJO></span></pre> |
| </div></div> |
| <p>In the previous snippet, you can see three configurable properties. |
| The first is a configurable property attached to the field 'foo' that |
| is a service property too. The second is an array property attached to |
| a method (updatArray). The third property is a <em>static</em> property, in the sense that neither field nor method is attached to this property.</p> |
| |
| <p>These three properties are configured by the instance configuration.</p> |
| |
| <p>By setting the attribute <b>propagation</b> to <b>"true"</b>, you |
| allow the property propagation to the service registration. It means |
| that at each time that the configuration of the instance is updated; |
| all properties contained in the configuration are propagated to the |
| service registrations. For example, in the previous example, not only <em>foo</em> will be published but <em>array</em> and <em>hello.language</em> are also published.<br> |
| If a property has a method, this method is invoked each time that the |
| property value changes (the method is called to push the initial value |
| just after the constructor). The method receives one argument of the |
| type of the property (an integer array in the example).</p> |
| |
| <h2><a name="ConfigurationHandler-ExposingaManagedService"></a>Exposing a Managed Service</h2> |
| <p>The ManagedService is a service specified in the OSGi Compendium. It |
| allows reconfiguring an instance with the Configuration Admin. There is |
| two way for an iPOJO instance to expose a Managed Service.<br> |
| • In the component type description by adding the <em>pid</em> attribute in the properties element <br> |
| • In the instance configuration by configuring the <em>managed.service.pid</em> property</p> |
| <div class="code"><div class="codeContent"> |
| <pre class="code-xml"><span class="code-tag"><iPOJO></span> |
| <span class="code-tag"><Component className=<span class="code-quote">"fr.imag.adele.escoffier.hello.impl.HelloServiceImpl"</span>></span> |
| <span class="code-tag"><Provides></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"foo"</span> field=<span class="code-quote">"m_foo"</span>/></span> |
| <span class="code-tag"></Provides></span> |
| <span class="code-tag"><Properties propagation=<span class="code-quote">"false"</span> pid=<span class="code-quote">"mymanagedservicepid"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"foo"</span> field=<span class="code-quote">"m_foo"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"array"</span> method=<span class="code-quote">"updateArray"</span>/></span> |
| <span class="code-tag"><Property name=<span class="code-quote">"hello.language"</span> type=<span class="code-quote">"java.lang.String"</span>/></span> |
| <span class="code-tag"></Properties></span> |
| <span class="code-tag"></Component></span> |
| |
| <span class="code-tag"><instance component=<span class="code-quote">"fr.imag.adele.escoffier.hello.impl.HelloServiceImpl"</span> name=<span class="code-quote">"HelloService"</span>></span> |
| <span class="code-tag"><property name=<span class="code-quote">"foo"</span> value=<span class="code-quote">"bar"</span>/></span> |
| <span class="code-tag"><property name=<span class="code-quote">"array"</span> value=<span class="code-quote">"\{1, 2, 3}"</span>/></span> |
| <span class="code-tag"><property name=<span class="code-quote">"hello.language"</span> value=<span class="code-quote">"en"</span>/></span> |
| <span class="code-tag"><property name=<span class="code-quote">"managed.service.pid"</span> value=<span class="code-quote">"mymanagedservicepid2"</span>/></span> |
| <span class="code-tag"></instance></span> |
| <span class="code-tag"></iPOJO></span></pre> |
| </div></div> |
| <p><em>Note</em>: if specified in the two locations, the instance configuration is used.</p> |
| |
| <p>The managed service pid is the identifier used by the Configuration |
| Admin to attach configuration to Managed Services. First this pid must |
| be unique (as any pid in OSGi). Moreover, this pid cannot be the same |
| one that the pid used in the Managed Service Factory to create the |
| instance (if you use this way to create your instance).</p> |
| |
| <p>When an instance is reconfigured with the Managed Service, the configuration is propagated if the propagation is enabled.</p> |
| |
| <h2><a name="ConfigurationHandler-DynamicReconfigurationusingFactoriesorManagedServiceFactories"></a>Dynamic Reconfiguration using Factories or ManagedServiceFactories</h2> |
| <p>The handler supports reconfiguration. To reconfigure an instance you |
| can use both iPOJO Factory and the ManagedServiceFactory exposed by the |
| factory of the targeted instance. By calling the method <em>reconfigure</em> or <em>update</em> |
| (according of the service do you use), the handler receive the new |
| configuration and apply it. If the propagation is activated, the |
| service registrations are updated too.</p></td> |
| <td class="confluenceTd" valign="top" width="20%"> |
| <h6><a name="ConfigurationHandler-Overview"></a><b>Overview</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</a></li> |
| <li><a href="http://felix.apache.org/site/download.html" title="Download">Download & Install </a></li> |
| </ul> |
| |
| |
| <h6><a name="ConfigurationHandler-GettingStarted"></a><b>Getting Started</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</a></li> |
| <li><a href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li> |
| </ul> |
| |
| |
| <h6><a name="ConfigurationHandler-UserGuide"></a><b>User Guide</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li> |
| <li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</a></li> |
| </ul> |
| |
| |
| <h6><a name="ConfigurationHandler-Tools"></a><b>Tools</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</a></li> |
| </ul> |
| |
| |
| <h6><a name="ConfigurationHandler-DeveloperGuide"></a><b>Developer Guide</b></h6> |
| <ul> |
| <li>API: <span class="nobr"><a href="http://people.apache.org/%7Eclement/ipojo/api/1.0/" title="Visit page outside Confluence" rel="nofollow">1.0<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li> |
| <li><a href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</a></li> |
| <li><a href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</a></li> |
| <li><a href="http://felix.apache.org/site/dive-into-the-ipojo-manipulation-depths.html" title="Dive into the iPOJO Manipulation depths">Dive into the iPOJO Manipulation depths</a></li> |
| </ul> |
| |
| |
| <h6><a name="ConfigurationHandler-Misc&Contact"></a><b>Misc & Contact</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li> |
| <li><span class="nobr"><a href="http://ipojo-dark-side.blogspot.com/" title="Visit page outside Confluence" rel="nofollow">iPOJO's Dark Side Blog<sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li> |
| <li><a href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</a></li> |
| <li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li> |
| <li><a href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</a></li> |
| <li><a href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</a></li> |
| </ul> |
| |
| |
| <hr> |
| <div class="" align="center"> |
| <p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&statuses=created&statuses=modified&spaces=FELIX&labelString=iPOJO&rssType=atom&maxResults=10&timeSpan=5&publicFeed=true&title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="configuration-handler_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="configuration-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></div> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script><script src="configuration-handler_files/ga.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| var pageTracker = _gat._getTracker("UA-1518442-4"); |
| pageTracker._trackPageview(); |
| </script> |
| </td></tr></tbody></table> |
| </div> |
| </body></html> |
