ADempiere and Tomcat

[marcalwestf]

ADEMPIERE AND TOMCAT (3.9.3 , 3.9.4)

Since ADempiere 3.9.3, Tomcat must be installed separately and be referred to in the ADempiere installation. Same applies to Jetty and Wildfly, too.

• In the following, I wrote some hints and observations I made this regarding.
• Feel free to comment and add your findings so others can be helped.
• I left installation paths as defined on my server; your path may differ from it.
• Same with users.

I IS TOMCAT RUNNING?

THE TOMCAT VERSION WE MUST USE IS 9.0.50 (as far as I know right now)

Test installed Tomcat Version:

• URL: https://www.javatpoint.com/how-to-check-tomcat-version-in-linux
• In the link, there are offered several methods.
• Only one of them is here described.

Supposing, Tomcat has been installed, run the following:

• cd $CATALINA_HOME/bin
• ./catalina.sh version
  Result:

Using CATALINA_BASE:   /data2/programme/apache-tomcat-9.0.50
      Using CATALINA_HOME:   /data2/programme/apache-tomcat-9.0.50
      Using CATALINA_TMPDIR: /data2/programme/apache-tomcat-9.0.50/temp
      Using JRE_HOME:        /usr/lib/jvm/jdk-11.0.11+9
      Using CLASSPATH:       /data2/programme/apache-tomcat-9.0.50/bin/bootstrap.jar:/data2/programme/apache-tomcat-9.0.50/bin/tomcat-juli.jar
      Using CATALINA_OPTS:   
      NOTE: Picked up JDK_JAVA_OPTIONS:  --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens=java.base/java.util.concurrent=ALL-UNNAMED --add-opens=java.rmi/sun.rmi.transport=ALL-UNNAMED
      Server version: Apache Tomcat/9.0.50
      Server built:   Jun 28 2021 08:46:44 UTC
      Server number:  9.0.50.0
      OS Name:        Linux
      OS Version:     5.15.0-89-generic
      Architecture:   amd64
      JVM Version:    11.0.11+9
      JVM Vendor:     AdoptOpenJDK

Does Tomcat run as Service?
What happens if it does not run as a service?

• sudo systemctl status tomcat
  Unit tomcat.service could not be found.

II TOMCAT INSTALLATION
URL: https://phoenixnap.com/kb/install-tomcat-ubuntu

Create Tomcat group:
sudo groupadd tomcat

Add user westfalia to group tomcat:
sudo usermod -a -G tomcat westfalia

Tests:
group westfalia
id westfalia

Tomcat user:
sudo useradd -s /bin/false -g tomcat -d /data2/programme/apache-tomcat-9.0.50 tomcat

Change Password for User "tomcat" (to "tomcat"):
sudo passwd tomcat
groups tomcat

sudo chown -RH tomcat: /data2/programme/apache-tomcat-9.0.50
sudo sh -c 'chmod +x /data2/programme/apache-tomcat-9.0.50/bin/*.sh'

III CREATE SYSTEM UNIT FILE

Create and open a new file in the /etc/system/system under the name tomcat.service:
sudo nano /etc/systemd/system/tomcat.service

Change to following contents
In the instructions there was User/Group=tomcat; if you change the group as I did to "westfalia", you must change it accordingly; otherwise you'll get an error.

[Unit]
Description=Apache 9.05 Tomcat Web Application Container by Systemhaus Westfalia
After=network.target

[Service]
Type=forking

User=westfalia
Group=westfalia

Environment="JAVA_HOME=/usr/lib/jvm/jdk-11.0.11+9"
Environment="JAVA_OPTS=-Djava.security.egd=file:///dev/urandom -Djava.awt.headless=true"

Environment="CATALINA_BASE=/data2/programme/apache-tomcat-9.0.50"
Environment="CATALINA_HOME=/data2/programme/apache-tomcat-9.0.50"
Environment="CATALINA_PID=/data2/programme/apache-tomcat-9.0.50/temp/tomcat.pid"
Environment="CATALINA_OPTS=-Xms512M -Xmx1024M -server -XX:+UseParallelGC"

ExecStart=/data2/programme/apache-tomcat-9.0.50/bin/startup.sh
ExecStop=/data2/programme/apache-tomcat-9.0.50/bin/shutdown.sh

[Install]
WantedBy=multi-user.target

IV START TOMCAT AS A SERVICE

For the changes to take place, reload the system daemon with the command:
sudo systemctl daemon-reload

Start the Tomcat service:
sudo systemctl start tomcat

Verify the Apache Tomcat service is running
sudo systemctl status tomcat

Result:

● tomcat.service - Apache 9.05 Tomcat Web Application Container by Systemhaus Westfalia
   Loaded: loaded (/etc/systemd/system/tomcat.service; disabled; vendor preset: enabled)
   Active: active (running) since Thu 2023-12-07 04:49:01 CST; 8s ago
  Process: 691313 ExecStart=/data2/programme/apache-tomcat-9.0.50/bin/startup.sh (code=exited, status=0/SUCCESS)
 Main PID: 691320 (java)
    Tasks: 36 (limit: 38319)
   Memory: 145.2M
      CPU: 5.500s
   CGroup: /system.slice/tomcat.service
           └─691320 /usr/lib/jvm/jdk-11.0.11+9/bin/java -Djava.util.logging.config.file=/data2/programme/apache-tomcat-9.0.50/conf/logging.properties -Djava.util.loggin>

Dec 07 04:49:00 westfalia-G75VW systemd[1]: Starting Apache 9.05 Tomcat Web Application Container by Systemhaus Westfalia...
Dec 07 04:49:01 westfalia-G75VW startup.sh[691313]: Tomcat started.
Dec 07 04:49:01 westfalia-G75VW systemd[1]: Started Apache 9.05 Tomcat Web Application Container by Systemhaus Westfalia.

For the following command, you may have to install "ufw"
sudo ufw enable
sudo ufw allow 8080

Check Tomcat run on browser
http://localhost:8080/
http://192.168.0.201:8080/

Stop the Tomcat service:
sudo systemctl stop tomcat

V ADEMPIERE SETUP WITH TOMCAT

If you have followed the previous instructions. you can proceed to ADempiere-Setup.

On ADempiere Setup Window make sure to have the correct entries in order to avoid any malfunction:

1 On Setup Window

• Important are the fields Application Server Directory and Deployment.
• Application Server Directory must refer to Tomcat 9 installation.
• Deployment must refer to $ADEMPIERE_HOME/tomcat/webapps.
• If these fields refer to other ĺocations, the setup might work, but RUN_Server2.sh not.

2 Variables, which are consequence of Setup

• Field Application Server Directory -> Tomcat-Istallation, e.g.: /data2/programme/apache-tomcat-9.0.50
  This will become CATALINA_HOME when executing ./RUN_Server2.sh.
• Field Deployment -> $ADEMPIERE_HOME/tomcat
  This will become CATALINA_BASE when executing ./RUN_Server2.sh.

If the installation is done graphically:

When Setup OK, the installation ends with

:
:  
BUILD SUCCESSFUL
 Total time: 1 minutes 6 seconds

When Setup OK, Server start:
./RUN_Server2.sh

  Setting myEnvironment ....
  CATALINA_BASE: /data2/app/Adempiere/tomcat
  ADempiere Server tomcat starting ...
  Using CATALINA_BASE:   /data2/app/Adempiere/tomcat
  Using CATALINA_HOME:   /data2/programme/apache-tomcat-9.0.50
  Using CATALINA_TMPDIR: /data2/app/Adempiere/tomcat/temp
  Using JRE_HOME:        /usr/lib/jvm/jdk-11.0.11+9
  Using CLASSPATH:       /data2/programme/apache-tomcat-9.0.50/bin/bootstrap.jar:/data2/app/Adempiere/tomcat/bin/tomcat-juli.jar
  Using CATALINA_OPTS:   
  Using CATALINA_PID:    /data2/app/Adempiere/tomcat/tomcat.pid
  Tomcat started.

VI DEBUGGING WITH ECLIPSE AND TOMCAT IN WINDOWS
Important!!!!

• This are my findings since ADempiere 3.9.4

• I had to do the changes described in order to get Tomcat running on Eclipse in Windows.

• You must do these changes, test and revert them after debugging.

• If somebody has another solution, please share it so we all improve.

  1.- Correction in DB_PostgreSQL.getDataSource()

  Line 614:
  DataSource dataSource = InitialContext.doLookup("java:comp/env/java/AdempiereDS");

  On Windows, it produces an Exception, which is caught and program continues on line.
  On Ubuntu 22.04 there is no Exception, and the variable is returned.

  To avoid the exception you must comment line 616:
  // return dataSource;

See image:

2.- IP in Server Configuration
The IP in the Server Configuration istn't "localhost", but the real IP.
As in following image:

Then it works!!!!

VII TOMCAT AND PROJECT ADEMPIERE-ALL-SERVICES
When working with the projects "adempiere-all-services", "adempiere-ui-gateway" or with containers, you may find of interest the following.

First, Tomcat must be started.
The database can be

• local (example of hostname: westfalia-G75VW) or
• in Container e.g. with project /data2/entwicklung/westfaliaRepository_2022-067/adempiere-processors-service

Start Tomcat as explained before.
Problem can arise when starting the project "adempiere-all-services" (docker compose up -d) an error pops up:
Error response from daemon: driver failed programming external connectivity on endpoint adempiere-saprod.site (eaed58c899779fac5765bcc99defc78543588f9a7a2cb3b6d725a320318d84ea): Error starting userland proxy: listen tcp4 0.0.0.0:8080: bind: address already in use.

First, find out the process which reserves the port:
sudo lsof -i :8080

With "sudo ps -efa | grep " I find out that is the local Tomcat:
westfal+ 1304 1 0 Jan05 ? 00:01:22 /usr/lib/jvm/jdk-11.0.11+9/bin/java -Djava.util.logging.config.file=/data2/programme/apache-tomcat-9.0.50/conf/logging.

Either kill the process or (better) stop Tomcat:
sudo systemctl stop tomcat