Blame - ipojo/plugin/doc/ipojo-maven-plug-in.html - onos-felix

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

[diff] [blame]

185

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

186

187

<ul>

188

<li><a href="#iPOJOMavenPlug-in-Basicconfiguration">Basic configuration</a></li>

189

<li><a href="#iPOJOMavenPlug-in-Execution">Execution</a></li>

190

<li><a href="#iPOJOMavenPlug-in-ConfigurationOptions">Configuration Options</a></li>

191

<li><a href="#iPOJOMavenPlug-in-GeneratetheskeletonofyouriPOJObundle">Generate the skeleton of your iPOJO bundle</a></li>

192

<li><a href="#iPOJOMavenPlug-in-DescribingiPOJOconfigurationinthepomfile">Describing iPOJO configuration in the pom file</a></li>

193

</ul></div>

194

195

<h2><a name="iPOJOMavenPlug-in-Basicconfiguration"></a>Basic configuration</h2>

196

Clement Escoffier

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

[diff] [blame]

197

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

198

Clement Escoffier

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

[diff] [blame]

199

200

<packaging>bundle</packaging> <br>

201

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

202

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

Clement Escoffier

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

[diff] [blame]

203

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

204

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

Clement Escoffier

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

[diff] [blame]

205

Clement Escoffier

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

[diff] [blame]

206

207

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

208

Clement Escoffier

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

[diff] [blame]

209

Clement Escoffier

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

[diff] [blame]

210

211

212

<br>

213

214

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

215

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

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

221

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

222

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

223

         </instructions><br>

224

       </configuration><br>

225

     </plugin><br>

226

<br>

227

228

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

229

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

230

Clement Escoffier

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

[diff] [blame]

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

236

              </goals><br>

237

         </execution><br>

238

       </executions><br>

239

     </plugin><br>

240

   </plugins><br>

241

 </build><br>

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

242

</project></p></div>

Clement Escoffier

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

[diff] [blame]

243

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

244

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

245

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

246

configuration section can be used as previously written without any

247

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

248

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

Clement Escoffier

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

[diff] [blame]

249

Clement Escoffier

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

[diff] [blame]

250

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

Clement Escoffier

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

[diff] [blame]

251

Clement Escoffier

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

[diff] [blame]

252

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

253

<div class="pom"><p>[INFO] Scanning for projects...<br>

Clement Escoffier

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

[diff] [blame]

254

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

255

[INFO] Building Hello Client<br>

256

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

257

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

258

[INFO] [clean:clean]<br>

259

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

260

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

261

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

262

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

263

[INFO] [resources:resources]<br>

264

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

265

[INFO] Copying 1 resource<br>

266

[INFO] [compiler:compile]<br>

267

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

268

[INFO] [resources:testResources]<br>

269

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

270

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

271

[INFO] [compiler:testCompile]<br>

272

[INFO] No sources to compile<br>

273

[INFO] [surefire:test]<br>

274

[INFO] No tests to run.<br>

275

[INFO] [bundle:bundle]<br>

276

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

277

[INFO] Start bundle manipulation<br>

278

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

279

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

280

[INFO] Bundle manipulation - SUCCESS<br>

281

[INFO] [install:install]<br>

282

[INFO] Installing

283

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

284

to

285

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

286

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

287

[INFO] BUILD SUCCESSFUL<br>

288

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

289

[INFO] Total time: 9 seconds<br>

290

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

291

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

292

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

Clement Escoffier

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

[diff] [blame]

293

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

Clement Escoffier

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

[diff] [blame]

294

Clement Escoffier

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

[diff] [blame]

295

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

296

Clement Escoffier

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

[diff] [blame]

297

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

298

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

299

Clement Escoffier

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

[diff] [blame]

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

304

        </goals><br>

305

306

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

307

        </configuration><br>

308

        </execution><br>

309

   </executions><br>

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

310

</plugin></p></div>

Clement Escoffier

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

[diff] [blame]

311

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

312

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

313

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

314

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

Clement Escoffier

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

[diff] [blame]

315

Clement Escoffier

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

[diff] [blame]

316

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

317

Clement Escoffier

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

[diff] [blame]

318

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

319

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

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

320

Clement Escoffier

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

[diff] [blame]

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

        </goals><br>

        </configuration><br>

329

        </execution><br>

330

   </executions><br>

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

331

</plugin></p></div>

Clement Escoffier

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

[diff] [blame]

332

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

333

<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:</p>

334

Clement Escoffier

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

[diff] [blame]

335

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

336

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

Clement Escoffier

8350751

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

[diff] [blame]

337

338

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

339

Clement Escoffier

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

[diff] [blame]

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

        </goals><br>

        </configuration><br>

348

        </execution><br>

349

   </executions><br>

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

350

</plugin></p></div>

Clement Escoffier

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

[diff] [blame]

351

352

Clement Escoffier

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

[diff] [blame]

353

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

354

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

355

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

356

command:</p>

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

357

358

<div class="dp-highlighter"><table class="dp-c" border="0" cellpadding="0" cellspacing="0"><tbody><tr><td class="line1"><span>mvn org.apache.maven.plugins:maven-archetype-plugin:create \ </span></td></tr><tr><td class="line2">-DarchetypeArtifactId=maven-ipojo-plugin \ </td></tr><tr><td class="line1">-DarchetypeGroupId=org.apache.felix \ </td></tr><tr><td class="line2">-DartifactId=ARTIFACT_NAME_OF_YOUR_PROJECT \ </td></tr><tr><td class="line1">-DgroupId=GROUP_ID_OF_YOUR_PROJECT \ </td></tr><tr><td class="line2">-DarchetypeVersion=VERSION_OF_YOUR_PROJECT \ </td></tr><tr><td class="line1">-DpackageName=PACKAGE_NAME </td></tr></tbody></table></div><textarea style="display: none;" name="newcodemacro" class="java:nocontrols:nogutter" rows="10" readonly="readonly">mvn org.apache.maven.plugins:maven-archetype-plugin:create \

Clement Escoffier

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

[diff] [blame]

359

-DarchetypeArtifactId=maven-ipojo-plugin \

360

-DarchetypeGroupId=org.apache.felix \

361

-DartifactId=ARTIFACT_NAME_OF_YOUR_PROJECT \

362

-DgroupId=GROUP_ID_OF_YOUR_PROJECT \

363

-DarchetypeVersion=VERSION_OF_YOUR_PROJECT \

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

364

-DpackageName=PACKAGE_NAME</textarea>

365

366

if(!window.newcodemacro_initialised)

367

{

368

window.newcodemacro_initialised = true;

369

window.oldonloadmethod = window.onload;

370

window.onload = function(){

371

dp.SyntaxHighlighter.HighlightAll('newcodemacro');

372

if(window.oldonloadmethod)

373

{

374

window.oldonloadmethod();

}

}

}

</script>

</div>

Clement Escoffier

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

[diff] [blame]

382

<p>This command generates :</p>

383

<ul>

384

385

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

386

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

387

</ul>

Clement Escoffier

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

[diff] [blame]

388

389

Clement Escoffier

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

[diff] [blame]

390

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

391

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

392

<div class="panelMacro"><table class="infoMacro"><colgroup><col width="24"><col></colgroup><tbody><tr><td valign="top"><img src="ipojo-maven-plug-in_files/information.gif" alt="" border="0" align="absmiddle" height="16" width="16"></td><td><b>Maven Archetype</b><br><p>The maven-ipojo-plugin archetype generates a pom file using the latest released version of the maven-ipojo-plugin.</p></td></tr></tbody></table></div>

Clement Escoffier

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

[diff] [blame]

393

Clement Escoffier

2009-07-21 11:48:26 +0000

[diff] [blame^]

394

<h2><a name="iPOJOMavenPlug-in-DescribingiPOJOconfigurationinthepomfile"></a>Describing iPOJO configuration in the pom file</h2>

Clement Escoffier

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

[diff] [blame]

395

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

396

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

397

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

Clement Escoffier