<?xml version="1.0"?>
<!DOCTYPE document [
  <!ENTITY project SYSTEM "project.xml">
]>
<document url="cluster-listener.html">

  &project;

  <properties>
    <author email="fhanik@apache.org">Filip Hanik</author>
    <title>The ClusterListener object</title>
  </properties>

<body>


<section name="Introduction">
  <p>
    The <code>org.apache.catalina.ha.ClusterListener</code> base class 
    lets you listen in on messages that are received by the <code>Cluster</code> component.
  </p>  

</section>
<section name="org.apache.catalina.ha.session.ClusterSessionListener">
  <p>
   When using the DeltaManager, the messages are received by the Cluster object and are propagated to the 
   to the manager through this listener.
   </p>
</section>
<section name="org.apache.catalina.ha.session.JvmRouteSessionIDBinderListener">
  <p>
   Listens for session Id changes. This listener is only used if you are using mod_jk
   along with the <code>jvmRoute</code> attribute where the session Id can change.
   In the event of a change, the <code>JvmRouteBinderValve</code> will broadcast the
   session change and it will get picked up by this listener.
   </p>
</section>

<section name="Attributes">

  <subsection name="Common Attributes">

  <attributes>
 
    <attribute name="className" required="true">

    </attribute>


  </attributes>


  </subsection>


</section>


</body>

</document>
