Blame - ipojo/plugin/doc/ipojo-maven-plug-in.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="ipojo-maven-plug-in_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>

16

<li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li>

17

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

18

<li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li>

19

20

<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="ipojo-maven-plug-in_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>

21

<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="ipojo-maven-plug-in_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span>

Clement Escoffier

6b928e9

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

[diff] [blame]

22

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

23

24

25

26

</p></li></ul> </div>

<h1><a name="iPOJOMavenPlug-in-HowtousetheiPOJOMavenPlugin"></a>How to use the iPOJO Maven Plug-in</h1>

Clement Escoffier

6b928e9

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

[diff] [blame]

31

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

32

<p>To use the iPOJO Maven plug-in, edit the following pom.xml (replace all $xxx elements):</p>

<packaging>bundle</packaging> <br>

37

<font color="red"> </font> <font color="red"><groupId>$YOUR_GROUP_ID</groupId></font><br>

38

<font color="red"> </font><font color="red"><artifactId>$YOUR_ARTIFACT_ID</artifactId></font><br>

39

<font color="red"> </font> <font color="red"><version>$YOUR_ARTIFACT_VERSION</version></font><br>

40

<font color="red"> </font> <font color="red"><name>$YOUR_PROJECT_NAME</name></font></p>

Clement Escoffier

6b928e9

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

[diff] [blame]

41

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

42

43

<font color="red">   </font> <font color="red">$YOUR_MAVEN_DEPENDENCIES</font><br>

44

Clement Escoffier

6b928e9

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

[diff] [blame]

45

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

46

47

48

<br>

49

50

       <groupId>org.apache.felix</groupId><br>

51

       <artifactId>maven-bundle-plugin</artifactId><br>

<Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName><br>

57

<font color="red">           </font><font color="red"><Private-Package>$YOUR_PRIVATE_PACKAGE</Private-Package></font><br>

58

<font color="red">           </font><font color="red"><Export-Package>$YOUR_EXPORTED_PACKAGE</Export-Package></font><br>

59

         </instructions><br>

60

       </configuration><br>

61

     </plugin><br>

62

<br>

63

64

             <groupId>org.apache.felix</groupId><br>

65

             <artifactId>maven-ipojo-plugin</artifactId><br>

             <goal>ipojo-bundle</goal><br>

72

              </goals><br>

73

         </execution><br>

74

       </executions><br>

     </plugin><br>

   </plugins><br>

 </build><br>

</project></p>

</div></div>

<p>The iPOJO Maven Plug-in is generally used with the BND Maven Plug-in

81

(more details here). However the two configurations are completely

82

separated. So, you can use all BND Maven plug-in features. The iPOJO

83

configuration section can be used as previously written without any

84

changes. However it requires that your metadata file is inside the

85

"src/main/resources" folder and is named "metadata.xml".</p>

Clement Escoffier

6b928e9

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

[diff] [blame]

86

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

87

<h2><a name="iPOJOMavenPlug-in-Execution"></a>Execution</h2>

Clement Escoffier

6b928e9

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

[diff] [blame]

88

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

89

<p>To manipulate your project, use the "<em>mvn clean install</em>" command. The output should be like:</p>

90

91

<p>[INFO] Scanning for projects...<br>

92

[INFO] ----------------------------------------------------------------------------<br>

93

[INFO] Building Hello Client<br>

94

[INFO]   task-segment: [clean, install]<br>

95

[INFO] ----------------------------------------------------------------------------<br>

96

[INFO] [clean:clean]<br>

97

[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target<br>

98

[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<br>

99

[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\test-classes<br>

100

[INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\site<br>

101

[INFO] [resources:resources]<br>

102

[INFO] Using default encoding to copy filtered resources.<br>

103

[INFO] Copying 1 resource<br>

104

[INFO] [compiler:compile]<br>

105

[INFO] Compiling 1 source file to D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<br>

106

[INFO] [resources:testResources]<br>

107

[INFO] Using default encoding to copy filtered resources.<br>

108

[INFO] Resource directory does not exist: D:\clement\workspaces\iPOJO-Dev\hello.client\src\test\resources<br>

109

[INFO] [compiler:testCompile]<br>

110

[INFO] No sources to compile<br>

111

[INFO] [surefire:test]<br>

112

[INFO] No tests to run.<br>

113

[INFO] [bundle:bundle]<br>

114

[INFO] [org.apache.felix.ipojo.:ipojo-bundle {execution: default}]<br>

115

[INFO] Start bundle manipulation<br>

116

[INFO] Metadata File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes\metadata.xml<br>

117

[INFO] Input Bundle File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar<br>

118

[INFO] Bundle manipulation - SUCCESS<br>

119

[INFO] [install:install]<br>

120

[INFO] Installing

121

D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar

122

to

123

D:\Dev\maven-repo\ipojo\example\hello.client\0.0.1\hello.client-0.0.1.jar<br>

124

[INFO] ------------------------------------------------------------------------<br>

125

[INFO] BUILD SUCCESSFUL<br>

126

[INFO] ------------------------------------------------------------------------<br>

127

[INFO] Total time: 9 seconds<br>

128

[INFO] Finished at: Mon Aug 13 14:04:55 CEST 2007<br>

129

[INFO] Final Memory: 6M/13M<br>

130

[INFO] ------------------------------------------------------------------------</p>

131

</div></div>

132

<h2><a name="iPOJOMavenPlug-in-ConfigurationOptions"></a>Configuration Options</h2>

Clement Escoffier

6b928e9

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

[diff] [blame]

133

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

134

<p>You can configure the localization of the iPOJO metadata file as following:</p>

135

136

137

    <groupId>org.apache.felix</groupId><br>

138

    <artifactId>maven-ipojo-plugin</artifactId><br>

            <goal>ipojo-bundle</goal><br>

144

        </goals><br>

145

146

             <font color="red"><metadata>ipojo/meta.xml</metadata></font><br>

147

        </configuration><br>

148

        </execution><br>

   </executions><br>

</plugin></p>

</div></div>

<p>In the metadata element, you can specify your metadata files. This

153

file must be either in the same directory than the POM file (project

154

root) or in one of the resource folder of the maven project (for

155

instance, "src/main/resources/ipojo/meta.xml").</p>

Clement Escoffier

6b928e9

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

[diff] [blame]

156

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

157

<p>The second option allows skipping annotations processing, by using the <tt>ignoreAnnotations</tt> element:</p>

158

159

160

    <groupId>org.apache.felix</groupId><br>

161

    <artifactId>maven-ipojo-plugin</artifactId><br>

            <goal>ipojo-bundle</goal><br>

        </goals><br>

        </configuration><br>

171

        </execution><br>

   </executions><br>

</plugin></p>

</div></div>

<p>You can also ignore embedded XML-Schemas to use external ones. To do so, add the <tt>ignoreEmbeddedSchemas</tt>. If set to <tt>true</tt>, the manipulator doesn't use embedded XML-Schemas [1.1.0-SNAPSHOT]:</p>

177

178

179

    <groupId>org.apache.felix</groupId><br>

180

    <artifactId>maven-ipojo-plugin</artifactId></p>

Clement Escoffier

8350751

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

[diff] [blame]

181

182

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

            <goal>ipojo-bundle</goal><br>

        </goals><br>

        </configuration><br>

192

        </execution><br>

193

   </executions><br>

194

</plugin></p>

195

</div></div>

Clement Escoffier

6b928e9

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

[diff] [blame]

196

197

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

198

<h2><a name="iPOJOMavenPlug-in-GeneratetheskeletonofyouriPOJObundle"></a>Generate the skeleton of your iPOJO bundle</h2>

199

<p>The maven-ipojo-plugin provides a way to generate the skeleton of

200

your project. To generate this structure, just launch the following

201

command:</p>

202

203

<pre class="code-java">mvn org.apache.maven.plugins:maven-archetype-plugin:create \

204

-DarchetypeArtifactId=maven-ipojo-plugin \

205

-DarchetypeGroupId=org.apache.felix \

206

-DartifactId=ARTIFACT_NAME_OF_YOUR_PROJECT \

207

-DgroupId=GROUP_ID_OF_YOUR_PROJECT \

208

-DarchetypeVersion=VERSION_OF_YOUR_PROJECT \

209

-DpackageName=PACKAGE_NAME</pre>

210

</div></div>

211

<p>This command generates :</p>

212

<ul>

213

214

<li>the src/main/java and src/main/resources folders,</li>

215

<li>the structure of your package name.</li>

216

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

217

218

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

219

<p>The src/main/resources folder contains a metadata.xml file to fill out.</p>

220

221

<p><em>Note:</em> the maven-ipojo-plugin archetype generates a pom file using the latest released version of the maven-ipojo-plugin.</p>

222

223

<h2><a name="iPOJOMavenPlug-in-DescribingiPOJOconfigurationinthepomfile\Newinthe1.1.0SNAPSHOTversion\"></a>Describing iPOJO configuration in the pom file [New in the 1.1.0-SNAPSHOT version ]</h2>

224

<p>It is also possible to describe iPOJO components and instances

225

inside the pom file (avoiding using a externalized file). The

226

configuration can be described in the <tt>metadata</tt> attribute inside a CDATA block.</p>

227

228

229

<span class="code-tag"><groupId></span>org.apache.felix<span class="code-tag"></groupId></span>

230

<span class="code-tag"><artifactId></span>maven-ipojo-plugin<span class="code-tag"></artifactId></span>

231

<span class="code-tag"><version></span>1.1.0-SNAPSHOT<span class="code-tag"></version></span>

<span class="code-tag"><goal></span>ipojo-bundle<span class="code-tag"></goal></span>

<![CDATA[

<ipojo

<span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span>

243

xsi:schemaLocation=<span class="code-quote">"org.apache.felix.ipojo http://felix.apache.org/ipojo/schemas/1.1.0-SNAPSHOT/core.xsd"</span>

244

xmlns=<span class="code-quote">"org.apache.felix.ipojo"</span>>

245

<component

246

classname=<span class="code-quote">"org.apache.felix.ipojo.test.scenarios.component.LifecycleControllerTest"</span>

247

name=<span class="code-quote">"LFC-Test"</span>>

248

249

<span class="code-tag"><controller field=<span class="code-quote">"m_state"</span> /></span>

250

251

<span class="code-tag"><property name=<span class="code-quote">"conf"</span> field=<span class="code-quote">"m_conf"</span> method=<span class="code-quote">"setConf"</span> /></span>

<component

classname=<span class="code-quote">"org.apache.felix.ipojo.test.scenarios.component.LifecycleControllerTest"</span>

256

name=<span class="code-quote">"LFC-Test-Immediate"</span> immediate=<span class="code-quote">"true"</span> architecture=<span class="code-quote">"true"</span>>

257

258

<span class="code-tag"><controller field=<span class="code-quote">"m_state"</span> /></span>

259

260

<span class="code-tag"><property name=<span class="code-quote">"conf"</span> field=<span class="code-quote">"m_conf"</span> method=<span class="code-quote">"setConf"</span> /></span>

]]>

</div></div>

</td>

<h6><a name="iPOJOMavenPlug-in-Overview"></a><b>Overview</b></h6>

274

<ul>

275

276

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

277

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

278

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

279

280

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

281

<h6><a name="iPOJOMavenPlug-in-GettingStarted"></a><b>Getting Started</b></h6>

282

<ul>

283

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

284

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

285

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

286

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

287

<li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li>

288

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

289

290

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

291

<h6><a name="iPOJOMavenPlug-in-UserGuide"></a><b>User Guide</b></h6>

292

<ul>

293

<li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li>

294

<li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li>

295

<li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li>

296

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

297

298

<li><a href="http://felix.apache.org/site/ipojo-reference-card.html" title="iPOJO-Reference-Card">iPOJO Reference Card</a></li>

299

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

300

301

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

302

<h6><a name="iPOJOMavenPlug-in-Tools"></a><b>Tools</b></h6>

303

<ul>

304

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

305

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

306

<li><a href="" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li>

307

<li><a href="http://felix.apache.org/site/ipojo-arch-command.html" title="iPOJO-Arch-Command">iPOJO Arch Command</a></li>

308

<li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li>

309

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

310

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

311

312

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

313

<h6><a name="iPOJOMavenPlug-in-DeveloperGuide"></a><b>Developer Guide</b></h6>

314

<ul>

315

316

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

317

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

318

<li><a href="http://felix.apache.org/site/dive-into-the-ipojo-manipulation-depths.html" title="Dive into the iPOJO Manipulation depths">Dive into the iPOJO Manipulation depths</a></li>

319

</ul>

Clement Escoffier

6b928e9

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

[diff] [blame]

320

Clement Escoffier

8251f60

2009-01-15 15:35:17 +0000

[diff] [blame]

321

322

<h6><a name="iPOJOMavenPlug-in-Misc&Contact"></a><b>Misc & Contact</b></h6>

323

<ul>

324

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

325

<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li>

326

<li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li>

327

<li><span class="nobr"><a href="http://ipojo-dark-side.blogspot.com/" title="Visit page outside Confluence" rel="nofollow">iPOJO's Dark Side Blog<sup><img class="rendericon" src="ipojo-maven-plug-in_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></li>

328

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

329

<li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li>

330

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

331

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

</ul>

<hr>

var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");

341

document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));

342

</script><script src="ipojo-maven-plug-in_files/ga.js" type="text/javascript"></script>

343

344

var pageTracker = _gat._getTracker("UA-1518442-4");

345

pageTracker._trackPageview();

346

</script>

347

</td></tr></tbody></table>

348

</div>

349

</body></html>