Bugzilla – Full Text Bug Listing
| Summary: | Eclipse infocenter as war file incompatible with Tomcat | ||||||
|---|---|---|---|---|---|---|---|
| Product: | [Eclipse Project] Platform | Reporter: | marcellus ludovicus <mark.ludwig> | ||||
| Component: | User Assistance | Assignee: | Karsten Thoms <karsten.thoms> | ||||
| Status: | RESOLVED FIXED | QA Contact: | |||||
| Severity: | major | ||||||
| Priority: | P3 | CC: | balazs.grill, birsan, carlos.morais, carsten.hammer, ChrisAustin, clindsey, daniel_megert, david.fischer, david_williams, digga1404, greensopinion, jantley, john.arthorne, john.kirkilis, j_a_hurrell, karsten.thoms, mark.ludwig, mat.booth, miwako.tokugawa, pdisabito, philippn, sw, tjwatson, wim.jongman | ||||
| Version: | 3.6.2 | ||||||
| Target Milestone: | 4.16 M3 | ||||||
| Hardware: | PC | ||||||
| OS: | Windows 7 | ||||||
| See Also: |
https://bugs.eclipse.org/bugs/show_bug.cgi?id=309529 https://git.eclipse.org/r/161113 https://git.eclipse.org/r/161132 https://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=f0221a36d49eef6e478ec0352ebb493b5c46c700 https://git.eclipse.org/r/161461 https://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4a4eb709ae737392fbc8964b19ae16191c09d935 https://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=b8616ce1f00ccd59585978d0a1829bdefa6bc428 |
||||||
| Whiteboard: | |||||||
| Bug Depends on: | 562249 | ||||||
| Bug Blocks: | 439498 | ||||||
| Attachments: |
|
||||||
|
Description
marcellus ludovicus
The same happens, when deployed in Glassfish 3.1.1. There are several problems in the org.eclipse.help.infocenter-feature that cause considerable pain in conjunction with Servlet 3.0: - org.apache.commons.el must be removed - org.apache.jasper must be removed - org.apache.jasper.glassfish must be added - javax.el must be added Also I had to remove javax.servlet, and use a patched /lib/servletbridge.jar as per #371028. Otherwise I ran into other errors. Also make sure to delete your Tomcats work directory between test runs, as it caches all previously resolved plugins. I would suggest to split this feature into two: One for Servlet 2.x and one for 3.x To make this clearer: This error basically means that you have a javax.servlet_2.5.0.jar in your plugins directory (or the cached work dir!!), which was probably pulled in by org.apache.jasper. Once you have resolved this, you will be greeted by a HTTP Status 404 - BridgeServlet: /help/index.jsp which basically means that one bundle or another could not be resolved. You can diagnose this using the telnet console, or try your luck by adding/removing the bundles as I noted above. It should also be noted that you should export the modified infocenter-feature from a Juno M5 target platform (atleast that's what I successfully tested), because otherwise some of the bundles (javax.el, org.apache.jasper.glassfish) may not exist to begin with. Would love to see this fixed. Clients are pushing to move to v 7 and I'm telling them they can't... can I do anything to help (not that I'm technically minded)... The only workaround is to move to Eclipse 4.2 and remake your infocenters. You'll need Equinox 3.8 for the servletbridge stuff. You will need to delete org.apache.commons.el and org.apache.jasper from the feature.xml before exporting. You will need to add the following plugins also: : javax.el, org.eclipse.jetty.http, org.eclipse.jetty.io, org.eclipse.jetty.server, org.eclipse.jetty.servlet, org.eclipse.jetty.util, and org.apache.jasper.glassfish. The infocenters I've created as war files this way work in Jetty 8, Tomcat 7, and (probably) WebSphere 8+. They don't work in Jetty 7, Tomcat 6, or WebSphere 7. In the latter cases, I get the following error: javax.servlet.ServletException: Servlet execution threw an exception root cause java.lang.IncompatibleClassChangeError: Class org.apache.jasper.servlet.JspServlet does not implement the requested interface javax.servlet.Servlet Wish there was a way to have compatibility across more releases of Eclipse and the servlet containers, but as a non-programmer I have no clue if that is even possible. (In reply to comment #6) > The infocenters I've created as war files this way work in Jetty 8, Tomcat > 7, and (probably) WebSphere 8+. They don't work in Jetty 7, Tomcat 6, or > WebSphere 7. In the latter cases, I get the following error: > javax.servlet.ServletException: Servlet execution threw an exception > root cause > java.lang.IncompatibleClassChangeError: Class > org.apache.jasper.servlet.JspServlet does not implement the requested > interface javax.servlet.Servlet > Wish there was a way to have compatibility across more releases of Eclipse > and the servlet containers, but as a non-programmer I have no clue if that > is even possible. I am seeing this too - does anyone have any thoughts about this situation? Is it just not possible to have Eclipse 4.2 help as an infocenter run on both Tomcat 6 and 7, for example? I suspect this is related to the difference in servlet container's being used (tomcat 7 uses servlet 3, tomcat 6 uses servlet 2.5), but what I don't know is if its possible for the eclipse code to be configured in a way where it can run in both. Could someone who has successfully created an InfoCenter WAR compatible with Tomcat7 share it with the rest of us (in a way similar to what Robert Sanders has done there: http://www.ipov.net/apps/blog/2011/01/eclipse-infocenter-help-as-web-app/)? Thanks in advance, David Using Robert Sanders procedure as a base, here is my procedure to create an infocenter web archive that works in Tomcat 7 and other newer servlet containers.
Using Eclipse 3.4 or later it is possible to configure the help plugins to be deployed as a web archive (war file) which will act as a fully functioning information center. The instructions below apply to Tomcat 7, JBoss 6 and higher, WebSphere 8.5 (and possibly 8.0), and Jetty 8. If you have servlet containers or application servers at lower release levels, build your infocenter war files using Eclipse 3.4 through 3.8.
In your Eclipse installation locate the plugin org.eclipse.help.webapp.<version>.jar and copy it to a temporary directory, unzip the copy into that folder.
1. In the webapp plugin locate the web-archive directory and underneath that there will be two directories titled "help" and "org.eclipse. help.infocenter-feature".
2. Import the org.eclipse.help.infocenter-feature using File->Import->Existing Projects into Workspace.
3. After import, Eclipse shows warnings on the feature.xml file that 2 plugins can’t be resolved: org.apache.jasper, and org.apache.commons.el. These two plugins have been replaced by different ones (which aren’t included in the feature.xml, but are in the 4.2.2 package). Delete the entries for these in feature.xml and save the changes.
4. Inside the WEB-INF directory where you unzipped the org.eclipse.help.webapp.<version>.jar file, create directories named “lib” and “eclipse.” Move the configuration directory and the launch.ini file into the eclipse directory. It is possible to do this setup in other ways, but this way works for me. I like to have all the Eclipse directories--such as configuration, plugins, and features—underneath the eclipse directory.
5. From the Eclipse IDE, export org.eclipse.help.infocenter-feature as a deployable feature and set the destination to be web-archive/help/WEB-INF/eclipse in the area where org.eclipse.help.webapp.<version>.jar was unzipped. This places 28 plugins in the eclipse/plugins directory, and a jar file for the feature in the features directory. A content.jar and artifact.jar are included in the export but probably aren’t needed. If you don’t want to see an annoying error in the eclipse\workspace\.metadata\.log file about it not being able to open feature.xml, then convert the jar file in the features directory to a directory.
6. From the plugins directory of your Eclipse installation, copy the following additional plugins into the eclipse/plugins directory for the area where you unzipped the org.eclipse.help.webapp.<version>.jar file.
javax.el_2.2.0.v<version>.jar
org.apache.jasper.glassfish_2.2.2.v<version>.jar
If you want to avoid unresolved bundles issues in the Osgi console, also add the following, which are required by the org.eclipse.equinox.http.jetty.v<version>.jar:
org.eclipse.jetty.http_8.1.3.v<version>.jar
org.eclipse.jetty.io_8.1.3.v<version>.jar
org.eclipse.jetty.server_8.1.3.v<version>.jar
org.eclipse.jetty.servlet_8.1.3.v<version>.jar
org.eclipse.jetty.util_8.1.3.v<version>.jar
org.eclipse.jetty.continuation_8.1.3.v<version>.jar
org.eclipse.jetty.security_8.1.3.v<version>.jar
(The infocenter seems to work OK without these org.eclipse.jetty plugins, but perhaps without them there would be occasions when something did not work, so I include them to be on the safe side.)
7. Place some documentation plugins into the plugins directory for the area where you unzipped the org.eclipse.help.webapp.<version>.jar file.
8. Download org.eclipse.equinox.http.servletbridge_<version>.jar and org.eclipse.equinox.servletbridge_<version>.jar from the equinox download site. Select a version of Equinox that matches the version of Eclipse you are running to take you to the downloads page. For Eclipse 4.2, the files I use are org.eclipse.equinox.servletbridge_1.2.200.v20120522-2049.jar (goes in the lib directory) and org.eclipse.equinox.http.servletbridge_1.0.300.v20120522-2049.jar (goes in the plugins directory).
9. Add the file org.eclipse.equinox.servletbridge_<version>.jar. to the help/WEB-INF/lib directory.
10.Add the file org.eclipse.equinox.http.servletbridge_<version>.jar to the help/WEB-INF/plugins directory.
11.Create a war file from the help directory or you can copy the directory and its contents to the webapps folder of your Tomcat installation. Be sure to build the war file starting at the help directory. I have occasionally accidentally started at the WEB-INF level and created an unworkable war file.
12.For Tomcat only. In conf/server.xml add URIEncoding="UTF-8" to the connector element, for example
<Connector port="8080" URIEncoding="UTF-8" etc.>
If this step is not performed search will fail if the search term contains non ASCII characters.
13.Start your servlet container and navigate to the URL for your infocenter. If the infocenter is on your own system, it will be something like http://localhost:8080/mytestwar/index.jsp, where 8080 is the servlet container (web server) port and mytestwar is the context root (by default many servlet containers use the name of the war file for this but it can be overridden).
Notes: If you look in the config.ini file in the help.war under directory help/WEB_INF/configuration you will notice the line eclipse.product=org.eclipse.productname. If your product has help system customizations in a product plugin you can activate these by changing this line to point to your product plugin.
If you don’t do any customization, comment out the eclipse.product=org.eclipse.productname. If you don’t, there will always be an error listed in the eclipse\workspace\.metadata\.log file.
Check if bug 374621 is similar. I believe you can change web.xml to force servlet 2.5 spec: <init-param> <param-name>extendedFrameworkExports</param-name> <param-value>com.ibm.team.repository.server.servletbridge,javax.servlet.resources;version="2.5",javax.servlet;version="2.5",javax.servlet.http;version="2.5"</param-value> </init-param> This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet. If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant. -- The automated Eclipse Genie. Please reopen if this is still an issue with 4.11 M1. *** Bug 548949 has been marked as a duplicate of this bug. *** This is still an issue, also for newer Tomcats or WildFly. *** Bug 381750 has been marked as a duplicate of this bug. *** New Gerrit change created: https://git.eclipse.org/r/161113 New Gerrit change created: https://git.eclipse.org/r/161132 I have provided a patch that refactors the building of the infocenter webapp without so much manual work. It is currently WIP. I had it already working, but with the current state the org.eclipse.equinox.http.servletbridge.internal.Activator is not invoked. I'll try to solve that later. Also note that I raised bug#562249 which I found when the application was started but not working on Tomcat. I deployed the resulting help.war on a standalone Tomcat and it worked. So my patch could be evaluated now. Is it available as download somewhere? see https://bugs.eclipse.org/bugs/show_bug.cgi?id=215676 Created attachment 282520 [details]
help.war
Works for me also on Tomcat 9.0.34 Gerrit change https://git.eclipse.org/r/161132 was merged to [master]. Commit: http://git.eclipse.org/c/platform/eclipse.platform.ua.git/commit/?id=f0221a36d49eef6e478ec0352ebb493b5c46c700 The refactored web project is checked in. Now I‘ll have to update the documentation. *** Bug 322677 has been marked as a duplicate of this bug. *** *** Bug 244449 has been marked as a duplicate of this bug. *** New Gerrit change created: https://git.eclipse.org/r/161461 Gerrit change https://git.eclipse.org/r/161461 was merged to [master]. Commit: http://git.eclipse.org/c/platform/eclipse.platform.common.git/commit/?id=4a4eb709ae737392fbc8964b19ae16191c09d935 Instructions have been updated. (In reply to Karsten Thoms from comment #29) > Instructions have been updated. Karsten, the README.MD talks about: * Register the plugins in `infocenter-web/infocenter-app/src/main/webapp/WEB-INF/configuration/org.eclipse.equinox.simpleconfigurator/bundles.info` However, that configuration directory does not exist. (In reply to Wim Jongman from comment #30) > (In reply to Karsten Thoms from comment #29) > > Instructions have been updated. > > Karsten, the README.MD talks about: > > * Register the plugins in > `infocenter-web/infocenter-app/src/main/webapp/WEB-INF/configuration/org. > eclipse.equinox.simpleconfigurator/bundles.info` > > However, that configuration directory does not exist. also the command 'mvnw' is not in the project. I believe it wraps mvn and should be part of the project? Gerrit change https://git.eclipse.org/r/c/equinox/rt.equinox.bundles/+/161113 was merged to [master]. Commit: http://git.eclipse.org/c/equinox/rt.equinox.bundles.git/commit/?id=b8616ce1f00ccd59585978d0a1829bdefa6bc428 (In reply to Wim Jongman from comment #31) > (In reply to Wim Jongman from comment #30) > > (In reply to Karsten Thoms from comment #29) > > > Instructions have been updated. > > > > Karsten, the README.MD talks about: > > > > * Register the plugins in > > `infocenter-web/infocenter-app/src/main/webapp/WEB-INF/configuration/org. > > eclipse.equinox.simpleconfigurator/bundles.info` > > > > However, that configuration directory does not exist. > > also the command 'mvnw' is not in the project. I believe it wraps mvn and > should be part of the project? If the dropins directory watching feature works, isn't it another option to drop the content into that folder so that the bundles.info automatically gets updated with the detected content plugin(s)? If so, it would be handy if the documentation mentioned it. (In reply to marcellus ludovicus from comment #9) > Using Robert Sanders procedure as a base, here is my procedure to create an > infocenter web archive that works in Tomcat 7 and other newer servlet > containers. > Using Eclipse 3.4 or later it is possible to configure the help plugins to > be deployed as a web archive (war file) which will act as a fully > functioning information center. The instructions below apply to Tomcat 7, > JBoss 6 and higher, WebSphere 8.5 (and possibly 8.0), and Jetty 8. If you > have servlet containers or application servers at lower release levels, > build your infocenter war files using Eclipse 3.4 through 3.8. > In your Eclipse installation locate the plugin > org.eclipse.help.webapp.<version>.jar and copy it to a temporary directory, > unzip the copy into that folder. > 1. In the webapp plugin locate the web-archive directory and underneath > that there will be two directories titled "help" and "org.eclipse. > help.infocenter-feature". > 2. Import the org.eclipse.help.infocenter-feature using > File->Import->Existing Projects into Workspace. > 3. After import, Eclipse shows warnings on the feature.xml file that 2 > plugins can’t be resolved: org.apache.jasper, and org.apache.commons.el. > These two plugins have been replaced by different ones (which aren’t > included in the feature.xml, but are in the 4.2.2 package). Delete the > entries for these in feature.xml and save the changes. > 4. Inside the WEB-INF directory where you unzipped the > org.eclipse.help.webapp.<version>.jar file, create directories named “lib” > and “eclipse.” Move the configuration directory and the launch.ini file > into the eclipse directory. It is possible to do this setup in other ways, > but this way works for me. I like to have all the Eclipse directories--such > as configuration, plugins, and features—underneath the eclipse directory. > 5. From the Eclipse IDE, export org.eclipse.help.infocenter-feature as > a deployable feature and set the destination to be > web-archive/help/WEB-INF/eclipse in the area where > org.eclipse.help.webapp.<version>.jar was unzipped. This places 28 plugins > in the eclipse/plugins directory, and a jar file for the feature in the > features directory. A content.jar and artifact.jar are included in the > export but probably aren’t needed. If you don’t want to see an annoying > error in the eclipse\workspace\.metadata\.log file about it not being able > to open feature.xml, then convert the jar file in the features directory to > a directory. > 6. From the plugins directory of your Eclipse installation, copy the > following additional plugins into the eclipse/plugins directory for the area > where you unzipped the org.eclipse.help.webapp.<version>.jar file. > > javax.el_2.2.0.v<version>.jar > org.apache.jasper.glassfish_2.2.2.v<version>.jar > > If you want to avoid unresolved bundles issues in the Osgi console, also add > the following, which are required by the > org.eclipse.equinox.http.jetty.v<version>.jar: > org.eclipse.jetty.http_8.1.3.v<version>.jar > org.eclipse.jetty.io_8.1.3.v<version>.jar > org.eclipse.jetty.server_8.1.3.v<version>.jar > org.eclipse.jetty.servlet_8.1.3.v<version>.jar > org.eclipse.jetty.util_8.1.3.v<version>.jar > org.eclipse.jetty.continuation_8.1.3.v<version>.jar > org.eclipse.jetty.security_8.1.3.v<version>.jar > > (The infocenter seems to work OK without these org.eclipse.jetty plugins, > but perhaps without them there would be occasions when something did not > work, so I include them to be on the safe side.) > 7. Place some documentation plugins into the plugins directory for the > area where you unzipped the org.eclipse.help.webapp.<version>.jar file. > 8. Download org.eclipse.equinox.http.servletbridge_<version>.jar and > org.eclipse.equinox.servletbridge_<version>.jar from the equinox download > site. Select a version of Equinox that matches the version of Eclipse you > are running to take you to the downloads page. For Eclipse 4.2, the files I > use are org.eclipse.equinox.servletbridge_1.2.200.v20120522-2049.jar (goes > in the lib directory) and > org.eclipse.equinox.http.servletbridge_1.0.300.v20120522-2049.jar (goes in > the plugins directory). > 9. Add the file org.eclipse.equinox.servletbridge_<version>.jar. to the > help/WEB-INF/lib directory. > 10.Add the file org.eclipse.equinox.http.servletbridge_<version>.jar to > the help/WEB-INF/plugins directory. > 11.Create a war file from the help directory or you can copy the > directory and its contents to the webapps folder of your Tomcat > installation. Be sure to build the war file starting at the help directory. > I have occasionally accidentally started at the WEB-INF level and created an > unworkable war file. > 12.For Tomcat only. In conf/server.xml add URIEncoding="UTF-8" to the > connector element, for example > <Connector port="8080" URIEncoding="UTF-8" etc.> > If this step is not performed search will fail if the search term contains > non ASCII characters. > 13.Start your servlet container and navigate to the URL for your > infocenter. If the infocenter is on your own system, it will be something > like http://localhost:8080/mytestwar/index.jsp, where 8080 is the servlet > container (web server) port and mytestwar is the context root (by default > many servlet containers use the name of the war file for this but it can be > overridden). > Notes: If you look in the config.ini file in the help.war under directory > help/WEB_INF/configuration you will notice the line > eclipse.product=org.eclipse.productname. If your product has help system > customizations in a product plugin you can activate these by changing this > line to point to your product plugin. > If you don’t do any customization, comment out the > eclipse.product=org.eclipse.productname. If you don’t, there will always be > an error listed in the eclipse\workspace\.metadata\.log file. If we needed a version of the sample help.war that includes the latest Eclipse Platform User Assistance fixes since the attached war, would we repeat your steps here but with more current dependencies? Or if you're feeling generous, would you be willing to create such a WAR and attach it here? I'm not a seasoned Java developer, but our Technical Writers would certainly appreciate it. Unfortunately I'm not in a good position to create a help.war with the latest Eclipse. My company has moved away from Eclipse infocenters so I've been developing a Javascript based solution instead. (BTW, I'm also not a Java expert and am technically a technical writer still, though that is a small part of my work now). If you have specific questions or issues if you try to follow the steps, I might be able to help. I just don't have time to figure out everything for a newer Eclipse. We're building a React-based Infocenter as a nextgen replacement, but it might be a while until these EclipseHelp Infocenters can be phased out. My biggest uncertainty in your recipe was how you arrived at the specific version numbers of the jars you added. The ones that are compatible with a given version of the Eclipse IDE or Platform SDK should be easy enough to find if they're documented properly and all dependency versions clearly spelled out. I'll try to follow your instructions, but substitute current versions of jars in place of the ones you used in April 2020. I may ask a question if I get stuck. Thanks for the quick response. I've noticed that additions to the dropins directory does not trigger and update of the bundles.info file in the WAR attached to this ticket. By default, this directory is documented as being a watched directory for this purpose. Is there an addition configuration that needs to occur in the WAR package? (In reply to John Kirkilis from comment #37) > I've noticed that additions to the dropins directory does not trigger and > update of the bundles.info file in the WAR attached to this ticket. By > default, this directory is documented as being a watched directory for this > purpose. > > Is there an addition configuration that needs to occur in the WAR package? John, this ticket is closed. Please open a new one. (In reply to Wim Jongman from comment #38) > (In reply to John Kirkilis from comment #37) > > I've noticed that additions to the dropins directory does not trigger and > > update of the bundles.info file in the WAR attached to this ticket. By > > default, this directory is documented as being a watched directory for this > > purpose. > > > > Is there an addition configuration that needs to occur in the WAR package? > > John, this ticket is closed. Please open a new one. Will do. I was wondering about that. This is my first use of this bug tracker. Thanks. |