documentation/virgo-documentation-3.0.3.RELEASE/docs/virgo-programmer-guide/html/ch07s05.html - www.eclipse.org/virgo - Git at Google

 <html><head>
       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
    <title>7.5&nbsp;Developing OSGi Bundles</title><link rel="stylesheet" href="css/stylesheet.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="index.html" title="Virgo Programmer Guide"><link rel="up" href="ch07.html" title="7.&nbsp;Tooling"><link rel="prev" href="ch07s04.html" title="7.4&nbsp;Setting up Eclipse Projects"><link rel="next" href="ch07s06.html" title="7.6&nbsp;Developing PARs"><!--Begin Google Analytics code--><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 type="text/javascript">
 			var pageTracker = _gat._getTracker("UA-2728886-3");
 			pageTracker._setDomainName("none");
 			pageTracker._setAllowLinker(true);
 			pageTracker._trackPageview();
 		</script><!--End Google Analytics code--></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.5&nbsp;Developing OSGi Bundles</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a>&nbsp;</td><th width="60%" align="center">7.&nbsp;Tooling</th><td width="20%" align="right">&nbsp;<a accesskey="n" href="ch07s06.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="tooling-developing"></a>7.5&nbsp;Developing OSGi Bundles</h2></div></div></div><p>
 				The Tools provide functionality that makes developing OSGi bundles,
 				especially the editing of MANIFEST.MF files, easier.
 			</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="tooling-developing-resolving-bundle-dependencies"></a>Resolving Bundle Dependencies</h3></div></div></div><p>
 				While working with OSGi bundles, one of the most interesting and challenging aspects is defining
 				the	package, bundle, and library imports in the manifest and then keeping this in sync
 				with your compile classpath	either in Ant and Maven or Eclipse. In most cases you would typically
 				be required to manually set up the Eclipse classpath. Ultimately, the Eclipse compile
 				classpath is still different from the bundle runtime classpath, as normally an entire
 				JAR file is being made available on the Eclipse classpath but not necessarily at runtime
 				due to the explicit visibility rules defined in <code class="code">Import-Package</code> headers.
 			</p><p>
 				The Tools address this problem by providing an Eclipse classpath container that
 				uses an Virgo Tomcat Server-specific dependency resolution mechanism. This classpath
 				container makes resolved dependencies available on the project&#8217;s classpath but allows
 				only access to those package that are imported explicitly (e.g., via <code class="code">Import-Package</code>)
 				or implicitly by using <code class="code">Import-Library</code> or <code class="code">Import-Bundle</code>.
 			</p><p>
 				To use the automatic dependency resolution, an OSGi bundle or PAR project needs to be
 				targeted to a configured Virgo Tomcat Server instance. This can be done from the project&#8217;s
 				preferences by selecting the runtime on the "Targeted Runtimes" preference page.
 			</p><p>
 				</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
 					In most scenarios it is sufficient to target the PAR project to a runtime. The nested
 					bundles will then automatically inherit this setting.
 				</td></tr></table></div><p>
 			</p><p>
 				<img src="images/tooling-classpath.png">
 			</p><p>
 				After targeting the project or PAR you will see a "Bundle Dependencies" classpath
 				container in your Java project. It is now safe to remove any manually configured classpath
 				entries.
 			</p><p>
 				The classpath container will automatically attach Java source code to the classpath
 				entries by looking for source JARs next to the binary JARs in the Virgo Tomcat Server&#8217;s
 				repository. You can also manually override the source code attachment by using the
 				properties dialog on a single JAR entry. This manual attachment will always override
 				the convention-based attachment.
 			</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="tooling-developing-editing-manifest-mf"></a>Editing the Manifest</h3></div></div></div><p>
 				The Tools provide a Bundle Manifest Editor that assists the developer to create and
 				edit MANIFEST.MF files. The editor understands the Virgo Tomcat Server specific headers
 				like <code class="code">Import-Library</code> and <code class="code">Import-Bundle</code> and provides content
 				assist features while editing source code. Furthermore a Eclipse Form-based UI is also
 				available.
 			</p><p>
 				To open the Bundle Manifest Editor right click a MANIFEST.MF file and select "Bundle
 				Manifest Editor" from the "Open With" menu.
 			</p><p>
 				</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
 					Please note that the Virgo Tomcat Server specific manifest headers appear in green color
 					to distinguish them from those headers defined in the OSGi specification. This also
 					makes navigating much easier.
 				</td></tr></table></div><p>
 			</p><p>
 				<img src="images/tooling-manifest-source-editor.png">
 			</p><p>
 				The content assist proposals in the source tab as well as in the UI-based tabs are
 				resolved from the bundle and library repository of an installed and configured
 				Virgo Tomcat Server. Therefore it is important to target the project or PAR to a specific
 				VTS instance to indicate to the tooling which bundle repository to use.
 			</p><p>
 				</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
 					If a OSGi bundle project is not targeted to a VTS instance, either
 					directory or indirectly via a PAR project&#8217;s targetting, the manifest editor will not
 					be able to provide content assist for importing packages, bundles, and libraries.
 				</td></tr></table></div><p>
 			</p><p>
 				<img src="images/tooling-manifest-form-ui-editor.png">
 			</p><p>
 				The Dependencies tab of the Bundle Manifest Editor enables the user to easily download
 				and install bundles and libraries from the SpringSource Enterprise Bundle Repository
 				by using the "Download..." buttons next to the "Import Bundle" and "Import Library"
 				sections.
 			</p></div></div><!--Begin LoopFuse code--><script src="http://loopfuse.net/webrecorder/js/listen.js" type="text/javascript"></script><script type="text/javascript">
 			_lf_cid = "LF_48be82fa";
 			_lf_remora();
 		</script><!--End LoopFuse code--><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a>&nbsp;</td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right">&nbsp;<a accesskey="n" href="ch07s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7.4&nbsp;Setting up Eclipse Projects&nbsp;</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">&nbsp;7.6&nbsp;Developing PARs</td></tr></table></div></body></html>
	<html><head>
	<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
	<title>7.5 Developing OSGi Bundles</title><link rel="stylesheet" href="css/stylesheet.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.74.0"><link rel="home" href="index.html" title="Virgo Programmer Guide"><link rel="up" href="ch07.html" title="7. Tooling"><link rel="prev" href="ch07s04.html" title="7.4 Setting up Eclipse Projects"><link rel="next" href="ch07s06.html" title="7.6 Developing PARs"><!--Begin Google Analytics code--><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 type="text/javascript">
	var pageTracker = _gat._getTracker("UA-2728886-3");
	pageTracker._setDomainName("none");
	pageTracker._setAllowLinker(true);
	pageTracker._trackPageview();
	</script><!--End Google Analytics code--></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">7.5 Developing OSGi Bundles</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a> </td><th width="60%" align="center">7. Tooling</th><td width="20%" align="right"> <a accesskey="n" href="ch07s06.html">Next</a></td></tr></table><hr></div><div class="section" lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="tooling-developing"></a>7.5 Developing OSGi Bundles</h2></div></div></div><p>
	The Tools provide functionality that makes developing OSGi bundles,
	especially the editing of MANIFEST.MF files, easier.
	</p><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="tooling-developing-resolving-bundle-dependencies"></a>Resolving Bundle Dependencies</h3></div></div></div><p>
	While working with OSGi bundles, one of the most interesting and challenging aspects is defining
	the package, bundle, and library imports in the manifest and then keeping this in sync
	with your compile classpath either in Ant and Maven or Eclipse. In most cases you would typically
	be required to manually set up the Eclipse classpath. Ultimately, the Eclipse compile
	classpath is still different from the bundle runtime classpath, as normally an entire
	JAR file is being made available on the Eclipse classpath but not necessarily at runtime
	due to the explicit visibility rules defined in <code class="code">Import-Package</code> headers.
	</p><p>
	The Tools address this problem by providing an Eclipse classpath container that
	uses an Virgo Tomcat Server-specific dependency resolution mechanism. This classpath
	container makes resolved dependencies available on the project’s classpath but allows
	only access to those package that are imported explicitly (e.g., via <code class="code">Import-Package</code>)
	or implicitly by using <code class="code">Import-Library</code> or <code class="code">Import-Bundle</code>.
	</p><p>
	To use the automatic dependency resolution, an OSGi bundle or PAR project needs to be
	targeted to a configured Virgo Tomcat Server instance. This can be done from the project’s
	preferences by selecting the runtime on the "Targeted Runtimes" preference page.
	</p><p>
	</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
	In most scenarios it is sufficient to target the PAR project to a runtime. The nested
	bundles will then automatically inherit this setting.
	</td></tr></table></div><p>
	</p><p>
	<img src="images/tooling-classpath.png">
	</p><p>
	After targeting the project or PAR you will see a "Bundle Dependencies" classpath
	container in your Java project. It is now safe to remove any manually configured classpath
	entries.
	</p><p>
	The classpath container will automatically attach Java source code to the classpath
	entries by looking for source JARs next to the binary JARs in the Virgo Tomcat Server’s
	repository. You can also manually override the source code attachment by using the
	properties dialog on a single JAR entry. This manual attachment will always override
	the convention-based attachment.
	</p></div><div class="section" lang="en"><div class="titlepage"><div><div><h3 class="title"><a name="tooling-developing-editing-manifest-mf"></a>Editing the Manifest</h3></div></div></div><p>
	The Tools provide a Bundle Manifest Editor that assists the developer to create and
	edit MANIFEST.MF files. The editor understands the Virgo Tomcat Server specific headers
	like <code class="code">Import-Library</code> and <code class="code">Import-Bundle</code> and provides content
	assist features while editing source code. Furthermore a Eclipse Form-based UI is also
	available.
	</p><p>
	To open the Bundle Manifest Editor right click a MANIFEST.MF file and select "Bundle
	Manifest Editor" from the "Open With" menu.
	</p><p>
	</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
	Please note that the Virgo Tomcat Server specific manifest headers appear in green color
	to distinguish them from those headers defined in the OSGi specification. This also
	makes navigating much easier.
	</td></tr></table></div><p>
	</p><p>
	<img src="images/tooling-manifest-source-editor.png">
	</p><p>
	The content assist proposals in the source tab as well as in the UI-based tabs are
	resolved from the bundle and library repository of an installed and configured
	Virgo Tomcat Server. Therefore it is important to target the project or PAR to a specific
	VTS instance to indicate to the tooling which bundle repository to use.
	</p><p>
	</p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.gif"></td><th align="left">Note</th></tr><tr><td align="left" valign="top">
	If a OSGi bundle project is not targeted to a VTS instance, either
	directory or indirectly via a PAR project’s targetting, the manifest editor will not
	be able to provide content assist for importing packages, bundles, and libraries.
	</td></tr></table></div><p>
	</p><p>
	<img src="images/tooling-manifest-form-ui-editor.png">
	</p><p>
	The Dependencies tab of the Bundle Manifest Editor enables the user to easily download
	and install bundles and libraries from the SpringSource Enterprise Bundle Repository
	by using the "Download..." buttons next to the "Import Bundle" and "Import Library"
	sections.
	</p></div></div><!--Begin LoopFuse code--><script src="http://loopfuse.net/webrecorder/js/listen.js" type="text/javascript"></script><script type="text/javascript">
	_lf_cid = "LF_48be82fa";
	_lf_remora();
	</script><!--End LoopFuse code--><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="ch07s04.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="ch07.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="ch07s06.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">7.4 Setting up Eclipse Projects </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> 7.6 Developing PARs</td></tr></table></div></body></html>