You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwebbeans.apache.org by st...@apache.org on 2016/04/27 19:54:21 UTC
svn commit: r1741301 - in /openwebbeans/cms-site/trunk/content:
documentation.mdtext owbsetup_ee.mdtext owbsetup_tomcat.mdtext
Author: struberg
Date: Wed Apr 27 17:54:21 2016
New Revision: 1741301
URL: http://svn.apache.org/viewvc?rev=1741301&view=rev
Log:
add owb-tomcat integration documentation (together with kgrosse)
Added:
openwebbeans/cms-site/trunk/content/owbsetup_tomcat.mdtext
- copied, changed from r1741296, openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext
Modified:
openwebbeans/cms-site/trunk/content/documentation.mdtext
openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext
Modified: openwebbeans/cms-site/trunk/content/documentation.mdtext
URL: http://svn.apache.org/viewvc/openwebbeans/cms-site/trunk/content/documentation.mdtext?rev=1741301&r1=1741300&r2=1741301&view=diff
==============================================================================
--- openwebbeans/cms-site/trunk/content/documentation.mdtext (original)
+++ openwebbeans/cms-site/trunk/content/documentation.mdtext Wed Apr 27 17:54:21 2016
@@ -21,6 +21,7 @@ Notice: Licensed to the Apache Softwa
# Getting Started
- [How CDI works](cdi_explained.html)
- [Adding OpenWebBeans to your JavaSE project](owbsetup_se.html)
+ - [Adding OpenWebBeans to Apache Tomcat](owbsetup_tomcat.html)
- [Adding OpenWebBeans to your Servlet Container project](owbsetup_ee.html)
- [OpenWebBeans as part of JavaEE Containers](owb-eecontainers.html)
- [OpenWebBeans configuration](owbconfig.html)
Modified: openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext
URL: http://svn.apache.org/viewvc/openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext?rev=1741301&r1=1741300&r2=1741301&view=diff
==============================================================================
--- openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext (original)
+++ openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext Wed Apr 27 17:54:21 2016
@@ -35,7 +35,7 @@ But since OpenWebBeans is modular you sh
### API jars
Several API bundles exists for java EE and they are mostly compatible with OpenWebBeans. If you already include one of these you might not need any api jars. CDI and thus OpenWebBeans depends on the following four apis:
- - **CDI: [geronimo-jcdi_1.0_spec.jar][3]**
+ - **CDI: [geronimo-jcdi_1.1_spec.jar][3]**
- **AtInject: [geronimo-atinject_1.0_spec.jar][3]**
- **Interceptor: [geronimo-interceptor_1.2_spec.jar][3]**
- **Common Annotations: [geronimo-annotation_1.2_spec.jar][3]**
Copied: openwebbeans/cms-site/trunk/content/owbsetup_tomcat.mdtext (from r1741296, openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext)
URL: http://svn.apache.org/viewvc/openwebbeans/cms-site/trunk/content/owbsetup_tomcat.mdtext?p2=openwebbeans/cms-site/trunk/content/owbsetup_tomcat.mdtext&p1=openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext&r1=1741296&r2=1741301&rev=1741301&view=diff
==============================================================================
--- openwebbeans/cms-site/trunk/content/owbsetup_ee.mdtext (original)
+++ openwebbeans/cms-site/trunk/content/owbsetup_tomcat.mdtext Wed Apr 27 17:54:21 2016
@@ -1,4 +1,4 @@
-Title: OpenWebBeans FAQ
+Title: OpenWebBeans Tomcat integration
Notice: 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
@@ -16,95 +16,20 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
-# Adding OpenWebBeans to your Servlet Container project
+# Adding OpenWebBeans to an Apache Tomcat installation
-OpenWebBeans in a great match for web-apps and should work well for your favorite Servlet Containers such as Jetty or Tomcat.
-To add OpenWebBeans to your Servlet Container project you need to take the following steps.
+By integrating OpenWebBeans with an existing tomcat installation you don't need to add any CDI container jars to your WAR files.
+Instead OpenWebBeans will get copied to the tomcat lib directory and activated for all webapps.
- 1. Add [dependencies][1] accordingly to instructions below.
- 2. In some cases add [org.apache.webbeans.servlet.WebBeansConfigurationListener][2] to web.xml as a listener
- 3. Done! Congratulations.
+## Downloading the latest OpenWebBeans distribution
+Download the latest [OWB distribution bundle](download.html) and unzip it.
-###Adding required jars and plugins to your project
+## Integrating Apache OpenWebBeans with Apache Tomcat
-You can add OpenWebBeans to your project manually by adding jars or with Apache Maven. How to download is explained here: [download page][3].
-The binary distributions include all the jars you need and the download page lists all the [maven dependencies][4].
-But since OpenWebBeans is modular you should read below so you know what to add.
+Change to the unzipped OWB distribution directory and run the following script:
-### API jars
-Several API bundles exists for java EE and they are mostly compatible with OpenWebBeans. If you already include one of these you might not need any api jars. CDI and thus OpenWebBeans depends on the following four apis:
+ ./install_owb_tomcat7.sh /path/to/your/tomcat/installation
- - **CDI: [geronimo-jcdi_1.0_spec.jar][3]**
- - **AtInject: [geronimo-atinject_1.0_spec.jar][3]**
- - **Interceptor: [geronimo-interceptor_1.2_spec.jar][3]**
- - **Common Annotations: [geronimo-annotation_1.2_spec.jar][3]**
-
-You will only reference these API:s in your own project. This way your project will stay CDI vendor neutral. A typical use case would be to add all four of the above to your parent-pom or your core module.
-
-
-### Required {#required-parts}
-
-For Servlet Container projects such as Tomcat and Jetty you always start with:
-
- - **[openwebbeans-spi][5]**
- - **[openwebbeans-impl][6]**
- - **[openwebbeans-web][7]**
-
-
-### Plugins
-The following plugins are very useful if you need JSF, expression language (el) etc. Add accordingly to your needs.
-
-- **[openwebbeans-el11][8]**
-- **[openwebbeans-el22][9]**
-- **[openwebbeans-tomcat7][10]**
-- **[openwebbeans-tomcat6][11]**
-- **[openwebbeans-jsf12][12]**
-- **[openwebbeans-jsf22][13]**
-
-###When to use respective plugin
-
-If the project uses Expression Language add EL plugin accordingly to your version. This is required for using EL.
-
-* Expression Language 1.1 - **[openwebbeans-jsf12][12]**
-* Expression Language 2.2 / 3.0 - **[openwebbeans-el22][9]**
-
-</br>
-For JSF support add JSF plugin accordingly to your version of JSF. This plugin is required for JSF support and do not forget the include the EL-plugin explained above.
-
-* Java Server Faces 2.0 or later - **[openwebbeans-jsf22][13]**
-* Java Server Faces 1.1/1.2 - **[openwebbeans-jsf12][12]**
-
-If the project uses Tomcat 6 or Tomcat 7 you can add the respective plugin. This is not required but enables injection in Servlets and Filters. Note that Tomcat7 should be read as Tomcat7+ thus it works perfectly fine with Tomcat 8.
-
-* Tomcat 6 - **[openwebbeans-tomcat6][11]**
-* Tomcat 7 / Tomcat 8 - **[openwebbeans-tomcat7][11]**
-
-
-###Bootstrapping OpenWebBeans {#configuring-owb}
-
-Simply put the following listener in web.xml:
-
- <listener>
- <listener-class>org.apache.webbeans.servlet.WebBeansConfigurationListener</listener-class>
- </listener>
-
-This is not required if you use Tomcat and added the corresponding Tomcat plugin because in that case it's managed by the plugin.
-
-From here you might want to look at our samples selection: [samples][14].
-
-
- [1]: #required-parts
- [2]: #configuring-owb
- [3]: /download.html#apis-version
- [4]: download.html#maven-dep
- [5]: /download.html#required-version
- [6]: /download.html#required-version
- [7]: /download.html#plugins-version
- [8]: /download.html#plugins-version
- [9]: /download.html#plugins-version
- [10]: /download.html#plugins-version
- [11]: /download.html#plugins-version
- [12]: /download.html#plugins-version
- [13]: /download.html#plugins-version
- [14]: /samples.html
\ No newline at end of file
+This will copy all necessary Apache OpenWebBeans jars over to your tomcat installation directory.
+It will also patch the tomcat context.xml and add org.apache.webbeans.web.tomcat7.ContextLifecycleListener.