| <!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html><head> |
| |
| |
| |
| <title>Apache Felix - iPOJO Maven Plug-in</title> |
| <link rel="stylesheet" href="ipojo-maven-plug-in_files/site.css" type="text/css" media="all"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| </head><body> |
| <div class="title"><div class="logo"><a href="http://felix.apache.org/site/index.html"><img alt="Apache Felix" src="ipojo-maven-plug-in_files/logo.png" border="0"></a></div><div class="header"><a href="http://www.apache.org/"><img alt="Apache" src="ipojo-maven-plug-in_files/apache.png" border="0"></a></div></div> |
| <div class="menu"> |
| <ul> |
| <li><a href="http://felix.apache.org/site/news.html" title="news">news</a></li> |
| <li><a href="http://felix.apache.org/site/license.html" title="license">license</a></li> |
| <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> |
| <li><a href="http://felix.apache.org/site/documentation.html" title="documentation">documentation</a></li> |
| <li><a href="http://felix.apache.org/site/mailinglists.html" title="mailinglists">mailing lists</a></li> |
| <li><a href="http://felix.apache.org/site/contributing.html" title="Contributing">contributing</a></li> |
| <li><span class="nobr"><a href="http://www.apache.org/" title="Visit page outside Confluence" rel="nofollow">asf<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> |
| <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> |
| <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> |
| <!-- ApacheCon Ad --> |
| <iframe src="ipojo-maven-plug-in_files/button.html" style="border-width: 0pt; float: left;" scrolling="no" width="135" frameborder="0" height="135"></iframe> |
| <p style="height: 100px;"> |
| <!-- ApacheCon Ad --> |
| </p></li></ul> </div> |
| <div class="main"> |
| <table class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><tbody><tr> |
| <td class="confluenceTd" valign="top" width="80%"> |
| <h1><a name="iPOJOMavenPlug-in-HowtousetheiPOJOMavenPlugin"></a>How to use the iPOJO Maven Plug-in</h1> |
| |
| <p>To use the iPOJO Maven plug-in, edit the following pom.xml (replace all $xxx elements):</p> |
| <div class="panel"><div class="panelContent"> |
| <p><project><br> |
| <modelVersion>4.0.0</modelVersion><br> |
| <packaging>bundle</packaging> <!-- Use the BND Maven plug-in --><br> |
| <font color="red"> </font> <font color="red"><groupId>$YOUR_GROUP_ID</groupId></font><br> |
| <font color="red"> </font><font color="red"><artifactId>$YOUR_ARTIFACT_ID</artifactId></font><br> |
| <font color="red"> </font> <font color="red"><version>$YOUR_ARTIFACT_VERSION</version></font><br> |
| <font color="red"> </font> <font color="red"><name>$YOUR_PROJECT_NAME</name></font></p> |
| |
| <p><font color="red"> </font> <font color="red"><dependencies></font><br> |
| <font color="red"> </font> <font color="red">$YOUR_MAVEN_DEPENDENCIES</font><br> |
| <font color="red"> </font> <font color="red"></dependencies></font></p> |
| |
| <p> <build><br> |
| <plugins><br> |
| <!-- BND Maven Plugin Configuration --><br> |
| <plugin><br> |
| <groupId>org.apache.felix</groupId><br> |
| <artifactId>maven-bundle-plugin</artifactId><br> |
| <extensions>true</extensions><br> |
| <configuration><br> |
| <instructions><br> |
| |
| <Bundle-SymbolicName>${pom.artifactId}</Bundle-SymbolicName><br> |
| <font color="red"> </font><font color="red"><Private-Package>$YOUR_PRIVATE_PACKAGE</Private-Package></font><br> |
| <font color="red"> </font><font color="red"><Export-Package>$YOUR_EXPORTED_PACKAGE</Export-Package></font><br> |
| </instructions><br> |
| </configuration><br> |
| </plugin><br> |
| <!-- iPOJO Maven Plugin Configuration : nothing to do --><br> |
| <plugin><br> |
| <groupId>org.apache.felix</groupId><br> |
| <artifactId>maven-ipojo-plugin</artifactId><br> |
| <version>1.0.0</version><br> |
| <executions><br> |
| <execution><br> |
| <goals><br> |
| |
| <goal>ipojo-bundle</goal><br> |
| </goals><br> |
| </execution><br> |
| </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 |
| (more details here). However the two configurations are completely |
| separated. So, you can use all BND Maven plug-in features. The iPOJO |
| configuration section can be used as previously written without any |
| changes. However it requires that your metadata file is inside the |
| "src/main/resources" folder and is named "metadata.xml".</p> |
| |
| <h2><a name="iPOJOMavenPlug-in-Execution"></a>Execution</h2> |
| |
| <p>To manipulate your project, use the "<em>mvn clean install</em>" command. The output should be like:</p> |
| <div class="panel"><div class="panelContent"> |
| <p>[INFO] Scanning for projects...<br> |
| [INFO] ----------------------------------------------------------------------------<br> |
| [INFO] Building Hello Client<br> |
| [INFO] task-segment: [clean, install]<br> |
| [INFO] ----------------------------------------------------------------------------<br> |
| [INFO] [clean:clean]<br> |
| [INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target<br> |
| [INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<br> |
| [INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\test-classes<br> |
| [INFO] Deleting directory D:\clement\workspaces\iPOJO-Dev\hello.client\target\site<br> |
| [INFO] [resources:resources]<br> |
| [INFO] Using default encoding to copy filtered resources.<br> |
| [INFO] Copying 1 resource<br> |
| [INFO] [compiler:compile]<br> |
| [INFO] Compiling 1 source file to D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes<br> |
| [INFO] [resources:testResources]<br> |
| [INFO] Using default encoding to copy filtered resources.<br> |
| [INFO] Resource directory does not exist: D:\clement\workspaces\iPOJO-Dev\hello.client\src\test\resources<br> |
| [INFO] [compiler:testCompile]<br> |
| [INFO] No sources to compile<br> |
| [INFO] [surefire:test]<br> |
| [INFO] No tests to run.<br> |
| [INFO] [bundle:bundle]<br> |
| [INFO] [org.apache.felix.ipojo.:ipojo-bundle {execution: default}]<br> |
| [INFO] Start bundle manipulation<br> |
| [INFO] Metadata File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\classes\metadata.xml<br> |
| [INFO] Input Bundle File : D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar<br> |
| [INFO] Bundle manipulation - SUCCESS<br> |
| [INFO] [install:install]<br> |
| [INFO] Installing |
| D:\clement\workspaces\iPOJO-Dev\hello.client\target\hello.client-0.0.1.jar |
| to |
| D:\Dev\maven-repo\ipojo\example\hello.client\0.0.1\hello.client-0.0.1.jar<br> |
| [INFO] ------------------------------------------------------------------------<br> |
| [INFO] BUILD SUCCESSFUL<br> |
| [INFO] ------------------------------------------------------------------------<br> |
| [INFO] Total time: 9 seconds<br> |
| [INFO] Finished at: Mon Aug 13 14:04:55 CEST 2007<br> |
| [INFO] Final Memory: 6M/13M<br> |
| [INFO] ------------------------------------------------------------------------</p> |
| </div></div> |
| <h2><a name="iPOJOMavenPlug-in-ConfigurationOptions"></a>Configuration Options</h2> |
| |
| <p>You can configure the localization of the iPOJO metadata file as following:</p> |
| <div class="panel"><div class="panelContent"> |
| <p><plugin><br> |
| <groupId>org.apache.felix</groupId><br> |
| <artifactId>maven-ipojo-plugin</artifactId><br> |
| <version>1.0.0</version><br> |
| <executions><br> |
| <execution><br> |
| <goals><br> |
| <goal>ipojo-bundle</goal><br> |
| </goals><br> |
| <configuration><br> |
| <font color="red"><metadata>ipojo/meta.xml</metadata></font><br> |
| </configuration><br> |
| </execution><br> |
| </executions><br> |
| </plugin></p> |
| </div></div> |
| <p>In the metadata element, you can specify your metadata files. This |
| file must be either in the same directory than the POM file (project |
| root) or in one of the resource folder of the maven project (for |
| instance, "src/main/resources/ipojo/meta.xml").</p> |
| |
| <p>The second option allows skipping annotations processing, by using the <tt>ignoreAnnotations</tt> element:</p> |
| <div class="panel"><div class="panelContent"> |
| <p><plugin><br> |
| <groupId>org.apache.felix</groupId><br> |
| <artifactId>maven-ipojo-plugin</artifactId><br> |
| <version>1.0.0</version><br> |
| <executions><br> |
| <execution><br> |
| <goals><br> |
| <goal>ipojo-bundle</goal><br> |
| </goals><br> |
| <configuration><br> |
| <font color="red"><ignoreAnnotations>true</ignoreAnnotations></font><br> |
| </configuration><br> |
| </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> |
| <div class="panel"><div class="panelContent"> |
| <p><plugin><br> |
| <groupId>org.apache.felix</groupId><br> |
| <artifactId>maven-ipojo-plugin</artifactId></p> |
| |
| |
| <p> <version>1.0.0</version><br> |
| <executions><br> |
| <execution><br> |
| <goals><br> |
| <goal>ipojo-bundle</goal><br> |
| </goals><br> |
| <configuration><br> |
| <font color="red"><ignoreEmbeddedSchemas>true</ignoreEmbeddedSchemas></font><br> |
| </configuration><br> |
| </execution><br> |
| </executions><br> |
| </plugin></p> |
| </div></div> |
| |
| |
| <h2><a name="iPOJOMavenPlug-in-GeneratetheskeletonofyouriPOJObundle"></a>Generate the skeleton of your iPOJO bundle</h2> |
| <p>The maven-ipojo-plugin provides a way to generate the skeleton of |
| your project. To generate this structure, just launch the following |
| command:</p> |
| <div class="code"><div class="codeContent"> |
| <pre class="code-java">mvn org.apache.maven.plugins:maven-archetype-plugin:create \ |
| -DarchetypeArtifactId=maven-ipojo-plugin \ |
| -DarchetypeGroupId=org.apache.felix \ |
| -DartifactId=ARTIFACT_NAME_OF_YOUR_PROJECT \ |
| -DgroupId=GROUP_ID_OF_YOUR_PROJECT \ |
| -DarchetypeVersion=VERSION_OF_YOUR_PROJECT \ |
| -DpackageName=PACKAGE_NAME</pre> |
| </div></div> |
| <p>This command generates :</p> |
| <ul> |
| <li>a pom file (to fill out),</li> |
| <li>the src/main/java and src/main/resources folders,</li> |
| <li>the structure of your package name.</li> |
| </ul> |
| |
| |
| <p>The src/main/resources folder contains a metadata.xml file to fill out.</p> |
| |
| <p><em>Note:</em> the maven-ipojo-plugin archetype generates a pom file using the latest released version of the maven-ipojo-plugin.</p> |
| |
| <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> |
| <p>It is also possible to describe iPOJO components and instances |
| inside the pom file (avoiding using a externalized file). The |
| configuration can be described in the <tt>metadata</tt> attribute inside a CDATA block.</p> |
| <div class="code"><div class="codeContent"> |
| <pre class="code-xml"><span class="code-tag"><plugin></span> |
| <span class="code-tag"><groupId></span>org.apache.felix<span class="code-tag"></groupId></span> |
| <span class="code-tag"><artifactId></span>maven-ipojo-plugin<span class="code-tag"></artifactId></span> |
| <span class="code-tag"><version></span>1.1.0-SNAPSHOT<span class="code-tag"></version></span> |
| <span class="code-tag"><executions></span> |
| <span class="code-tag"><execution></span> |
| <span class="code-tag"><goals></span> |
| <span class="code-tag"><goal></span>ipojo-bundle<span class="code-tag"></goal></span> |
| <span class="code-tag"></goals></span> |
| <span class="code-tag"><configuration></span> |
| <span class="code-tag"><ignoreAnnotations></span>true<span class="code-tag"></ignoreAnnotations></span> |
| <span class="code-tag"><metadata></span> |
| <![CDATA[ |
| <ipojo |
| <span class="code-keyword">xmlns:xsi</span>=<span class="code-quote">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| xsi:schemaLocation=<span class="code-quote">"org.apache.felix.ipojo http://felix.apache.org/ipojo/schemas/1.1.0-SNAPSHOT/core.xsd"</span> |
| xmlns=<span class="code-quote">"org.apache.felix.ipojo"</span>> |
| <component |
| classname=<span class="code-quote">"org.apache.felix.ipojo.test.scenarios.component.LifecycleControllerTest"</span> |
| name=<span class="code-quote">"LFC-Test"</span>> |
| <span class="code-tag"><provides /></span> |
| <span class="code-tag"><controller field=<span class="code-quote">"m_state"</span> /></span> |
| <span class="code-tag"><properties></span> |
| <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> |
| <span class="code-tag"></properties></span> |
| <span class="code-tag"></component></span> |
| <component |
| classname=<span class="code-quote">"org.apache.felix.ipojo.test.scenarios.component.LifecycleControllerTest"</span> |
| name=<span class="code-quote">"LFC-Test-Immediate"</span> immediate=<span class="code-quote">"true"</span> architecture=<span class="code-quote">"true"</span>> |
| <span class="code-tag"><provides /></span> |
| <span class="code-tag"><controller field=<span class="code-quote">"m_state"</span> /></span> |
| <span class="code-tag"><properties></span> |
| <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> |
| <span class="code-tag"></properties></span> |
| <span class="code-tag"></component></span> |
| <span class="code-tag"></ipojo></span> |
| ]]> |
| <span class="code-tag"></metadata></span> |
| <span class="code-tag"></configuration></span> |
| <span class="code-tag"></execution></span> |
| <span class="code-tag"></executions></span> |
| <span class="code-tag"></plugin></span></pre> |
| </div></div> |
| </td> |
| <td class="confluenceTd" valign="top" width="20%"> |
| <h6><a name="iPOJOMavenPlug-in-Overview"></a><b>Overview</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo.html" title="Apache Felix iPOJO">Home Page</a></li> |
| <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> |
| <li><a href="http://felix.apache.org/site/download.html" title="Download">Download & Install </a></li> |
| </ul> |
| |
| |
| <h6><a name="iPOJOMavenPlug-in-GettingStarted"></a><b>Getting Started</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</a></li> |
| <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> |
| <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> |
| <li><a href="http://felix.apache.org/site/ipojo-advanced-tutorial.html" title="iPOJO Advanced Tutorial">iPOJO Advanced Tutorial</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-composition-tutorial.html" title="iPOJO Composition Tutorial">iPOJO Composition Tutorial</a></li> |
| </ul> |
| |
| |
| <h6><a name="iPOJOMavenPlug-in-UserGuide"></a><b>User Guide</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/describing-components.html" title="Describing components">Describing components (handler list) </a></li> |
| <li><a href="http://felix.apache.org/site/using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-testing-components.html" title="apache-felix-ipojo-testing-components">Testing components</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-advanced-topics.html" title="iPOJO Advanced Topics">Advanced Topics</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-faq.html" title="iPOJO FAQ">FAQ</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-reference-card.html" title="iPOJO-Reference-Card">iPOJO Reference Card</a></li> |
| </ul> |
| |
| |
| <h6><a name="iPOJOMavenPlug-in-Tools"></a><b>Tools</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</a></li> |
| <li><a href="" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</a></li> |
| <li><a href="http://felix.apache.org/site/ipojo-arch-command.html" title="iPOJO-Arch-Command">iPOJO Arch Command</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-junit4osgi.html" title="apache-felix-ipojo-junit4osgi">Junit4OSGi</a></li> |
| <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="iPOJOMavenPlug-in-DeveloperGuide"></a><b>Developer Guide</b></h6> |
| <ul> |
| <li>API: <span class="nobr"><a href="http://people.apache.org/%7Eclement/ipojo/api/1.0/" title="Visit page outside Confluence" rel="nofollow">1.0<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> |
| <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> |
| <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> |
| <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> |
| </ul> |
| |
| |
| <h6><a name="iPOJOMavenPlug-in-Misc&Contact"></a><b>Misc & Contact</b></h6> |
| <ul> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-issuestracker.html" title="apache-felix-ipojo-issuestracker">Issues Tracker</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedvms.html" title="apache-felix-ipojo-supportedVMs">Supported JVMs</a></li> |
| <li><a href="http://felix.apache.org/site/apache-felix-ipojo-supportedosgi.html" title="apache-felix-ipojo-supportedOSGi">Supported OSGi Implementations</a></li> |
| <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> |
| <li><a href="http://felix.apache.org/site/future-ideas.html" title="Future Ideas">Future Ideas</a></li> |
| <li><a href="http://felix.apache.org/site/contact.html" title="Contact">Contact</a></li> |
| <li><a href="http://felix.apache.org/site/related-works.html" title="Related Works">Related Works</a></li> |
| <li><a href="http://felix.apache.org/site/article-presentations.html" title="Article & Presentations">Article & Presentations</a></li> |
| </ul> |
| |
| |
| <hr> |
| <div class="" align="center"> |
| <p><span class="nobr"><a href="http://cwiki.apache.org/confluence/createrssfeed.action?types=blogpost&statuses=created&statuses=modified&spaces=FELIX&labelString=iPOJO&rssType=atom&maxResults=10&timeSpan=5&publicFeed=true&title=iPOJO%20Atom%20Feed" title="Stay tuned!" rel="nofollow"><img src="ipojo-maven-plug-in_files/feed-icon-32x32.png" align="absmiddle" border="0"><sup><img class="rendericon" src="ipojo-maven-plug-in_files/linkext7.gif" alt="" align="absmiddle" border="0" width="7" height="7"></sup></a></span></p></div> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script><script src="ipojo-maven-plug-in_files/ga.js" type="text/javascript"></script> |
| <script type="text/javascript"> |
| var pageTracker = _gat._getTracker("UA-1518442-4"); |
| pageTracker._trackPageview(); |
| </script> |
| </td></tr></tbody></table> |
| </div> |
| </body></html> |