[Apache Tomcat] The story of using Apache OpenWebBeans to enable CDI

Overview

Making CDI available in Apache Tomcat is tedious by writing and configuring pom.xml. So, this time, I will use Apache OpenWebBeans to make it easy to use CDI.

Prerequisites

1. Java command can be used
2. Git can be used
3. Can use eclipse (if possible)

overall structure

/Work destination/
  ├ Tomcat/
  │  ├ apache-tomcat-9.0.22/
  │  │  ├ bin/
  │  │  │  ├ startup.bat
  │  │  │  └ startup.sh
  │  │  └ conf/
  │  │     ├ Catalina/
  │  │     │  └ localhost
  │  │     │     └ Sample.xml
  │  │     ├ context.xml
  │  │     └ logging.properties
  │  ├ current -> (/Work destination/Tomcat/apache-tomcat-9.0.22/)
  │  ├ openwebbeans-distribution-2.0.9
  │  │  ├ install_owb_tomcat7.bat
  │  │  └ install_owb_tomcat7.sh
  │  ├ apache-tomcat-9.0.22
  │  └ openwebbeans-distribution-2.0.9-binary.zip
  └ quita
     └ cdi-sample
        └ WebContent
          └ WEB-INF
            └ beanse.xml

Work procedure

1. Create a directory for this work. (Hereafter, work destination)

2. Create a Tomcat directory at your destination.

3. Download Apache Tomcat to the Tomcat directory and unzip it.

4. Create a current link in consideration of the version change.

   #For Windows
   mklink /j current apache-tomcat-9.0.22
   
   #For linux
   ln -s apache-tomcat-9.0.22 ./current
   

5. [Implemented for Windows] Change conf / logging.properties in Apache Tomcat to prevent the console from being garbled.

   #Near line 51
   #Change before
   java.util.logging.ConsoleHandler.encoding = UTF-8
   #After change
   java.util.logging.ConsoleHandler.encoding = SJIS
   

6. Download Apache OpenWebBeans to the Tomcat directory and unzip it.

7. Run install_owb_tomcat7 in Apache OpenWebBeans

   #For Windows
   install_owb_tomcat7.bat ..\current
   
   #For linux
   install_owb_tomcat7.sh ../current
   

8. [Implemented for Windows] Add a tag in the "" tag of conf / context.xml in Apache Tomcat, and do as follows.

   <Context>
   
       <!-- Default set of monitored resources. If one of these changes, the    -->
       <!-- web application will be reloaded.                                   -->
       <WatchedResource>WEB-INF/web.xml</WatchedResource>
       <WatchedResource>WEB-INF/tomcat-web.xml</WatchedResource>
       <WatchedResource>${catalina.base}/conf/web.xml</WatchedResource>
       <!--↓ Added tag-->
       <Listener className="org.apache.webbeans.web.tomcat7.ContextLifecycleListener"/>
       <!-- Uncomment this to disable session persistence across Tomcat restarts -->
       <!--
       <Manager pathname="" />
       -->
   </Context>
   

9. Clone the following Git to your destination

   • https://gitlab.com/P488/qiita.git

10. Create xml with the following contents in conf / Catalina / localhost in Apache Tomcat.

``` xml:Sample.xml
<Context path="/Sample" reloadable="true" docBase="/Work destination/quita/cdi-sample/WebContent">
</Context>
```

11. Run startup in the Apache Tomcat bin

``` sh
#For Windows
startup.bat

#For linux
startup.sh
```

12. Access localhost: 8080 / Sample / SampleServlet and confirm that "Served at:" is output.

Impressions / Summary

Now I've used Apache OpenWebBeans to enable Apache Tomcat to use CDI. In the case of Windows, it is a little annoying because it requires manual work, but I wondered if it would be easy to use CDI by executing bat / sh. The source used this time is created with eclipse, so if you can, you may want to play around with it. (When using with eclipse, change the Tomcat installation directory to / work / Tomcat / current from Window-> Settings-> Server-> Runtime environment-> Tomcat9 (Java11)-> Edit)

Please comment if you have any mistakes or problems.