Gitiles
Code Review Sign In
gerrit.onosproject.org / onos-felix / 3c9a419e06018f4c9a2fb7a97602dad348bdde5a / . / ipojo / core / doc / service-requirement-handler.html
blob: 8d84dc71fa26699b517bb65844afd3a84d4d85dd [file] [log] [blame]
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]1
2<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3<HTML>
4
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]5<!-- Mirrored Site: felix.apache.org. File: /site/service-requirement-handler.html. Date: Mon, 13 Oct 2008 06:53:05 GMT -->
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]6<HEAD>
7 <TITLE>Apache Felix - Service Requirement Handler</TITLE>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]8 <LINK rel="stylesheet" href="media.data/site.css" type="text/css" media="all">
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]9 <META http-equiv="Content-Type" content="text/html;charset=UTF-8">
10 </HEAD>
11 <BODY>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]12 <DIV class="title"><DIV class="logo"><A href="index.html"><IMG border="0" alt="Apache Felix" src="media.data/logo.png"></A></DIV><DIV class="header"><A href="http://www.apache.org/"><IMG border="0" alt="Apache" src="media.data/apache.png"></A></DIV></DIV>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]13 <DIV class="menu">
14 <UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]15 <LI><A href="news.html" title="news">news</A></LI>
16 <LI><A href="license.html" title="license">license</A></LI>
17 <LI><SPAN class="nobr"><A href="downloads.html" title="Visit page outside Confluence" rel="nofollow">downloads<SUP><IMG class="rendericon" src="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
18 <LI><A href="documentation.html" title="documentation">documentation</A></LI>
19 <LI><A href="mailinglists.html" title="mailinglists">mailing lists</A></LI>
20 <LI><A href="contributing.html" title="Contributing">contributing</A></LI>
21 <LI><SPAN class="nobr"><A href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<SUP><IMG class="rendericon" src="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
22 <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="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
23 <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="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]24<!-- ApacheCon Ad -->
25<IFRAME src="http://www.apache.org/ads/button.html" style="border-width:0; float: left" frameborder="0" scrolling="no" width="135" height="135"></IFRAME>
26<P style="height: 100px">
27<!-- ApacheCon Ad --></LI>
28</UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]29 </DIV>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]30 <DIV class="main">
31<TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR>
32<TD class="confluenceTd" valign="top" width="80%">
33<H1><A name="ServiceRequirementHandler-ServiceDependencyManagement"></A>Service Dependency Management</H1>
34
35<P>The dependency handler manages <EM>OSGi service</EM> <EM>dependencies/requirements</EM>. It allows a component to consume service without managing service discovery, tracking and binding. The handler manages all this interaction and injects required service in the component.</P>
36
37<H2><A name="ServiceRequirementHandler-ServiceRequirement"></A>Service Requirement</H2>
38
39
40<H3><A name="ServiceRequirementHandler-What%27saservicerequirement%3F"></A>What's a service requirement?</H3>
41
42<P>A requirement represents a required service. Therefore, it manages the service lookup and the service binding. When an instance requires a service, the handler injects directly a service object inside a field, or invokes a method when a consistent service appears (or disappears). Service requirements can be:</P>
43<UL>
44 <LI>Simple / Aggregate : the component can require one or several service providers</LI>
45 <LI>Mandatory / Optional : a component can declare an optional dependency</LI>
46 <LI>Filtered : a component can filter available providers</LI>
47 <LI>Dynamic / Static / Dynamic-Priority : the component can specify the binding policy</LI>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]48 <LI>Specific : the dependency targets a specific service provider</LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]49</UL>
50
51
52<H3><A name="ServiceRequirementHandler-Dynamism%26InstanceLifecycle"></A>Dynamism &amp; Instance Lifecycle</H3>
53
54<P>In OSGi&trade;, services can appear and disappear dynamically. This implies dependencies can target a provider which can appear or disappear dynamically.&nbsp; So, dependencies need to manage this dynamism by tracking every time available services. At any moment, a dependency can be unresolved (i.e. no more provider can fulfill the requirement).&nbsp; In the case of a mandatory requirement, the instance becomes invalid (an invalid instance is no more accessible externally, for example provided service are unpublished). If a service, resolving the unfilled dependency appears, the instance becomes valid. In consequence, dependencies affect directly the instance state, and must manage correctly OSGi dynamism to allow a complete unloading when a service goes away. As soon a mandatory dependency cannot be fulfilled, the instance is invalidated.</P>
55
56<P>By default, dependencies are managed dynamically (as previously explained). However, iPOJO supports two other types of binding policies:&nbsp;</P>
57<UL>
58 <LI>Static : if a bound service disappears, the instance is invalidated and cannot be revalidated (binding broken)</LI>
59 <LI>Dynamic-Priority: at each injection, the <EM>best</EM> provider is injected, or the providers array is sorted according to the OSGi Ranking policy.</LI>
60</UL>
61
62
63<H2><A name="ServiceRequirementHandler-ServiceRequirementInjectionMechanisms"></A>Service Requirement Injection Mechanisms</H2>
64
65<P>The handler manages two types of injections:</P>
66<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]67 <LI>Field injection: a field contains the service object. As soon as the field is used, a consistent service object is injected. This injection type fully hides the dynamism</LI>
68 <LI>Method invocation: when a service appears, or disappears a method in the component is invoked. For each dependency, bind and unbind methods are invoke to notify the component of the event.</LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]69</UL>
70
71
72<P>Moreover, the two injections type can be merged. A component can declare a requirement containing both a field and 'binding'.</P>
73
74<H3><A name="ServiceRequirementHandler-Fieldinjection"></A>Field injection</H3>
75
76<P>Imagine a Hello service with one method 'getMessage' returning a &quot;Hello Message&quot;. The following component implementation can use this service by attaching this service to a field and by using the field:</P>
77<DIV class="code"><DIV class="codeContent">
78<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
79 <SPAN class="code-keyword">private</SPAN> Hello m_hello;
80 <SPAN class="code-keyword">public</SPAN> doSomething() {
81 <SPAN class="code-object">System</SPAN>.out.println(m_hello.getMesage());
82 }
83}</PRE>
84</DIV></DIV>
85<P>For this component, metadata could be:</P>
86<DIV class="code"><DIV class="codeContent">
87<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
88 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hello&quot;</SPAN>/&gt;</SPAN>
89 ...
90<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
91</DIV></DIV>
92<P>The metadata contains a 'requires' element (representing the service dependency). This element has a field attribute. This attribute is the name of the field representing the service dependency in the implementation class. The implementation uses the field as a normal field without managing service interactions.</P>
93
94<H3><A name="ServiceRequirementHandler-Methodinvocation"></A>Method invocation</H3>
95
96<P>The second injection mechanism uses methods in the implementation class. By this way, the dynamics can be managed directly by the developer. Each dependency can declare two methods:</P>
97<UL>
98 <LI>A bind method called when a service appears</LI>
99 <LI>An unbind method called when a service disappears</LI>
100</UL>
101
102
103<P>Moreover, callbacks can be in the component super class (in this case methods must be public). These methods can have one of these four signatures:</P>
104<UL>
105 <LI>Without any argument: the method is just a notification (method())</LI>
106 <LI>With the service object : the object is the implicated service object (method(Service svc))</LI>
107 <LI>With an OSGi service reference: the service reference appearing or disappearing (method(ServiceReference ref))</LI>
108 <LI>With the service object and the OSGi service reference (method(Service svc, ServiceReference ref))</LI>
109</UL>
110
111
112<P>The following component implementation shows an example of implementation using this mechanism:</P>
113<DIV class="code"><DIV class="codeContent">
114<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
115 <SPAN class="code-keyword">private</SPAN> Hello m_hello;
116
117 <SPAN class="code-keyword">public</SPAN> void bindHello(Hello h) { m_hello = h; }
118 <SPAN class="code-keyword">public</SPAN> void unbindHello() { m_hello = <SPAN class="code-keyword">null</SPAN>; }
119 <SPAN class="code-keyword">public</SPAN> doSomething() { <SPAN class="code-object">System</SPAN>.out.println(m_hello.getMesage()); }
120}</PRE>
121</DIV></DIV>
122<P>For this component, metadata could be:</P>
123<DIV class="code"><DIV class="codeContent">
124<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
125<SPAN class="code-tag">&lt;requires&gt;</SPAN>
126 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
127 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
128<SPAN class="code-tag">&lt;/requires&gt;</SPAN>
129...
130<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
131</DIV></DIV>
132<P>Note, that the bind the unbind method can be have different signatures. By using this mechanism, you need to be sure to manage the dynamism correctly.<BR>
133(<A href="#ServiceRequirementHandler-discovery" title="discovery on Service Requirement Handler">See note on type discovery</A>)</P>
134
135<H3><A name="ServiceRequirementHandler-FieldinjectionsandMethodinvocations"></A>Field injections and Method invocations</H3>
136
137<P>The two mechanisms can be used together. In this case, the field receives the value before the bind method invocation. So, if the field is use in the method, the returned value will be up to date. The following component implementation uses this mechanism:</P>
138<DIV class="code"><DIV class="codeContent">
139<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
140 <SPAN class="code-keyword">private</SPAN> Hello m_hello; <SPAN class="code-comment">// Injected Field
141</SPAN>
142 <SPAN class="code-keyword">public</SPAN> void bindHello() { <SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">&quot;Hello appears&quot;</SPAN>); }
143 <SPAN class="code-keyword">public</SPAN> void unbindHello() { <SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">&quot;Hello disapears&quot;</SPAN>); }
144 <SPAN class="code-keyword">public</SPAN> doSomething() { <SPAN class="code-object">System</SPAN>.out.println(m_hello.getMesage()); }
145}</PRE>
146</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]147
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]148<P>For this component, metadata could be:</P>
149<DIV class="code"><DIV class="codeContent">
150<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
151 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hello&quot;</SPAN>&gt;</SPAN>
152 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
153 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
154 <SPAN class="code-tag">&lt;/requires&gt;</SPAN>
155 ...
156<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
157</DIV></DIV>
158
159<H3><A name="ServiceRequirementHandler-Injectionmechanisms%26lazyobjectcreation"></A>Injection mechanisms &amp; lazy object creation</H3>
160
161<P>IPOJO creates objects only when required. When needed, iPOJO invokes the constructor of the implementation class. The implementation class can use field requirement because values are already injected. However, method dependencies are called just after the constructor. If the service already presents, the invocation of the methods are delayed just after the constructor invocation.</P>
162
163<H2><A name="ServiceRequirementHandler-SomeExamples"></A>Some Examples</H2>
164
165
166<H3><A name="ServiceRequirementHandler-SimpleRequirement"></A>Simple Requirement</H3>
167
168<P>By default, a requirement is mandatory, non-filtered and simple (non-aggregate). The two previous examples illustrate this kind of dependency. When services goes away and appears, the service substitution is hidden. Fields attached to simple requirement point always a consistent service object. For a simple dependency, the bind method is called once time when the service appears or just after the POJO constructor invocation is the service is available. When the service disappears the unbind method is called. The bind method is re-invoked as soon as another service provider is available. This invocation occurs immediately if another service provider if available. In this case, the instance is not invalidated.</P>
169
170<H3><A name="ServiceRequirementHandler-AggregateRequirement"></A>Aggregate Requirement</H3>
171
172<P>When a component requires several providers of the same service, it declares an aggregate dependency.</P>
173
174<H4><A name="ServiceRequirementHandler-AggregateDependencywithfieldinjection"></A>Aggregate Dependency with field injection</H4>
175
176<DIV class="code"><DIV class="codeContent">
177<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
178 <SPAN class="code-keyword">private</SPAN> Hello m_hellos[];
179 <SPAN class="code-keyword">public</SPAN> doSomething() {
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]180 <SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I &lt; m_hellos.length; i++) {
181 <SPAN class="code-object">System</SPAN>.out.println(m_hellos[i].getMessage());
182 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]183 }
184}</PRE>
185</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]186
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]187<P>For this component, metadata could be:</P>
188<DIV class="code"><DIV class="codeContent">
189<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
190 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN>/&gt;</SPAN>
191 ...
192<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
193</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]194
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]195<P>To declare an aggregate field for field requirement, you only need to declare an array (instead of a scalar type). IPOJO will create and inject the service object array. IPOJO discover that the dependency is aggregate during the bytecode introspection.</P>
196
197<P><EM>Note:</EM> The synchronization is managed by iPOJO. As soon as you are 'touching' a dependency in a method, iPOJO ensure that you will keep these objects until the end of the method. Nested methods will share the same service object set.</P>
198
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]199<H4><A name="ServiceRequirementHandler-AggregateDependencywithfieldinjection%3Alist%2Cvector%2Ccollectionandset%5CNewinthe0.9.0SNAPSHOTversion%5C"></A>Aggregate Dependency with field injection: list, vector, collection and set [New in the 0.9.0-SNAPSHOT version]</H4>
200<P>It is also possible to inject service objects inside fields of the type:</P>
201<UL>
202 <LI>list</LI>
203 <LI>vector</LI>
204 <LI>collection</LI>
205 <LI>set</LI>
206</UL>
207
208
209<DIV class="code"><DIV class="codeContent">
210<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
211 <SPAN class="code-keyword">private</SPAN> List m_hellos;
212 <SPAN class="code-keyword">public</SPAN> doSomething() {
213 <SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I &lt; m_hellos.size(); i++) {
214 <SPAN class="code-object">System</SPAN>.out.println(((Hello) m_hellos.get(i)).
215 getMessage());
216 }
217 }
218}</PRE>
219</DIV></DIV>
220<P>For this component, metadata could be:</P>
221<DIV class="code"><DIV class="codeContent">
222<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
223 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN> interface=<SPAN class="code-quote">&quot;o.a.f.i.Hello&quot;</SPAN>/&gt;</SPAN>
224 ...
225<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
226</DIV></DIV>
227<P>In this case, just use the supported type that you want. iPOJO will automatically understand that it is an aggregate dependency, and will create the collection object containing service objects.<BR>
228<EM>Note:</EM> The service interface cannot be discovered when using these types as the bytecode does not provide enough information. So, you have to indicate the required service interface (with the 'interface' attribute) in the requirement description.<BR>
229<EM>Note:</EM> As in the previous case, the synchronization is managed by iPOJO. As soon as you are 'touching' a dependency in a method, iPOJO ensure that you will keep these objects until the end of the method. Nested methods will share the same service object set.<BR>
230<EM>Note:</EM> The 0.9.0-SNAPSHOT version has changed the 'interface' attribute in 'specification'. The attribute semantic don't change.</P>
231
232
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]233<H4><A name="ServiceRequirementHandler-AggregateDependencywithmethodinvocation"></A>Aggregate Dependency with method invocation</H4>
234
235<DIV class="code"><DIV class="codeContent">
236<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
237 <SPAN class="code-keyword">private</SPAN> List m_hellos= <SPAN class="code-keyword">new</SPAN> ArrayList();
238 <SPAN class="code-keyword">private</SPAN> void bindHello(Hello h) { m_hellos.add(h); }
239 <SPAN class="code-keyword">private</SPAN> void unbindHello(Hello h) { m_hellos.remove(h); }
240 <SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">synchronized</SPAN> doSomething() {
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]241 <SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I &lt; m_hellos.size(); i++) {
242 <SPAN class="code-object">System</SPAN>.out.println(m_hellos.get(i).
243 getMessage());
244 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]245 }
246 }
247}</PRE>
248</DIV></DIV>
249<P>This requirement is configured as following:</P>
250<DIV class="code"><DIV class="codeContent">
251<PRE class="code-xml"><SPAN class="code-tag">&lt;requires aggregate=<SPAN class="code-quote">&quot;true&quot;</SPAN>&gt;</SPAN>
252 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
253 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
254<SPAN class="code-tag">&lt;/requires&gt;</SPAN></PRE>
255</DIV></DIV>
256<P>In this case, iPOJO cannot detect if the dependency is aggregate or not. So, you need to add the '<EM>aggregate</EM>' attribute. The bindHello and unbindHello will be called each time a Hello service appears or disappears.<BR>
257<EM>Note:</EM> To avoid the list modification during the loop, you need synchronized the block. Indeed, as the field is not an iPOJO requirement, iPOJO will not manage the synchronization.</P>
258
259<H3><A name="ServiceRequirementHandler-OptionalRequirement%28nonaggregate%29"></A>Optional Requirement (non-aggregate)</H3>
260
261<P>An optional requirement does not invalidate the instance despite no providers are available. Moreover, it is possible to inject a default service implementation when no <EM>real</EM> providers are available.</P>
262
263<H4><A name="ServiceRequirementHandler-OptionalRequirementwithfieldinjection"></A>Optional Requirement with field injection</H4>
264
265<DIV class="code"><DIV class="codeContent">
266<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
267 <SPAN class="code-keyword">private</SPAN> Hello m_hello;
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]268 <SPAN class="code-keyword">public</SPAN> doSomething() {
269 <SPAN class="code-object">System</SPAN>.out.println(m_hello.getMesage());
270 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]271}</PRE>
272</DIV></DIV>
273<P>For this component, metadata could be:</P>
274<DIV class="code"><DIV class="codeContent">
275<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
276 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hello&quot;</SPAN> optional=<SPAN class="code-quote">&quot;true&quot;</SPAN>/&gt;</SPAN>
277 ...
278<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
279</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]280<P>To declare an optional requirement, you need to add the <EM>'optional'</EM> attribute. To avoid null pointer exception, iPOJO injects a <EM>Nullable</EM> object in the field when no service provider is available. The <EM>nullable</EM> object implements the service interface, but does nothing. Moreover, it is possible to set a default-implementation for the service. A default-implementation is a class implementing the service but used only when no others service providers are available. The default-implementation object will be injected instead of the <EM>Nullable</EM> objet. For further information <A href="#ServiceRequirementHandler-nullable" title="nullable on Service Requirement Handler">refer to the note about nullable object</A>.</P>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]281
282<H4><A name="ServiceRequirementHandler-OptionalDependencywithmethodinvocation"></A>Optional Dependency with method invocation</H4>
283
284<DIV class="code"><DIV class="codeContent">
285<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
286 <SPAN class="code-keyword">private</SPAN> Hello m_hello;
287 <SPAN class="code-keyword">public</SPAN> void bindHello(Hello h) { m_hello = h; }
288 <SPAN class="code-keyword">public</SPAN> void unbindHello() { m_hello = <SPAN class="code-keyword">null</SPAN>; }
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]289 <SPAN class="code-keyword">public</SPAN> doSomething() {
290 <SPAN class="code-keyword">if</SPAN>(m_hello != <SPAN class="code-keyword">null</SPAN>) {
291 <SPAN class="code-object">System</SPAN>.out.println(m_hello.getMesage());
292 }
293 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]294}</PRE>
295</DIV></DIV>
296<P>For this component, metadata should be:</P>
297<DIV class="code"><DIV class="codeContent">
298<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
299<SPAN class="code-tag">&lt;requires optional=<SPAN class="code-quote">&quot;true&quot;</SPAN>&gt;</SPAN>
300 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
301 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
302<SPAN class="code-tag">&lt;/requires&gt;</SPAN>
303...
304<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
305</DIV></DIV>
306<P>As for field requirement, the dependency metadata needs to contain the optional attribute. IPOJO invokes the method only when a 'real' service is available, so you need to test if m_hello is null before to use it.</P>
307
308<H3><A name="ServiceRequirementHandler-Aggregate%26OptionalRequirement"></A>Aggregate &amp; Optional Requirement</H3>
309
310<P>A dependency can be both aggregate and optional.</P>
311
312<H4><A name="ServiceRequirementHandler-Aggregate%26OptionalDependencywithfieldinjection"></A>Aggregate &amp; Optional Dependency with field injection</H4>
313
314<DIV class="code"><DIV class="codeContent">
315<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
316 <SPAN class="code-keyword">private</SPAN> Hello m_hellos[];
317 <SPAN class="code-keyword">public</SPAN> doSomething() {
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]318 <SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I &lt; m_hellos.length; i++) {
319 <SPAN class="code-object">System</SPAN>.out.println(m_hellos[i].getMessage());
320 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]321 }
322}</PRE>
323</DIV></DIV>
324<P>For this component, metadata could be:</P>
325<DIV class="code"><DIV class="codeContent">
326<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
327<SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN> optional=<SPAN class="code-quote">&quot;true&quot;</SPAN>/&gt;</SPAN>
328...
329<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
330</DIV></DIV>
331<P>To declare an optional &amp; aggregate field requirement you need to write the optional attribute in the dependency metadata and to point on a field array. If no service available, iPOJO injects an empty array.</P>
332
333<H4><A name="ServiceRequirementHandler-Aggregate%26OptionalRequirementwithmethodinvocation"></A>Aggregate &amp; Optional Requirement with method invocation</H4>
334
335<DIV class="code"><DIV class="codeContent">
336<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {
337 <SPAN class="code-keyword">private</SPAN> List m_hellos&lt;Hello&gt; = <SPAN class="code-keyword">new</SPAN> ArrayList&lt;Hello&gt;();
338 <SPAN class="code-keyword">private</SPAN> void bindHello(Hello h) { m_hellos.add(h); }
339 <SPAN class="code-keyword">private</SPAN> void unbindHello(Hello h) { m_hellos.remove(h); }
340 <SPAN class="code-keyword">public</SPAN> <SPAN class="code-keyword">synchronized</SPAN> doSomething() {
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]341 <SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I &lt; m_hellos.size(); i++) {
342 <SPAN class="code-object">System</SPAN>.out.println(m_hellos.get(i).getMessage());
343 }
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]344 }
345}</PRE>
346</DIV></DIV>
347<P>For this component, metadata could be:</P>
348<DIV class="code"><DIV class="codeContent">
349<PRE class="code-xml"><SPAN class="code-tag">&lt;requires aggregate=<SPAN class="code-quote">&quot;true&quot;</SPAN> optional=<SPAN class="code-quote">&quot;true&quot;</SPAN>&gt;</SPAN>
350 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
351 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
352<SPAN class="code-tag">&lt;/requires&gt;</SPAN></PRE>
353</DIV></DIV>
354<P>In this case, you need to add the &#95;'aggregate'_attribute and the &#95;'optional'_attribute. The bindHello and unbindHello will be called each time a Hello service appears or disappears. These bind / unbind methods are not called when binding / unbinding a Nullable object (when both field and method are used).</P>
355
356<H3><A name="ServiceRequirementHandler-FilteredRequirement"></A>Filtered Requirement</H3>
357
358<P>A filtered dependency applies an LDAP filter on service provider. IPOJO reuses OSGi LDAP filter ability. The following metadata illustrates how to use filters:</P>
359<DIV class="code"><DIV class="codeContent">
360<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
361<SPAN class="code-tag">&lt;requires filter=<SPAN class="code-quote">&quot;(language=fr)&quot;</SPAN>&gt;</SPAN>
362 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
363 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
364<SPAN class="code-tag">&lt;/requires&gt;</SPAN>
365...
366<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
367</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]368<P>To add a filter, just add a 'filter' attribute in your dependency containing the LDAP filter. iPOJO will select only provider matching with this filter.</P>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]369
370<P>Moreover, filters can be customized instance by instance. It is possible to specialize / change / add the filter of a component in the instance description. It is useful when you want to create different instances of the same component, with different filter. To do it, you have to identify your dependency with an 'id' attribute. Then, you can adapt the filter of the dependency in the instance description by using the property &quot;requires.filters&quot;. In this property you can specify each dependency identified by its id and the new value of the filter.</P>
371<DIV class="code"><DIV class="codeContent">
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]372<PRE class="code-xml">&lt;component
373 className=<SPAN class="code-quote">&quot;org.apache.felix.ipojo.example.FilteredDependency&quot;</SPAN>
374 name=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]375 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_foo&quot;</SPAN> fiter=<SPAN class="code-quote">&quot;(foo.property=FOO)&quot;</SPAN> id=<SPAN class="code-quote">&quot;id1&quot;</SPAN>&gt;</SPAN>
376 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bind&quot;</SPAN>/&gt;</SPAN>
377 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbind&quot;</SPAN>/&gt;</SPAN>
378 <SPAN class="code-tag">&lt;/requires&gt;</SPAN>
379<SPAN class="code-tag">&lt;/component&gt;</SPAN>
380
381<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO1&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>/&gt;</SPAN>
382
383<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO2&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;</SPAN>
384 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;requires.filters&quot;</SPAN>&gt;</SPAN>
385 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;id1&quot;</SPAN> value=<SPAN class="code-quote">&quot;(foo.property=BAR)&quot;</SPAN>/&gt;</SPAN>
386 <SPAN class="code-tag">&lt;/property&gt;</SPAN>
387<SPAN class="code-tag">&lt;/instance&gt;</SPAN>
388
389<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO3&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;</SPAN>
390 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;requires.filters&quot;</SPAN>&gt;</SPAN>
391 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;id1&quot;</SPAN> value=<SPAN class="code-quote">&quot;(foo.property=BAZ)&quot;</SPAN>/&gt;</SPAN>
392 <SPAN class="code-tag">&lt;/property&gt;</SPAN>
393<SPAN class="code-tag">&lt;/instance&gt;</SPAN></PRE>
394</DIV></DIV>
395<P>The FOO component type declares a service dependency with the 'id1' id. This dependency has no filter by default. The first instance is just an instance of the FOO component type and does not modify the dependency. The second one adds a filter to the declared dependency to target providers with foo.property = BAR. The last one adds another filter to the declared dependency. By using instance filter customization, it is possible to create complex applications where you avoid binding problems by filtering dependencies instance by instance.</P>
396
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]397<H3><A name="ServiceRequirementHandler-Targetingaspecificprovider%5CNewinthe0.9.0SNAPSHOTversion%5C"></A>Targeting a specific provider [New in the 0.9.0-SNAPSHOT version]</H3>
398<P>A service dependency can choose a specific provider. To achieve this, add a 'from' attribute in your requirement description such as in:</P>
399<DIV class="code"><DIV class="codeContent">
400<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
401<SPAN class="code-tag">&lt;requires from=<SPAN class="code-quote">&quot;MyHelloProvider&quot;</SPAN>&gt;</SPAN>
402 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bindHello&quot;</SPAN>&gt;</SPAN>
403 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbindHello&quot;</SPAN>&gt;</SPAN>
404<SPAN class="code-tag">&lt;/requires&gt;</SPAN>
405...
406<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
407</DIV></DIV>
408<P>iPOJO maps the from attribute to a specific filter : '|(instance.name=MyHelloProvider)(service.pid=MyHelloProvider)'. Then the dependency can only be fulfilled by a service matching this filter.</P>
409
410<P>Moreover, from attributes can be customized instance by instance. It is possible to specialize / change / add a 'from' attribute of a component in the instance configuration. It is useful when you want to create different instances of the same component, with different 'from' clauses. To do it, you have to identify your dependency with an 'id' attribute. Then, you can adapt the 'from' of the dependency in the instance configuration by using the property &quot;requires.from&quot;. In this property you can specify each dependency identified by its id and the 'from' value.</P>
411
412<DIV class="code"><DIV class="codeContent">
413<PRE class="code-xml">&lt;component
414 className=<SPAN class="code-quote">&quot;org.apache.felix.ipojo.example.FilteredDependency&quot;</SPAN>
415 name=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;
416 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_foo&quot;</SPAN> id=<SPAN class="code-quote">&quot;id1&quot;</SPAN>&gt;</SPAN>
417 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;bind&quot;</SPAN> method=<SPAN class="code-quote">&quot;bind&quot;</SPAN>/&gt;</SPAN>
418 <SPAN class="code-tag">&lt;callback type=<SPAN class="code-quote">&quot;unbind&quot;</SPAN> method=<SPAN class="code-quote">&quot;unbind&quot;</SPAN>/&gt;</SPAN>
419 <SPAN class="code-tag">&lt;/requires&gt;</SPAN>
420<SPAN class="code-tag">&lt;/component&gt;</SPAN>
421
422<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO1&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>/&gt;</SPAN>
423
424<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO2&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;</SPAN>
425 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;requires.from&quot;</SPAN>&gt;</SPAN>
426 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;id1&quot;</SPAN> value=<SPAN class="code-quote">&quot;myprovider&quot;</SPAN>/&gt;</SPAN>
427 <SPAN class="code-tag">&lt;/property&gt;</SPAN>
428<SPAN class="code-tag">&lt;/instance&gt;</SPAN>
429
430<SPAN class="code-tag">&lt;instance name=<SPAN class="code-quote">&quot;FOO3&quot;</SPAN> component=<SPAN class="code-quote">&quot;FOO&quot;</SPAN>&gt;</SPAN>
431 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;requires.from&quot;</SPAN>&gt;</SPAN>
432 <SPAN class="code-tag">&lt;property name=<SPAN class="code-quote">&quot;id1&quot;</SPAN> value=<SPAN class="code-quote">&quot;myotherprovider&quot;</SPAN>/&gt;</SPAN>
433 <SPAN class="code-tag">&lt;/property&gt;</SPAN>
434<SPAN class="code-tag">&lt;/instance&gt;</SPAN></PRE>
435</DIV></DIV>
436
437<P>The FOO component type declares a service dependency with the 'id1' id. This dependency has no 'from' attribute by default. The first instance is just an instance of the FOO component type and does not modify the dependency. The second one adds a 'from' attribute to the declared dependency to target the 'myprovider' provider. The last one adds another 'from' clause to the declared dependency.</P>
438
439
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]440<H2><A name="ServiceRequirementHandler-BindingPolicies"></A>Binding Policies</H2>
441
442<P>Three binding policies are supported inside iPOJO.</P>
443<UL>
444 <LI>Dynamic policy (default): the binding are managed dynamically. At each injection, the same provider is injected if the provider is always available. Else a new one is chosen. For aggregate dependency, the array order does not change; new providers are placed at the end of the array.</LI>
445 <LI>Static policy: the binding is static. So, once bound a provider cannot disappear. If it disappears, the instance is invalidated and cannot be revalidated without stopping and restarting the instance.</LI>
446 <LI>Dynamic-priority policy: the binding is managed dynamically but the injected provider is selected by using a ranking policy. Two injections can return two different providers, is a new provider is 'better' than the previous one, despite the first one is always available. For aggregate dependency, the array is sorted.</LI>
447</UL>
448
449
450<P>A static binding is declared as following:</P>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]451
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]452<DIV class="code"><DIV class="codeContent">
453<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
454 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN> policy=<SPAN class="code-quote">&quot;static&quot;</SPAN>/&gt;</SPAN>
455 ...
456<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
457</DIV></DIV>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]458
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]459<P>A dynamic-priority binding is declared as following:</P>
460<DIV class="code"><DIV class="codeContent">
461<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
462 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN> policy=<SPAN class="code-quote">&quot;dynamic-priority&quot;</SPAN>/&gt;</SPAN>
463 ...
464<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
465</DIV></DIV>
466<P>By default, the dynamic-priority policy uses the OSGi service ranking policy. However, it is possible to customize the policy by adding the '<EM>comparator</EM>' attribute. This attribute indicates the class name of a class implementing the java.util.Comparator interface. IPOJO will create an instance of your comparator and use it to sort service references (so your customized comparator needs to be able to sort OSGi Service Reference).</P>
467<DIV class="code"><DIV class="codeContent">
468<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...HelloConsumer&quot;</SPAN>&gt;</SPAN>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]469 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_hellos&quot;</SPAN> policy=<SPAN class="code-quote">&quot;dynamic-priority&quot;</SPAN> comparator=<SPAN class="code-quote">&quot;my.great.Comparator&quot;</SPAN>/&gt;</SPAN>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]470 ...
471<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
472</DIV></DIV>
473
474<P><A name="ServiceRequirementHandler-nullable"></A></P>
475<H2><A name="ServiceRequirementHandler-Noteaboutnullableobject%26defaultimplementation"></A>Note about nullable object &amp; default-implementation</H2>
476
477<P>The instance implementation can use an optional dependency without any checking. Indeed, when an instance declares an optional dependency using field injection, iPOJO create on the fly a Nullable class implementing the service specification but doing nothing (mock object). Therefore, iPOJO cannot return a service to the instance, for an optional dependency, it returns a nullable object.</P>
478
479<P>A nullable object returns:</P>
480<UL>
481 <LI>Null when the method returns an object</LI>
482 <LI>0 when the method returns an int, log, byte, short, char, float or a double</LI>
483 <LI>False when the method return a boolean</LI>
484</UL>
485
486
487<P>You can check if the returned object is a nullable object with the test: <EM>&quot;myservice instanceof Nullable&quot;</EM>.</P>
488
489<P>You can disable the Nullable pattern too (activated by default). In this case, iPOJO will inject <EM>null</EM> instead of a <EM>Nullable</EM> object. So, you can just test if your field is equals to <EM>null</EM> to check if the service is available. To disable the Nullable pattern, you need to add the 'nullable=&quot;false&quot;' attribute in your service dependency description as follows:</P>
490<DIV class="code"><DIV class="codeContent">
491<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...LogExample&quot;</SPAN>&gt;</SPAN>
492 <SPAN class="code-tag">&lt;requires field=<SPAN class="code-quote">&quot;m_log&quot;</SPAN> optional=<SPAN class="code-quote">&quot;true&quot;</SPAN> nullable=<SPAN class="code-quote">&quot;false&quot;</SPAN>/&gt;</SPAN>
493 ...
494<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
495</DIV></DIV>
496
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]497<P>However, you can also indicate a <EM>default-implementation</EM> for your optional service. In this case, if no providers are found, iPOJO creates an instance of the default-implementation and injects it. The default-implementation attribute describes the class name of your implementation. The given class <B>MUST</B> implement the required service interface.</P>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]498
499<P>For example, the following component uses a default implementation for a Log Service dependency:</P>
500<DIV class="code"><DIV class="codeContent">
501<PRE class="code-xml"><SPAN class="code-tag">&lt;component classname=<SPAN class="code-quote">&quot;...LogExample&quot;</SPAN>&gt;</SPAN>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]502 &lt;requires field=<SPAN class="code-quote">&quot;m_log&quot;</SPAN> optional=<SPAN class="code-quote">&quot;true&quot;</SPAN>
503 default-implementation=
504 <SPAN class="code-quote">&quot;org.apache.felix.ipojo.example.default.MyLogService&quot;</SPAN>/&gt;
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]505 ...
506<SPAN class="code-tag">&lt;/component&gt;</SPAN></PRE>
507</DIV></DIV>
508<P>If the log service is not available, iPOJO creates an object of the 'org.apache.felix.ipojo.example.default.MyLogService' class. This object is injected instead of a Nullable object. For instance, the default implementation can print messages on the System.err stream. The nullable object does no display anything.</P>
509
510
511<P><A name="ServiceRequirementHandler-callbacks"></A></P>
512<H2><A name="ServiceRequirementHandler-NoteaboutCallbacks"></A>Note about Callbacks</H2>
513<P>Dependency manages two type of callback: bind and unbind. A callback with a type &quot;bind&quot; is called each type that a service provider arrives and the binding is necessary. According to the cardinality of the dependency it means:</P>
514<UL>
515 <LI>Simple dependency : at the firs binding and at each rebinding to another service provider</LI>
516 <LI>Aggregate dependencies: each time that a service provider arrives</LI>
517</UL>
518
519
520<P>An unbind callback is called each time that a <B>used</B> service provider goes away. For a simple dependency this method is called each time that the used service provider goes away. For a multiple dependency this method is called each time that a service provider goes away.</P>
521
522<P>The method can receive in argument the service object or the service reference (in order to obtain service properties). The bind methods are delayed since a POJO object is created.</P>
523
524<P><A name="ServiceRequirementHandler-discovery"></A></P>
525<H2><A name="ServiceRequirementHandler-Noteonserviceinterfacediscovery"></A>Note on service interface discovery</H2>
526
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]527<P>The <EM>'interface'</EM> (replaced by 'specification' during the 0.9.0-SNASPHOT version development) attribute is generally optional except when iPOJO cannot discover the type of the service. iPOJO cannot infer the type when the dependency has no field and callbacks do not receive the service object in parameter. In this case, you need to declare the service interface.</P>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]528</TD>
529<TD class="confluenceTd" valign="top" width="20%">
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]530<H6><A name="ServiceRequirementHandler-Overview"></A><B>Overview</B></H6>
531<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]532 <LI><A href="apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</A></LI>
533 <LI><A href="apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</A></LI>
534 <LI><A href="download.html" title="Download">Download &amp; Install </A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]535</UL>
536
537
538<H6><A name="ServiceRequirementHandler-GettingStarted"></A><B>Getting Started</B></H6>
539<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]540 <LI><A href="ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</A></LI>
541 <LI><A href="ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word &#40;Maven&#45;Based&#41; tutorial</A></LI>
542 <LI><A href="ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]543</UL>
544
545
546<H6><A name="ServiceRequirementHandler-UserGuide"></A><B>User Guide</B></H6>
547<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]548 <LI><A href="describing-components.html" title="Describing components">Describing components (handler list) </A></LI>
549 <LI><A href="how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</A></LI>
550 <LI><A href="using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</A></LI>
551 <LI><A href="ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</A></LI>
552 <LI><A href="ipojo-faq.html" title="iPOJO FAQ">FAQ</A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]553</UL>
554
555
556<H6><A name="ServiceRequirementHandler-Tools"></A><B>Tools</B></H6>
557<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]558 <LI><A href="ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug&#45;in</A></LI>
559 <LI><A href="ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</A></LI>
560 <LI><A href="ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug&#45;in</A></LI>
561 <LI><A href="ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]562</UL>
563
564
565<H6><A name="ServiceRequirementHandler-DeveloperGuide"></A><B>Developer Guide</B></H6>
566<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]567 <LI>API: <SPAN class="nobr"><A href="http://people.apache.org/~clement/ipojo/api/0.8/" title="Visit page outside Confluence" rel="nofollow">0.8<SUP><IMG class="rendericon" src="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>
568 <LI><A href="how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</A></LI>
569 <LI><A href="how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]570</UL>
571
572
573<H6><A name="ServiceRequirementHandler-Misc%26Contact"></A><B>Misc &amp; Contact</B></H6>
574<UL>
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]575 <LI><A href="apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</A></LI>
576 <LI><A href="apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</A></LI>
577 <LI><A href="apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</A></LI>
578 <LI><A href="future-ideas.html" title="Future Ideas">Future Ideas</A></LI>
579 <LI><A href="contact.html" title="Contact">Contact</A></LI>
580 <LI><A href="related-works.html" title="Related Works">Related Works</A></LI>
581 <LI><A href="article-presentations.html" title="Article & Presentations">Article &amp; Presentations</A></LI>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]582</UL>
583
584
585<HR>
586<DIV class="" align="center">
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]587<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="../../cwiki.apache.org/confluence/images/icons/feed-icon-32x32.png" align="absmiddle" border="0"><SUP><IMG class="rendericon" src="../../cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></P></DIV></TD></TR></TBODY></TABLE>
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]588 </DIV>
589 </BODY>
590
Clement Escoffier130ca572008-10-13 07:33:03 +0000[diff] [blame]591<!-- Mirrored Site: felix.apache.org. File: /site/service-requirement-handler.html. Date: Mon, 13 Oct 2008 06:53:05 GMT -->
Clement Escoffier50254022008-05-16 20:33:54 +0000[diff] [blame]592</HTML>