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 Configuration Reference (9.0.112) - The Server Component</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 Configuration Reference</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="index.html">Config Ref. Home</a></li><li><a href="https://cwiki.apache.org/confluence/display/TOMCAT/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul></div><div><h2>Top Level Elements</h2><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul></div><div><h2>Executors</h2><ul><li><a href="executor.html">Executor</a></li></ul></div><div><h2>Connectors</h2><ul><li><a href="http.html">HTTP/1.1</a></li><li><a href="http2.html">HTTP/2</a></li><li><a href="ajp.html">AJP</a></li></ul></div><div><h2>Containers</h2><ul><li><a href="context.html">Context</a></li><li><a href="engine.html">Engine</a></li><li><a href="host.html">Host</a></li><li><a href="cluster.html">Cluster</a></li></ul></div><div><h2>Nested Components</h2><ul><li><a href="cookie-processor.html">CookieProcessor</a></li><li><a href="credentialhandler.html">CredentialHandler</a></li><li><a href="globalresources.html">Global Resources</a></li><li><a href="jar-scanner.html">JarScanner</a></li><li><a href="jar-scan-filter.html">JarScanFilter</a></li><li><a href="listeners.html">Listeners</a></li><li><a href="loader.html">Loader</a></li><li><a href="manager.html">Manager</a></li><li><a href="realm.html">Realm</a></li><li><a href="resources.html">Resources</a></li><li><a href="sessionidgenerator.html">SessionIdGenerator</a></li><li><a href="valve.html">Valve</a></li></ul></div><div><h2>Cluster Elements</h2><ul><li><a href="cluster.html">Cluster</a></li><li><a href="cluster-manager.html">Manager</a></li><li><a href="cluster-channel.html">Channel</a></li><li><a href="cluster-membership.html">Channel/Membership</a></li><li><a href="cluster-sender.html">Channel/Sender</a></li><li><a href="cluster-receiver.html">Channel/Receiver</a></li><li><a href="cluster-interceptor.html">Channel/Interceptor</a></li><li><a href="cluster-valve.html">Valve</a></li><li><a href="cluster-deployer.html">Deployer</a></li><li><a href="cluster-listener.html">ClusterListener</a></li></ul></div><div><h2>web.xml</h2><ul><li><a href="filter.html">Filter</a></li></ul></div><div><h2>Other</h2><ul><li><a href="runtime-attributes.html">Runtime attributes</a></li><li><a href="systemprops.html">System properties</a></li><li><a href="jaspic.html">JASPIC</a></li></ul></div></nav></div></div><div id="mainRight"><div id="content"><h2>The Server Component</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="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#Standard_Implementation">Standard Implementation</a></li></ol></li><li><a href="#Nested_Components">Nested Components</a></li><li><a href="#Special_Features">Special Features</a></li></ul> |
||
| 6 | </div><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 7 | |||
| 8 | <p>A <strong>Server</strong> element represents the entire Catalina |
||
| 9 | servlet container. Therefore, it must be the single outermost element |
||
| 10 | in the <code>conf/server.xml</code> configuration file. Its attributes |
||
| 11 | represent the characteristics of the servlet container as a whole.</p> |
||
| 12 | |||
| 13 | </div><h3 id="Attributes">Attributes</h3><div class="text"> |
||
| 14 | |||
| 15 | <div class="subsection"><h4 id="Common_Attributes">Common Attributes</h4><div class="text"> |
||
| 16 | |||
| 17 | <p>All implementations of <strong>Server</strong> |
||
| 18 | support the following attributes:</p> |
||
| 19 | |||
| 20 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 21 | Attribute |
||
| 22 | </th><th style="width: 85%;"> |
||
| 23 | Description |
||
| 24 | </th></tr><tr id="Attributes_Common Attributes_className"><td><code class="attributeName">className</code></td><td> |
||
| 25 | <p>Java class name of the implementation to use. This class must |
||
| 26 | implement the <code>org.apache.catalina.Server</code> interface. |
||
| 27 | If no class name is specified, the standard implementation will |
||
| 28 | be used.</p> |
||
| 29 | </td></tr><tr id="Attributes_Common Attributes_address"><td><code class="attributeName">address</code></td><td> |
||
| 30 | <p>The TCP/IP address on which this server waits for a shutdown |
||
| 31 | command. If no address is specified, <code>localhost</code> is used.</p> |
||
| 32 | </td></tr><tr id="Attributes_Common Attributes_port"><td><strong><code class="attributeName">port</code></strong></td><td> |
||
| 33 | <p>The TCP/IP port number on which this server waits for a shutdown |
||
| 34 | command. Set to <code>-1</code> to disable the shutdown port.</p> |
||
| 35 | <p>Note: Disabling the shutdown port works well when Tomcat is started |
||
| 36 | using <a href="https://commons.apache.org/daemon/">Apache Commons Daemon</a> |
||
| 37 | (running as a service on Windows or with jsvc on un*xes). It cannot be |
||
| 38 | used when running Tomcat with the standard shell scripts though, as it |
||
| 39 | will prevent shutdown.bat|.sh and catalina.bat|.sh from stopping it |
||
| 40 | gracefully.</p> |
||
| 41 | </td></tr><tr id="Attributes_Common Attributes_portOffset"><td><code class="attributeName">portOffset</code></td><td> |
||
| 42 | <p>The offset to apply to <code>port</code> and to the ports of any |
||
| 43 | nested connectors. It must be a non-negative integer. If not specified, |
||
| 44 | the default value of <code>0</code> is used.</p> |
||
| 45 | </td></tr><tr id="Attributes_Common Attributes_shutdown"><td><strong><code class="attributeName">shutdown</code></strong></td><td> |
||
| 46 | <p>The command string that must be received via a TCP/IP connection |
||
| 47 | to the specified port number, in order to shut down Tomcat.</p> |
||
| 48 | </td></tr><tr id="Attributes_Common Attributes_utilityThreads"><td><code class="attributeName">utilityThreads</code></td><td> |
||
| 49 | <p>The number of threads this <strong>Service</strong> will use for |
||
| 50 | various utility tasks, including recurring ones. The special value |
||
| 51 | of 0 will result in the value of |
||
| 52 | <code>Runtime.getRuntime().availableProcessors()</code> being |
||
| 53 | used. Negative values will result in |
||
| 54 | <code>Runtime.getRuntime().availableProcessors() + value</code> being |
||
| 55 | used unless this is less than 1 in which case 1 thread will be used. |
||
| 56 | The default value is 1. |
||
| 57 | </p> |
||
| 58 | </td></tr></table> |
||
| 59 | |||
| 60 | </div></div> |
||
| 61 | |||
| 62 | <div class="subsection"><h4 id="Standard_Implementation">Standard Implementation</h4><div class="text"> |
||
| 63 | |||
| 64 | <p>The standard implementation of <strong>Server</strong> is |
||
| 65 | <strong>org.apache.catalina.core.StandardServer</strong>. |
||
| 66 | It supports the following additional attributes (in addition to the |
||
| 67 | common attributes listed above):</p> |
||
| 68 | |||
| 69 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 70 | Attribute |
||
| 71 | </th><th style="width: 85%;"> |
||
| 72 | Description |
||
| 73 | </th></tr><tr id="Attributes_Standard Implementation_utilityThreadsAsDaemon"><td><code class="attributeName">utilityThreadsAsDaemon</code></td><td> |
||
| 74 | <p>Set the daemon flag value for the utility threads. The default value |
||
| 75 | is <code>false</code>. |
||
| 76 | </p> |
||
| 77 | </td></tr><tr id="Attributes_Standard Implementation_periodicEventDelay"><td><code class="attributeName">periodicEventDelay</code></td><td> |
||
| 78 | <p>This value represents the delay in seconds between periodic |
||
| 79 | lifecycle event invocation of the lifecycle listeners configured on this |
||
| 80 | Server. The value is in seconds, and a negative or zero value will |
||
| 81 | disable the invocations. If not specified, the default value for this |
||
| 82 | attribute is 10 seconds.</p> |
||
| 83 | </td></tr></table> |
||
| 84 | |||
| 85 | </div></div> |
||
| 86 | |||
| 87 | </div><h3 id="Nested_Components">Nested Components</h3><div class="text"> |
||
| 88 | |||
| 89 | <p>The following components may be nested inside a <strong>Server</strong> |
||
| 90 | element:</p> |
||
| 91 | <ul> |
||
| 92 | <li><a href="service.html"><strong>Service</strong></a> - |
||
| 93 | One or more service element.</li> |
||
| 94 | <li><a href="globalresources.html"><strong>GlobalNamingResources</strong></a> - |
||
| 95 | Configure the JNDI global resources for the server.</li> |
||
| 96 | </ul> |
||
| 97 | |||
| 98 | </div><h3 id="Special_Features">Special Features</h3><div class="text"> |
||
| 99 | |||
| 100 | <p>There are no special features associated with a <strong>Server</strong>. |
||
| 101 | </p> |
||
| 102 | |||
| 103 | </div></div></div></div></div><footer><div id="footer"> |
||
| 104 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 105 | <br> |
||
| 106 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 107 | are either registered trademarks or trademarks of the Apache Software |
||
| 108 | Foundation. |
||
| 109 | </div></footer></div></body></html> |