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) - Runtime attributes</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>Runtime attributes</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="#Request_attributes">Request attributes</a></li><li><a href="#ServletContext_attributes">ServletContext attributes</a></li></ul> |
||
| 6 | </div><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 7 | <p>The following attributes are made available to web applications at runtime. |
||
| 8 | Many of these attributes provide access to Tomcat internals. Attributes that |
||
| 9 | expose Tomcat internals may be explicitly requested by name but are often |
||
| 10 | deliberately not included when requesting a list of available attributes.</p> |
||
| 11 | </div><h3 id="Request_attributes">Request attributes</h3><div class="text"> |
||
| 12 | <p>Request attributes are made available to web applications via a call to |
||
| 13 | <code>ServletRequest.getAttribute(String)</code>.</p> |
||
| 14 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 15 | Property |
||
| 16 | </th><th style="width: 85%;"> |
||
| 17 | Description |
||
| 18 | </th></tr><tr><td><code class="propertyName">javax.servlet.request.cipher_suite</code></td><td> |
||
| 19 | <p>The Servlet specification defined attribute for the name of the cipher |
||
| 20 | suite being used on an SSL connection.</p> |
||
| 21 | </td></tr><tr><td><code class="propertyName">javax.servlet.request.key_size</code></td><td> |
||
| 22 | <p>The Servlet specification defined attribute for the key size being used |
||
| 23 | on an SSL connection.</p> |
||
| 24 | </td></tr><tr><td><code class="propertyName">javax.servlet.request.secure_protocol</code></td><td> |
||
| 25 | <p>The Servlet specification defined attribute for the name of the |
||
| 26 | security protocol (e.g. TLSv1.3) being used on a secured connection.</p> |
||
| 27 | </td></tr><tr><td><code class="propertyName">javax.servlet.request.ssl_session_id</code></td><td> |
||
| 28 | <p>The Servlet specification defined attribute for the session ID being |
||
| 29 | used for an SSL connection.</p> |
||
| 30 | </td></tr><tr><td><code class="propertyName">javax.servlet.request.ssl_session_mgr</code></td><td> |
||
| 31 | <p>A Tomcat specific extension to the Servlet specification that provides |
||
| 32 | the session manager being used for an SSL connection.</p> |
||
| 33 | </td></tr><tr><td><code class="propertyName">javax.servlet.request.X509Certificate</code></td><td> |
||
| 34 | <p>The Servlet specification defined attribute for the array of |
||
| 35 | X509Certificate objects representing the certificate chain presented by |
||
| 36 | our client, if any.</p> |
||
| 37 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.ASYNC_SUPPORTED</code></td><td> |
||
| 38 | <p>Does the processing chain (Servlet, Filters, Valves) for the current |
||
| 39 | request support asynchronous processing? Each component in the chain must |
||
| 40 | support asynchronous processing for this to be <code>true</code>.</p> |
||
| 41 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.NAMED</code></td><td> |
||
| 42 | <p>The name of the target Servlet for the current named dispatch, if |
||
| 43 | any.</p> |
||
| 44 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.core.DISPATCHER_TYPE</code></td><td> |
||
| 45 | <p>The current <code>jakarta.servlet.DispatcherType</code> for the |
||
| 46 | request.</p> |
||
| 47 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.core.DISPATCHER_REQUEST_PATH</code></td><td> |
||
| 48 | <p>The current path (Servlet Info + Path Info) to which the request has |
||
| 49 | been dispatched.</p> |
||
| 50 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.filters.RemoteIpFilter.secure</code></td><td> |
||
| 51 | <p>The request attribute that is set to the value of |
||
| 52 | <code>Boolean.TRUE</code> if the RemoteIpFilter determines that this |
||
| 53 | request was submitted via a secure channel.</p> |
||
| 54 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.parameter_parse_failed</code></td><td> |
||
| 55 | <p>The request attribute that is set to <code>Boolean.TRUE</code> if some |
||
| 56 | request parameters have been ignored during request parameters parsing. It |
||
| 57 | can happen, for example, if there is a limit on the total count of |
||
| 58 | parseable parameters, or if parameter cannot be decoded, or any other |
||
| 59 | error happened during parameter parsing.</p> |
||
| 60 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.parameter_parse_failed_reason</code></td><td> |
||
| 61 | <p>The reason that the parameter parsing failed.</p> |
||
| 62 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.realm.GSS_CREDENTIAL</code></td><td> |
||
| 63 | <p>The GSS credential for the currently authenticated user if they have |
||
| 64 | successfully authenticated using SPNEGO authentication.</p> |
||
| 65 | </td></tr><tr><td><code class="propertyName">org.apache.coyote.connectionID</code></td><td> |
||
| 66 | <p>The request attribute used to expose the current connection ID |
||
| 67 | associated with the request, if any. Used with multiplexing protocols such |
||
| 68 | as HTTTP/2.</p> |
||
| 69 | </td></tr><tr><td><code class="propertyName">org.apache.coyote.streamID</code></td><td> |
||
| 70 | <p>The request attribute used to expose the current stream ID associated |
||
| 71 | with the request, if any. Used with multiplexing protocols such as |
||
| 72 | HTTTP/2.</p> |
||
| 73 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.peerAddr</code></td><td> |
||
| 74 | <p>The request attribute set by the RemoteIpFilter, RemoteIpValve (and may |
||
| 75 | be set by other similar components) that identifies the connection peer IP |
||
| 76 | address.</p> |
||
| 77 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.remoteAddr</code></td><td> |
||
| 78 | <p>The request attribute set by the RemoteIpFilter, RemoteIpValve (and may |
||
| 79 | be set by other similar components) that identifies for the connector the |
||
| 80 | remote IP address claimed to be associated with this request when a |
||
| 81 | request is received via one or more proxies. It is typically provided via |
||
| 82 | the X-Forwarded-For HTTP header.</p> |
||
| 83 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.request.forwarded</code></td><td> |
||
| 84 | <p>The request attribute that is set to the value of |
||
| 85 | <code>Boolean.TRUE</code> by the RemoteIpFilter, RemoteIpValve (and other |
||
| 86 | similar components) that identifies a request which been forwarded via one |
||
| 87 | or more proxies.</p> |
||
| 88 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.sendfile.end</code></td><td> |
||
| 89 | <p>The request attribute that can be used by a servlet to pass to the |
||
| 90 | connector the end offset (not included) of the part of a file that is to |
||
| 91 | be served by sendfile. The value should be <code>Long</code>. To serve the |
||
| 92 | complete file the value should be equal to the length of the file.</p> |
||
| 93 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.sendfile.filename</code></td><td> |
||
| 94 | <p>The request attribute that can be used by a servlet to pass to the |
||
| 95 | connector the name of the file that is to be served by sendfile. The value |
||
| 96 | should be a <code>String</code> that is the canonical path of the file to |
||
| 97 | be served.</p> |
||
| 98 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.sendfile.start</code></td><td> |
||
| 99 | <p>The request attribute that can be used by a servlet to pass to the |
||
| 100 | connector the start offset of the part of a file that is to be served by |
||
| 101 | sendfile. The value should be a <code>Long</code>. To serve the complete |
||
| 102 | file the value should be <code>Long.valueOf(0)</code>.</p> |
||
| 103 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.sendfile.support</code></td><td> |
||
| 104 | <p>The request attribute that is set to the value of |
||
| 105 | <code>Boolean.TRUE</code> if connector processing this request supports |
||
| 106 | the use of sendfile.</p> |
||
| 107 | </td></tr></table> |
||
| 108 | </div><h3 id="ServletContext_attributes">ServletContext attributes</h3><div class="text"> |
||
| 109 | <p>ServletContext attributes are made available to web applications via a call |
||
| 110 | to <code>ServletContext.getAttribute(String)</code>.</p> |
||
| 111 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 112 | Property |
||
| 113 | </th><th style="width: 85%;"> |
||
| 114 | Description |
||
| 115 | </th></tr><tr><td><code class="propertyName">org.apache.catalina.CredentialHandler</code></td><td> |
||
| 116 | <p>The CredentialHandler (if any) associated with the Realm (if any) |
||
| 117 | that has been explicitly associated with the Context. Realms associated |
||
| 118 | with parent containers (Hosts or Engines) are not considered.</p> |
||
| 119 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.deploy.alt_dd</code></td><td> |
||
| 120 | <p>The alternate deployment descriptor for this web application.</p> |
||
| 121 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.jsp_classpath</code></td><td> |
||
| 122 | <p>The class path for our application class loader (as an object of type |
||
| 123 | String), delimited with the appropriate path delimiter for the |
||
| 124 | platform.</p> |
||
| 125 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.resources</code></td><td> |
||
| 126 | <p>The WebResourceRoot which is associated with the context.</p> |
||
| 127 | </td></tr><tr><td><code class="propertyName">org.apache.catalina.webappVersion</code></td><td> |
||
| 128 | <p>The web application version string (the text that appears after ## |
||
| 129 | when parallel deployment is configured).</p> |
||
| 130 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.InstanceManager</code></td><td> |
||
| 131 | <p>The InstanceManager used to create Servlets, Filters, Listeners etc. |
||
| 132 | for the web application.</p> |
||
| 133 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.JarScanner</code></td><td> |
||
| 134 | <p>The JarScanner instance used to scan the web application for |
||
| 135 | annotations, TLDs, web fragments and similar features.</p> |
||
| 136 | </td></tr><tr><td><code class="propertyName">org.apache.tomcat.util.threads.ScheduledThreadPoolExecutor</code></td><td> |
||
| 137 | <p>The utility executor for this Context.</p> |
||
| 138 | </td></tr></table> |
||
| 139 | </div></div></div></div></div><footer><div id="footer"> |
||
| 140 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 141 | <br> |
||
| 142 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 143 | are either registered trademarks or trademarks of the Apache Software |
||
| 144 | Foundation. |
||
| 145 | </div></footer></div></body></html> |