The Apache Tomcat Native Library 2.0

To build TC-Native, the following components must be installed:

• APR library
• OpenSSL libraries
• Java SE Development Kit (JDK)

For Debian-based Linux distributions, these dependencies can be installed using the following command:

apt-get install libapr1-dev libssl-dev openjdk-11-jdk

For RPM-based Linux distributions, these dependencies can be installed using the following command:

yum install apr-devel openssl-devel java-11-openjdk-devel

On all POSIX-like systems (Linux, Solaris, HP-UX, AIX etc...), the well-known configure and make are used to build TC-Native.
To see a description of all configuration parameters, run the following command in the native directory of the source distribution:

./configure --help

To create the includes and makefiles necessary for building TC-Native, use the following command:

./configure --with-apr=$HOME/APR \
            --with-java-home=$JAVA_HOME \
            --with-ssl=$HOME/OPENSSL \
            --prefix=$CATALINA_HOME

Where:
$HOME/APR is the path to the APR installation, such as /usr/bin/apr-1-config.
$JAVA_HOME is the path to a JDK installation, for example, /home/jfclere/JAVA/jdk11. Any JDK version should work, but it is advisable to use the same JVM version as the one you use with Tomcat.
$HOME/OPENSSL is the path where OpenSSL is installed.
$CATALINA_HOME is the path where the produced libraries will be installed, such as $HOME/apache-tomcat-10.1.0

The configure script can automatically detect most standard APR and OpenSSL installations. Therefore, an equivalent command is usually sufficient:

./configure --with-java-home=$JAVA_HOME --prefix=$CATALINA_HOME

To build and install the libraries, run:

make && make install

The libraries will be installed in $CATALINA_HOME/lib.

Detailed building instructions including the steps to create a standard release distribution are provided on the Wiki.

Apache Tomcat comes with the AprLifecycleListener enabled by default. However, it is recommended to check conf/server.xml file to ensure that the following configuration is present and uncommented:

<Listener className="org.apache.catalina.core.AprLifecycleListener" />

For detailed configuration instructions, please refer to the Apache Tomcat documentation (See Tomcat 11.0.x, Tomcat 10.1.x and Tomcat 9.0.x).

To ensure the TC-Native libraries are correctly loaded, follow these steps:

• Edit the $CATALINA_HOME/bin/setenv.sh file. For detailed instructions, please refer to the RUNNING.txt file of your Apache Tomcat distribution.
• Check that TC-Native libraries exist in $CATALINA_HOME/lib and add the path to the TC-Native libraries to the LD_LIBRARY_PATH:
  

  LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$CATALINA_HOME/lib
  export LD_LIBRARY_PATH

• Start Tomcat and look for messages similar to the following in the logs:
  

  21-Jun-2024 11:06:23.274 INFO [main] org.apache.catalina.core.AprLifecycleListener.lifecycleEvent Loaded Apache Tomcat Native library [2.0.7] using APR version [1.7.3].
  21-Jun-2024 11:06:23.298 INFO [main] org.apache.catalina.core.AprLifecycleListener.initializeSSL OpenSSL successfully initialized [OpenSSL 3.2.1 30 Jan 2024]

For detailed configuration of connectors, refer to the Apache Tomcat documentation (See Tomcat 11.0.x, Tomcat 10.1.x and Tomcat 9.0.x).

To ensure the TC-Native libraries are correctly loaded, follow these steps:

• Edit the $CATALINA_HOME/bin/setenv.sh file. For detailed instructions, please refer to the RUNNING.txt file of your Apache Tomcat distribution.
• Ensure that the tcnative-2.dll file matches CPU architecture of JVM that you use to run Tomcat (x86 or x64) and is located in the $CATALINA_HOME/bin directory.
  Alternatively, you can add the path to the TC-Native libraries to the PATH environment variable:
  

  set PATH=%PATH%;C:\your\path\to\tc-native-dll

• Start Tomcat and look for messages similar to the following in the logs:
  

  21-Jun-2024 11:06:23.274 INFO [main] org.apache.catalina.core.AprLifecycleListener.lifecycleEvent Loaded Apache Tomcat Native library [2.0.7] using APR version [1.7.3].
  21-Jun-2024 11:06:23.298 INFO [main] org.apache.catalina.core.AprLifecycleListener.initializeSSL OpenSSL successfully initialized [OpenSSL 3.2.1 30 Jan 2024]