Wnlab

User Tools

Site Tools

You are here: start » giraffplus » 3rdparty
Trace:
giraffplus:3rdparty

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
giraffplus:3rdparty [2013-07-18 11:54] – filippogiraffplus:3rdparty [2013-07-18 12:17] (current) – [If You Have the Following Execution Errors when Starting Your Bundle] filippo
Line 1: Line 1:
 +====== How to Include Third-Party Jars in Your Component ======
 +
 The process of including third-party JARs into your bundle is probably the most difficult and tricky part of creating new OSGi bundles. The process of including third-party JARs into your bundle is probably the most difficult and tricky part of creating new OSGi bundles.
  
Line 11: Line 13:
 How do you know that it is safe to ignore these "improperly required" packages? Basically, if your component passes its unit tests, then you are guaranteed to not need any of the additional packages stated by the bundle program. How do you know that it is safe to ignore these "improperly required" packages? Basically, if your component passes its unit tests, then you are guaranteed to not need any of the additional packages stated by the bundle program.
  
-== Preparations ==+===== Preparations =====
  
-Generally, the aspire-stage-archetype sets everything up automatically for you, so things should go (relatively) smoothly. But first check the following in your project's "pom.xml" file:+First check the following in your project's "pom.xml" file:
  
-# The "aspire-test" dependency has scope=provided. +  - The "maven-bundle-plugin" plugin is listed in your pom.xml as one of the plug-ins in the <build> section of your pom.xml file. 
-# The "JUnit" dependency has scope=provided. +  - That the plugin/configuration/instructions section of your maven-bundle-plugin contains sections for Bundle-Activator, Private-Package, and Import-Package. 
-# The "maven-bundle-plugin" plugin is listed in your pom.xml as one of the plug-ins in the &lt;build&gt; section of your pom.xml file. +  - Make sure it says <nowiki><packaging>bundle</packaging></nowiki>. This goes after the <nowiki><artifactId></nowiki> tag.
-# That the plugin/configuration/instructions section of your maven-bundle-plugin contains sections for Bundle-Activator, Private-Package, and Import-Package. +
-#  Make sure it says <nowiki><packaging>bundle</packaging></nowiki>. This goes after the <nowiki><artifactId></nowiki> tag.+
  
-== Your Third-Party JARs Should be Specified as Maven Dependencies ==+===== Your Third-Party JARs Should be Specified as Maven Dependencies =====
  
-Your third-party JARs should be specified as dependencies of your project in the "dependency" section of your Maven pom.xml file. Eclipse actually provides quite a nice editor for specifying dependencies in a pom.xml file. The scope for all dependent JARs must be "compile" and cannot be "provided" (only Aspire services and Aspire components can have "provided" dependencies in Aspire).+Your third-party JARs should be specified as dependencies of your project in the "dependency" section of your Maven pom.xml file. Eclipse actually provides quite a nice editor for specifying dependencies in a pom.xml file. The scope for all dependent JARs must be "compile" and cannot be "provided".
  
 This means, of course, that you will need to know the "groupId" and the "artifactId" for all of your third-party JARs. This information can usually be located by browsing your third-party JAR's web site, or one of the public repository centers: This means, of course, that you will need to know the "groupId" and the "artifactId" for all of your third-party JARs. This information can usually be located by browsing your third-party JAR's web site, or one of the public repository centers:
-* http://mvnrepository.com/ + 
-* https://maven-repository.dev.java.net/ +  * http://mvnrepository.com/ 
-* http://repo2.maven.org/maven2 +  * https://maven-repository.dev.java.net/ 
-* http://mirrors.ibiblio.org/pub/mirrors/maven2/+  * http://repo2.maven.org/maven2 
 +  * http://mirrors.ibiblio.org/pub/mirrors/maven2/
  
 However, if it is impossible to locate a maven repository which contains your third-party JAR, then you will need to load the JAR into your local repository manually. This can be done with a Maven command, for example: However, if it is impossible to locate a maven repository which contains your third-party JAR, then you will need to load the JAR into your local repository manually. This can be done with a Maven command, for example:
Line 41: Line 42:
 And then make sure that the JAR's groupId and artifactId (and version) are specified as a dependency in your pom.xml file. And then make sure that the JAR's groupId and artifactId (and version) are specified as a dependency in your pom.xml file.
  
-=== If the Third Party JAR Is Not in a Public Repository ===+==== If the Third Party JAR Is Not in a Public Repository ====
  
-You can download the third-party JAR from the owner's website, and then install it into the Search Technologies repository. This is done using the following command:+You can download the third-party JAR from the owner's website, and then install it into the a repository. This is done using the following command:
  
-  mvn deploy:deploy-file -DgroupId={GROUPID} -DartifactId={ARTIFACTID} -Dversion={VERSIONNUM} -Dpackaging=JAR -Dfile={PATH-TO-JAR-FILE} -DrepositoryId=stPublic -Durl=http://repository.searchtechnologies.com/artifactory/simple/community-public/+  mvn deploy:deploy-file -DgroupId={GROUPID} -DartifactId={ARTIFACTID} -Dversion={VERSIONNUM} -Dpackaging=JAR -Dfile={PATH-TO-JAR-FILE} -DrepositoryId=stPublic -Durl=http://repository.giraffplus.com/artifacts/public/
  
 This makes building our components which depend on these third-party JAR files easier to build. This makes building our components which depend on these third-party JAR files easier to build.
  
-For example, I added the ROME libraries to our repository using the following:+For example, if I added the TEST libraries to our repository using the following:
  
-  mvn deploy:deploy-file -DgroupId=rome -DartifactId=rome -Dversion=1.0 -Dpackaging=JAR -Dfile=rome-1.0.JAR -DrepositoryId=stPublic -Durl=http://repository.searchtechnologies.com/artifactory/simple/community-public/+  mvn deploy:deploy-file -DgroupId=test -DartifactId=test -Dversion=1.0 -Dpackaging=JAR -Dfile=test-1.0.JAR -DrepositoryId=stPublic -Durl=http://epository.giraffplus.com/artifacts/public/
  
-And now, anyone building the RSS feeder will no longer have to manually install the ROME libraries onto their own local repository. Instead, Maven will automatically down load it from the Search Technologies repository.+anyone building the application that need it will no longer have to manually install the TEST libraries onto their own local repository. Instead, Maven will automatically download it from the GiraffPlus repository.
  
-== Creating the Bundle ==+===== Creating the Bundle =====
  
 Now we're ready to try and create the bundle. Note that it is almost guaranteed to return errors which will need to be corrected. Do not fret. Now we're ready to try and create the bundle. Note that it is almost guaranteed to return errors which will need to be corrected. Do not fret.
Line 73: Line 74:
   mvn -Dmaven.test.skip=true clean package   mvn -Dmaven.test.skip=true clean package
  
-== Embedding Dependencies ==+===== Embedding Dependencies =====
  
 If you get the following error, you will need to go through the following procedure to include your third-party JARs into your bundle: If you get the following error, you will need to go through the following procedure to include your third-party JARs into your bundle:
  
-  [ERROR] Error building bundle com.searchtechnologies:aspire-extract-text:bundle:0.0.1-SNAPSHOT : Unresolved references to...+  [ERROR] Error building bundle org.giraffplus:test-component:bundle:0.0.1-SNAPSHOT : Unresolved references to...
  
 This process can be time-consuming and frustrating, so be warned. This process can be time-consuming and frustrating, so be warned.
  
-1.  First, embed dependencies of the JARs which are specified in your POM as dependencies. For example:+==== 1. Embed dependencies of the JARs which are specified in your POM as dependencies. ====
  
-  <Embed-Dependency>tika</Embed-Dependency>+For example: 
 +   
 +  <Embed-Dependency>test</Embed-Dependency>
   <Embed-Transitive>true</Embed-Transitive>    <Embed-Transitive>true</Embed-Transitive> 
  
-In the above example, "tika" is the artifact name of the dependency that I want to embed. The above should be added to the plugin/configuration/instructions section of the maven-bundle-plugin in your project's pom.xml file. +In the above example, "test" is the artifact name of the dependency that I want to embed. The above should be added to the plugin/configuration/instructions section of the maven-bundle-plugin in your project's pom.xml file. If you have multiple dependencies to include, specify them all separated by commas. If you have lots and lots of dependencies, you could say "*" for Embed-Dependency. For example:
- +
-If you have multiple dependencies to include, specify them all separated by commas. +
- +
-If you have lots and lots of dependencies, you could say "*" for Embed-Dependency. For example:+
  
   <Embed-Dependency>*</Embed-Dependency>   <Embed-Dependency>*</Embed-Dependency>
   <Embed-Transitive>true</Embed-Transitive>    <Embed-Transitive>true</Embed-Transitive> 
  
-2.  Then, run the "mvn clean package" command again (you'll probably want to run "mvn -Dmaven.test.skip=true clean package" to skip the unit tests).+==== 2. Run the "mvn clean package" command again. ====
  
-3.  Once you've done this, all dependencies are included. However, there will still likely be many java packages which can not be found by the maven bundle plug-in.+==== 3. Still errors. ==== 
 + 
 +Once you've done this, all dependencies are included. However, there will still likely be many java packages which can not be found by the maven bundle plug-in.
  
 If maven didn't include the JARs for these packages automatically, then clearly these packages are not required for actual execution of the software. What happens is that these packages represent code in your dependent libraries which import other packages that are never used (spurious imports or unreachable code). If maven didn't include the JARs for these packages automatically, then clearly these packages are not required for actual execution of the software. What happens is that these packages represent code in your dependent libraries which import other packages that are never used (spurious imports or unreachable code).
Line 120: Line 121:
 After some time, and lots of executing of the "mvn" command, eventually should have a complete Import-Package statement and your bundle will be created. After some time, and lots of executing of the "mvn" command, eventually should have a complete Import-Package statement and your bundle will be created.
  
-== Verifying Your Bundle ==+===== Verifying Your Bundle =====
  
 Open up the bundle .JAR file and verify the following: Open up the bundle .JAR file and verify the following:
  
-# Does it have your ComponentFactory.xml at the top level? +  * Does it have a META-INF/MANIFEST.MF file? 
-# Does it have a META-INF/MANIFEST.MF file? +  * Are the contents of the manifest correct?  (Imports, Exports, etc.) 
-#*  Are the contents of the manifest correct?  (Imports, Exports, etc.) +  * Does it have your classes in it? 
-# Does it have your classes in it? +  * Does it contain the 3rd party JARs at the top level, embedded in your JAR?
-# Does it have the com.searchtechnologies.aspire.framework classes in it?  (It should.) +
-# Does it have the com.searchtechnologies.aspire.services classes in it? (It should not.) +
-# Does it contain the 3rd party JARs at the top level, embedded in your JAR?+
  
-== Problems You May Discover Running Your Bundle in Apache Felix ==+===== Problems You May Discover Running Your Bundle in Apache Felix =====
  
 First, try running your bundle in the application. First, try running your bundle in the application.
  
-If your bundle installs but does not start, try installing the bundle by hand within the +If your bundle installs but does not start, try installing the bundle by hand within the Felix console. For example:
-Felix console. For example:+
  
-  -> install file:bundles/aspire/... +<code> 
-  . +  -> install file:bundles/test/... 
-  . +  ...
-  .+
   -> start 12   -> start 12
   org.osgi.framework.BundleException: Unresolved constraint in bundle 12: package; (package=javax.jms)   org.osgi.framework.BundleException: Unresolved constraint in bundle 12: package; (package=javax.jms)
 +</code>
  
-Notice the unresolved constraint above. This is something which will need to be added to your POM +Notice the unresolved constraint above. This is something which will need to be added to your POM as an imported package. Change your pom.xml file, add the package to the Import-Package statement, re-build your bundle JAR, and then try again.
-as an imported package. Change your pom.xml file, add the package to the Import-Package statement, re-build your bundle JAR, and then try again.+
  
-== If You Have the Following Execution Errors when Starting Your Bundle == +===== Other Hints and Tricks =====
- +
->> Provider for javax.xml.transform.TransformerFactory cannot be found +
- +
->> Provider for javax.xml.parsers.SAXParserFactory cannot be found +
- +
->> com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryImpl cannot be cast to javax.xml.transform.sax.SAXTransformerFactory +
- +
->> loader constraint violation: when resolving method "javax.xml.transform.sax.SAXResult.<init>(Lorg/xml/sax/ContentHandler;)V" the class loader (instance of org/apache/felix/framework/searchpolicy/ModuleImpl$ModuleClassLoader) of the current class, com/searchtechnologies/aspire/framework/SimpleDigester, and the class loader (instance of <bootloader>) for resolved class, javax/xml/transform/sax/SAXResult, have different Class objects for the type org/xml/sax/ContentHandler used in the signature +
- +
->> Caused by: javax.xml.transform.TransformerException: Source object passed to ''{0}'' has no contents. at com.sun.org.apache.xalan.internal.xsltc.trax.TransformerImpl.transformIdentity(Unknown Source) +
- +
->> Class not found:  x.y.z.CLASS +
- +
->> Unable to load class +
- +
-If you have thes execution errors when starting your bundle, add the following to your <Import-Package> description: +
- +
-  javax.xml.parsers,javax.xml.transform,javax.xml.transform.sax,org.xml.sax,javax.xml.transform.dom,javax.xml.namespace,org.xml.sax.ext, +
- +
-NOTE:  These should be included even if the maven-bundle-plugin reports warnings that they're not needed. +
- +
-== Version Errors == +
- +
-For a currently unknown reason, Maven sometimes adds a "version" to the packaged imports when it builds the bundle. You'll typically notice this when your bundle fails to load with the following exception: +
- +
-  com.searchtechnologies.aspire.services.AspireException: Unable to install bundle file:/C:/Users/sdenny/.m2/repository/com/searchtechnologies/aspire-fast-qpl/1.2-SNAPSHOT/aspire-fast-qpl-1.2-SNAPSHOT.JAR from repository MavenRepository[C:\Users\sdenny/.m2/repository]. +
-        at com.searchtechnologies.aspire.application.ComponentBundleInfo.load(ComponentBundleInfo.java:156) +
-        at com.searchtechnologies.aspire.application.RepositoryManager.load(RepositoryManager.java:170) +
-        at com.searchtechnologies.aspire.application.AspireApplicationImpl.loadFactoryBundle(AspireApplicationImpl.java:394) +
-        at com.searchtechnologies.aspire.application.ComponentManagerImpl.registerComponents(ComponentManagerImpl.java:238) +
-        . +
-        . +
-        at org.mortbay.io.nio.SelectChannelEndPoint.run(SelectChannelEndPoint.java:410) +
-        at org.mortbay.thread.QueuedThreadPool$PoolThread.run(QueuedThreadPool.java:582) +
-       '''Caused by: org.osgi.framework.BundleException: Unresolved constraint in bundle com.searchtechnologies.aspire-fast-qpl [24]: Unable to resolve 24.0: missing requirement [24.0] osgi.wiring.package; (&(osgi.wiring.package=groovy.lang)(version>=2.0.0))''' +
-   +
-        at org.apache.felix.framework.Felix.resolveBundleRevision(Felix.java:3826) +
-        at org.apache.felix.framework.Felix.startBundle(Felix.java:1868) +
-        at org.apache.felix.framework.BundleImpl.start(BundleImpl.java:944) +
-        at org.apache.felix.framework.BundleImpl.start(BundleImpl.java:931) +
-        at com.searchtechnologies.aspire.application.ComponentBundleInfo.load(ComponentBundleInfo.java:152) +
-        ... 42 more +
- +
-If you examine the bundle (using winrar or similar)and look in the ''META-INF/MANIFEST.MF'' file, you'll see the imports have a version specified: +
- +
-  Import-Package: com.searchtechnologies.aspire.services,com.searchtechnologies.aspire.services.xml,'''groovy.lang;version="2.0"''',javax.xml.parsers,javax.xml.transform,javax.xml.transform.dom,javax.xml.transform.sax,javax.xml.transform.stream,org.osgi.framework,org.osgi.service.log,org.osgi.util.tracker,org.w3c.dom,org.w3c.dom.bootstrap,org.w3c.dom.ls,org.xml.sax,org.xml.sax.ext,org.xml.sax.helpers +
- +
-Unless the packages were exported with this version, then the import cannot find them. In Aspire we don't add versions to exported packages, so the easiest way to work around this issue is to suppress the addition of the version number to the import. This can be done by specifying the import in the following manner: +
- +
-  <Import-Package> +
-    groovy.lang''';version=!''', +
- +
-== Other Hints and Tricks ==+
  
 If you make changes to the framework, you'll likely need to re-run "mvn install" on the framework before those changes will be visible in your project. If you make changes to the framework, you'll likely need to re-run "mvn install" on the framework before those changes will be visible in your project.
Line 208: Line 151:
 You can find more information here:  You can find more information here: 
  
-: http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html+http://felix.apache.org/site/apache-felix-maven-bundle-plugin-bnd.html
  
 Also, check out the BND documentation page for additional options (Maven bundle plugin is based on BND, so the syntax for specifying imports/exports is the same): Also, check out the BND documentation page for additional options (Maven bundle plugin is based on BND, so the syntax for specifying imports/exports is the same):
  
-: http://www.aqute.biz/Bnd/Bnd+http://www.aqute.biz/Bnd/Bnd
  
 Specifically, look at the "Import Package" section: Specifically, look at the "Import Package" section:
  
-: http://www.aqute.biz/Bnd/Format#import-package+http://www.aqute.biz/Bnd/Format#import-package
  
-== APPENDIX:  Packages provided by the System Bundle ==+===== APPENDIX:  Packages provided by the System Bundle =====
  
 Note that you will need to import these with &lt;Import-Package&gt; if you use them, or if any of your 3rd party JARs use them. Note that you will need to import these with &lt;Import-Package&gt; if you use them, or if any of your 3rd party JARs use them.
  
-<pre>+<code>
 javax.accessibility,version=1.6.0 javax.accessibility,version=1.6.0
 javax.activation,version=1.6.0 javax.activation,version=1.6.0
Line 387: Line 330:
 org.xml.sax.ext,version=1.6.0 org.xml.sax.ext,version=1.6.0
 org.xml.sax.helpers,version=1.6.0 org.xml.sax.helpers,version=1.6.0
-</pre> +</code>
- +
-[[Category:Component Development Topics]]+
giraffplus/3rdparty.1374148451.txt.gz · Last modified: 2013-07-18 11:54 by filippo
Donate Powered by PHP Valid HTML5 Valid CSS Run on Debian Driven by DokuWiki