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 Channel Interceptor object</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 Channel Interceptor object</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="#Available_Interceptors">Available Interceptors</a></li><li><a href="#Static_Membership">Static Membership</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes">org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes</a></li><li><a href="#org.apache.catalina.tribes.group.interceptors.EncryptInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.EncryptInterceptor Attributes</a></li></ol></li><li><a href="#Nested_Components">Nested Components</a><ol><li><a href="#StaticMember_Attributes">StaticMember Attributes</a></li></ol></li></ul> |
||
| 6 | </div><h3 id="Introduction">Introduction</h3><div class="text"> |
||
| 7 | <p> |
||
| 8 | Apache Tribes supports an interceptor architecture to intercept both messages and membership notifications. |
||
| 9 | This architecture allows decoupling of logic and opens the way for some very useful feature add-ons. |
||
| 10 | </p> |
||
| 11 | </div><h3 id="Available_Interceptors">Available Interceptors</h3><div class="text"> |
||
| 12 | <ul> |
||
| 13 | <li><code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code></li> |
||
| 14 | <li><code>org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor</code></li> |
||
| 15 | <li><code>org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor</code></li> |
||
| 16 | <li><code>org.apache.catalina.tribes.group.interceptors.NonBlockingCoordinator</code></li> |
||
| 17 | <li><code>org.apache.catalina.tribes.group.interceptors.OrderInterceptor</code></li> |
||
| 18 | <li><code>org.apache.catalina.tribes.group.interceptors.SimpleCoordinator</code></li> |
||
| 19 | <li><code>org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor</code></li> |
||
| 20 | <li><code>org.apache.catalina.tribes.group.interceptors.TwoPhaseCommitInterceptor</code></li> |
||
| 21 | <li><code>org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor</code></li> |
||
| 22 | <li><code>org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor</code></li> |
||
| 23 | <li><code>org.apache.catalina.tribes.group.interceptors.GzipInterceptor</code></li> |
||
| 24 | <li><code>org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor</code></li> |
||
| 25 | <li><code>org.apache.catalina.tribes.group.interceptors.EncryptInterceptor</code></li> |
||
| 26 | </ul> |
||
| 27 | </div><h3 id="Static_Membership">Static Membership</h3><div class="text"> |
||
| 28 | <p> |
||
| 29 | In addition to dynamic discovery, Apache Tribes also supports static membership, with membership verification. |
||
| 30 | To achieve this add the <code>org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor</code> |
||
| 31 | after the <code>org.apache.catalina.tribes.group.interceptors.TcpFailureDetector</code> interceptor. |
||
| 32 | Inside the <code>StaticMembershipInterceptor</code> you can add the static members you wish to have. |
||
| 33 | The <code>TcpFailureDetector</code> will do a health check on the static members,and also monitor them for crashes |
||
| 34 | so they will have the same level of notification mechanism as the members that are automatically discovered.</p> |
||
| 35 | <div class="codeBox"><pre><code> <Interceptor className="org.apache.catalina.tribes.group.interceptors.StaticMembershipInterceptor"> |
||
| 36 | <LocalMember className="org.apache.catalina.tribes.membership.StaticMember" |
||
| 37 | domain="staging-cluster" |
||
| 38 | uniqueId="{1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,1}"/> |
||
| 39 | <Member className="org.apache.catalina.tribes.membership.StaticMember" |
||
| 40 | port="5678" |
||
| 41 | securePort="-1" |
||
| 42 | host="tomcat01.mydomain.com" |
||
| 43 | domain="staging-cluster" |
||
| 44 | uniqueId="{0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}"/> |
||
| 45 | </Interceptor></code></pre></div> |
||
| 46 | </div><h3 id="Attributes">Attributes</h3><div class="text"> |
||
| 47 | |||
| 48 | <div class="subsection"><h4 id="Common_Attributes">Common Attributes</h4><div class="text"> |
||
| 49 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 50 | Attribute |
||
| 51 | </th><th style="width: 85%;"> |
||
| 52 | Description |
||
| 53 | </th></tr><tr id="Attributes_Common Attributes_className"><td><strong><code class="attributeName">className</code></strong></td><td> |
||
| 54 | Required, as there is no default |
||
| 55 | </td></tr><tr id="Attributes_Common Attributes_optionFlag"><td><code class="attributeName">optionFlag</code></td><td> |
||
| 56 | If you want the interceptor to trigger on certain message depending on the message's option flag, |
||
| 57 | you can setup the interceptors flag here. |
||
| 58 | The default value is <code>0</code>, meaning this interceptor will trigger on all messages. |
||
| 59 | </td></tr></table> |
||
| 60 | </div></div> |
||
| 61 | |||
| 62 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes</h4><div class="text"> |
||
| 63 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 64 | Attribute |
||
| 65 | </th><th style="width: 85%;"> |
||
| 66 | Description |
||
| 67 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes_domain"><td><strong><code class="attributeName">domain</code></strong></td><td> |
||
| 68 | The logical cluster domain that this Interceptor accepts. |
||
| 69 | Two different type of values are possible:<br> |
||
| 70 | 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes |
||
| 71 | using ISO-8859-1 encoding.<br> |
||
| 72 | 2. byte array in string form, for example {216,123,12,3}<br> |
||
| 73 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.DomainFilterInterceptor Attributes_logInterval"><td><code class="attributeName">logInterval</code></td><td> |
||
| 74 | This value indicates the interval for logging for messages from different domains. |
||
| 75 | The default is 100, which means that to log per 100 messages. |
||
| 76 | </td></tr></table> |
||
| 77 | </div></div> |
||
| 78 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor Attributes</h4><div class="text"> |
||
| 79 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 80 | Attribute |
||
| 81 | </th><th style="width: 85%;"> |
||
| 82 | Description |
||
| 83 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor Attributes_expire"><td><code class="attributeName">expire</code></td><td> |
||
| 84 | How long do we keep the fragments in memory and wait for the rest to arrive. |
||
| 85 | The default is 60000 ms. |
||
| 86 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.FragmentationInterceptor Attributes_maxSize"><td><code class="attributeName">maxSize</code></td><td> |
||
| 87 | The maximum message size in bytes. If the message size exceeds this value, this interceptor fragments the message and sends them. |
||
| 88 | If it is less than this value, this interceptor does not fragment the message and sent in as one message. The default is 1024*100. |
||
| 89 | </td></tr></table> |
||
| 90 | </div></div> |
||
| 91 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes</h4><div class="text"> |
||
| 92 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 93 | Attribute |
||
| 94 | </th><th style="width: 85%;"> |
||
| 95 | Description |
||
| 96 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_optionFlag"><td><code class="attributeName">optionFlag</code></td><td> |
||
| 97 | The default and hard coded value is <code>8 (org.apache.catalina.tribes.Channel.SEND_OPTIONS_ASYNCHRONOUS)</code>. |
||
| 98 | The dispatcher will trigger on this value only, as it is predefined by Tribes. |
||
| 99 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_alwaysSend"><td><code class="attributeName">alwaysSend</code></td><td> |
||
| 100 | What behavior should be executed when the dispatch queue is full. If <code>true</code> (default), then the message is |
||
| 101 | is sent synchronously, if <code>false</code> an error is thrown. |
||
| 102 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_maxQueueSize"><td><code class="attributeName">maxQueueSize</code></td><td> |
||
| 103 | Size in bytes of the dispatch queue, the default value is <code> 1024*1024*64 (64 MiB)</code> sets the maximum queue size for the dispatch queue |
||
| 104 | if the queue fills up, one can trigger the behavior, if <code>alwaysSend</code> is set to true, the message will be sent synchronously |
||
| 105 | if the flag is false, an error is thrown |
||
| 106 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_maxThreads"><td><code class="attributeName">maxThreads</code></td><td> |
||
| 107 | The maximum number of threads in this pool, default is 10. |
||
| 108 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_maxSpareThreads"><td><code class="attributeName">maxSpareThreads</code></td><td> |
||
| 109 | The number of threads to keep in the pool, default is 2. |
||
| 110 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.MessageDispatchInterceptor Attributes_keepAliveTime"><td><code class="attributeName">keepAliveTime</code></td><td> |
||
| 111 | Maximum number of milliseconds of until Idle thread terminates. Default value is 5000(5 seconds). |
||
| 112 | </td></tr></table> |
||
| 113 | </div></div> |
||
| 114 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.TcpFailureDetector_Attributes">org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes</h4><div class="text"> |
||
| 115 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 116 | Attribute |
||
| 117 | </th><th style="width: 85%;"> |
||
| 118 | Description |
||
| 119 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes_connectTimeout"><td><code class="attributeName">connectTimeout</code></td><td> |
||
| 120 | Specifies the timeout, in milliseconds, to use when attempting a TCP connection |
||
| 121 | to the suspect node. Default is 1000. |
||
| 122 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes_performSendTest"><td><code class="attributeName">performSendTest</code></td><td> |
||
| 123 | If true is set, send a test message to the suspect node. Default is true. |
||
| 124 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes_performReadTest"><td><code class="attributeName">performReadTest</code></td><td> |
||
| 125 | If true is set, read the response of the test message that sent. Default is false. |
||
| 126 | <strong>Note:</strong> if <code>performSendTest</code> is false, this attribute will have no effect. |
||
| 127 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes_readTestTimeout"><td><code class="attributeName">readTestTimeout</code></td><td> |
||
| 128 | Specifies the timeout, in milliseconds, to use when performing a read test |
||
| 129 | to the suspicious node. Default is 5000. |
||
| 130 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpFailureDetector Attributes_removeSuspectsTimeout"><td><code class="attributeName">removeSuspectsTimeout</code></td><td> |
||
| 131 | The maximum time(in seconds) for remove from removeSuspects. Member of |
||
| 132 | removeSuspects will be automatically removed after removeSuspectsTimeout. |
||
| 133 | If a negative value specified, the removeSuspects members never be |
||
| 134 | removed until disappeared really. If the attribute is not provided, |
||
| 135 | a default of 300 seconds (5 minutes) is used. |
||
| 136 | </td></tr></table> |
||
| 137 | </div></div> |
||
| 138 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes</h4><div class="text"> |
||
| 139 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 140 | Attribute |
||
| 141 | </th><th style="width: 85%;"> |
||
| 142 | Description |
||
| 143 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes_interval"><td><code class="attributeName">interval</code></td><td> |
||
| 144 | If useThread == true, defines the interval of sending a ping message. |
||
| 145 | default is 1000 ms. |
||
| 146 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.TcpPingInterceptor Attributes_useThread"><td><code class="attributeName">useThread</code></td><td> |
||
| 147 | Flag of whether to start a thread for sending a ping message. |
||
| 148 | If set to true, this interceptor will start a local thread for sending a ping message. |
||
| 149 | if set to false, channel heartbeat will send a ping message. |
||
| 150 | default is false. |
||
| 151 | </td></tr></table> |
||
| 152 | </div></div> |
||
| 153 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes</h4><div class="text"> |
||
| 154 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 155 | Attribute |
||
| 156 | </th><th style="width: 85%;"> |
||
| 157 | Description |
||
| 158 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.ThroughputInterceptor Attributes_interval"><td><code class="attributeName">interval</code></td><td> |
||
| 159 | Defines the interval in number of messages when we are to report the throughput statistics. |
||
| 160 | The report is logged to the <code>org.apache.juli.logging.LogFactory.getLog(ThroughputInterceptor.class)</code> |
||
| 161 | logger under the <code>INFO</code> level. |
||
| 162 | Default value is to report every <code>10000</code> messages. |
||
| 163 | </td></tr></table> |
||
| 164 | </div></div> |
||
| 165 | <div class="subsection"><h4 id="org.apache.catalina.tribes.group.interceptors.EncryptInterceptor_Attributes">org.apache.catalina.tribes.group.interceptors.EncryptInterceptor Attributes</h4><div class="text"> |
||
| 166 | <p> |
||
| 167 | The EncryptInterceptor adds encryption to the channel messages carrying |
||
| 168 | session data between nodes. Added in Tomcat 9.0.13. |
||
| 169 | </p> |
||
| 170 | <p> |
||
| 171 | If using the <code>TcpFailureDetector</code>, the <code>EncryptInterceptor</code> |
||
| 172 | <i>must</i> be inserted into the interceptor chain <i>before</i> the |
||
| 173 | <code>TcpFailureDetector</code>. This is because when validating cluster |
||
| 174 | members, <code>TcpFailureDetector</code> writes channel data directly |
||
| 175 | to the other members without using the remainder of the interceptor chain, |
||
| 176 | but on the receiving side, the message still goes through the chain (in reverse). |
||
| 177 | Because of this asymmetry, the <code>EncryptInterceptor</code> must execute |
||
| 178 | <i>before</i> the <code>TcpFailureDetector</code> on the sender and <i>after</i> |
||
| 179 | it on the receiver, otherwise message corruption will occur. |
||
| 180 | </p> |
||
| 181 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 182 | Attribute |
||
| 183 | </th><th style="width: 85%;"> |
||
| 184 | Description |
||
| 185 | </th></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.EncryptInterceptor Attributes_encryptionAlgorithm"><td><code class="attributeName">encryptionAlgorithm</code></td><td> |
||
| 186 | The encryption algorithm to be used, including the mode and padding. Please see |
||
| 187 | <a href="https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html">https://docs.oracle.com/javase/8/docs/technotes/guides/security/StandardNames.html</a> |
||
| 188 | for the standard JCA names that can be used. |
||
| 189 | |||
| 190 | EncryptInterceptor currently supports the following |
||
| 191 | <a href="https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation">block-cipher modes</a>: |
||
| 192 | CBC, OFB, CFB, and GCM. |
||
| 193 | |||
| 194 | The length of the key will specify the flavor of the encryption algorithm |
||
| 195 | to be used, if applicable (e.g. AES-128 versus AES-256). |
||
| 196 | |||
| 197 | The default algorithm is <code>AES/CBC/PKCS5Padding</code>. |
||
| 198 | </td></tr><tr id="Attributes_org.apache.catalina.tribes.group.interceptors.EncryptInterceptor Attributes_encryptionKey"><td><strong><code class="attributeName">encryptionKey</code></strong></td><td> |
||
| 199 | The key to be used with the encryption algorithm. |
||
| 200 | |||
| 201 | The key should be specified as hex-encoded bytes of the appropriate |
||
| 202 | length for the algorithm (e.g. 16 bytes / 32 characters / 128 bits for |
||
| 203 | AES-128, 32 bytes / 64 characters / 256 bits for AES-256, etc.). |
||
| 204 | </td></tr></table> |
||
| 205 | </div></div> |
||
| 206 | </div><h3 id="Nested_Components">Nested Components</h3><div class="text"> |
||
| 207 | |||
| 208 | <div class="subsection"><h4 id="StaticMember_Attributes">StaticMember Attributes</h4><div class="text"> |
||
| 209 | <p><b>LocalMember:</b> <br> |
||
| 210 | Static member that is the local member of the static cluster group. |
||
| 211 | </p> |
||
| 212 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 213 | Attribute |
||
| 214 | </th><th style="width: 85%;"> |
||
| 215 | Description |
||
| 216 | </th></tr><tr id="Nested Components_StaticMember Attributes_className"><td><strong><code class="attributeName">className</code></strong></td><td> |
||
| 217 | Only one implementation available:<code>org.apache.catalina.tribes.membership.StaticMember</code> |
||
| 218 | </td></tr><tr id="Nested Components_StaticMember Attributes_port"><td><code class="attributeName">port</code></td><td> |
||
| 219 | There is no need to set. |
||
| 220 | The value of this attribute inherits from the cluster receiver setting. |
||
| 221 | </td></tr><tr id="Nested Components_StaticMember Attributes_securePort"><td><code class="attributeName">securePort</code></td><td> |
||
| 222 | There is no need to set. |
||
| 223 | The value of this attribute inherits from the cluster receiver setting. |
||
| 224 | </td></tr><tr id="Nested Components_StaticMember Attributes_host"><td><code class="attributeName">host</code></td><td> |
||
| 225 | There is no need to set. |
||
| 226 | The value of this attribute inherits from the cluster receiver setting. |
||
| 227 | </td></tr><tr id="Nested Components_StaticMember Attributes_domain"><td><code class="attributeName">domain</code></td><td> |
||
| 228 | The logical cluster domain for that this static member listens for cluster messages. |
||
| 229 | Two different type of values are possible:<br> |
||
| 230 | 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes |
||
| 231 | using ISO-8859-1 encoding. |
||
| 232 | 2. byte array in string form, for example {216,123,12,3}<br> |
||
| 233 | </td></tr><tr id="Nested Components_StaticMember Attributes_uniqueId"><td><strong><code class="attributeName">uniqueId</code></strong></td><td> |
||
| 234 | A universally uniqueId for this static member. |
||
| 235 | The values must be 16 bytes in the following form:<br> |
||
| 236 | 1. byte array in string form, for example {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}<br> |
||
| 237 | </td></tr></table> |
||
| 238 | |||
| 239 | <p><b>Member:</b> <br> |
||
| 240 | Static member that add to the static cluster group. |
||
| 241 | </p> |
||
| 242 | <table class="defaultTable"><tr><th style="width: 15%;"> |
||
| 243 | Attribute |
||
| 244 | </th><th style="width: 85%;"> |
||
| 245 | Description |
||
| 246 | </th></tr><tr id="Nested Components_StaticMember Attributes_className"><td><strong><code class="attributeName">className</code></strong></td><td> |
||
| 247 | Only one implementation available:<code>org.apache.catalina.tribes.membership.StaticMember</code> |
||
| 248 | </td></tr><tr id="Nested Components_StaticMember Attributes_port"><td><strong><code class="attributeName">port</code></strong></td><td> |
||
| 249 | The port that this static member listens to for cluster messages |
||
| 250 | </td></tr><tr id="Nested Components_StaticMember Attributes_securePort"><td><code class="attributeName">securePort</code></td><td> |
||
| 251 | The secure port this static member listens to for encrypted cluster messages |
||
| 252 | default value is <code>-1</code>, this value means the member is not listening on a secure port |
||
| 253 | </td></tr><tr id="Nested Components_StaticMember Attributes_host"><td><strong><code class="attributeName">host</code></strong></td><td> |
||
| 254 | The host (or network interface) that this static member listens for cluster messages. |
||
| 255 | Three different type of values are possible:<br> |
||
| 256 | 1. IP address in the form of "216.123.1.23"<br> |
||
| 257 | 2. Hostnames like "tomcat01.mydomain.com" or "tomcat01" as long as they resolve correctly<br> |
||
| 258 | 3. byte array in string form, for example {216,123,12,3}<br> |
||
| 259 | </td></tr><tr id="Nested Components_StaticMember Attributes_domain"><td><code class="attributeName">domain</code></td><td> |
||
| 260 | The logical cluster domain for that this static member listens for cluster messages. |
||
| 261 | Two different type of values are possible:<br> |
||
| 262 | 1. Regular string values like "staging-domain" or "tomcat-cluster" will be converted into bytes |
||
| 263 | using ISO-8859-1 encoding.<br> |
||
| 264 | 2. byte array in string form, for example {216,123,12,3}<br> |
||
| 265 | </td></tr><tr id="Nested Components_StaticMember Attributes_uniqueId"><td><strong><code class="attributeName">uniqueId</code></strong></td><td> |
||
| 266 | A universally uniqueId for this static member. |
||
| 267 | The values must be 16 bytes in the following form:<br> |
||
| 268 | 1. byte array in string form, for example {0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15}<br> |
||
| 269 | </td></tr></table> |
||
| 270 | </div></div> |
||
| 271 | |||
| 272 | |||
| 273 | </div></div></div></div></div><footer><div id="footer"> |
||
| 274 | Copyright © 1999-2025, The Apache Software Foundation |
||
| 275 | <br> |
||
| 276 | Apache Tomcat, Tomcat, Apache, the Apache Tomcat logo and the Apache logo |
||
| 277 | are either registered trademarks or trademarks of the Apache Software |
||
| 278 | Foundation. |
||
| 279 | </div></footer></div></body></html> |