| [66] | 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The ClusterManager object</title><meta value="Filip Hanik" name="author"><meta value="fhanik@apache.org" name="email"></head><body vlink="#525D76" alink="#525D76" link="#525D76" text="#000000" bgcolor="#ffffff"><table cellspacing="0" width="100%" border="0"><!--PAGE HEADER--><tr><td><!--PROJECT LOGO--><a href="http://tomcat.apache.org/"><img border="0" alt=" | 
|---|
 | 2 |     The Apache Tomcat Servlet/JSP Container | 
|---|
 | 3 |   " align="right" src="../../images/tomcat.gif"></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 border="0" alt="Apache Logo" align="right" src="../../images/asf-logo.gif"></a></td></tr></table><table cellspacing="4" width="100%" border="0"><!--HEADER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><tr><!--RIGHT SIDE MAIN BODY--><td align="left" valign="top" width="80%"><table cellspacing="4" width="100%" border="0"><tr><td valign="top" align="left"><h1>Apache Tomcat Configuration Reference</h1><h2>The ClusterManager object</h2></td><td nowrap="true" valign="top" align="right"><img border="0" hspace="0" vspace="0" height="1" width="1" src="../../images/void.gif"></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Introduction"><strong>Introduction</strong></a></font></td></tr><tr><td><blockquote> | 
|---|
 | 4 |   <p> | 
|---|
 | 5 |   A cluster manager is an extension to Tomcat's session manager interface,  | 
|---|
 | 6 |   <code>org.apache.catalina.Manager</code> | 
|---|
 | 7 |   A cluster manager must implement the <code>org.apache.catalina.ha.ClusterManager</code> and is solely  | 
|---|
 | 8 |   responsible for how the session is replicated.<br> | 
|---|
 | 9 |   There are currently two different managers, the <code>org.apache.catalina.ha.session.DeltaManager</code> replicates deltas  | 
|---|
 | 10 |   of session data to all members in the cluster. This implementation is proven and works very well, but has a limitation | 
|---|
 | 11 |   as it requires the cluster members to be homogeneous, all nodes must deploy the same applications and be exact replicas. | 
|---|
 | 12 |   The <code>org.apache.catalina.ha.session.BackupManager</code> also replicates deltas but only to one backup node. | 
|---|
 | 13 |   The location of the backup node is known to all nodes in the cluster. It also supports heterogeneous deployments, | 
|---|
 | 14 |   so the manager knows at what locations the webapp is deployed.<br> | 
|---|
 | 15 |   We are planning to add more managers with even more sophisticated backup mechanism to support even larger clusters. | 
|---|
 | 16 |   Check back soon!  | 
|---|
 | 17 |   </p> | 
|---|
 | 18 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="The <Manager>"><strong>The <Manager></strong></a></font></td></tr><tr><td><blockquote> | 
|---|
 | 19 |   <p> | 
|---|
 | 20 |    The <code><Manager></code> element defined inside the <code><Cluster></code> element | 
|---|
 | 21 |    is the template defined for all web applications that are marked <code><distributable/></code> | 
|---|
 | 22 |    in their <code>web.xml</code> file.  | 
|---|
 | 23 |    However, you can still override the manager implementation on a per web application basis, | 
|---|
 | 24 |    by putting the <code><Manager></code> inside the <code><Context></code> element either in the  | 
|---|
 | 25 |    <code><a href="context.html">context.xml</a></code> file or the <code><a href="index.html">server.xml</a></code> file. | 
|---|
 | 26 |   </p>  | 
|---|
 | 27 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> | 
|---|
 | 28 |   <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Common Attributes"><strong>Common Attributes</strong></a></font></td></tr><tr><td><blockquote> | 
|---|
 | 29 |     <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><strong><code>className</code></strong></td><td valign="center" align="left"> | 
|---|
 | 30 |      </td></tr><tr><td valign="center" align="left"><code>name</code></td><td valign="center" align="left"> | 
|---|
 | 31 |       <b>The name of this cluster manager, the name is used to identify a session manager on a node. | 
|---|
 | 32 |       The name might get modified by the <code>Cluster</code> element to make it unique in the container.</b> | 
|---|
 | 33 |      </td></tr><tr><td valign="center" align="left"><code>defaultMode</code></td><td valign="center" align="left"> | 
|---|
 | 34 |       <b>Deprecated since 6.0.0</b> | 
|---|
 | 35 |      </td></tr><tr><td valign="center" align="left"><code>notifyListenersOnReplication</code></td><td valign="center" align="left"> | 
|---|
 | 36 |        Set to <code>true</code> if you wish to have session listeners notified when | 
|---|
 | 37 |        session attributes are being replicated or removed across Tomcat nodes in the cluster. | 
|---|
 | 38 |      </td></tr><tr><td valign="center" align="left"><code>expireSessionsOnShutdown</code></td><td valign="center" align="left"> | 
|---|
 | 39 |        When a webapplication is being shutdown, Tomcat issues an expire call to each session to  | 
|---|
 | 40 |        notify all the listeners. If you wish for all sessions to expire on all nodes when | 
|---|
 | 41 |        a shutdown occurs on one node, set this value to <code>true</code>. | 
|---|
 | 42 |        Default value is <code>false</code>. | 
|---|
 | 43 |      </td></tr></table> | 
|---|
 | 44 |   </blockquote></td></tr></table>  | 
|---|
 | 45 |   <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><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> | 
|---|
 | 46 |     <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>domainReplication</code></td><td valign="center" align="left"> | 
|---|
 | 47 |       Set to true if you wish sessions to be replicated only to members that have the same logical | 
|---|
 | 48 |       domain set. If set to false, session replication will ignore the domain setting the  | 
|---|
 | 49 |       <code><a href="cluster-membership.html"><Membership></a></code> | 
|---|
 | 50 |       element. | 
|---|
 | 51 |      </td></tr><tr><td valign="center" align="left"><code>expireSessionsOnShutdown</code></td><td valign="center" align="left"> | 
|---|
 | 52 |        When a webapplication is being shutdown, Tomcat issues an expire call to each session to  | 
|---|
 | 53 |        notify all the listeners. If you wish for all sessions to expire on all nodes when | 
|---|
 | 54 |        a shutdown occurs on one node, set this value to <code>true</code>. | 
|---|
 | 55 |        Default value is <code>false</code>. | 
|---|
 | 56 |      </td></tr><tr><td valign="center" align="left"><code>stateTransferTimeout</code></td><td valign="center" align="left"> | 
|---|
 | 57 |        The time in seconds to wait for a session state transfer to complete from another node | 
|---|
 | 58 |        when a node is starting up. | 
|---|
 | 59 |        Default value is <code>60</code> seconds. | 
|---|
 | 60 |      </td></tr></table> | 
|---|
 | 61 |   </blockquote></td></tr></table> | 
|---|
 | 62 |   <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><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> | 
|---|
 | 63 |     <table cellpadding="5" border="1"><tr><th bgcolor="#023264" width="15%"><font color="#ffffff">Attribute</font></th><th bgcolor="#023264" width="85%"><font color="#ffffff">Description</font></th></tr><tr><td valign="center" align="left"><code>mapSendOptions</code></td><td valign="center" align="left"> | 
|---|
 | 64 |        The backup manager uses a replicated map, this map is sending and receiving messages. | 
|---|
 | 65 |        You can setup the flag for how this map is sending messages, the default value is <code>6</code>(asynchronous). | 
|---|
 | 66 |      </td></tr></table> | 
|---|
 | 67 |   </blockquote></td></tr></table> | 
|---|
 | 68 | </blockquote></td></tr></table></td></tr><!--FOOTER SEPARATOR--><tr><td colspan="2"><hr size="1" noshade></td></tr><!--PAGE FOOTER--><tr><td colspan="2"><div align="center"><font size="-1" color="#525D76"><em> | 
|---|
 | 69 |         Copyright © 1999-2008, Apache Software Foundation | 
|---|
 | 70 |         </em></font></div></td></tr></table></body></html> | 
|---|