56 lines
6.9 KiB
HTML
56 lines
6.9 KiB
HTML
|
<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 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><!--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 Valve object</h2></td><td align="right" valign="top" nowrap="true"><img src="../../images/void.gif" width="1" height="1" vspace="0" hspace="0" border="0"></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>
|
||
|
|
A cluster valve is no different from any other <a href="valve.html">Tomcat <code>Valve</code></a>.
|
||
|
|
The cluster valves are interceptors in the invokation chain for HTTP requests, and the clustering implementation
|
||
|
|
uses these valves to make intelligent decision around data and when data should be replicated.
|
||
|
|
</p>
|
||
|
|
<p>
|
||
|
|
A cluster valve must implement the <code>org.apache.catalina.ha.ClusterValve</code> interface.
|
||
|
|
This is a simple interface that extends the <code>org.apache.catalina.Valve</code> interface.
|
||
|
|
</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="org.apache.catalina.ha.tcp.ReplicationValve"><strong>org.apache.catalina.ha.tcp.ReplicationValve</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
The <code>ReplicationValve</code> will notify the cluster at the end of a HTTP request
|
||
|
|
so that the cluster can make a decision whether there is data to be replicated or not.
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Attributes"><strong>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">
|
||
|
|
Set value to <code>org.apache.catalina.ha.tcp.ReplicationValve</code>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>filter</code></td><td align="left" valign="center">
|
||
|
|
For known file extensions or urls, you can use a filter to
|
||
|
|
notify the cluster that the session has not been modified during this
|
||
|
|
request and the cluster doesn't have to probe the session managers for changes.
|
||
|
|
If there is a filter match, the cluster assumes there has been no session change.
|
||
|
|
An example filter would look like <code>filter=".*\.gif;.*\.js;.*\.jpg;.*\.png;.*\.htm;.*\.html;.*\.css;.*\.txt;"</code>
|
||
|
|
The filter uses regular expressions and each filter is delimited by a semi colon.
|
||
|
|
<code>Pattern#compile(java.lang.String)</code>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>primaryIndicator</code></td><td align="left" valign="center">
|
||
|
|
Boolean value, so to true, and the replication valve will insert a request attribute with the name
|
||
|
|
defined by the <code>primaryIndicatorName</code> attribute.
|
||
|
|
The value inserted into the request attribute is either <code>Boolean.TRUE</code> or
|
||
|
|
<code>Boolean.FALSE</code>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>primaryIndicatorName</code></td><td align="left" valign="center">
|
||
|
|
Default value is <code>org.apache.catalina.ha.tcp.isPrimarySession</code>
|
||
|
|
The value defined here is the name of the request attribute that contains the boolean value
|
||
|
|
if the session is primary on this server or not.
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>statistics</code></td><td align="left" valign="center">
|
||
|
|
Boolean value. Set to <code>true</code> if you want the valve to collect request statistics.
|
||
|
|
Default value is <code>false</code>
|
||
|
|
</td></tr></table>
|
||
|
|
</blockquote></td></tr></table>
|
||
|
|
</blockquote></td></tr></table><table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#525D76"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="org.apache.catalina.ha.session.JvmRouteBinderValve"><strong>org.apache.catalina.ha.session.JvmRouteBinderValve</strong></a></font></td></tr><tr><td><blockquote>
|
||
|
|
In case of a mod_jk failover, the <code>JvmRouteBinderValve</code> will replace the
|
||
|
|
<code>jvmWorker</code> attribute in the session Id, to make future requests stick to this
|
||
|
|
node. If you want failback capability, don't enable this valve, but if you want your failover to stick,
|
||
|
|
and for mod_jk not to have to keep probing the node that went down, you use this valve.
|
||
|
|
<table border="0" cellspacing="0" cellpadding="2"><tr><td bgcolor="#828DA6"><font color="#ffffff" face="arial,helvetica.sanserif"><a name="Attributes"><strong>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">
|
||
|
|
<code>org.apache.catalina.ha.session.JvmRouteBinderValve</code>
|
||
|
|
</td></tr><tr><td align="left" valign="center"><code>enabled</code></td><td align="left" valign="center">
|
||
|
|
Default value is <code>true</code>
|
||
|
|
Runtime attribute to turn on and off turn over of the session's jvmRoute value.
|
||
|
|
</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>
|