| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 Configuration Reference (7.0.77) - The ClusterManager object</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print">
|
| 2 | .noPrint {display: none;}
|
| 3 | td#mainBody {width: 100%;}
|
| 4 | </style><style type="text/css">
|
| 5 | code {background-color:rgb(224,255,255);padding:0 0.1em;}
|
| 6 | code.attributeName, code.propertyName {background-color:transparent;}
|
| 7 |
|
| 8 |
|
| 9 | table {
|
| 10 | border-collapse: collapse;
|
| 11 | text-align: left;
|
| 12 | }
|
| 13 | table *:not(table) {
|
| 14 | /* Prevent border-collapsing for table child elements like <div> */
|
| 15 | border-collapse: separate;
|
| 16 | }
|
| 17 |
|
| 18 | th {
|
| 19 | text-align: left;
|
| 20 | }
|
| 21 |
|
| 22 |
|
| 23 | div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
|
| 24 | background-color: transparent;
|
| 25 | }
|
| 26 | div.codeBox {
|
| 27 | overflow: auto;
|
| 28 | margin: 1em 0;
|
| 29 | }
|
| 30 | div.codeBox pre {
|
| 31 | margin: 0;
|
| 32 | padding: 4px;
|
| 33 | border: 1px solid #999;
|
| 34 | border-radius: 5px;
|
| 35 | background-color: #eff8ff;
|
| 36 | display: table; /* To prevent <pre>s from taking the complete available width. */
|
| 37 | /*
|
| 38 | When it is officially supported, use the following CSS instead of display: table
|
| 39 | to prevent big <pre>s from exceeding the browser window:
|
| 40 | max-width: available;
|
| 41 | width: min-content;
|
| 42 | */
|
| 43 | }
|
| 44 |
|
| 45 | div.codeBox pre.wrap {
|
| 46 | white-space: pre-wrap;
|
| 47 | }
|
| 48 |
|
| 49 |
|
| 50 | table.defaultTable tr, table.detail-table tr {
|
| 51 | border: 1px solid #CCC;
|
| 52 | }
|
| 53 |
|
| 54 | table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
|
| 55 | background-color: #FAFBFF;
|
| 56 | }
|
| 57 |
|
| 58 | table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
|
| 59 | background-color: #EEEFFF;
|
| 60 | }
|
| 61 |
|
| 62 | table.defaultTable th, table.detail-table th {
|
| 63 | background-color: #88b;
|
| 64 | color: #fff;
|
| 65 | }
|
| 66 |
|
| 67 | table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
|
| 68 | padding: 5px 8px;
|
| 69 | }
|
| 70 |
|
| 71 |
|
| 72 | p.notice {
|
| 73 | border: 1px solid rgb(255, 0, 0);
|
| 74 | background-color: rgb(238, 238, 238);
|
| 75 | color: rgb(0, 51, 102);
|
| 76 | padding: 0.5em;
|
| 77 | margin: 1em 2em 1em 1em;
|
| 78 | }
|
| 79 | </style></head><body bgcolor="#ffffff" text="#000000" link="#525D76" alink="#525D76" vlink="#525D76"><table border="0" width="100%" cellspacing="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img src="../images/tomcat.gif" align="right" alt="
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 80 | The Apache Tomcat Servlet/JSP Container
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 81 | " border="0"></a></td><td><h1><font face="arial,helvetica,sanserif">Apache Tomcat 7</font></h1><font face="arial,helvetica,sanserif">Version 7.0.77, Mar 28 2017</font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.svg" align="right" alt="Apache Logo" border="0" style="width: 266px;height: 83px;"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap class="noPrint"><p><strong>Links</strong></p><ul><li><a href="../index.html">Docs Home</a></li><li><a href="index.html">Config Ref. Home</a></li><li><a href="http://wiki.apache.org/tomcat/FAQ">FAQ</a></li><li><a href="#comments_section">User Comments</a></li></ul><p><strong>Top Level Elements</strong></p><ul><li><a href="server.html">Server</a></li><li><a href="service.html">Service</a></li></ul><p><strong>Executors</strong></p><ul><li><a href="executor.html">Executor</a></li></ul><p><strong>Connectors</strong></p><ul><li><a href="http.html">HTTP</a></li><li><a href="ajp.html">AJP</a></li></ul><p><strong>Containers</strong></p><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><p><strong>Nested Components</strong></p><ul><li><a href="globalresources.html">Global Resources</a></li><li><a href="jar-scanner.html">JarScanner</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><p><strong>Cluster Elements</strong></p><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><p><strong>web.xml</strong></p><ul><li><a href="filter.html">Filter</a></li></ul><p><strong>Other</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left" id="mainBody"><h1>The ClusterManager object</h1><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Table of Contents"><!--()--></a><a name="Table_of_Contents"><strong>Table of Contents</strong></a></font></td></tr><tr><td><blockquote>
|
| 82 | <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#The_<Manager>">The <Manager></a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#Common_Attributes">Common Attributes</a></li><li><a href="#org.apache.catalina.ha.session.DeltaManager_Attributes">org.apache.catalina.ha.session.DeltaManager Attributes</a></li><li><a href="#org.apache.catalina.ha.session.BackupManager_Attributes">org.apache.catalina.ha.session.BackupManager Attributes</a></li></ol></li><li><a href="#Nested_Components">Nested Components</a></li></ul>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 83 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 84 | <p>A cluster manager is an extension to Tomcat's session manager interface,
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 85 | <code>org.apache.catalina.Manager</code>.
|
| 86 | A cluster manager must implement the
|
| 87 | <code>org.apache.catalina.ha.ClusterManager</code> and is solely responsible
|
| 88 | for how the session is replicated.<br>
|
| 89 | There are currently two different managers, the
|
| 90 | <code>org.apache.catalina.ha.session.DeltaManager</code> replicates deltas of
|
| 91 | session data to all members in the cluster. This implementation is proven and
|
| 92 | works very well, but has a limitation as it requires the cluster members to be
|
| 93 | homogeneous, all nodes must deploy the same applications and be exact
|
| 94 | replicas. The <code>org.apache.catalina.ha.session.BackupManager</code> also
|
| 95 | replicates deltas but only to one backup node. The location of the backup node
|
| 96 | is known to all nodes in the cluster. It also supports heterogeneous
|
| 97 | deployments, so the manager knows at what locations the web application is
|
| 98 | deployed.</p>
|
| 99 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="The <Manager>"><!--()--></a><a name="The_<Manager>"><strong>The <Manager></strong></a></font></td></tr><tr><td><blockquote>
|
| 100 | <p>The <code><Manager></code> element defined inside the
|
| 101 | <code><Cluster></code> element is the template defined for all web
|
| 102 | applications that are marked <code><distributable/></code> in their
|
| 103 | <code>web.xml</code> file. However, you can still override the manager
|
| 104 | implementation on a per web application basis, by putting the
|
| 105 | <code><Manager></code> inside the <code><Context></code> element
|
| 106 | either in the <code><a href="context.html">context.xml</a></code> file or the
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 107 | <code><a href="index.html">server.xml</a></code> file.</p>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 108 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
| 109 | <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Common Attributes"><!--()--></a><a name="Common_Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 110 | <table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><strong><code class="attributeName">className</code></strong></td><td align="left" valign="center">
|
| 111 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">name</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 112 | <b>The name of this cluster manager, the name is used to identify a
|
| 113 | session manager on a node. The name might get modified by the
|
| 114 | <code>Cluster</code> element to make it unique in the container.</b>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 115 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">notifyListenersOnReplication</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 116 | Set to <code>true</code> if you wish to have session listeners notified
|
| 117 | when session attributes are being replicated or removed across Tomcat
|
| 118 | nodes in the cluster.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 119 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">expireSessionsOnShutdown</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 120 | When a web application is being shutdown, Tomcat issues an expire call
|
| 121 | to each session to notify all the listeners. If you wish for all
|
| 122 | sessions to expire on all nodes when a shutdown occurs on one node, set
|
| 123 | this value to <code>true</code>. Default value is <code>false</code>.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 124 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxInactiveInterval</code></td><td align="left" valign="center">
|
| 125 | <p><strong>Deprecated</strong>: This should be configured via the
|
| 126 | Context.</p>
|
| 127 | <p>The initial maximum time interval, in seconds,
|
| 128 | between client requests before a session is invalidated. A negative value
|
| 129 | will result in sessions never timing out. If the attribute is not provided,
|
| 130 | a default of 1800 seconds (30 minutes) is used.</p>
|
| 131 | <p>This attribute provides the initial value whenever a
|
| 132 | new session is created, but the interval may be dynamically
|
| 133 | varied by a servlet via the
|
| 134 | <code>setMaxInactiveInterval</code> method of the <code>HttpSession</code> object.</p>
|
| 135 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sessionIdLength</code></td><td align="left" valign="center">
|
| 136 | <p>The length of session ids created by this Manager, measured in bytes,
|
| 137 | excluding subsequent conversion to a hexadecimal string and
|
| 138 | excluding any JVM route information used for load balancing.
|
| 139 | The default is 16. You should set the length on a nested
|
| 140 | <strong>SessionIdGenerator</strong> element instead.</p>
|
| 141 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">processExpiresFrequency</code></td><td align="left" valign="center">
|
| 142 | <p>Frequency of the session expiration, and related manager operations.
|
| 143 | Manager operations will be done once for the specified amount of
|
| 144 | backgroundProcess calls (i.e., the lower the amount, the more often the
|
| 145 | checks will occur). The minimum value is 1, and the default value is 6.
|
| 146 | </p>
|
| 147 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">secureRandomClass</code></td><td align="left" valign="center">
|
| 148 | <p>Name of the Java class that extends
|
| 149 | <code>java.security.SecureRandom</code> to use to generate session IDs.
|
| 150 | If not specified, the default value is
|
| 151 | <code>java.security.SecureRandom</code>.</p>
|
| 152 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">secureRandomProvider</code></td><td align="left" valign="center">
|
| 153 | <p>Name of the provider to use to create the
|
| 154 | <code>java.security.SecureRandom</code> instances that generate session
|
| 155 | IDs. If an invalid algorithm and/or provider is specified, the Manager
|
| 156 | will use the platform default provider and the default algorithm. If not
|
| 157 | specified, the platform default provider will be used.</p>
|
| 158 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">secureRandomAlgorithm</code></td><td align="left" valign="center">
|
| 159 | <p>Name of the algorithm to use to create the
|
| 160 | <code>java.security.SecureRandom</code> instances that generate session
|
| 161 | IDs. If an invalid algorithm and/or provider is specified, the Manager
|
| 162 | will use the platform default provider and the default algorithm. If not
|
| 163 | specified, the default algorithm of SHA1PRNG will be used. If the
|
| 164 | default algorithm is not supported, the platform default will be used.
|
| 165 | To specify that the platform default should be used, do not set the
|
| 166 | secureRandomProvider attribute and set this attribute to the empty
|
| 167 | string.</p>
|
| 168 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">recordAllActions</code></td><td align="left" valign="center">
|
| 169 | <p>Flag whether send all actions for session across Tomcat cluster
|
| 170 | nodes. If set to false, if already done something to the same attribute,
|
| 171 | make sure don't send multiple actions across Tomcat cluster nodes.
|
| 172 | In that case, sends only the actions that have been added at last.
|
| 173 | Default is <code>false</code>.</p>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 174 | </td></tr></table>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 175 | </blockquote></td></tr></table>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 176 | <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.ha.session.DeltaManager Attributes"><!--()--></a><a name="org.apache.catalina.ha.session.DeltaManager_Attributes"><strong>org.apache.catalina.ha.session.DeltaManager Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 177 | <table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code class="attributeName">expireSessionsOnShutdown</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 178 | When a web application is being shutdown, Tomcat issues an expire call
|
| 179 | to each session to notify all the listeners. If you wish for all
|
| 180 | sessions to expire on all nodes when a shutdown occurs on one node, set
|
| 181 | this value to <code>true</code>.
|
| 182 | Default value is <code>false</code>.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 183 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxActiveSessions</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 184 | The maximum number of active sessions that will be created by this
|
| 185 | Manager, or -1 (the default) for no limit. For this manager, all
|
| 186 | sessions are counted as active sessions irrespective if whether or not
|
| 187 | the current node is the primary node for the session.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 188 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">notifySessionListenersOnReplication</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 189 | Set to <code>true</code> if you wish to have session listeners notified
|
| 190 | when sessions are created and expired across Tomcat nodes in the
|
| 191 | cluster.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 192 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">notifyContainerListenersOnReplication</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 193 | Set to <code>true</code> if you wish to have container listeners notified
|
| 194 | across Tomcat nodes in the cluster.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 195 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">stateTransferTimeout</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 196 | The time in seconds to wait for a session state transfer to complete
|
| 197 | from another node when a node is starting up.
|
| 198 | Default value is <code>60</code> seconds.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 199 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sendAllSessions</code></td><td align="left" valign="center">
|
| 200 | Flag whether send sessions as split blocks.
|
| 201 | If set to <code>true</code>, send all sessions as one big block.
|
| 202 | If set to <code>false</code>, send sessions as split blocks.
|
| 203 | Default value is <code>true</code>.
|
| 204 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sendAllSessionsSize</code></td><td align="left" valign="center">
|
| 205 | The number of sessions in a session block message. This value is
|
| 206 | effective only when <code>sendAllSessions</code> is <code>false</code>.
|
| 207 | Default is <code>1000</code>.
|
| 208 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sendAllSessionsWaitTime</code></td><td align="left" valign="center">
|
| 209 | Wait time between sending of session block messages. This value is
|
| 210 | effective only when <code>sendAllSessions</code> is <code>false</code>.
|
| 211 | Default is <code>2000</code> milliseconds.
|
| 212 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sessionAttributeNameFilter</code></td><td align="left" valign="center">
|
| 213 | <p>A regular expression used to filter which session attributes will be
|
| 214 | replicated. An attribute will only be replicated if its name matches
|
| 215 | this pattern. If the pattern is zero length or <code>null</code>, all
|
| 216 | attributes are eligible for replication. The pattern is anchored so the
|
| 217 | session attribute name must fully match the pattern. As an example, the
|
| 218 | value <code>(userName|sessionHistory)</code> will only replicate the
|
| 219 | two session attributes named <code>userName</code> and
|
| 220 | <code>sessionHistory</code>. If not specified, the default value of
|
| 221 | <code>null</code> will be used.</p>
|
| 222 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sessionAttributeValueClassNameFilter</code></td><td align="left" valign="center">
|
| 223 | <p>A regular expression used to filter which session attributes will be
|
| 224 | replicated. An attribute will only be replicated if the implementation
|
| 225 | class name of the value matches this pattern. If the pattern is zero
|
| 226 | length or <code>null</code>, all attributes are eligible for
|
| 227 | replication. The pattern is anchored so the fully qualified class name
|
| 228 | must fully match the pattern. If not specified, the default value of
|
| 229 | <code>null</code> will be used unless a <code>SecurityManager</code> is
|
| 230 | enabled in which case the default will be
|
| 231 | <code>java\\.lang\\.(?:Boolean|Integer|Long|Number|String)</code>.</p>
|
| 232 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">stateTimestampDrop</code></td><td align="left" valign="center">
|
| 233 | When this node sends a <code>GET_ALL_SESSIONS</code> message to other
|
| 234 | node, all session messages that are received as a response are queued.
|
| 235 | If this attribute is set to <code>true</code>, the received session
|
| 236 | messages (except any <code>GET_ALL_SESSIONS</code> sent by other nodes)
|
| 237 | are filtered by their timestamp. A message is dropped if it is not a
|
| 238 | <code>GET_ALL_SESSIONS</code> message and its timestamp is earlier than
|
| 239 | the timestamp of our <code>GET_ALL_SESSIONS</code> message.
|
| 240 | If set to <code>false</code>, all queued session messages are handled.
|
| 241 | Default is <code>true</code>.
|
| 242 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">warnOnSessionAttributeFilterFailure</code></td><td align="left" valign="center">
|
| 243 | <p>If <strong>sessionAttributeNameFilter</strong> or
|
| 244 | <strong>sessionAttributeValueClassNameFilter</strong> blocks an
|
| 245 | attribute, should this be logged at <code>WARN</code> level? If
|
| 246 | <code>WARN</code> level logging is disabled then it will be logged at
|
| 247 | <code>DEBUG</code>. The default value of this attribute is
|
| 248 | <code>false</code> unless a <code>SecurityManager</code> is enabled in
|
| 249 | which case the default will be <code>true</code>.</p>
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 250 | </td></tr></table>
|
| 251 | </blockquote></td></tr></table>
|
| 252 | <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.ha.session.BackupManager Attributes"><!--()--></a><a name="org.apache.catalina.ha.session.BackupManager_Attributes"><strong>org.apache.catalina.ha.session.BackupManager Attributes</strong></a></font></td></tr><tr><td><blockquote>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 253 | <table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code class="attributeName">mapSendOptions</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 254 | The backup manager uses a replicated map, this map is sending and
|
| 255 | receiving messages. You can setup the flag for how this map is sending
|
| 256 | messages, the default value is <code>6</code>(synchronous).<br>
|
| 257 | Note that if you use asynchronous messaging it is possible for update
|
| 258 | messages for a session to be processed by the receiving node in a
|
| 259 | different order to the order in which they were sent.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 260 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">maxActiveSessions</code></td><td align="left" valign="center">
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 261 | The maximum number of active sessions that will be created by this
|
| 262 | Manager, or -1 (the default) for no limit. For this manager, only
|
| 263 | sessions where the current node is the primary node for the session are
|
| 264 | considered active sessions.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 265 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">rpcTimeout</code></td><td align="left" valign="center">
|
| 266 | Timeout for RPC message used for broadcast and transfer state from
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 267 | another map.
|
| 268 | Default value is <code>15000</code> milliseconds.
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 269 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sessionAttributeNameFilter</code></td><td align="left" valign="center">
|
| 270 | <p>A regular expression used to filter which session attributes will be
|
| 271 | replicated. An attribute will only be replicated if its name matches
|
| 272 | this pattern. If the pattern is zero length or <code>null</code>, all
|
| 273 | attributes are eligible for replication. The pattern is anchored so the
|
| 274 | session attribute name must fully match the pattern. As an example, the
|
| 275 | value <code>(userName|sessionHistory)</code> will only replicate the
|
| 276 | two session attributes named <code>userName</code> and
|
| 277 | <code>sessionHistory</code>. If not specified, the default value of
|
| 278 | <code>null</code> will be used.</p>
|
| 279 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">sessionAttributeValueClassNameFilter</code></td><td align="left" valign="center">
|
| 280 | <p>A regular expression used to filter which session attributes will be
|
| 281 | replicated. An attribute will only be replicated if the implementation
|
| 282 | class name of the value matches this pattern. If the pattern is zero
|
| 283 | length or <code>null</code>, all attributes are eligible for
|
| 284 | replication. The pattern is anchored so the fully qualified class name
|
| 285 | must fully match the pattern. If not specified, the default value of
|
| 286 | <code>null</code> will be used unless a <code>SecurityManager</code> is
|
| 287 | enabled in which case the default will be
|
| 288 | <code>java\\.lang\\.(?:Boolean|Integer|Long|Number|String)</code>.</p>
|
| 289 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">terminateOnStartFailure</code></td><td align="left" valign="center">
|
| 290 | Set to true if you wish to terminate replication map when replication
|
| 291 | map fails to start. If replication map is terminated, associated context
|
| 292 | will fail to start. If you set this attribute to false, replication map
|
| 293 | does not end. It will try to join the map membership in the heartbeat.
|
| 294 | Default value is <code>false</code> .
|
| 295 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">warnOnSessionAttributeFilterFailure</code></td><td align="left" valign="center">
|
| 296 | <p>If <strong>sessionAttributeNameFilter</strong> or
|
| 297 | <strong>sessionAttributeValueClassNameFilter</strong> blocks an
|
| 298 | attribute, should this be logged at <code>WARN</code> level? If
|
| 299 | <code>WARN</code> level logging is disabled then it will be logged at
|
| 300 | <code>DEBUG</code>. The default value of this attribute is
|
| 301 | <code>false</code> unless a <code>SecurityManager</code> is enabled in
|
| 302 | which case the default will be <code>true</code>.</p>
|
| 303 | </td></tr><tr><td align="left" valign="center"><code class="attributeName">accessTimeout</code></td><td align="left" valign="center">
|
| 304 | The timeout for a ping message. If a remote map does not respond within
|
| 305 | this timeout period, its regarded as disappeared.
|
| 306 | Default value is <code>5000</code> milliseconds.
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 307 | </td></tr></table>
|
| 308 | </blockquote></td></tr></table>
|
| 刘洪青 | 6266f99 | 2017-05-15 21:21:03 +0800 | [diff] [blame^] | 309 | </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Nested Components"><!--()--></a><a name="Nested_Components"><strong>Nested Components</strong></a></font></td></tr><tr><td><blockquote>
|
| 310 | <h3>All Manager Implementations</h3>
|
| 311 | <p>All Manager implementations allow nesting of a
|
| 312 | <strong><SessionIdGenerator></strong> element. It defines
|
| 313 | the behavior of session id generation. All implementations
|
| 314 | of the <a href="sessionidgenerator.html">SessionIdGenerator</a> allow the
|
| 315 | following attributes:
|
| 316 | </p>
|
| 317 | <table border="1" cellpadding="5"><tr><th width="15%" bgcolor="#023264"><font color="#ffffff">Attribute</font></th><th width="85%" bgcolor="#023264"><font color="#ffffff">Description</font></th></tr><tr><td align="left" valign="center"><code class="attributeName">sessionIdLength</code></td><td align="left" valign="center">
|
| 318 | <p>The length of the session ID may be changed with the
|
| 319 | <strong>sessionIdLength</strong> attribute.
|
| 320 | </p>
|
| 321 | </td></tr></table>
|
| 322 | </blockquote></td></tr></table></td></tr><tr class="noPrint"><td width="20%" valign="top" nowrap class="noPrint"></td><td width="80%" valign="top" align="left"><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="comments_section" id="comments_section"><strong>Comments</strong></a></font></td></tr><tr><td><blockquote><p class="notice"><strong>Notice: </strong>This comments section collects your suggestions
|
| 323 | on improving documentation for Apache Tomcat.<br><br>
|
| 324 | If you have trouble and need help, read
|
| 325 | <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
|
| 326 | and ask your question on the tomcat-users
|
| 327 | <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
|
| 328 | Do not ask such questions here. This is not a Q&A section.<br><br>
|
| 329 | The Apache Comments System is explained <a href="../comments.html">here</a>.
|
| 330 | Comments may be removed by our moderators if they are either
|
| 331 | implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
|
| 332 | var comments_shortname = 'tomcat';
|
| 333 | var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/config/cluster-manager.html';
|
| 334 | (function(w, d) {
|
| 335 | if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
|
| 336 | d.write('<div id="comments_thread"><\/div>');
|
| 337 | var s = d.createElement('script');
|
| 338 | s.type = 'text/javascript';
|
| 339 | s.async = true;
|
| 340 | s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
|
| 341 | (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
| 342 | }
|
| 343 | else {
|
| 344 | d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
|
| 345 | }
|
| 346 | })(window, document);
|
| 347 | //--><!]]></script></blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
| 348 | Copyright © 1999-2017, Apache Software Foundation
|
| Hongqing Liu | fd5ee81 | 2014-05-10 16:32:51 +0800 | [diff] [blame] | 349 | </em></font></div></td></tr></table></body></html> |