Blame - ipojo/core/doc/service-requirement-handler.html - onos-felix

<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

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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

24

25

26

27

</LI>

28

</UL>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

29

</DIV>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

<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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

48

<LI>Specific : the dependency targets a specific service provider</LI>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H3><A name="ServiceRequirementHandler-Dynamism%26InstanceLifecycle"></A>Dynamism & Instance Lifecycle</H3>

53

54

<P>In OSGi™, services can appear and disappear dynamically. This implies dependencies can target a provider which can appear or disappear dynamically.  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).  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: </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>

</UL>

<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 Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<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 "Hello Message". The following component implementation can use this service by attaching this service to a field and by using the field:</P>

77

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());

}

}</PRE>

</DIV></DIV>

<P>For this component, metadata could be:</P>

86

87

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

88

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hello"</SPAN>/></SPAN>

...

</DIV></DIV>

<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>

</UL>

<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>

</UL>

<P>The following component implementation shows an example of implementation using this mechanism:</P>

113

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

124

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

125

126

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

127

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

...

</DIV></DIV>

<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

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">"Hello appears"</SPAN>); }

143

<SPAN class="code-keyword">public</SPAN> void unbindHello() { <SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"Hello disapears"</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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

147

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

148

<P>For this component, metadata could be:</P>

149

150

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

151

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hello"</SPAN>></SPAN>

152

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

153

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

...

</DIV></DIV>

<H3><A name="ServiceRequirementHandler-Injectionmechanisms%26lazyobjectcreation"></A>Injection mechanisms & 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

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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

180

<SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I < m_hellos.length; i++) {

181

<SPAN class="code-object">System</SPAN>.out.println(m_hellos[i].getMessage());

182

}

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

183

}

184

}</PRE>

185

</DIV></DIV>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

186

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

187

<P>For this component, metadata could be:</P>

188

189

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

190

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN>/></SPAN>

191

...

192

193

</DIV></DIV>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

194

Clement Escoffier

6b928e9

2008-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 Escoffier

8350751

2008-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>

<UL>

<LI>vector</LI>

<LI>collection</LI>

</UL>

<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 < m_hellos.size(); i++) {

214

<SPAN class="code-object">System</SPAN>.out.println(((Hello) m_hellos.get(i)).

getMessage());

}

}

}</PRE>

</DIV></DIV>

<P>For this component, metadata could be:</P>

221

222

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

223

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN> interface=<SPAN class="code-quote">"o.a.f.i.Hello"</SPAN>/></SPAN>

...

</DIV></DIV>

<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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

233

<H4><A name="ServiceRequirementHandler-AggregateDependencywithmethodinvocation"></A>Aggregate Dependency with method invocation</H4>

234

235

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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

241

<SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I < m_hellos.size(); i++) {

242

<SPAN class="code-object">System</SPAN>.out.println(m_hellos.get(i).

243

getMessage());

244

}

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

}

}

}</PRE>

</DIV></DIV>

<P>This requirement is configured as following:</P>

250

251

252

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

253

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

254

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

266

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {

267

<SPAN class="code-keyword">private</SPAN> Hello m_hello;

Clement Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

271

}</PRE>

272

</DIV></DIV>

273

<P>For this component, metadata could be:</P>

274

275

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

276

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hello"</SPAN> optional=<SPAN class="code-quote">"true"</SPAN>/></SPAN>

277

...

278

279

</DIV></DIV>

Clement Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

281

282

<H4><A name="ServiceRequirementHandler-OptionalDependencywithmethodinvocation"></A>Optional Dependency with method invocation</H4>

283

284

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 Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

294

}</PRE>

295

</DIV></DIV>

296

<P>For this component, metadata should be:</P>

297

298

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

299

300

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

301

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

...

</DIV></DIV>

<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 & 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 & Optional Dependency with field injection</H4>

313

314

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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

318

<SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I < m_hellos.length; i++) {

319

<SPAN class="code-object">System</SPAN>.out.println(m_hellos[i].getMessage());

320

}

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

}

}</PRE>

</DIV></DIV>

<P>For this component, metadata could be:</P>

325

326

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

327

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN> optional=<SPAN class="code-quote">"true"</SPAN>/></SPAN>

...

</DIV></DIV>

<P>To declare an optional & 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 & Optional Requirement with method invocation</H4>

334

335

336

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class HelloConsumer {

337

<SPAN class="code-keyword">private</SPAN> List m_hellos<Hello> = <SPAN class="code-keyword">new</SPAN> ArrayList<Hello>();

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 Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

341

<SPAN class="code-keyword">for</SPAN>(<SPAN class="code-object">int</SPAN> I = 0; I < m_hellos.size(); i++) {

342

<SPAN class="code-object">System</SPAN>.out.println(m_hellos.get(i).getMessage());

343

}

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

}

}</PRE>

</DIV></DIV>

<P>For this component, metadata could be:</P>

348

349

<PRE class="code-xml"><SPAN class="code-tag"><requires aggregate=<SPAN class="code-quote">"true"</SPAN> optional=<SPAN class="code-quote">"true"</SPAN>></SPAN>

350

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

351

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

352

353

</DIV></DIV>

354

<P>In this case, you need to add the _'aggregate'_attribute and the _'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

360

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

361

<SPAN class="code-tag"><requires filter=<SPAN class="code-quote">"(language=fr)"</SPAN>></SPAN>

362

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

363

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

...

</DIV></DIV>

Clement Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-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 "requires.filters". In this property you can specify each dependency identified by its id and the new value of the filter.</P>

371

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

372

<PRE class="code-xml"><component

373

className=<SPAN class="code-quote">"org.apache.felix.ipojo.example.FilteredDependency"</SPAN>

374

name=<SPAN class="code-quote">"FOO"</SPAN>>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

375

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_foo"</SPAN> fiter=<SPAN class="code-quote">"(foo.property=FOO)"</SPAN> id=<SPAN class="code-quote">"id1"</SPAN>></SPAN>

376

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bind"</SPAN>/></SPAN>

377

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbind"</SPAN>/></SPAN>

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO1"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>/></SPAN>

382

383

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO2"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>></SPAN>

384

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"requires.filters"</SPAN>></SPAN>

385

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"id1"</SPAN> value=<SPAN class="code-quote">"(foo.property=BAR)"</SPAN>/></SPAN>

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO3"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>></SPAN>

390

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"requires.filters"</SPAN>></SPAN>

391

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"id1"</SPAN> value=<SPAN class="code-quote">"(foo.property=BAZ)"</SPAN>/></SPAN>

</DIV></DIV>

<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 Escoffier

8350751

2008-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

400

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

401

<SPAN class="code-tag"><requires from=<SPAN class="code-quote">"MyHelloProvider"</SPAN>></SPAN>

402

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bindHello"</SPAN>></SPAN>

403

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbindHello"</SPAN>></SPAN>

...

</DIV></DIV>

<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 "requires.from". In this property you can specify each dependency identified by its id and the 'from' value.</P>

411

412

413

<PRE class="code-xml"><component

414

className=<SPAN class="code-quote">"org.apache.felix.ipojo.example.FilteredDependency"</SPAN>

415

name=<SPAN class="code-quote">"FOO"</SPAN>>

416

417

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"bind"</SPAN> method=<SPAN class="code-quote">"bind"</SPAN>/></SPAN>

418

<SPAN class="code-tag"><callback type=<SPAN class="code-quote">"unbind"</SPAN> method=<SPAN class="code-quote">"unbind"</SPAN>/></SPAN>

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO1"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>/></SPAN>

423

424

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO2"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>></SPAN>

425

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"requires.from"</SPAN>></SPAN>

426

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"id1"</SPAN> value=<SPAN class="code-quote">"myprovider"</SPAN>/></SPAN>

<SPAN class="code-tag"><instance name=<SPAN class="code-quote">"FOO3"</SPAN> component=<SPAN class="code-quote">"FOO"</SPAN>></SPAN>

431

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"requires.from"</SPAN>></SPAN>

432

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"id1"</SPAN> value=<SPAN class="code-quote">"myotherprovider"</SPAN>/></SPAN>

</DIV></DIV>

<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 Escoffier

6b928e9

2008-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>

</UL>

<P>A static binding is declared as following:</P>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

451

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

452

453

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

454

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN> policy=<SPAN class="code-quote">"static"</SPAN>/></SPAN>

455

...

456

457

</DIV></DIV>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

458

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

459

<P>A dynamic-priority binding is declared as following:</P>

460

461

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

462

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN> policy=<SPAN class="code-quote">"dynamic-priority"</SPAN>/></SPAN>

...

</DIV></DIV>

<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

468

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...HelloConsumer"</SPAN>></SPAN>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

469

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_hellos"</SPAN> policy=<SPAN class="code-quote">"dynamic-priority"</SPAN> comparator=<SPAN class="code-quote">"my.great.Comparator"</SPAN>/></SPAN>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

...

</DIV></DIV>

<H2><A name="ServiceRequirementHandler-Noteaboutnullableobject%26defaultimplementation"></A>Note about nullable object & 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>

</UL>

<P>You can check if the returned object is a nullable object with the test: <EM>"myservice instanceof Nullable"</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="false"' attribute in your service dependency description as follows:</P>

490

491

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...LogExample"</SPAN>></SPAN>

492

<SPAN class="code-tag"><requires field=<SPAN class="code-quote">"m_log"</SPAN> optional=<SPAN class="code-quote">"true"</SPAN> nullable=<SPAN class="code-quote">"false"</SPAN>/></SPAN>

...

</DIV></DIV>

Clement Escoffier

2008-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 Escoffier

6b928e9

2008-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

501

<PRE class="code-xml"><SPAN class="code-tag"><component classname=<SPAN class="code-quote">"...LogExample"</SPAN>></SPAN>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

502

<requires field=<SPAN class="code-quote">"m_log"</SPAN> optional=<SPAN class="code-quote">"true"</SPAN>

503

default-implementation=

504

<SPAN class="code-quote">"org.apache.felix.ipojo.example.default.MyLogService"</SPAN>/>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

...

</DIV></DIV>

<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>

<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 "bind" 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>

</UL>

<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

525

<H2><A name="ServiceRequirementHandler-Noteonserviceinterfacediscovery"></A>Note on service interface discovery</H2>

526

Clement Escoffier

8350751

2008-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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

528

</TD>

529

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

530

<H6><A name="ServiceRequirementHandler-Overview"></A><B>Overview</B></H6>

531

<UL>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

532

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 & Install </A></LI>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H6><A name="ServiceRequirementHandler-GettingStarted"></A><B>Getting Started</B></H6>

539

<UL>

Clement Escoffier

8350751

2008-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 (Maven-Based) tutorial</A></LI>

542

<LI><A href="ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</A></LI>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H6><A name="ServiceRequirementHandler-UserGuide"></A><B>User Guide</B></H6>

547

<UL>

Clement Escoffier

8350751

2008-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

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H6><A name="ServiceRequirementHandler-Tools"></A><B>Tools</B></H6>

557

<UL>

Clement Escoffier

8350751

2008-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-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-in</A></LI>

561

<LI><A href="ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</A></LI>

Clement Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H6><A name="ServiceRequirementHandler-DeveloperGuide"></A><B>Developer Guide</B></H6>

566

<UL>

Clement Escoffier

8350751

2008-10-13 07:33:03 +0000

[diff] [blame^]

567

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 Escoffier

6b928e9

2008-05-16 20:33:54 +0000

[diff] [blame]

</UL>

<H6><A name="ServiceRequirementHandler-Misc%26Contact"></A><B>Misc & Contact</B></H6>

574

<UL>