How to Create a new OSGi Bundle - Revision history

Sichen at 00:26, 18 April 2013

2013-04-18T00:26:02Z

Sichen at 00:06, 25 February 2012

2012-02-25T00:06:33Z

Sichen at 00:01, 25 February 2012

2012-02-25T00:01:23Z

Sichen at 00:00, 25 February 2012

2012-02-25T00:00:47Z

Sichen at 00:00, 25 February 2012

2012-02-25T00:00:18Z

Sichen at 23:34, 24 February 2012

2012-02-24T23:34:23Z

Sichen at 22:59, 24 February 2012

2012-02-24T22:59:15Z

Sichen at 22:58, 24 February 2012

2012-02-24T22:58:53Z

Sichen at 22:32, 24 February 2012

2012-02-24T22:32:59Z

Sichen: Protected "How to Create a new OSGi Bundle": Sysop page [edit=sysop:move=sysop]

2012-02-24T22:02:41Z

Protected "How to Create a new OSGi Bundle": Sysop page [edit=sysop:move=sysop]

← Older revision		Revision as of 00:26, 18 April 2013
Line 59:		Line 59:

	Usually, I would be finished here. I've created a bundle, put code there, made a POM file for it, and then added it to its parent.		Usually, I would be finished here. I've created a bundle, put code there, made a POM file for it, and then added it to its parent.
		+
		+	If you are using the Eclipse IDE, then reimport the existing maven projects, and you will see your bundle listed under the Package Explorer, with the Java directory listed as a source code directory.

	This particular case, however, is more complex. You'll see why when we try to build it:		This particular case, however, is more complex. You'll see why when we try to build it:

@@ Line 58: / Line 58: @@
 </pre>
-It looks pretty good, doesn't it?  Let's try to build it:
+Usually, I would be finished here.  I've created a bundle, put code there, made a POM file for it, and then added it to its parent.
 <pre>
 $ mvn clean install
@@ Line 77: / Line 79: @@
 </pre>
-Ouch!  What happened?
+What happened is that the bundle where we moved <tt>Note.java</tt> was still looking for it.  In fact, if you look at <tt>notes/api/services/pom.xml, you will notice that it is listing <tt>org.opentaps.notes.domain</tt> as one of the packages that it exports:
 <pre>

@@ Line 178: / Line 178: @@
 After I install it, I go to Geronimo to deploy my new EBA -- and got an error:
 <pre>
-Caused by: org.apache.aries.application.management.ResolverException: The system cannot provision the EBA org.opentaps.notes.eba because the following problems in the dependency chain were detected:
+Caused by: org.apache.aries.application.management.ResolverException:
-The package dependency org.opentaps.notes.domain required by bundle [org.opentaps.notes.repository.api_2.0.1.SNAPSHOT, org.opentaps.notes.repository.impl_2.0.1.SNAPSHOT, org.opentaps.notes.services.impl_2.0.1.SNAPSHOT, org.opentaps.notes.rest_2.0.1.SNAPSHOT, org.opentaps.notes.services.api_2.0.1.SNAPSHOT] cannot be resolved.
+The system cannot provision the EBA org.opentaps.notes.eba because the following problems in the dependency chain were detected:
 </pre>

@@ Line 180: / Line 180: @@
 Caused by: org.apache.aries.application.management.ResolverException: The system cannot provision the EBA org.opentaps.notes.eba because the following problems in the dependency chain were detected:
 The package dependency org.opentaps.notes.domain required by bundle [org.opentaps.notes.repository.api_2.0.1.SNAPSHOT, org.opentaps.notes.repository.impl_2.0.1.SNAPSHOT, org.opentaps.notes.services.impl_2.0.1.SNAPSHOT, org.opentaps.notes.rest_2.0.1.SNAPSHOT, org.opentaps.notes.services.api_2.0.1.SNAPSHOT] cannot be resolved.
-<pre>
+</pre>
 This is because the EBA doesn't have my new bundle.  During the <tt>mvn clean install</tt>, maven showed me what it was putting in my EBA:

← Older revision		Revision as of 00:00, 25 February 2012
Line 144:		Line 144:

	It belongs to a different group!		It belongs to a different group!
		+
		+	With this correction, we finally get:
		+	<pre>
		+	[INFO] ------------------------------------------------------------------------
		+	[INFO] BUILD SUCCESS
		+	[INFO] ------------------------------------------------------------------------
		+	[INFO] Total time: 32.930s
		+	[INFO] Finished at: Fri Feb 24 15:26:18 PST 2012
		+	[INFO] Final Memory: 25M/81M
		+	[INFO] ------------------------------------------------------------------------
		+	</pre>
		+
		+	But wait -- there's more! We also got a jar file at <tt>modules/notes/domain/target/org.opentaps.notes.domain-2.0.1-SNAPSHOT.jar</tt>, and in that jar file you will find a <tt>MANIFEST.MF</tt> which contains:
		+	<pre>
		+	Manifest-Version: 1.0
		+	Export-Package: org.opentaps.notes.domain
		+	Built-By: sichen
		+	Tool: Bnd-1.15.0
		+	Bundle-Name: Notes domain
		+	Created-By: Apache Maven Bundle Plugin
		+	Bundle-Copyright: Copyright (c) 2010-2011 Open Source Strategies, Inc.
		+	Bundle-Vendor: Open Source Strategies
		+	Build-Jdk: 1.6.0_29
		+	Bundle-Version: 2.0.1.SNAPSHOT
		+	Bnd-LastModified: 1330125965050
		+	Bundle-ManifestVersion: 2
		+	Bundle-SymbolicName: org.opentaps.notes.domain
		+	Bundle-DocURL: http://www.opensourcestrategies.com/
		+	</pre>
		+
		+	This has turned a standard Java jar into an OSGi bundle. The key part is <tt>Export-Package: org.opentaps.notes.domain</tt>, which means that it is exporting our <tt>org.opentaps.notes.domain</tt> package so other bundles can import it. Our bundle is very simple, and by default the bundle plugin (remember the <tt> <artifactId>maven-bundle-plugin</artifactId></tt> from our <tt>pom.xml</tt>?) exports all packages in the bundle. You can, however, also specify <tt><Export-Package>, <Private-Package>, <Import-Package><tt> directives in <tt>pom.xml</tt> to control which packages are exported and which ones are not.
		+
		+	After I install it, I go to Geronimo to deploy my new EBA -- and got an error:
		+	<pre>
		+	Caused by: org.apache.aries.application.management.ResolverException: The system cannot provision the EBA org.opentaps.notes.eba because the following problems in the dependency chain were detected:
		+	The package dependency org.opentaps.notes.domain required by bundle [org.opentaps.notes.repository.api_2.0.1.SNAPSHOT, org.opentaps.notes.repository.impl_2.0.1.SNAPSHOT, org.opentaps.notes.services.impl_2.0.1.SNAPSHOT, org.opentaps.notes.rest_2.0.1.SNAPSHOT, org.opentaps.notes.services.api_2.0.1.SNAPSHOT] cannot be resolved.
		+	<pre>
		+
		+	This is because the EBA doesn't have my new bundle. During the <tt>mvn clean install</tt>, maven showed me what it was putting in my EBA:
		+	<pre>
		+	[INFO] --- eba-maven-plugin:0.3:eba (default-eba) @ tests-run ---
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:core:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:entity:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:tests:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps.testsuit, org.opentaps.testsuit:tests-wab:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps.testsuit, org.opentaps.testsuit:tests-app:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:org.apache.xmlrpc:jar:3.0.0-v20100427-1100, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:org.apache.ws.commons.util:jar:1.0.1-v20100518-1140, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.validator:jar:1.3.1, compile]
		+	[INFO] Copying artifact[org.apache.oro, org.apache.oro:com.springsource.org.apache.oro:jar:2.0.8, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.httpclient:jar:3.1.0, compile]
		+	[INFO] Copying artifact[mysql, mysql:mysql-connector-java:jar:5.1.18, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:validation.api:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:validation.impl:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:rest:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.rest:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.services.api:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.repository.api:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.repository.impl:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.services.impl:jar:2.0.1-SNAPSHOT, compile]
		+	[INFO] Copying artifact[org.restlet.jee, org.restlet.jee:org.restlet:jar:2.0.11, compile]
		+	[INFO] Copying artifact[org.restlet.jee, org.restlet.jee:org.restlet.ext.servlet:jar:2.0.11, compile]
		+	[INFO] Copying artifact[net.sourceforge.ezmorph, net.sourceforge.ezmorph:com.springsource.net.sf.ezmorph:jar:1.0.5, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.beanutils:jar:1.8.0, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.collections:jar:3.2.1, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.logging:jar:1.1.1, compile]
		+	[INFO] Copying artifact[org.apache.commons, org.apache.commons:com.springsource.org.apache.commons.lang:jar:2.5.0, compile]
		+	[INFO] Copying artifact[net.sourceforge.json, net.sourceforge.json:com.springsource.net.sf.json:jar:2.2.2, compile]
		+	[INFO] Building zip: /Users/sichen/git/opentaps-2/integration-tests/tests-run/target/org.opentaps.testsuit.tests-run-2.0.1-SNAPSHOT.eba
		+	[INFO]
		+	</pre>
		+
		+	and <tt>org.opentaps.notes.domain</tt> wasn't in the list. So I need to go to <tt>notes.eba/pom.xml</tt> to add my dependency, and then the next time I see it:
		+	<pre>
		+	[INFO] Copying artifact[org.opentaps, org.opentaps:notes.domain:jar:2.0.1-SNAPSHOT, compile]
		+	</pre>
		+
		+	Now Geronimo deploys the notes EBA, and I see <tt>org.opentaps.domain</tt> on the list of the OSGi bundles:
		+
		+	When I create a note from my HTML client, it works:
		+	<pre>
		+	mysql> select note_id, note_text, client_domain from NOTE_DATA where date_time_created > '2012-02-24' order by sequence_num;
		+	+----------------------------------+--------------------------------------------------------+---------------+
		+	\| note_id \| note_text \| client_domain \|
		+	+----------------------------------+--------------------------------------------------------+---------------+
		+	\| E20C2CF9868D44A7B05659B0203DBFBC \| creating a note from the new org.opentaps.notes.domain \| localhost \|
		+	+----------------------------------+--------------------------------------------------------+---------------+
		+	1 row in set (0.00 sec)
		+	</pre>

← Older revision		Revision as of 23:34, 24 February 2012
Line 57:		Line 57:
	$ git mv modules/notes/api/services/src/main/java/org/opentaps/notes/domain/Note.java modules/notes/domain/src/main/java/org/opentaps/notes/domain/		$ git mv modules/notes/api/services/src/main/java/org/opentaps/notes/domain/Note.java modules/notes/domain/src/main/java/org/opentaps/notes/domain/
	</pre>		</pre>
		+
		+	It looks pretty good, doesn't it? Let's try to build it:
		+	<pre>
		+	$ mvn clean install
		+	...
		+	[INFO] ------------------------------------------------------------------------
		+	[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:2.3.2:compile (default-compile) on project notes.services.api: Compilation failure: Compilation failure:
		+	[ERROR] /Users/sichen/git/opentaps-2/modules/notes/api/services/src/main/java/org/opentaps/notes/services/GetNoteByIdServiceOutput.java:[20,32] package org.opentaps.notes.domain does not exist
		+	[ERROR] /Users/sichen/git/opentaps-2/modules/notes/api/services/src/main/java/org/opentaps/notes/services/GetNoteByIdServiceOutput.java:[24,12] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.notes.services.GetNoteByIdServiceOutput
		+	[ERROR] /Users/sichen/git/opentaps-2/modules/notes/api/services/src/main/java/org/opentaps/notes/services/GetNoteByIdServiceOutput.java:[26,24] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.notes.services.GetNoteByIdServiceOutput
		+	[ERROR] /Users/sichen/git/opentaps-2/modules/notes/api/services/src/main/java/org/opentaps/notes/services/GetNoteByIdServiceOutput.java:[27,11] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.notes.services.GetNoteByIdServiceOutput
		+	[ERROR] -> [Help 1]
		+	</pre>
		+
		+	Ouch! What happened?
		+
		+	What happened is that the bundle where we moved <tt>Note.java</tt> was still looking for it! In fact, if you look at <tt>notes/api/services/pom.xml, you will notice that it is listing <tt>org.opentaps.notes.domain</tt> as one of the packages that it exports:
		+	<pre>
		+
		+	<Export-Package>
		+	org.opentaps.notes.services,
		+	org.opentaps.notes.services.security,
		+	org.opentaps.notes.domain
		+	</Export-Package>
		+	</pre>
		+
		+	So first I need to remove that, since the package is no longer there.
		+
		+	Then, I need to add to a dependency from the <tt>notes/api/services</tt> bundle to our new <tt>notes/domain</tt> bundle by modifying the <tt>notes/api/services/pom.xml</tt>:
		+
		+	<pre>
		+	<dependencies>
		+	...
		+	<dependency>
		+	<groupId>${project.groupId}</groupId>
		+	<artifactId>notes.domain</artifactId>
		+	<version>${project.version}</version>
		+	<scope>provided</scope>
		+	</dependency>
		+	</dependencies>
		+	</pre>
		+
		+	I also added this to the other bundles which were using <tt>Note.java</tt>. Since this is a domain class, it was used throughout the application, so there were many bundles which I had to change. Finally, though, they were all fixed, and I get a different build error message:
		+	<pre>
		+	[ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:2.3.2:testCompile (default-testCompile) on project tests-run: Compilation failure: Compilation failure:
		+	[ERROR] /Users/sichen/git/opentaps-2/integration-tests/tests-run/src/test/java/org/opentaps/testsuit/notes/NotesTests.java:[27,32] package org.opentaps.notes.domain does not exist
		+	[ERROR] /Users/sichen/git/opentaps-2/integration-tests/tests-run/src/test/java/org/opentaps/testsuit/notes/NotesTests.java:[125,12] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.testsuit.notes.NotesTests
		+	[ERROR] /Users/sichen/git/opentaps-2/integration-tests/tests-run/src/test/java/org/opentaps/testsuit/notes/NotesTests.java:[80,8] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.testsuit.notes.NotesTests
		+	[ERROR] /Users/sichen/git/opentaps-2/integration-tests/tests-run/src/test/java/org/opentaps/testsuit/notes/NotesTests.java:[134,16] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.testsuit.notes.NotesTests
		+	[ERROR] /Users/sichen/git/opentaps-2/integration-tests/tests-run/src/test/java/org/opentaps/testsuit/notes/NotesTests.java:[134,46] cannot find symbol
		+	[ERROR] symbol : class Note
		+	[ERROR] location: class org.opentaps.testsuit.notes.NotesTests
		+	[ERROR] -> [Help 1]
		+	</pre>
		+
		+	This is because in this last bundle <tt>integration-tests/tests-run</tt>, we need to reference the groupId explicitly when we import the dependency to our bundle:
		+	<pre>
		+	<dependency>
		+	<groupId>org.opentaps</groupId>
		+	<artifactId>notes.domain</artifactId>
		+	<version>${project.version}</version>
		+	<scope>provided</scope>
		+	</dependency>
		+	</pre>
		+
		+	Why? Read its <tt>pom.xml</tt>:
		+	<pre>
		+	<parent>
		+	<artifactId>integration-tests</artifactId>
		+	<groupId>org.opentaps.testsuit</groupId>
		+	<version>2.0.1-SNAPSHOT</version>
		+	</parent>
		+	</pre>
		+
		+	It belongs to a different group!

@@ Line 55: / Line 55: @@
 Now my <tt>notes/domain</tt> bundle is set up.  I create the directory structure and move my <tt>Note.java</tt> over:
 <pre>
-$ git mv modules/notes/api/services/src/main/java/org/opentaps/notes/domain/Note.java modules/notes/domain/src/main/java/
+$ git mv modules/notes/api/services/src/main/java/org/opentaps/notes/domain/Note.java modules/notes/domain/src/main/java/org/opentaps/notes/domain/
 </pre>

@@ Line 43: / Line 43: @@
 <pre>
      <modules>
-		<module>domain</module>
+        <module>domain</module>
      	<module>api</module>
      	<module>impl</module>
@@ Line 51: / Line 51: @@
          <module>eba</module>
      </modules>
 </pre>

@@ Line 13: / Line 13: @@
      <modelVersion>4.0.0</modelVersion>
      <artifactId>notes.domain</artifactId>
-     <version>2.0.1-SNAPSHOT</version>
      <name>Notes domain</name>
      <packaging>bundle</packaging>
@@ Line 35: / Line 33: @@
          <artifactId>notes</artifactId>
      </parent>
 </project>
 </pre>

← Older revision	Revision as of 22:02, 24 February 2012
(No difference)