ipojo/handler/whiteboard/doc/white-board-pattern-handler.html - onos-felix - Gitiles

 <!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 - White Board Pattern Handler</title>
     <link rel="stylesheet" href="white-board-pattern-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="white-board-pattern-handler_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="white-board-pattern-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="white-board-pattern-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="white-board-pattern-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="white-board-pattern-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="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>
 <!-- ApacheCon Ad -->
 <iframe src="white-board-pattern-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="WhiteBoardPatternHandler-Thewhiteboardpatternhandler"></a>The white board pattern handler</h1>
 <p>The objective of this handler is to simplify the development of
 white-board architecture. This architecture-style is based is very
 close to the extender architecture style but use services instead of
 bundles.<br>
 A whiteboard is based on two different roles:</p>
 <ul>
 	<li>A consumer looking to special services or a services published with a special mark</li>
 	<li>Looked services</li>
 </ul>


 <p>More information on this pattern is available in this <span class="nobr"><a href="http://www.osgi.org/wiki/uploads/Links/whiteboard.pdf" title="Visit page outside Confluence" rel="nofollow">document<sup><img class="rendericon" src="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span><br>
 Implementing a white board pattern could be complex as the extender
 needs to track these services dynamically. Indeed looked services can
 be highly dynamic; they can arrive, leave or be modified at runtime.<br>
 Several services specified in the OSGi specification use white board pattern such as the Device Access Manager.</p>

 <p><b>UPDATE</b>: the 1.1.0-SNAPSHOT has a new namespace <tt>org.apache.felix.ipojo.whiteboard</tt> instead of <tt>org.apache.felix.ipojo.white-board-pattern</tt></p>

 <h2><a name="WhiteBoardPatternHandler-Usingthehandler"></a>Using the handler</h2>
 <p>First of all, you need to configure the component type to use the handler such as:</p>
 <div class="code"><div class="codeContent">
 <pre class="code-xml"><span class="code-tag">&lt;ipojo <span class="code-keyword">xmlns:wbp</span>=<span class="code-quote">"org.apache.felix.ipojo.whiteboard"</span>&gt;</span>
      &lt;component
           className=<span class="code-quote">"org.apache.felix.ipojo.test.FooWhiteBoardPattern"</span>
       &gt;
         &lt;wbp:wbp
    	      filter=<span class="code-quote">"(my.property=1)"</span>
               onArrival=<span class="code-quote">"onArrival"</span>
               onDeparture=<span class="code-quote">"onDeparture"</span>
               onModification=<span class="code-quote">"onModification"</span>
          /&gt;

          <span class="code-tag">&lt;provides/&gt;</span>
       <span class="code-tag">&lt;/component&gt;</span></pre>
 </div></div>
 <p>Notice that, this handler is an external handler. So, it uses the "org.apache.felix.ipojo.whiteboard" namespace.<br>
 Once described, you can implement your component. The methods specified
 methods will be called when a matching services arrives or leaves or
 are modified. The modification callback is optional. A matching service
 is detected by confronting the service reference against the specified
 filter.<br>
 The filter can target specific service interface (with the objectclass property) or property values.<br>
 In the previous example, these methods could be: </p>
 <div class="code"><div class="codeContent">
 <pre class="code-java"><span class="code-keyword">public</span> class FooWhiteBoardPattern <span class="code-keyword">implements</span> Observable {
     List list = <span class="code-keyword">new</span> ArrayList();
     <span class="code-object">int</span> modifications = 0;
     <span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onArrival(ServiceReference ref) {
         list.add(ref);
     }
     <span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onDeparture(ServiceReference ref) {
         list.remove(ref);
     }
     <span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onModification(ServiceReference ref) {
         modifications = modifications + 1;
     }
     <span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> Map getObservations() {
         Map map = <span class="code-keyword">new</span> HashMap();
         map.put(<span class="code-quote">"list"</span>, list);
         map.put(<span class="code-quote">"modifications"</span>, <span class="code-keyword">new</span> <span class="code-object">Integer</span>(modifications));
         <span class="code-keyword">return</span> map;
     }</pre>
 </div></div>
 <p>All method received the arriving, leaving or modified service reference.</p>
 <h2><a name="WhiteBoardPatternHandler-Configuration"></a>Configuration</h2>
 <p>The handler has only three mandatory attributes:</p>
 <ul>
 	<li>Filter: filter use to discover matching filter.</li>
 	<li>onArrival: declaring the method to invoke when a matching service arrives</li>
 	<li>onDeparture: declaring the method to invoke when a matching service leaves</li>
 </ul>


 <p>The onModification attribute is optional. This method is called when
 an injected service reference is modified but stills valid against the
 filter.</p>
 <table class="noteMacro" align="center" border="0" cellpadding="5" cellspacing="8" width="85%"><colgroup><col width="24"><col></colgroup><tbody><tr><td valign="top"><img src="white-board-pattern-handler_files/warning.gif" alt="" align="absmiddle" border="0" width="16" height="16"></td><td>
 <p>The implementation will be notified of arrivals, modifications and
 departures, despite the instance is invalid. Indeed, the implementation
 must release all objects created from another bundle as soon it leaves.</p></td></tr></tbody></table>
 <h2><a name="WhiteBoardPatternHandler-Configuringthehandlerwithannotations\Newin1.1.0SNAPSHOT\"></a>Configuring the handler with annotations [New in 1.1.0-SNAPSHOT]</h2>

 <p>It is possible to configure the handler with a simple annotation
 available in the annotation pack ('annotation' project in the iPOJO
 trunk). Here is an example of usage:</p>
 <div class="code"><div class="codeContent">
 <pre class="code-java"><span class="code-keyword">import</span> org.apache.felix.ipojo.annotations.Component;
 <span class="code-keyword">import</span> org.osgi.framework.ServiceReference;

 @Component
 @org.apache.felix.ipojo.whiteboard.Wbp(filter=<span class="code-quote">"(foo=<span class="code-keyword">true</span>)"</span>,
         onArrival=<span class="code-quote">"onArrival"</span>,
         onDeparture=<span class="code-quote">"onDeparture"</span>,
         onModification=<span class="code-quote">"onModification"</span>)
 <span class="code-keyword">public</span> class WhiteBoardExemple {

     <span class="code-keyword">public</span> void onArrival(ServiceReference ref) {
         <span class="code-comment">// <span class="code-keyword">do</span> something
 </span>    }

     <span class="code-keyword">public</span> void onDeparture(ServiceReference ref) {
         <span class="code-comment">// <span class="code-keyword">do</span> something
 </span>    }

     <span class="code-keyword">public</span> void onModification(ServiceReference ref) {
         <span class="code-comment">// <span class="code-keyword">do</span> something
 </span>    }

 }</pre>
 </div></div>

 <p>The <tt>onModification</tt> attribute is optional.The <tt>filter</tt> attribute allows setting the service filter.</p>


 <h2><a name="WhiteBoardPatternHandler-Download"></a>Download</h2>
 <p>The handler is available on the <a href="http://felix.apache.org/site/download.html" title="Download">download</a> page.<br>
 Sources are available on the Felix trunk at the following location: <span class="nobr"><a href="http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/whiteboard" title="Visit page outside Confluence" rel="nofollow">http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/whiteboard<sup><img class="rendericon" src="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></td>
 <td class="confluenceTd" valign="top" width="20%">
 <h6><a name="WhiteBoardPatternHandler-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 &amp; Install </a></li>
 </ul>


 <h6><a name="WhiteBoardPatternHandler-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="WhiteBoardPatternHandler-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>
 	<li><a href="http://felix.apache.org/site/ipojo-reference-card.html" title="iPOJO-Reference-Card">iPOJO Reference Card</a></li>
 </ul>


 <h6><a name="WhiteBoardPatternHandler-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/ipojo-arch-command.html" title="iPOJO-Arch-Command">iPOJO Arch Command</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="WhiteBoardPatternHandler-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="white-board-pattern-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="WhiteBoardPatternHandler-Misc&amp;Contact"></a><b>Misc &amp; 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="white-board-pattern-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 &amp; Presentations">Article &amp; Presentations</a></li>
 </ul>


 <hr>
 <div class="" align="center">
 <p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&amp;statuses=created&amp;statuses=modified&amp;spaces=FELIX&amp;labelString=iPOJO&amp;rssType=atom&amp;maxResults=10&amp;timeSpan=5&amp;publicFeed=true&amp;title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="white-board-pattern-handler_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="white-board-pattern-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="white-board-pattern-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>
	<!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 - White Board Pattern Handler</title>
	<link rel="stylesheet" href="white-board-pattern-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="white-board-pattern-handler_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="white-board-pattern-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="white-board-pattern-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="white-board-pattern-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="white-board-pattern-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="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>
	<!-- ApacheCon Ad -->
	<iframe src="white-board-pattern-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="WhiteBoardPatternHandler-Thewhiteboardpatternhandler"></a>The white board pattern handler</h1>
	<p>The objective of this handler is to simplify the development of
	white-board architecture. This architecture-style is based is very
	close to the extender architecture style but use services instead of
	bundles.<br>
	A whiteboard is based on two different roles:</p>
	<ul>
	<li>A consumer looking to special services or a services published with a special mark</li>
	<li>Looked services</li>
	</ul>


	<p>More information on this pattern is available in this <span class="nobr"><a href="http://www.osgi.org/wiki/uploads/Links/whiteboard.pdf" title="Visit page outside Confluence" rel="nofollow">document<sup><img class="rendericon" src="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span><br>
	Implementing a white board pattern could be complex as the extender
	needs to track these services dynamically. Indeed looked services can
	be highly dynamic; they can arrive, leave or be modified at runtime.<br>
	Several services specified in the OSGi specification use white board pattern such as the Device Access Manager.</p>

	<p><b>UPDATE</b>: the 1.1.0-SNAPSHOT has a new namespace <tt>org.apache.felix.ipojo.whiteboard</tt> instead of <tt>org.apache.felix.ipojo.white-board-pattern</tt></p>

	<h2><a name="WhiteBoardPatternHandler-Usingthehandler"></a>Using the handler</h2>
	<p>First of all, you need to configure the component type to use the handler such as:</p>
	<div class="code"><div class="codeContent">
	<pre class="code-xml"><span class="code-tag"><ipojo <span class="code-keyword">xmlns:wbp</span>=<span class="code-quote">"org.apache.felix.ipojo.whiteboard"</span>></span>
	<component
	className=<span class="code-quote">"org.apache.felix.ipojo.test.FooWhiteBoardPattern"</span>
	>
	<wbp:wbp
	filter=<span class="code-quote">"(my.property=1)"</span>
	onArrival=<span class="code-quote">"onArrival"</span>
	onDeparture=<span class="code-quote">"onDeparture"</span>
	onModification=<span class="code-quote">"onModification"</span>
	/>

	<span class="code-tag"><provides/></span>
	<span class="code-tag"></component></span></pre>
	</div></div>
	<p>Notice that, this handler is an external handler. So, it uses the "org.apache.felix.ipojo.whiteboard" namespace.<br>
	Once described, you can implement your component. The methods specified
	methods will be called when a matching services arrives or leaves or
	are modified. The modification callback is optional. A matching service
	is detected by confronting the service reference against the specified
	filter.<br>
	The filter can target specific service interface (with the objectclass property) or property values.<br>
	In the previous example, these methods could be: </p>
	<div class="code"><div class="codeContent">
	<pre class="code-java"><span class="code-keyword">public</span> class FooWhiteBoardPattern <span class="code-keyword">implements</span> Observable {
	List list = <span class="code-keyword">new</span> ArrayList();
	<span class="code-object">int</span> modifications = 0;
	<span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onArrival(ServiceReference ref) {
	list.add(ref);
	}
	<span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onDeparture(ServiceReference ref) {
	list.remove(ref);
	}
	<span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> void onModification(ServiceReference ref) {
	modifications = modifications + 1;
	}
	<span class="code-keyword">public</span> <span class="code-keyword">synchronized</span> Map getObservations() {
	Map map = <span class="code-keyword">new</span> HashMap();
	map.put(<span class="code-quote">"list"</span>, list);
	map.put(<span class="code-quote">"modifications"</span>, <span class="code-keyword">new</span> <span class="code-object">Integer</span>(modifications));
	<span class="code-keyword">return</span> map;
	}</pre>
	</div></div>
	<p>All method received the arriving, leaving or modified service reference.</p>
	<h2><a name="WhiteBoardPatternHandler-Configuration"></a>Configuration</h2>
	<p>The handler has only three mandatory attributes:</p>
	<ul>
	<li>Filter: filter use to discover matching filter.</li>
	<li>onArrival: declaring the method to invoke when a matching service arrives</li>
	<li>onDeparture: declaring the method to invoke when a matching service leaves</li>
	</ul>


	<p>The onModification attribute is optional. This method is called when
	an injected service reference is modified but stills valid against the
	filter.</p>
	<table class="noteMacro" align="center" border="0" cellpadding="5" cellspacing="8" width="85%"><colgroup><col width="24"><col></colgroup><tbody><tr><td valign="top"><img src="white-board-pattern-handler_files/warning.gif" alt="" align="absmiddle" border="0" width="16" height="16"></td><td>
	<p>The implementation will be notified of arrivals, modifications and
	departures, despite the instance is invalid. Indeed, the implementation
	must release all objects created from another bundle as soon it leaves.</p></td></tr></tbody></table>
	<h2><a name="WhiteBoardPatternHandler-Configuringthehandlerwithannotations\Newin1.1.0SNAPSHOT\"></a>Configuring the handler with annotations [New in 1.1.0-SNAPSHOT]</h2>

	<p>It is possible to configure the handler with a simple annotation
	available in the annotation pack ('annotation' project in the iPOJO
	trunk). Here is an example of usage:</p>
	<div class="code"><div class="codeContent">
	<pre class="code-java"><span class="code-keyword">import</span> org.apache.felix.ipojo.annotations.Component;
	<span class="code-keyword">import</span> org.osgi.framework.ServiceReference;

	@Component
	@org.apache.felix.ipojo.whiteboard.Wbp(filter=<span class="code-quote">"(foo=<span class="code-keyword">true</span>)"</span>,
	onArrival=<span class="code-quote">"onArrival"</span>,
	onDeparture=<span class="code-quote">"onDeparture"</span>,
	onModification=<span class="code-quote">"onModification"</span>)
	<span class="code-keyword">public</span> class WhiteBoardExemple {

	<span class="code-keyword">public</span> void onArrival(ServiceReference ref) {
	<span class="code-comment">// <span class="code-keyword">do</span> something
	</span> }

	<span class="code-keyword">public</span> void onDeparture(ServiceReference ref) {
	<span class="code-comment">// <span class="code-keyword">do</span> something
	</span> }

	<span class="code-keyword">public</span> void onModification(ServiceReference ref) {
	<span class="code-comment">// <span class="code-keyword">do</span> something
	</span> }

	}</pre>
	</div></div>

	<p>The <tt>onModification</tt> attribute is optional.The <tt>filter</tt> attribute allows setting the service filter.</p>


	<h2><a name="WhiteBoardPatternHandler-Download"></a>Download</h2>
	<p>The handler is available on the <a href="http://felix.apache.org/site/download.html" title="Download">download</a> page.<br>
	Sources are available on the Felix trunk at the following location: <span class="nobr"><a href="http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/whiteboard" title="Visit page outside Confluence" rel="nofollow">http://svn.apache.org/repos/asf/felix/trunk/ipojo/handler/whiteboard<sup><img class="rendericon" src="white-board-pattern-handler_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></td>
	<td class="confluenceTd" valign="top" width="20%">
	<h6><a name="WhiteBoardPatternHandler-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="WhiteBoardPatternHandler-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="WhiteBoardPatternHandler-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>
	<li><a href="http://felix.apache.org/site/ipojo-reference-card.html" title="iPOJO-Reference-Card">iPOJO Reference Card</a></li>
	</ul>


	<h6><a name="WhiteBoardPatternHandler-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/ipojo-arch-command.html" title="iPOJO-Arch-Command">iPOJO Arch Command</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="WhiteBoardPatternHandler-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="white-board-pattern-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="WhiteBoardPatternHandler-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="white-board-pattern-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="white-board-pattern-handler_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="white-board-pattern-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="white-board-pattern-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>