tomcat-cas/webapps/docs/config/cluster.html - UniIdentify/tomcat - Gitiles

 <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 Configuration Reference (7.0.77) - The Cluster object</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print">
     .noPrint {display: none;}
     td#mainBody {width: 100%;}
 </style><style type="text/css">
 code {background-color:rgb(224,255,255);padding:0 0.1em;}
 code.attributeName, code.propertyName {background-color:transparent;}


 table {
   border-collapse: collapse;
   text-align: left;
 }
 table *:not(table) {
   /* Prevent border-collapsing for table child elements like <div> */
   border-collapse: separate;
 }

 th {
   text-align: left;
 }


 div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
   background-color: transparent;
 }
 div.codeBox {
   overflow: auto;
   margin: 1em 0;
 }
 div.codeBox pre {
   margin: 0;
   padding: 4px;
   border: 1px solid #999;
   border-radius: 5px;
   background-color: #eff8ff;
   display: table; /* To prevent <pre>s from taking the complete available width. */
   /*
   When it is officially supported, use the following CSS instead of display: table
   to prevent big <pre>s from exceeding the browser window:
   max-width: available;
   width: min-content;
   */
 }

 div.codeBox pre.wrap {
   white-space: pre-wrap;
 }


 table.defaultTable tr, table.detail-table tr {
     border: 1px solid #CCC;
 }

 table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
     background-color: #FAFBFF;
 }

 table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
     background-color: #EEEFFF;
 }

 table.defaultTable th, table.detail-table th {
   background-color: #88b;
   color: #fff;
 }

 table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
   padding: 5px 8px;
 }


 p.notice {
     border: 1px solid rgb(255, 0, 0);
     background-color: rgb(238, 238, 238);
     color: rgb(0, 51, 102);
     padding: 0.5em;
     margin: 1em 2em 1em 1em;
 }
 </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="
     The Apache Tomcat Servlet/JSP Container
   " 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 Cluster 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>
 <ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Security">Security</a></li><li><a href="#Engine_vs_Host_placement">Engine vs Host placement</a></li><li><a href="#Context_Attribute_Replication">Context Attribute Replication</a></li><li><a href="#Nested_Components">Nested Components</a></li><li><a href="#Deprecated_configuration_options">Deprecated configuration options</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#SimpleTcpCluster_Attributes">SimpleTcpCluster Attributes</a></li></ol></li></ul>
 </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>
   <p>
   The tomcat cluster implementation provides session replication, context attribute replication and
   cluster wide WAR file deployment.
   While the <code>Cluster</code> configuration is fairly complex, the default configuration will work
   for most people out of the box. </p><p>
   The Tomcat Cluster implementation is very extensible, and hence we have exposed a myriad of options,
   making the configuration seem like a lot, but don't lose faith, instead you have a tremendous control
   over what is going on.</p>
 </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Security"><strong>Security</strong></a></font></td></tr><tr><td><blockquote>

 <p>The cluster implementation is written on the basis that a secure, trusted
 network is used for all of the cluster related network traffic. It is not safe
 to run a cluster on a insecure, untrusted network.</p>

 <p>There are many options for providing a secure, trusted network for use by a
 Tomcat cluster. These include:</p>
 <ul>
   <li>private LAN</li>
   <li>a Virtual Private Network (VPN)</li>
   <li>IPSEC</li>
 </ul>

 </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Engine vs Host placement"><!--()--></a><a name="Engine_vs_Host_placement"><strong>Engine vs Host placement</strong></a></font></td></tr><tr><td><blockquote>
   <p>
    You can place the <code>&lt;Cluster&gt;</code> element inside either the <code>&lt;Engine&gt;</code>
    container or the <code>&lt;Host&gt;</code> container.<br>
    Placing it in the engine, means that you will support clustering in all virtual hosts of Tomcat,
    and share the messaging component. When you place the <code>&lt;Cluster&gt;</code> inside the <code>&lt;Engine&gt;</code>
    element, the cluster will append the host name of each session manager to the managers name so that two contexts with
    the same name but sitting inside two different hosts will be distinguishable.
   </p>
 </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Context Attribute Replication"><!--()--></a><a name="Context_Attribute_Replication"><strong>Context Attribute Replication</strong></a></font></td></tr><tr><td><blockquote>
   <p>To configure context attribute replication, simply do this by swapping out the context implementation
   used for your application context.</p>
   <div class="codeBox"><pre><code>&lt;Context className="org.apache.catalina.ha.context.ReplicatedContext"/&gt;</code></pre></div>
   <p>
     This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>
     so all the options from the <a href="context.html">base implementation</a> are valid.
   </p>
 </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>
   <p><b><a href="cluster-manager.html">Manager</a>:</b> <br>
     The session manager element identifies what kind of session manager is used in this cluster implementation.
     This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested_Components">&lt;Context&gt;</a></code> configuration.
     <br>The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with
     the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>
     are/could be loosely coupled and don't rely on the <code>SimpleTcpCluster</code> for its data replication.
   </p>
   <p><b><a href="cluster-channel.html">Channel</a>:</b> <br>
     The Channel and its sub components are all part of the IO layer
     for the cluster group, and is a module in it's own that we have nick named "Tribes"
     <br>
     Any configuring and tuning of the network layer, the messaging and the membership logic
     will be done in the channel and its nested components.
     You can always find out more about <a href="../tribes/introduction.html">Apache Tribes</a>
   </p>
   <p><b><a href="cluster-valve.html">Valve</a>:</b> <br>
     The Tomcat Cluster implementation uses <code>Tomcat <a href="valve.html">Valves</a></code> to
     track when requests enter and exit the servlet container. It uses these valves to be able to make
     intelligent decisions on when to replicate data, which is always at the end of a request.
   </p>
   <p><b><a href="cluster-deployer.html">Deployer</a>:</b> <br>
     The Deployer component is the Tomcat Farm Deployer. It allows you to deploy and undeploy applications
     cluster wide.
   </p>
   <p><b><a href="cluster-listener.html">ClusterListener</a>:</b> <br>
     ClusterListener's are used to track messages sent and received using the <code>SimpleTcpCluster</code>.
     If you wish to track messages, you can add a listener here, or you can add a valve to the channel object.
   </p>
 </blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deprecated configuration options"><!--()--></a><a name="Deprecated_configuration_options"><strong>Deprecated configuration options</strong></a></font></td></tr><tr><td><blockquote>
   <p>
     <b>Deprecated settings:</b> In the previous version of Tomcat you were able to control session
        manager settings using manager.&lt;property&gt;=value.
        This has been discontinued, as the way it was written interferes with
        the ability to support multiple different manager classes under one cluster implementation,
        as the same properties might have the different effect on different managers.
   </p>
 </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>
   <table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="SimpleTcpCluster Attributes"><!--()--></a><a name="SimpleTcpCluster_Attributes"><strong>SimpleTcpCluster Attributes</strong></a></font></td></tr><tr><td><blockquote>
   <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">
       <p>The main cluster class, currently only one is available,
          <code>org.apache.catalina.ha.tcp.SimpleTcpCluster</code>
       </p>
     </td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">channelSendOptions</code></strong></td><td align="left" valign="center">
       <p>The Tribes channel send options, default is <code>8</code>.<br>
          This option is used to set the flag that all messages sent through the
          SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.</p>

       <div class="codeBox"><pre><code>int options = Channel.SEND_OPTIONS_ASYNCHRONOUS |
               Channel.SEND_OPTIONS_SYNCHRONIZED_ACK |
               Channel.SEND_OPTIONS_USE_ACK;</code></pre></div>
       <p>Some of the values are:<br>
       <code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br>
       <code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br>
       <code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br>
       So to use ACK and ASYNC messaging, the flag would be <code>10</code> (8+2)
       <br>
       Note that if you use ASYNC messaging it is possible for update messages
       for a session to be processed by the receiving nodes in a different order
       to the order in which they were sent.</p>
     </td></tr><tr><td align="left" valign="center"><code class="attributeName">channelStartOptions</code></td><td align="left" valign="center">
       <p>Sets the start and stop flags for the &lt;Channel&gt; object used by the cluster.
          The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as
          sender, receiver, multicast sender and multicast receiver.
          The following flags are available today:</p>
          <div class="codeBox"><pre><code>Channel.DEFAULT = Channel.SND_RX_SEQ (1) |
                   Channel.SND_TX_SEQ (2) |
                   Channel.MBR_RX_SEQ (4) |
                   Channel.MBR_TX_SEQ (8);</code></pre></div>
          <p>To start a channel without multicasting, you would want to use the value <code>Channel.SND_RX_SEQ | Channel.SND_TX_SEQ</code>
          that equals to <code>3</code>.
       </p>
     </td></tr><tr><td align="left" valign="center"><code class="attributeName">heartbeatBackgroundEnabled</code></td><td align="left" valign="center">
       <p>Flag whether invoke channel heartbeat at container background thread. Default value is false.
          Enable this flag don't forget to disable the channel heartbeat thread.
       </p>
     </td></tr><tr><td align="left" valign="center"><code class="attributeName">notifyLifecycleListenerOnFailure</code></td><td align="left" valign="center">
       <p>Flag whether notify LifecycleListeners if all ClusterListener couldn't accept channel message.
          Default value is false.
       </p>
     </td></tr></table>
   </blockquote></td></tr></table>
 </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
               on improving documentation for Apache Tomcat.<br><br>
               If you have trouble and need help, read
               <a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
               and ask your question on the tomcat-users
               <a href="http://tomcat.apache.org/lists.html">mailing list</a>.
               Do not ask such questions here. This is not a Q&amp;A section.<br><br>
               The Apache Comments System is explained <a href="../comments.html">here</a>.
               Comments may be removed by our moderators if they are either
               implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
               var comments_shortname = 'tomcat';
               var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/config/cluster.html';
               (function(w, d) {
                   if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
                       d.write('<div id="comments_thread"><\/div>');
                       var s = d.createElement('script');
                       s.type = 'text/javascript';
                       s.async = true;
                       s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
                       (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
                   }
                   else {
                       d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
                   }
               })(window, document);
               //--><!]]></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>
         Copyright &copy; 1999-2017, Apache Software Foundation
         </em></font></div></td></tr></table></body></html>
	<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat 7 Configuration Reference (7.0.77) - The Cluster object</title><meta name="author" content="Filip Hanik"><style type="text/css" media="print">
	.noPrint {display: none;}
	td#mainBody {width: 100%;}
	</style><style type="text/css">
	code {background-color:rgb(224,255,255);padding:0 0.1em;}
	code.attributeName, code.propertyName {background-color:transparent;}


	table {
	border-collapse: collapse;
	text-align: left;
	}
	table *:not(table) {
	/* Prevent border-collapsing for table child elements like <div> */
	border-collapse: separate;
	}

	th {
	text-align: left;
	}


	div.codeBox pre code, code.attributeName, code.propertyName, code.noHighlight, .noHighlight code {
	background-color: transparent;
	}
	div.codeBox {
	overflow: auto;
	margin: 1em 0;
	}
	div.codeBox pre {
	margin: 0;
	padding: 4px;
	border: 1px solid #999;
	border-radius: 5px;
	background-color: #eff8ff;
	display: table; /* To prevent <pre>s from taking the complete available width. */
	/*
	When it is officially supported, use the following CSS instead of display: table
	to prevent big <pre>s from exceeding the browser window:
	max-width: available;
	width: min-content;
	*/
	}

	div.codeBox pre.wrap {
	white-space: pre-wrap;
	}


	table.defaultTable tr, table.detail-table tr {
	border: 1px solid #CCC;
	}

	table.defaultTable tr:nth-child(even), table.detail-table tr:nth-child(even) {
	background-color: #FAFBFF;
	}

	table.defaultTable tr:nth-child(odd), table.detail-table tr:nth-child(odd) {
	background-color: #EEEFFF;
	}

	table.defaultTable th, table.detail-table th {
	background-color: #88b;
	color: #fff;
	}

	table.defaultTable th, table.defaultTable td, table.detail-table th, table.detail-table td {
	padding: 5px 8px;
	}


	p.notice {
	border: 1px solid rgb(255, 0, 0);
	background-color: rgb(238, 238, 238);
	color: rgb(0, 51, 102);
	padding: 0.5em;
	margin: 1em 2em 1em 1em;
	}
	</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="
	The Apache Tomcat Servlet/JSP Container
	" 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 Cluster 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>
	<ul><li><a href="#Introduction">Introduction</a></li><li><a href="#Security">Security</a></li><li><a href="#Engine_vs_Host_placement">Engine vs Host placement</a></li><li><a href="#Context_Attribute_Replication">Context Attribute Replication</a></li><li><a href="#Nested_Components">Nested Components</a></li><li><a href="#Deprecated_configuration_options">Deprecated configuration options</a></li><li><a href="#Attributes">Attributes</a><ol><li><a href="#SimpleTcpCluster_Attributes">SimpleTcpCluster Attributes</a></li></ol></li></ul>
	</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>
	<p>
	The tomcat cluster implementation provides session replication, context attribute replication and
	cluster wide WAR file deployment.
	While the <code>Cluster</code> configuration is fairly complex, the default configuration will work
	for most people out of the box. </p><p>
	The Tomcat Cluster implementation is very extensible, and hence we have exposed a myriad of options,
	making the configuration seem like a lot, but don't lose faith, instead you have a tremendous control
	over what is going on.</p>
	</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Security"><strong>Security</strong></a></font></td></tr><tr><td><blockquote>

	<p>The cluster implementation is written on the basis that a secure, trusted
	network is used for all of the cluster related network traffic. It is not safe
	to run a cluster on a insecure, untrusted network.</p>

	<p>There are many options for providing a secure, trusted network for use by a
	Tomcat cluster. These include:</p>
	<ul>
	<li>private LAN</li>
	<li>a Virtual Private Network (VPN)</li>
	<li>IPSEC</li>
	</ul>

	</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Engine vs Host placement"><!--()--></a><a name="Engine_vs_Host_placement"><strong>Engine vs Host placement</strong></a></font></td></tr><tr><td><blockquote>
	<p>
	You can place the <code><Cluster></code> element inside either the <code><Engine></code>
	container or the <code><Host></code> container.<br>
	Placing it in the engine, means that you will support clustering in all virtual hosts of Tomcat,
	and share the messaging component. When you place the <code><Cluster></code> inside the <code><Engine></code>
	element, the cluster will append the host name of each session manager to the managers name so that two contexts with
	the same name but sitting inside two different hosts will be distinguishable.
	</p>
	</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Context Attribute Replication"><!--()--></a><a name="Context_Attribute_Replication"><strong>Context Attribute Replication</strong></a></font></td></tr><tr><td><blockquote>
	<p>To configure context attribute replication, simply do this by swapping out the context implementation
	used for your application context.</p>
	<div class="codeBox"><pre><code><Context className="org.apache.catalina.ha.context.ReplicatedContext"/></code></pre></div>
	<p>
	This context extends the Tomcat <code><a href="context.html">StandardContext</a></code>
	so all the options from the <a href="context.html">base implementation</a> are valid.
	</p>
	</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>
	<p><b><a href="cluster-manager.html">Manager</a>:</b> <br>
	The session manager element identifies what kind of session manager is used in this cluster implementation.
	This manager configuration is identical to the one you would use in a regular <code><a href="context.html#Nested_Components"><Context></a></code> configuration.
	<br>The default value is the <code>org.apache.catalina.ha.session.DeltaManager</code> that is closely coupled with
	the <code>SimpleTcpCluster</code> implementation. Other managers like the <code>org.apache.catalina.ha.session.BackupManager</code>
	are/could be loosely coupled and don't rely on the <code>SimpleTcpCluster</code> for its data replication.
	</p>
	<p><b><a href="cluster-channel.html">Channel</a>:</b> <br>
	The Channel and its sub components are all part of the IO layer
	for the cluster group, and is a module in it's own that we have nick named "Tribes"
	<br>
	Any configuring and tuning of the network layer, the messaging and the membership logic
	will be done in the channel and its nested components.
	You can always find out more about <a href="../tribes/introduction.html">Apache Tribes</a>
	</p>
	<p><b><a href="cluster-valve.html">Valve</a>:</b> <br>
	The Tomcat Cluster implementation uses <code>Tomcat <a href="valve.html">Valves</a></code> to
	track when requests enter and exit the servlet container. It uses these valves to be able to make
	intelligent decisions on when to replicate data, which is always at the end of a request.
	</p>
	<p><b><a href="cluster-deployer.html">Deployer</a>:</b> <br>
	The Deployer component is the Tomcat Farm Deployer. It allows you to deploy and undeploy applications
	cluster wide.
	</p>
	<p><b><a href="cluster-listener.html">ClusterListener</a>:</b> <br>
	ClusterListener's are used to track messages sent and received using the <code>SimpleTcpCluster</code>.
	If you wish to track messages, you can add a listener here, or you can add a valve to the channel object.
	</p>
	</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Deprecated configuration options"><!--()--></a><a name="Deprecated_configuration_options"><strong>Deprecated configuration options</strong></a></font></td></tr><tr><td><blockquote>
	<p>
	<b>Deprecated settings:</b> In the previous version of Tomcat you were able to control session
	manager settings using manager.<property>=value.
	This has been discontinued, as the way it was written interferes with
	the ability to support multiple different manager classes under one cluster implementation,
	as the same properties might have the different effect on different managers.
	</p>
	</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>
	<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="SimpleTcpCluster Attributes"><!--()--></a><a name="SimpleTcpCluster_Attributes"><strong>SimpleTcpCluster Attributes</strong></a></font></td></tr><tr><td><blockquote>
	<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">
	<p>The main cluster class, currently only one is available,
	<code>org.apache.catalina.ha.tcp.SimpleTcpCluster</code>
	</p>
	</td></tr><tr><td align="left" valign="center"><strong><code class="attributeName">channelSendOptions</code></strong></td><td align="left" valign="center">
	<p>The Tribes channel send options, default is <code>8</code>.<br>
	This option is used to set the flag that all messages sent through the
	SimpleTcpCluster uses. The flag decides how the messages are sent, and is a simple logical OR.</p>

	<div class="codeBox"><pre><code>int options = Channel.SEND_OPTIONS_ASYNCHRONOUS \|
	Channel.SEND_OPTIONS_SYNCHRONIZED_ACK \|
	Channel.SEND_OPTIONS_USE_ACK;</code></pre></div>
	<p>Some of the values are:<br>
	<code>Channel.SEND_OPTIONS_SYNCHRONIZED_ACK = 0x0004</code><br>
	<code>Channel.SEND_OPTIONS_ASYNCHRONOUS = 0x0008</code><br>
	<code>Channel.SEND_OPTIONS_USE_ACK = 0x0002</code><br>
	So to use ACK and ASYNC messaging, the flag would be <code>10</code> (8+2)
	<br>
	Note that if you use ASYNC messaging it is possible for update messages
	for a session to be processed by the receiving nodes in a different order
	to the order in which they were sent.</p>
	</td></tr><tr><td align="left" valign="center"><code class="attributeName">channelStartOptions</code></td><td align="left" valign="center">
	<p>Sets the start and stop flags for the <Channel> object used by the cluster.
	The default is <code>Channel.DEFAULT</code> which starts all the channel services, such as
	sender, receiver, multicast sender and multicast receiver.
	The following flags are available today:</p>
	<div class="codeBox"><pre><code>Channel.DEFAULT = Channel.SND_RX_SEQ (1) \|
	Channel.SND_TX_SEQ (2) \|
	Channel.MBR_RX_SEQ (4) \|
	Channel.MBR_TX_SEQ (8);</code></pre></div>
	<p>To start a channel without multicasting, you would want to use the value <code>Channel.SND_RX_SEQ \| Channel.SND_TX_SEQ</code>
	that equals to <code>3</code>.
	</p>
	</td></tr><tr><td align="left" valign="center"><code class="attributeName">heartbeatBackgroundEnabled</code></td><td align="left" valign="center">
	<p>Flag whether invoke channel heartbeat at container background thread. Default value is false.
	Enable this flag don't forget to disable the channel heartbeat thread.
	</p>
	</td></tr><tr><td align="left" valign="center"><code class="attributeName">notifyLifecycleListenerOnFailure</code></td><td align="left" valign="center">
	<p>Flag whether notify LifecycleListeners if all ClusterListener couldn't accept channel message.
	Default value is false.
	</p>
	</td></tr></table>
	</blockquote></td></tr></table>
	</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
	on improving documentation for Apache Tomcat.<br><br>
	If you have trouble and need help, read
	<a href="http://tomcat.apache.org/findhelp.html">Find Help</a> page
	and ask your question on the tomcat-users
	<a href="http://tomcat.apache.org/lists.html">mailing list</a>.
	Do not ask such questions here. This is not a Q&A section.<br><br>
	The Apache Comments System is explained <a href="../comments.html">here</a>.
	Comments may be removed by our moderators if they are either
	implemented or considered invalid/off-topic.</p><script type="text/javascript"><!--//--><![CDATA[//><!--
	var comments_shortname = 'tomcat';
	var comments_identifier = 'http://tomcat.apache.org/tomcat-7.0-doc/config/cluster.html';
	(function(w, d) {
	if (w.location.hostname.toLowerCase() == "tomcat.apache.org") {
	d.write('<div id="comments_thread"><\/div>');
	var s = d.createElement('script');
	s.type = 'text/javascript';
	s.async = true;
	s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
	(d.getElementsByTagName('head')[0] \|\| d.getElementsByTagName('body')[0]).appendChild(s);
	}
	else {
	d.write('<div id="comments_thread"><strong>Comments are disabled for this page at the moment.<\/strong><\/div>');
	}
	})(window, document);
	//--><!]]></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>
	Copyright © 1999-2017, Apache Software Foundation
	</em></font></div></td></tr></table></body></html>