svn commit: r1497091 - in /tomcat/jk/trunk/xdocs: miscellaneous/changelog.xml reference/uriworkermap.xml reference/workers.xml

[rj...@apache.org]

Author: rjung
Date: Wed Jun 26 20:54:26 2013
New Revision: 1497091

URL: http://svn.apache.org/r1497091
Log:
Basic docs for the new cookie generation feature.

Modified:
    tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml
    tomcat/jk/trunk/xdocs/reference/uriworkermap.xml
    tomcat/jk/trunk/xdocs/reference/workers.xml

Modified: tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml
URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml?rev=1497091&r1=1497090&r2=1497091&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml (original)
+++ tomcat/jk/trunk/xdocs/miscellaneous/changelog.xml Wed Jun 26 20:54:26 2013
@@ -56,6 +56,11 @@
         Clean up config file parsing. Worker names are now restricted to
         60 bytes. (rjung)
       </update>
+      <update>
+        Allow to set a stickyness cookie in case a web framework breaks
+        Tomcat's adding of the routing ID to the end of the JSESSIONID
+        cookie. (rjung)
+      </update>
     </changelog>
   </subsection>
 </section>

Modified: tomcat/jk/trunk/xdocs/reference/uriworkermap.xml
URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/uriworkermap.xml?rev=1497091&r1=1497090&r2=1497091&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/uriworkermap.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/uriworkermap.xml Wed Jun 26 20:54:26 2013
@@ -340,12 +340,19 @@ for this status code.
 </source>
 </p>
 </subsection>
-<subsection name="Extensions session_cookie and session_path">
+<subsection name="Extensions controlling load balancer stickyness">
 <br/>
 <p>
-The extensions <code>session_cookie</code> and <code>session_path</code>
-allows to define the load balancer worker attributes of the same name
-per mount.
+The extensions
+<ul>
+<li><code>session_cookie</code></li>
+<li><code>session_path</code></li>
+<li><code>set_session_cookie</code></li>
+<li><code>session_cookie_path</code></li>
+</ul>
+allow to define the load balancer worker attributes of the same name
+per mount. See their descriptions in the
+<a href="../reference/workers.html">worker.properties configuration reference</a>.
 </p>
 </subsection>
 </section>

Modified: tomcat/jk/trunk/xdocs/reference/workers.xml
URL: http://svn.apache.org/viewvc/tomcat/jk/trunk/xdocs/reference/workers.xml?rev=1497091&r1=1497090&r2=1497091&view=diff
==============================================================================
--- tomcat/jk/trunk/xdocs/reference/workers.xml (original)
+++ tomcat/jk/trunk/xdocs/reference/workers.xml Wed Jun 26 20:54:26 2013
@@ -1067,6 +1067,40 @@ This feature has been added in <b>jk 1.2
 </p>
 </directive>
 
+<directive name="set_session_cookie" workers="LB" default="False" required="false">
+Activates generation of session stickyness cookies. Typically you don't need this.
+<p>
+Some web frameworks replace Tomcat session management and use a different way
+of generating session IDs. As a consequence the routing ID added by Tomcat to the
+end of the session ID is lost and we no longer can do sticky load balancing.
+As a workaround you can use the following steps:
+<ul>
+<li>Choose a non-standard cookie name using the "session_cookie" attribute.</li>
+<li>Activate cookie sending by setting the attribute "set_session_cookie" to "True".</li>
+<li>Set the attribute "session_cookie_path" to the correct application URI, like
+e.g. "/myapp/".</li>
+</ul>
+</p>
+<p>
+The cookie will only be send if the request does not already contain
+a cookie of the same name, or that cookie does not contain a routing
+ID which the load balancer can fulfill. Especially after a node failover
+we will send a new cookie to switch stickyness to the new node.
+</p>
+<p>
+This feature has been added in <b>jk 1.2.38</b>.
+</p>
+</directive>
+
+<directive name="session_cookie_path" workers="LB" default="" required="false">
+This attribute is only used if "set_session_cookie" is set to "True".
+See "set_session_cookie" for a description. If the value of "session_cookie_path"
+is empty (default), then the send cookie will not contain a PATH information.
+<p>
+This feature has been added in <b>jk 1.2.38</b>.
+</p>
+</directive>
+
 </advanceddirectives>
 </subsection>
 



---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org