You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2011/08/10 17:54:05 UTC
svn commit: r1156243 - in /uima/site/trunk/uima-website:
docs/staging/osgi.html xdocs/staging/osgi.xml
Author: schor
Date: Wed Aug 10 15:54:04 2011
New Revision: 1156243
URL: http://svn.apache.org/viewvc?rev=1156243&view=rev
Log:
no Jira - add info on OSGi packaging to staging site
Added:
uima/site/trunk/uima-website/docs/staging/osgi.html (with props)
uima/site/trunk/uima-website/xdocs/staging/osgi.xml (with props)
Added: uima/site/trunk/uima-website/docs/staging/osgi.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/staging/osgi.html?rev=1156243&view=auto
==============================================================================
--- uima/site/trunk/uima-website/docs/staging/osgi.html (added)
+++ uima/site/trunk/uima-website/docs/staging/osgi.html Wed Aug 10 15:54:04 2011
@@ -0,0 +1,262 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+
+
+ <!-- ====================================================================== -->
+ <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+ <style type="text/css">@import "stylesheets/base.css";</style>
+ <meta name="author" value="
+ Apache UIMA Documentation Team
+ ">
+ <meta name="email" value="dev@uima.apache.org">
+
+
+
+ <title>Apache UIMA - OSGi packaging and support</title>
+ </head>
+
+ <body>
+ <div class="topLogos">
+ <table border="0" width="100%" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td align='LEFT'>
+ <a href="index.html">
+ <img style="border: 1px solid black;" src="../images/UIMA_banner2tlp.png" alt="UIMA project logo" border="0"/>
+ </a>
+ </td>
+ <td align='CENTER'>
+ <div class="pageBanner">OSGi packaging and support</div>
+ </td>
+ <td align='RIGHT'>
+ <a href="http://www.apache.org">
+ <img src="../images/asf-logo-on-white-small.png" alt="Apache UIMA" border="0"/>
+ </a>
+ </td>
+ </tr>
+ </table>
+ <hr noshade="" size="1"/>
+ </div>
+ <table border="0" width="100%" cellspacing="4">
+ <tr>
+ <td align='RIGHT' colspan="2">
+ <form method="get" action="http://www.google.com/search">
+ Search the site
+ <input type="text" name="q" size="25" maxlength="255" value="" />
+ <input type="hidden" name="sitesearch" value="http://uima.apache.org/" />
+ <input name="Search" value="Search Site" type="submit"/>
+ </form>
+ </td>
+ </tr>
+ <tr> <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top">
+
+
+
+
+
+
+ <!-- regular menu -->
+ <div class="navBar">
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">General</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="../index.html">Home</a>
+ </div>
+ <div class="navBarItem"> <a href="../downloads.cgi">Downloads</a>
+ </div>
+ <div class="navBarItem"> <a href="../documentation.html">Documentation</a>
+ </div>
+ <div class="navBarItem"> <a href="../news.html">News</a>
+ </div>
+ <br style="line-height: .5em"/>
+ <div class="navBarItem"> <a href="../mail-lists.html">Mailing Lists</a>
+ </div>
+ <div class="navBarItem"> <a href="../mail-lists.html#Apache_UIMA_Forums">Forums</a>
+ <a href="http://news.gmane.org/gmane.comp.apache.uima.general" target="_blank"><em> Users</em> <img src="images/offsitelink.png" /></a>
+ <a href="http://news.gmane.org/gmane.comp.apache.uima.devel" target="_blank"><em>Dev</em> <img src="images/offsitelink.png" /></a>
+ </div>
+ <div class="navBarItem"> <a href="http://cwiki.apache.org/UIMA/powered-by-apache-uima.html" target="_blank">Powered By UIMA <img src="images/offsitelink.png"/></a>
+ </div>
+ <br style="line-height: .5em"/>
+ <div class="navBarItem"> <a href="http://issues.apache.org/jira/browse/uima" target="_blank">Issue tracker <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://cwiki.apache.org/UIMA/" target="_blank">Wiki <img src="images/offsitelink.png"/></a>
+ </div>
+ </div>
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">Components & Tools</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="../annotators.html">Annotators</a>
+ </div>
+ <div class="navBarItem"> <a href="../toolsServers.html">Tools & Servers</a>
+ </div>
+ <div class="navBarItem"> <a href="../sandbox.html">Sandbox</a>
+ </div>
+ <div class="navBarItem"> <a href="../external-resources.html">External Resources</a>
+ </div>
+ </div>
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">Community</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="../get-involved.html">Get Involved</a>
+ </div>
+ <div class="navBarItem"> <a href="../contribution-policy.html">Contribution Policies</a>
+ </div>
+ <div class="navBarItem"> <a href="../faq.html">FAQ</a>
+ </div>
+ <div class="navBarItem"> <a href="../project-guidelines.html">Project Guidelines</a>
+ </div>
+ </div>
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">Development</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="../dev-quick.html">Quick Start: building</a>
+ </div>
+ <div class="navBarItem"> <a href="../building-uima.html">Building from Source</a>
+ </div>
+ <div class="navBarItem"> <a href="../one-time-setup.html">One-time setups</a>
+ </div>
+ <div class="navBarItem"> <a href="../svn.html">Source Code</a>
+ </div>
+ <div class="navBarItem"> <a href="../distribution.html">Creating a Distribution</a>
+ </div>
+ <div class="navBarItem"> <a href="../release.html">Doing a UIMA release</a>
+ </div>
+ <div class="navBarItem"> <a href="../codeConventions.html">Code Conventions</a>
+ </div>
+ <div class="navBarItem"> <a href="../uima-specification.html">UIMA Specification (OASIS)</a>
+ </div>
+ <div class="navBarItem"> <a href="../team-list.html">Project Team</a>
+ </div>
+ <div class="navBarItem"> <a href="../maven-design.html">Maven Use</a>
+ </div>
+ </div>
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">Events and Conferences</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="../iks09.html">IKS 2009</a>
+ </div>
+ <div class="navBarItem"> <a href="../gscl09.html">GSCL 2009</a>
+ </div>
+ <div class="navBarItem"> <a href="../lsm09.html">LSM 2009</a>
+ </div>
+ <div class="navBarItem"> <a href="../lrec08.html">LREC 2008</a>
+ </div>
+ <div class="navBarItem"> <a href="../gldv07.html">GLDV 2007</a>
+ </div>
+ </div>
+ <br/>
+ <div class="navBarItem"> <div class="navPartHeading">ASF</div>
+ </div>
+ <div class="navBar">
+ <div class="navBarItem"> <a href="http://www.apache.org/licenses/" target="_blank">License <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://apache.org/foundataion/thanks.html" target="_blank">ASF Sponsors <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/foundation/sponsorship.html" target="_blank">ASF Sponsorship <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/foundation/thanks.html" target="_blank">Thanks <img src="images/offsitelink.png"/></a>
+ </div>
+ <div class="navBarItem"> <a href="http://www.apache.org/security" target="_blank">Security <img src="images/offsitelink.png"/></a>
+ </div>
+ </div>
+ </div>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <div class="sectionTable">
+ <table class="sectionTable">
+ <tr><td>
+ <a name="OSGi packaging and support"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> OSGi packaging and support</h1></a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="sectionBody">
+ <p>OSGi is not supported directly by the UIMA framework; the framework has no knowledge or interfaces for making use of it.
+ However, components are being packaged as OSGi bundles: in particular, there are Eclipse Plugin tools that are packaged this way.
+ The Eclipse plugins are organized further using the Eclipse infrastructure for Features and Update Sites.</p>
+ <p>Some of the addon annotators are being packaged experimentally as OSGi bundles. Due to UIMA not knowing about OSGi,
+ the current experimental packaging includes the uimaj-core jar in the package; the expected use of this bundle
+ is as an embedded UIMA application, running just the one annotator that is being bundled (because other annotators in other
+ bundles will not be "visible" in the class-loading sense)</p>
+ <p>Users wanting to develop more advance deployments, such as UIMA pipelines containing multiple annotators, can use
+ these bundles and the maven processes that build them, as examples. They will need to create special bundles of their
+ own, combining the UIMA framework, and all of the jars for the multiple annotators (and their dependencies), and again,
+ use that collection as a UIMA application.</p>
+ <table class="subsectionTable">
+ <tr><td>
+
+
+
+ <a name="OSGi and Eclipse-Buddy">
+ <h2>OSGi and Eclipse-Buddy
+ </h2>
+ </a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="subsectionBody">
+ <p>There are two kinds of OSGi container/frameworks. One, represented by Apache Felix, might be characterized
+ as a "pure" OSGi implementation. The other, represented by Eclipse RCP and the equinox framework, is charactereized by
+ including support to enable "legacy" frameworks (including UIMA) be used in some circumstances, by exploiting
+ Eclipse-buddy manifest directives.</p>
+ <p>If users decide to use an OSGi container that supports the Eclipse-buddy directive, then it is possible to create
+ bundle structures where the annotators do not contain uimaj-core jars, and a common uimaj-ep-runtime bundle contains
+ the common UIMA framework jars used by the application.</p>
+ <p>To do this, each annotator bundle will need to have the directive in the MANIFEST.MF
+ <code>Eclipse-RegisterBuddy: org.apache.uima.runtime</code>; furthermore, the bundle
+ uimaj-ep-runtime (having the symbolic name org.apache.uima.runtime) must be the bundle in the container
+ that will provide the UIMA framework.</p>
+ <p class="note">Currently, the experimental OSGi builds do not provide this directive.</p>
+ <p class="note">Apache Felix has stated that they do not support these "buddy" extensions,
+ as a matter of principle.</p>
+ </blockquote>
+ </td></tr>
+ </table>
+ </blockquote>
+ </p>
+ </td></tr>
+ </table>
+ <div class="sectionTable">
+ <table class="sectionTable">
+ <tr><td>
+ <a name="Jigsaw as an alternative to OSGi"><h1><img src="images/UIMA_4sq50tightCropSolid.png"/> Jigsaw as an alternative to OSGi</h1></a>
+ </td></tr>
+ <tr><td>
+ <blockquote class="sectionBody">
+ <p>Jigsaw is the Java community's approach to improving class-path mechanisms, slated for inclusion into core Java at release 8.
+ It looks like it has similar goals to a subset of what OSGi is providing.</p>
+ </blockquote>
+ </p>
+ </td></tr>
+ </table>
+ </td>
+ </tr>
+ <!-- FOOTER -->
+ <tr><td colspan="2">
+ <hr noshade="" size="1"/>
+ </td></tr>
+ <tr><td colspan="2">
+ <table class="pageFooter">
+ <tr>
+ <td><a href="index.html">Home</a></td>
+ <td><a href="privacy-policy.html">Privacy Policy</a></td>
+ <td style="font-size:75%">
+ Copyright © 2006-2011, The Apache Software Foundation.<br/>
+ Apache UIMA, UIMA, the Apache UIMA logo and the Apache Feather logo are trademarks of The Apache Software Foundation.<br/>
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </td>
+ <td><a href="mailto:dev@uima.apache.org">Contact us</a></td>
+ </tr>
+ </table>
+ </td></tr>
+ </table>
+ </body>
+ </html>
+
Propchange: uima/site/trunk/uima-website/docs/staging/osgi.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: uima/site/trunk/uima-website/xdocs/staging/osgi.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/staging/osgi.xml?rev=1156243&view=auto
==============================================================================
--- uima/site/trunk/uima-website/xdocs/staging/osgi.xml (added)
+++ uima/site/trunk/uima-website/xdocs/staging/osgi.xml Wed Aug 10 15:54:04 2011
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+<document>
+
+ <properties>
+ <title>OSGi packaging and support</title>
+ <author email="dev@uima.apache.org">
+ Apache UIMA Documentation Team
+ </author>
+ </properties>
+
+ <body>
+
+ <section name="OSGi packaging and support">
+
+ <p>OSGi is not supported directly by the UIMA framework; the framework has no knowledge or interfaces for making use of it.
+ However, components are being packaged as OSGi bundles: in particular, there are Eclipse Plugin tools that are packaged this way.
+ The Eclipse plugins are organized further using the Eclipse infrastructure for Features and Update Sites.</p>
+
+ <p>Some of the addon annotators are being packaged experimentally as OSGi bundles. Due to UIMA not knowing about OSGi,
+ the current experimental packaging includes the uimaj-core jar in the package; the expected use of this bundle
+ is as an embedded UIMA application, running just the one annotator that is being bundled (because other annotators in other
+ bundles will not be "visible" in the class-loading sense)</p>
+
+ <p>Users wanting to develop more advance deployments, such as UIMA pipelines containing multiple annotators, can use
+ these bundles and the maven processes that build them, as examples. They will need to create special bundles of their
+ own, combining the UIMA framework, and all of the jars for the multiple annotators (and their dependencies), and again,
+ use that collection as a UIMA application.</p>
+
+ <subsection name="OSGi and Eclipse-Buddy">
+ <p>There are two kinds of OSGi container/frameworks. One, represented by Apache Felix, might be characterized
+ as a "pure" OSGi implementation. The other, represented by Eclipse RCP and the equinox framework, is charactereized by
+ including support to enable "legacy" frameworks (including UIMA) be used in some circumstances, by exploiting
+ Eclipse-buddy manifest directives.</p>
+
+ <p>If users decide to use an OSGi container that supports the Eclipse-buddy directive, then it is possible to create
+ bundle structures where the annotators do not contain uimaj-core jars, and a common uimaj-ep-runtime bundle contains
+ the common UIMA framework jars used by the application.</p>
+
+ <p>To do this, each annotator bundle will need to have the directive in the MANIFEST.MF
+ <code>Eclipse-RegisterBuddy: org.apache.uima.runtime</code>; furthermore, the bundle
+ uimaj-ep-runtime (having the symbolic name org.apache.uima.runtime) must be the bundle in the container
+ that will provide the UIMA framework.</p>
+
+ <p class="note">Currently, the experimental OSGi builds do not provide this directive.</p>
+ <p class="note">Apache Felix has stated that they do not support these "buddy" extensions,
+ as a matter of principle.</p>
+
+ </subsection>
+
+ </section>
+
+ <section name="Jigsaw as an alternative to OSGi">
+ <p>Jigsaw is the Java community's approach to improving class-path mechanisms, slated for inclusion into core Java at release 8.
+ It looks like it has similar goals to a subset of what OSGi is providing.</p>
+ </section>
+
+ </body>
+</document>
\ No newline at end of file
Propchange: uima/site/trunk/uima-website/xdocs/staging/osgi.xml
------------------------------------------------------------------------------
svn:eol-style = native