| 1 | <html><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-1"><title>Apache Tomcat Configuration Reference - The Cluster Valve 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><!--LEFT SIDE NAVIGATION--><td nowrap="true" valign="top" width="20%"><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><p><strong>Global Settings</strong></p><ul><li><a href="systemprops.html">System properties</a></li></ul></td><!--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 Cluster Valve object</h2></td><td nowrap="true" valign="top" align="right"><small><a href="printer/cluster-valve.html"><img alt="Printer Friendly Version" border="0" src="../images/printer.gif"><br>print-friendly<br>version |
|---|
| 4 | </a></small></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> |
|---|
| 5 | <p> |
|---|
| 6 | A cluster valve is no different from any other <a href="valve.html">Tomcat <code>Valve</code></a>. |
|---|
| 7 | The cluster valves are interceptors in the invokation chain for HTTP requests, and the clustering implementation |
|---|
| 8 | uses these valves to make intelligent decision around data and when data should be replicated. |
|---|
| 9 | </p> |
|---|
| 10 | <p> |
|---|
| 11 | A cluster valve must implement the <code>org.apache.catalina.ha.ClusterValve</code> interface. |
|---|
| 12 | This is a simple interface that extends the <code>org.apache.catalina.Valve</code> interface. |
|---|
| 13 | </p> |
|---|
| 14 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="org.apache.catalina.ha.tcp.ReplicationValve"><strong>org.apache.catalina.ha.tcp.ReplicationValve</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 15 | The <code>ReplicationValve</code> will notify the cluster at the end of a HTTP request |
|---|
| 16 | so that the cluster can make a decision whether there is data to be replicated or not. |
|---|
| 17 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 18 | <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"> |
|---|
| 19 | Set value to <code>org.apache.catalina.ha.tcp.ReplicationValve</code> |
|---|
| 20 | </td></tr><tr><td valign="center" align="left"><code>filter</code></td><td valign="center" align="left"> |
|---|
| 21 | For known file extensions or urls, you can use a filter to |
|---|
| 22 | notify the cluster that the session has not been modified during this |
|---|
| 23 | request and the cluster doesn't have to probe the session managers for changes. |
|---|
| 24 | If there is a filter match, the cluster assumes there has been no session change. |
|---|
| 25 | An example filter would look like <code>filter=".*\.gif;.*\.js;.*\.jpg;.*\.png;.*\.htm;.*\.html;.*\.css;.*\.txt;"</code> |
|---|
| 26 | The filter uses regular expressions and each filter is delimited by a semi colon. |
|---|
| 27 | <code>Pattern#compile(java.lang.String)</code> |
|---|
| 28 | </td></tr><tr><td valign="center" align="left"><code>primaryIndicator</code></td><td valign="center" align="left"> |
|---|
| 29 | Boolean value, so to true, and the replication valve will insert a request attribute with the name |
|---|
| 30 | defined by the <code>primaryIndicatorName</code> attribute. |
|---|
| 31 | The value inserted into the request attribute is either <code>Boolean.TRUE</code> or |
|---|
| 32 | <code>Boolean.FALSE</code> |
|---|
| 33 | </td></tr><tr><td valign="center" align="left"><code>primaryIndicatorName</code></td><td valign="center" align="left"> |
|---|
| 34 | Default value is <code>org.apache.catalina.ha.tcp.isPrimarySession</code> |
|---|
| 35 | The value defined here is the name of the request attribute that contains the boolean value |
|---|
| 36 | if the session is primary on this server or not. |
|---|
| 37 | </td></tr><tr><td valign="center" align="left"><code>statistics</code></td><td valign="center" align="left"> |
|---|
| 38 | Boolean value. Set to <code>true</code> if you want the valve to collect request statistics. |
|---|
| 39 | Default value is <code>false</code> |
|---|
| 40 | </td></tr></table> |
|---|
| 41 | </blockquote></td></tr></table> |
|---|
| 42 | </blockquote></td></tr></table><table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#525D76"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="org.apache.catalina.ha.session.JvmRouteBinderValve"><strong>org.apache.catalina.ha.session.JvmRouteBinderValve</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 43 | In case of a mod_jk failover, the <code>JvmRouteBinderValve</code> will replace the |
|---|
| 44 | <code>jvmWorker</code> attribute in the session Id, to make future requests stick to this |
|---|
| 45 | node. If you want failback capability, don't enable this valve, but if you want your failover to stick, |
|---|
| 46 | and for mod_jk not to have to keep probing the node that went down, you use this valve. |
|---|
| 47 | <table cellpadding="2" cellspacing="0" border="0"><tr><td bgcolor="#828DA6"><font face="arial,helvetica.sanserif" color="#ffffff"><a name="Attributes"><strong>Attributes</strong></a></font></td></tr><tr><td><blockquote> |
|---|
| 48 | <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"> |
|---|
| 49 | <code>org.apache.catalina.ha.session.JvmRouteBinderValve</code> |
|---|
| 50 | </td></tr><tr><td valign="center" align="left"><code>enabled</code></td><td valign="center" align="left"> |
|---|
| 51 | Default value is <code>true</code> |
|---|
| 52 | Runtime attribute to turn on and off turn over of the session's jvmRoute value. |
|---|
| 53 | </td></tr></table> |
|---|
| 54 | </blockquote></td></tr></table> |
|---|
| 55 | </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> |
|---|
| 56 | Copyright © 1999-2008, Apache Software Foundation |
|---|
| 57 | </em></font></div></td></tr></table></body></html> |
|---|
