Blame - ipojo/core/doc/providing-osgi-services.html - onos-felix

<LI><SPAN class="nobr"><A href="http://felix.apache.org/site/downloads.cgi" title="Visit page outside Confluence" rel="nofollow">downloads<SUP><IMG class="rendericon" src="http://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="http://felix.apache.org/site/documentation.html" title="documentation">documentation</A></LI>

19

<LI><A href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</A></LI>

20

<LI><A href="http://felix.apache.org/site/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="http://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="http://cwiki.apache.org/confluence/images/icons/linkext7.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN>

24

25

26

27

</LI>

</UL>

</DIV>

<H1><A name="ProvidingOSGiservices-ProvidingOSGiservices"></A>Providing OSGi services</H1>

34

35

<P>This handler allows publishing OSGi services. It manages:</P>

36

<UL>

37

<LI>service publication</LI>

38

<LI>service object creation</LI>

39

<LI>service un-registration</LI>

40

<LI>configuration property propagation</LI>

</UL>

<H1><A name="ProvidingOSGiservices-Asimpleexample"></A><B>A simple example</B></H1>

47

48

<P>The following code snippet shows a simple class implementing the FooService interface:</P>

49

50

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class FooProviderType1 <SPAN class="code-keyword">implements</SPAN> FooService {

51

<SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> m_foo = <SPAN class="code-quote">"foo"</SPAN>;

52

53

<SPAN class="code-keyword">public</SPAN> void foo() {

54

<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"foo "</SPAN> + m_foo);

}

}</PRE>

</DIV></DIV>

<P>To provide a service, the implementation class <B>NEEDS</B> to implement the service interface. By the way, it guaranties that each methods of the service interface are implemented.</P>

60

61

<P>To provide the service, the component type needs to declare the providing:</P>

62

63

<PRE class="code-xml"><SPAN class="code-tag"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>></SPAN>

</DIV></DIV>

<P>The <provides/> element suffice to declare that each instance of this type will provide the FooService. Indeed, the provided interface can be discovered by analyzing the implementation class. By default, all implemented interface are published in the same service registration. IPOJO looks down the entire inheritance tree.</P>

70

71

<H1><A name="ProvidingOSGiservices-ServicePublication"></A><B>Service Publication</B></H1>

72

73

<P>The provided service handler manages the service publication and providing. For each declared <EM>provides</EM>, the handler register a service. The service is published as long as the instance is valid. If the instance becomes invalid, the service is removed from the service registry.</P>

74

75

<P>By default, it publishes all interfaces implemented by the implementation class of the component class. It collects all super-interfaces (interfaces implemented by implemented interfaces and by super class). However it is possible to set exposed interface with the <EM>interface</EM> attribute to avoid to exposes all collected interfaces.</P>

76

77

<P>The following xml snippet is equivalent to the previous example:</P>

78

79

<PRE class="code-xml"><SPAN class="code-tag"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>></SPAN>

80

<SPAN class="code-tag"><provides interface=<SPAN class="code-quote">"...FooService "</SPAN>/></SPAN>

81

82

</DIV></DIV>

83

<P>If the implementation class implements several interfaces, all these interfaces are published by default in the same service publication. You can use the interface attribute to set exactly published interfaces. If you want to publish several interfaces, you can use the following syntax:</P>

84

85

<PRE class="code-xml"><SPAN class="code-tag"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>></SPAN>

86

<SPAN class="code-tag"><provides interface=<SPAN class="code-quote">"{...FooService, ...BarService}"</SPAN>/></SPAN>

</DIV></DIV>

<P><EM>Note</EM>: if you use the interface attribute, the handler check that all declared interface are really implemented by the implementation class. If an interface is not implemented, the handler throws an error.</P>

92

93

<P><EM>Note</EM>: if the implementation class does not implement any interface, you cannot provide a service. In this case, the handler throws an error.</P>

94

95

<H1><A name="ProvidingOSGiservices-ServiceProperties"></A><B>Service Properties</B></H1>

96

97

<P>The handler can manage service properties. Service properties are attached to published service and allow consumer filtering providers. A property can be attached to a field (contained in the component implementation class), and so by handle dynamically.</P>

98

99

<P>Let's take a new example very closed of the last one:</P>

100

101

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class FooProviderType1 <SPAN class="code-keyword">implements</SPAN> FooService {

102

<SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> m_foo;

103

<SPAN class="code-keyword">public</SPAN> void foo() {

104

<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"foo "</SPAN> + m_foo);

105

m_foo = <SPAN class="code-quote">"bar"</SPAN>;

}

}</PRE>

</DIV></DIV>

<P>Remark that the m_foo field does not have any value. The following snippet shows a component publishing the <EM>FooService</EM>with two properties:</P>

110

111

<PRE class="code-xml"><SPAN class="code-tag"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>></SPAN>

112

113

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"foo"</SPAN> field=<SPAN class="code-quote">"m_foo"</SPAN> value=<SPAN class="code-quote">"Foo"</SPAN>></SPAN>

114

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"intProps"</SPAN> type=<SPAN class="code-quote">"int"</SPAN> value=<SPAN class="code-quote">"5"</SPAN>></SPAN>

</DIV></DIV>

<P>The first declared property will be attached to the _m_foo_ field. This property is published with the name <EM>foo</EM>. This property has a default value "Foo". This value will be injected in the _m_foo_ field, when this field asks for a value. A property with a field attribute does not need to declare a type (the type can be discovered by analyzing the implementation class).</P>

119

120

<P>The second property is published with the name <EM>intProps</EM>. This property is not attached to a field, so, we need to declare the property type. All primitive types or objects can be used has property type (for object, the qualified name of the class is used as java.lang.String).</P>

<P>The implementation class set a new value to the _m_foo_ field in the code. When this action occurs, the handler will modify the service publication to update the <EM>foo</EM> property published value. If a published property value becomes <EM>null</EM>, the property is unpublished since it has a new value.</P>

<P>If property does not have default value, the instance configuration needs to set a value for each unvalued property. Moreover, the instance can override the property value. The following xml snippet shows the declaration of an instance overriding the property values:</P>

129

130

<PRE class="code-xml"><SPAN class="code-tag"><instance component=<SPAN class="code-quote">"...FooProviderType1"</SPAN> name=<SPAN class="code-quote">"myFooServiceProvider"</SPAN>></SPAN>

131

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"foo"</SPAN> value=<SPAN class="code-quote">"baz"</SPAN>/></SPAN>

132

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"intProps"</SPAN> value=<SPAN class="code-quote">"2"</SPAN>/></SPAN>

</DIV></DIV>

<P>Properties can be attached to a method too. When a property receive a new value, this method is called with the new value in parameter. For example, when the foo property receive a new value (at instance creation or when the instance is reconfigured), the <EM>fooMethod</EM> is called. The <EM>fooMethod</EM> must have only one argument of the Foo type (String in the example).</P>

138

139

<PRE class="code-xml"><SPAN class="code-tag"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>></SPAN>

140

141

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"foo"</SPAN> method=<SPAN class="code-quote">"fooMethod"</SPAN> value=<SPAN class="code-quote">"Foo"</SPAN>></SPAN>

142

<SPAN class="code-tag"><property name=<SPAN class="code-quote">"intProps"</SPAN> type=<SPAN class="code-quote">"int"</SPAN> value=<SPAN class="code-quote">"5"</SPAN>></SPAN>

</DIV></DIV>

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class FooProviderType1 <SPAN class="code-keyword">implements</SPAN> FooService {

148

<SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> m_foo;

149

<SPAN class="code-keyword">public</SPAN> void foo() {

150

<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"foo "</SPAN> + m_foo);

151

} void fooMethod(<SPAN class="code-object">String</SPAN> newFoo) {

m_foo = newFoo;

}</PRE>

</DIV></DIV>

<P>A property can declare both a field and a method. In this case, the field receive the value and then the method is called. </P>

156

157

<PRE class="code-java"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>>

158

159

<property name=<SPAN class="code-quote">"foo"</SPAN> method=<SPAN class="code-quote">"fooMethod"</SPAN> field=<SPAN class="code-quote">"m_foo"</SPAN> value=<SPAN class="code-quote">"Foo"</SPAN>>

160

<property name=<SPAN class="code-quote">"intProps"</SPAN> type=<SPAN class="code-quote">"<SPAN class="code-object">int</SPAN>"</SPAN> value=<SPAN class="code-quote">"5"</SPAN>>

</provides>

</component></PRE>

</DIV></DIV>

<PRE class="code-java"><SPAN class="code-keyword">public</SPAN> class FooProviderType1 <SPAN class="code-keyword">implements</SPAN> FooService {

166

<SPAN class="code-keyword">private</SPAN> <SPAN class="code-object">String</SPAN> m_foo;

167

<SPAN class="code-keyword">public</SPAN> void foo() {

168

<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"foo "</SPAN> + m_foo);

169

} void fooMethod(<SPAN class="code-object">String</SPAN> newFoo) {

170

<SPAN class="code-object">System</SPAN>.out.println(<SPAN class="code-quote">"Update foo : "</SPAN> + m_foo);

}</PRE>

</DIV></DIV>

<H1><A name="ProvidingOSGiservices-Advancedfeatures"></A>Advanced features</H1>

175

176

177

<H2><A name="ProvidingOSGiservices-ServiceServing%26ObjectCreation"></A><B>Service Serving & Object Creation</B></H2>

178

179

<P>When a consumer requires the published service, the handler sends an object (instance) of the implementation class. By default, it is always the same instance. If no instance already exists, an instance is created.</P>

180

181

<P>However, the handler supports the OSGi <EM>Service Factory</EM>. In this case, for each requester bundle, the handler sends a new object. To activate this policy, add the <EM>factory</EM> attribute in the <EM>provides</EM> element:</P>

182

183

<PRE class="code-xml"><SPAN class="code-tag"><provides factory=<SPAN class="code-quote">"SERVICE"</SPAN>/></SPAN></PRE>

184

</DIV></DIV>

185

186

<H2><A name="ProvidingOSGiservices-SeveralServiceProviding"></A><B>Several Service Providing</B></H2>

187

188

<P>You can declare several <EM>provides</EM> inside the same component. All this provided service will be manage by the same handler but separately. Several services will be published (with different service registrations). This case is useful when service properties are different for the different services.</P>

189

190

<PRE class="code-java"><component className=<SPAN class="code-quote">"...FooProviderType1"</SPAN>>

191

<provides <SPAN class="code-keyword">interface</SPAN>=<SPAN class="code-quote">"...Foo"</SPAN>/>

192

<provides <SPAN class="code-keyword">interface</SPAN>=<SPAN class="code-quote">"...Bar"</SPAN>>

193

<property name=<SPAN class="code-quote">"foo"</SPAN> value=<SPAN class="code-quote">"baz"</SPAN>/>

</provides>

</component></PRE>

</DIV></DIV>

<H2><A name="ProvidingOSGiservices-ServicePropertyPropagation"></A><B>Service Property Propagation</B></H2>

200

201

<P>The configuration handler has the possibility to propagate received properties to service publication. So, when the propagation is activated, all properties received by the configuration handler will be propagated to all published service. If some properties are mapped on methods, these methods are invoked with the new value in argument.</P>

<H2><A name="ProvidingOSGiservices-Instancereconfiguration"></A><B>Instance reconfiguration</B></H2>

206

207

<P>The handler supports instance reconfiguration. When an instance is dynamically reconfigured, if the new configuration updates property values, these value are take into account (both for field, and service publication). If some of these properties have methods, these methods are invoked with the new value in argument.</P>

</TD>

</FORM>

<HR>

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

217

<UL>

218

219

<LI><A href="http://felix.apache.org/site/apache-felix-ipojo-feature-overview.html" title="Apache Felix iPOJO Feature Overview">iPOJO Feature Overview</A></LI>

220

<LI><A href="http://felix.apache.org/site/download.html" title="Download">Download & Install </A></LI>

</UL>

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

225

<UL>

226

<LI><A href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</A></LI>

227

<LI><A href="http://felix.apache.org/site/ipojo-hello-word-maven-based-tutorial.html" title="iPOJO Hello Word (Maven-Based) tutorial">iPOJO Hello Word (Maven-Based) tutorial</A></LI>

228

<LI><A href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</A></LI>

</UL>

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

233

<UL>

234

<LI><A href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components</A></LI>

235

<LI><A href="http://felix.apache.org/site/how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</A></LI>

236

<LI><A href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</A></LI>

</UL>

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

242

<UL>

243

<LI><A href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</A></LI>

244

<LI><A href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</A></LI>

245

<LI><A href="http://felix.apache.org/site/ipojo-maven-plug-in.html" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</A></LI>

246

<LI><A href="http://felix.apache.org/site/ipojo-concepts-overview.html" title="iPOJO Concepts Overview">iPOJO concepts overview</A></LI>

</UL>

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

251

<UL>

252

<LI><A href="http://felix.apache.org/site/how-to-write-your-own-handler.html" title="How to write your own handler">How to write your own handler</A></LI>

253

<LI><A href="http://felix.apache.org/site/how-to-use-ipojo-manipulation-metadata.html" title="How to use iPOJO Manipulation Metadata">How to use iPOJO Manipulation Metadata</A></LI>

</UL>

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

258

<UL>

259

<LI><A href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</A></LI>

260

<LI><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=FELIX&title=Supported%20JVMs&linkCreation=true&fromPageId=82824" title="Create Page: Supported JVMs" class="createlink">Supported JVMs<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>

261

<LI><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=FELIX&title=Supported%20OSGi%20Implementations&linkCreation=true&fromPageId=82824" title="Create Page: Supported OSGi Implementations" class="createlink">Supported OSGi Implementations<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>

262

<LI><A href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</A></LI>

263

<LI><SPAN class="nobr"><A href="http://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=FELIX&title=Contact&linkCreation=true&fromPageId=82824" title="Create Page: Contact" class="createlink">Contact<SUP><IMG class="rendericon" src="http://cwiki.apache.org/confluence/images/icons/plus.gif" height="7" width="7" align="absmiddle" alt="" border="0"></SUP></A></SPAN></LI>

264

<LI><A href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</A></LI>

265

<LI><A href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</A></LI>

</UL>

<HR>