Blame - ipojo/plugin/doc/ipojo-maven-plug-in.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

5025402

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

[diff] [blame]

24

25

26

27

</LI>

28

</UL>

Clement Escoffier

130ca57

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

[diff] [blame]

29

</DIV>

Clement Escoffier

5025402

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

[diff] [blame]

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

34

35

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

<packaging>bundle</packaging> <BR>

40

<FONT color="red"> </FONT> <FONT color="red"><groupId>$YOUR_GROUP_ID</groupId></FONT><BR>

41

<FONT color="red"> </FONT><FONT color="red"><artifactId>$YOUR_ARTIFACT_ID</artifactId></FONT><BR>

42

<FONT color="red"> </FONT> <FONT color="red"><version>$YOUR_ARTIFACT_VERSION</version></FONT><BR>

43

<FONT color="red"> </FONT> <FONT color="red"><name>$YOUR_PROJECT_NAME</name></FONT></P>

44

45

Clement Escoffier

130ca57

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

[diff] [blame]

46

<FONT color="red">   </FONT> <FONT color="red">$YOUR_MAVEN_DEPENDENCIES</FONT><BR>

Clement Escoffier

5025402

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

[diff] [blame]

47

48

Clement Escoffier

5025402

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

[diff] [blame]

49

50

51

<BR>

52

53

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

54

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

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

59

<FONT color="red">           </FONT><FONT color="red"><Private-Package>$YOUR_PRIVATE_PACKAGE</Private-Package></FONT><BR>

60

<FONT color="red">           </FONT><FONT color="red"><Export-Package>$YOUR_EXPORTED_PACKAGE</Export-Package></FONT><BR>

61

         </instructions><BR>

62

       </configuration><BR>

63

     </plugin><BR>

64

<BR>

65

66

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

67

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

Clement Escoffier

130ca57

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

[diff] [blame]

68

Clement Escoffier

5025402

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

[diff] [blame]

                     <goal>ipojo-bundle</goal><BR>

73

              </goals><BR>

74

         </execution><BR>

75

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

82

83

<H2><A name="iPOJOMavenPlug-in-Execution"></A>Execution</H2>

84

85

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

86

87

<P>[INFO] Scanning for projects...<BR>

88

[INFO] ----------------------------------------------------------------------------<BR>

89

[INFO] Building Hello Client<BR>

90

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

91

[INFO] ----------------------------------------------------------------------------<BR>

92

[INFO] [clean:clean]<BR>

93

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

94

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

95

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

96

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

97

[INFO] [resources:resources]<BR>

98

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

99

[INFO] Copying 1 resource<BR>

100

[INFO] [compiler:compile]<BR>

101

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

102

[INFO] [resources:testResources]<BR>

103

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

104

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

105

[INFO] [compiler:testCompile]<BR>

106

[INFO] No sources to compile<BR>

107

[INFO] [surefire:test]<BR>

108

[INFO] No tests to run.<BR>

109

[INFO] [bundle:bundle]<BR>

110

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

111

[INFO] Start bundle manipulation<BR>

112

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

113

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

114

[INFO] Bundle manipulation - SUCCESS<BR>

115

[INFO] [install:install]<BR>

116

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

117

[INFO] ------------------------------------------------------------------------<BR>

118

[INFO] BUILD SUCCESSFUL<BR>

119

[INFO] ------------------------------------------------------------------------<BR>

120

[INFO] Total time: 9 seconds<BR>

121

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

122

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

123

[INFO] ------------------------------------------------------------------------</P>

124

</DIV></DIV>

125

<H2><A name="iPOJOMavenPlug-in-ConfigurationOptions"></A>Configuration Options</H2>

126

127

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

128

129

130

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

131

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

Clement Escoffier

130ca57

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

[diff] [blame]

132

Clement Escoffier

5025402

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

[diff] [blame]

            <goal>ipojo-bundle</goal><BR>

137

        </goals><BR>

138

139

             <FONT color="red"><metadata>ipojo/meta.xml</metadata></FONT><BR>

140

        </configuration><BR>

141

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

146

147

<P>The second option allows skipping annotations processing, by using the "<EM>ignoreAnnotations</EM>" element:</P>

148

149

150

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

151

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

Clement Escoffier

130ca57

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

[diff] [blame]

152

Clement Escoffier

5025402

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

[diff] [blame]

            <goal>ipojo-bundle</goal><BR>

        </goals><BR>

        </configuration><BR>

161

        </execution><BR>

162

   </executions><BR>

163

</plugin></P>

Clement Escoffier

130ca57

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

[diff] [blame]

164

</DIV></DIV>

165

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

166

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

167

168

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

169

-DarchetypeArtifactId=maven-ipojo-plugin

170

-DarchetypeGroupId=org.apache.felix

171

-DartifactId=ARTIFACT_NAME_OF_YOUR_PROJECT

172

-DgroupId=GROUP_ID_OF_YOUR_PROJECT

173

-DarchetypeVersion=VERSION_OF_YOUR_PROJECT

174

-DpackageName=PACKAGE_NAME</PRE>

175

</DIV></DIV>

176

<P>This command generates :</P>

177

<UL>

178

179

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

180

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

</UL>

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

185

186

<P><EM>Note:</EM> the maven-ipojo-plugin archetype gerenrate a pom file using the latest released version of the mavne-ipojo-plugin.</P>

187

</TD>

Clement Escoffier

5025402

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

[diff] [blame]

188

Clement Escoffier

5025402

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

[diff] [blame]

189

<H6><A name="iPOJOMavenPlug-in-Overview"></A><B>Overview</B></H6>

190

<UL>

Clement Escoffier

130ca57

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

[diff] [blame]

191

192

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

193

<LI><A href="download.html" title="Download">Download & Install </A></LI>

Clement Escoffier

5025402

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

[diff] [blame]

</UL>

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

198

<UL>

Clement Escoffier

130ca57

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

[diff] [blame]

199

<LI><A href="ipojo-in-10-minutes.html" title="iPOJO in 10 minutes">iPOJO in 10 minutes</A></LI>

200

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

201

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

Clement Escoffier

5025402

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

[diff] [blame]

</UL>

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

206

<UL>

Clement Escoffier

130ca57

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

[diff] [blame]

207

<LI><A href="describing-components.html" title="Describing components">Describing components (handler list) </A></LI>

208

<LI><A href="how-to-use-ipojo-annotations.html" title="How to use iPOJO Annotations">How to use iPOJO Annotations</A></LI>

209

<LI><A href="using-xml-schemas.html" title="Using XML Schemas">Using XML Schemas</A></LI>

210

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

211

Clement Escoffier

5025402

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

[diff] [blame]

</UL>

<H6><A name="iPOJOMavenPlug-in-Tools"></A><B>Tools</B></H6>

216

<UL>

Clement Escoffier

130ca57

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

[diff] [blame]

217

<LI><A href="ipojo-eclipse-plug-in.html" title="iPOJO Eclipse Plug-in">iPOJO Eclipse Plug-in</A></LI>

218

<LI><A href="ipojo-ant-task.html" title="iPOJO Ant Task">iPOJO Ant Task</A></LI>

Clement Escoffier

5025402

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

[diff] [blame]

219

<LI><A href="#" title="iPOJO Maven Plug-in">iPOJO Maven Plug-in</A></LI>

Clement Escoffier

130ca57

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

[diff] [blame]

220

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

Clement Escoffier

5025402

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

[diff] [blame]

</UL>

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

225

<UL>

Clement Escoffier

130ca57

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

[diff] [blame]

226

227

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

228

<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

5025402

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

[diff] [blame]

</UL>

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

233

<UL>