Subversion Repositories Integrator Subversion

Rev

Details | Last modification | View Log | RSS feed

Rev Author Line No. Line
771 blopes 1 
<!DOCTYPE html SYSTEM "about:legacy-compat">
2 
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=UTF-8"><link href="./images/docs-stylesheet.css" rel="stylesheet" type="text/css"><title>Apache Tomcat 9 (9.0.112) - Apache Portable Runtime (APR) based Native library for Tomcat</title></head><body><div id="wrapper"><header><div id="header"><div><div><div class="logo noPrint"><a href="https://tomcat.apache.org/"><img alt="Tomcat Home" src="./images/tomcat.png"></a></div><div style="height: 1px;"></div><div class="asfLogo noPrint"><a href="https://www.apache.org/" target="_blank"><img src="./images/asf-logo.svg" alt="The Apache Software Foundation" style="width: 266px; height: 83px;"></a></div><h1>Apache Tomcat 9</h1><div class="versionInfo">
3 
            Version 9.0.112,
4 
            <time datetime="2025-11-06">Nov 6 2025</time></div><div style="height: 1px;"></div><div style="clear: left;"></div></div></div></div></header><div id="middle"><div><div id="mainLeft" class="noprint"><div><nav><div><h2>Links</h2><ul><li><a href="index.html">Docs Home</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</a></li></ul></div><div><h2>User Guide</h2><ul><li><a href="introduction.html">1) Introduction</a></li><li><a href="setup.html">2) Setup</a></li><li><a href="appdev/index.html">3) First webapp</a></li><li><a href="deployer-howto.html">4) Deployer</a></li><li><a href="manager-howto.html">5) Manager</a></li><li><a href="host-manager-howto.html">6) Host Manager</a></li><li><a href="realm-howto.html">7) Realms and AAA</a></li><li><a href="security-manager-howto.html">8) Security Manager</a></li><li><a href="jndi-resources-howto.html">9) JNDI Resources</a></li><li><a href="jndi-datasource-examples-howto.html">10) JDBC DataSources</a></li><li><a href="class-loader-howto.html">11) Classloading</a></li><li><a href="jasper-howto.html">12) JSPs</a></li><li><a href="ssl-howto.html">13) SSL/TLS</a></li><li><a href="ssi-howto.html">14) SSI</a></li><li><a href="cgi-howto.html">15) CGI</a></li><li><a href="proxy-howto.html">16) Proxy Support</a></li><li><a href="mbeans-descriptors-howto.html">17) MBeans Descriptors</a></li><li><a href="default-servlet.html">18) Default Servlet</a></li><li><a href="cluster-howto.html">19) Clustering</a></li><li><a href="balancer-howto.html">20) Load Balancer</a></li><li><a href="connectors.html">21) Connectors</a></li><li><a href="monitoring.html">22) Monitoring and Management</a></li><li><a href="logging.html">23) Logging</a></li><li><a href="apr.html">24) APR/Native</a></li><li><a href="virtual-hosting-howto.html">25) Virtual Hosting</a></li><li><a href="aio.html">26) Advanced IO</a></li><li><a href="maven-jars.html">27) Mavenized</a></li><li><a href="security-howto.html">28) Security Considerations</a></li><li><a href="windows-service-howto.html">29) Windows Service</a></li><li><a href="windows-auth-howto.html">30) Windows Authentication</a></li><li><a href="jdbc-pool.html">31) Tomcat's JDBC Pool</a></li><li><a href="web-socket-howto.html">32) WebSocket</a></li><li><a href="rewrite.html">33) Rewrite</a></li><li><a href="cdi.html">34) CDI 2 and JAX-RS</a></li><li><a href="graal.html">35) AOT/GraalVM Support</a></li></ul></div><div><h2>Reference</h2><ul><li><a href="RELEASE-NOTES.txt">Release Notes</a></li><li><a href="config/index.html">Configuration</a></li><li><a href="api/index.html">Tomcat Javadocs</a></li><li><a href="servletapi/index.html">Servlet 4.0 Javadocs</a></li><li><a href="jspapi/index.html">JSP 2.3 Javadocs</a></li><li><a href="elapi/index.html">EL 3.0 Javadocs</a></li><li><a href="websocketapi/index.html">WebSocket 1.1 Javadocs</a></li><li><a href="jaspicapi/index.html">JASPIC 1.1 Javadocs</a></li><li><a href="annotationapi/index.html">Common Annotations 1.3 Javadocs</a></li><li><a href="https://tomcat.apache.org/connectors-doc/">JK 1.2 Documentation</a></li></ul></div><div><h2>Apache Tomcat Development</h2><ul><li><a href="building.html">Building</a></li><li><a href="changelog.html">Changelog</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/Tomcat+Versions">Status</a></li><li><a href="developers.html">Developers</a></li><li><a href="architecture/index.html">Architecture</a></li><li><a href="tribes/introduction.html">Tribes</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>Apache Portable Runtime (APR) based Native library for Tomcat</h2><h3 id="Table_of_Contents">Table of Contents</h3><div class="text">
5 
<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Installation">Installation</a><ol><li><a href="#Windows">Windows</a></li><li><a href="#Linux">Linux</a></li></ol></li><li><a href="#APR_Components">APR Components</a></li><li><a href="#APR_Lifecycle_Listener_Configuration">APR Lifecycle Listener Configuration</a></li><li><a href="#APR_Connectors_Configuration">APR Connectors Configuration</a><ol><li><a href="#HTTP/HTTPS">HTTP/HTTPS</a></li><li><a href="#AJP">AJP</a></li></ol></li></ul>
6 
</div><h3 id="Introduction">Introduction</h3><div class="text">
7 
 
8 
  <p>
9 
      Tomcat can use the <a href="https://apr.apache.org/">Apache Portable Runtime</a> to
10 
      provide superior scalability, performance, and better integration with native server
11 
      technologies. The Apache Portable Runtime is a highly portable library that is at
12 
      the heart of Apache HTTP Server 2.x. APR has many uses, including access to advanced IO
13 
      functionality (such as sendfile, epoll and OpenSSL), OS level functionality (random number
14 
      generation, system status, etc), and native process handling (shared memory, NT
15 
      pipes and Unix sockets).
16 
  </p>
17 
 
18 
  <p>
19 
      These features allows making Tomcat a general purpose webserver, will enable much better
20 
      integration with other native web technologies, and overall make Java much more viable as
21 
      a full fledged webserver platform rather than simply a backend focused technology.
22 
  </p>
23 
 
24 
  </div><h3 id="Installation">Installation</h3><div class="text">
25 
 
26 
    <p>
27 
      APR support requires three main native components to be installed:
28 
    </p>
29 
    <ul>
30 
      <li>APR library</li>
31 
      <li>JNI wrappers for APR used by Tomcat (libtcnative)</li>
32 
      <li>OpenSSL libraries</li>
33 
    </ul>
34 
 
35 
    <div class="subsection"><h4 id="Windows">Windows</h4><div class="text">
36 
 
37 
    <p>
38 
      Windows binaries are provided for tcnative-1, which is a statically compiled .dll which includes
39 
      OpenSSL and APR. It can be downloaded from <a href="https://tomcat.apache.org/download-native.cgi">here</a>
40 
      as 32bit or AMD x86-64 binaries.
41 
      In security conscious production environments, it is recommended to use separate shared dlls
42 
      for OpenSSL, APR, and libtcnative-1, and update them as needed according to security bulletins.
43 
      Windows OpenSSL binaries are linked from the <a href="https://www.openssl.org">Official OpenSSL
44 
      website</a> (see related/binaries).
45 
    </p>
46 
 
47 
    </div></div>
48 
 
49 
    <div class="subsection"><h4 id="Linux">Linux</h4><div class="text">
50 
 
51 
    <p>
52 
      Most Linux distributions will ship packages for APR and OpenSSL. The JNI wrapper (libtcnative) will
53 
      then have to be compiled. It depends on APR, OpenSSL, and the Java headers.
54 
    </p>
55 
 
56 
    <p>
57 
      Requirements:
58 
    </p>
59 
    <ul>
60 
      <li>APR 1.2+ development headers (libapr1-dev package)</li>
61 
      <li>OpenSSL 1.0.2+ development headers (libssl-dev package)</li>
62 
      <li>JNI headers from Java compatible JDK 1.4+</li>
63 
      <li>GNU development environment (gcc, make)</li>
64 
    </ul>
65 
 
66 
    <p>
67 
      The wrapper library sources are located in the Tomcat binary bundle, in the
68 
      <code>bin/tomcat-native.tar.gz</code> archive.
69 
      Once the build environment is installed and the source archive is extracted, the wrapper library
70 
      can be compiled using (from the folder containing the configure script):
71 
    </p>
72 
    <div class="codeBox"><pre><code>./configure &amp;&amp; make &amp;&amp; make install</code></pre></div>
73 
 
74 
    </div></div>
75 
 
76 
  </div><h3 id="APR_Components">APR Components</h3><div class="text">
77 
 
78 
  <p>
79 
    Once the libraries are properly installed and available to Java (if loading fails, the library path
80 
    will be displayed), the Tomcat connectors will automatically use APR. Configuration of the connectors
81 
    is similar to the regular connectors, but have a few extra attributes which are used to configure
82 
    APR components. Note that the defaults should be well tuned for most use cases, and additional
83 
    tweaking shouldn't be required.
84 
  </p>
85 
 
86 
  <p>
87 
    When APR is enabled, the following features are also enabled in Tomcat:
88 
  </p>
89 
  <ul>
90 
    <li>Secure session ID generation by default on all platforms (platforms other than Linux required
91 
        random number generation using a configured entropy)</li>
92 
    <li>OS level statistics on memory usage and CPU usage by the Tomcat process are displayed by
93 
        the status servlet</li>
94 
  </ul>
95 
 
96 
  </div><h3 id="APR_Lifecycle_Listener_Configuration">APR Lifecycle Listener Configuration</h3><div class="text">
97 
    <p>See <a href="config/listeners.html#APR_Lifecycle_Listener_-_org.apache.catalina.core.AprLifecycleListener">the
98 
    listener configuration</a>.</p>
99 
  </div><h3 id="APR_Connectors_Configuration">APR Connectors Configuration</h3><div class="text">
100 
 
101 
    <div class="subsection"><h4 id="HTTP/HTTPS">HTTP/HTTPS</h4><div class="text">
102 
 
103 
      <p>For HTTP configuration, see the <a href="config/http.html">HTTP</a>
104 
      connector configuration documentation.</p>
105 
 
106 
      <p>For HTTPS configuration, see the
107 
      <a href="config/http.html#SSL_Support">HTTPS</a> connector configuration
108 
      documentation.</p>
109 
 
110 
      <p>An example SSL Connector declaration is:</p>
111 
      <div class="codeBox"><pre><code>&lt;Connector port="443" maxHttpHeaderSize="8192"
112 
                 maxThreads="150"
113 
                 enableLookups="false" disableUploadTimeout="true"
114 
                 acceptCount="100" scheme="https" secure="true"
115 
                 SSLEnabled="true"
116 
                 SSLCertificateFile="${catalina.base}/conf/localhost.crt"
117 
                 SSLCertificateKeyFile="${catalina.base}/conf/localhost.key" /&gt;</code></pre></div>
118 
 
119 
 
120 
    </div></div>
121 
 
122 
    <div class="subsection"><h4 id="AJP">AJP</h4><div class="text">
123 
 
124 
      <p>For AJP configuration, see the <a href="config/ajp.html">AJP</a>
125 
      connector configuration documentation.</p>
126 
 
127 
    </div></div>
128 
 
129 
  </div></div></div></div></div><footer><div id="footer">
130 
    Copyright &copy; 1999-2025, The Apache Software Foundation
131 
    <br>
132 
    Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo
133 
    are either registered trademarks or trademarks of the Apache Software
134 
    Foundation.
135 
    </div></footer></div></body></html>