107 lines
14 KiB
HTML
107 lines
14 KiB
HTML
|
<html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Cluster object</title><meta name="author" value="Filip Hanik"><meta name="email" value="fhanik@apache.org"></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><font face="arial,helvetica,sanserif"><h1>Apache Tomcat 6.0</h1></font></td><td><!--APACHE LOGO--><a href="http://www.apache.org/"><img src="../images/asf-logo.gif" align="right" alt="Apache Logo" border="0"></a></td></tr></table><table border="0" width="100%" cellspacing="4"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><tr><!--LEFT SIDE NAVIGATION--><td width="20%" valign="top" nowrap="true"><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></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="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="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></td><!--RIGHT SIDE MAIN BODY--><td width="80%" valign="top" align="left"><table border="0" width="100%" cellspacing="4"><tr><td align="left" valign="top"><h1>Apache Tomcat Configuration Reference</h1><h2>The Cluster object</h2></td><td align="right" valign="top" nowrap="true"><small><a href="printer/cluster.html"><img src="../images/printer.gif" border="0" alt="Printer Friendly Version"><br>print-friendly<br>version
|
||
|
|
</a></small></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="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"><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.
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre><Context className="org.apache.catalina.ha.context.ReplicatedContext"/></pre></td><td bgcolor="#023264" width="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
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"><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%20xComponents"><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"><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 interfers 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"><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>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>channelSendOptions</code></strong></td><td align="left" valign="center">
|
||
|
|
<p>The Tribes channel send options, default is 11.<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.<br>
|
||
|
|
|
||
|
|
<div align="left"><table cellspacing="4" cellpadding="0" border="0"><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#ffffff" height="1"><pre>
|
||
|
|
int options= Channel.SEND_OPTIONS_ASYNCHRONOUS |
|
||
|
|
Channel.SEND_OPTIONS_SYNCHRONIZED_ACK |
|
||
|
|
Channel.SEND_OPTIONS_USE_ACK;
|
||
|
|
</pre></td><td bgcolor="#023264" width="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr><tr><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td><td bgcolor="#023264" width="1" height="1"><img src="../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></td></tr></table></div>
|
||
|
|
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 (8+2) or 0x000B</code><br>
|
||
|
|
</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>heartbeatBackgroundEnabled</code></td><td align="left" valign="center">
|
||
|
|
<p>Enable this flag don't forget to disable the channel heartbeat thread.
|
||
|
|
</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>doClusterLog</code></td><td align="left" valign="center">
|
||
|
|
<p><b>Deprecated since 6.0.0</b></p>
|
||
|
|
<p>Possible values are <code>true</code> or <code>false</code><br>
|
||
|
|
Value is inherited from Tomcat 5.5 and has no official meaning.
|
||
|
|
to configure logging, use the standard tomcat logging configuration.
|
||
|
|
</p>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>clusterLogName</code></td><td align="left" valign="center">
|
||
|
|
<p><b>Deprecated since 6.0.0</b></p>
|
||
|
|
<p>
|
||
|
|
Value is inherited from Tomcat 5.5 and has no official meaning.
|
||
|
|
to configure logging, use the standard tomcat logging configuration.
|
||
|
|
</p>
|
||
|
|
</td></tr></table>
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
</blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr noshade="noshade" size="1"></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font color="#525D76" size="-1"><em>
|
||
|
|
Copyright © 1999-2006, Apache Software Foundation
|
||
|
|
</em></font></div></td></tr></table></body></html>
|