| Links Top Level Elements Executors Connectors Containers Nested Components Cluster Elements web.xml Other | The ClusterManager object| Introduction |  | 
  A cluster manager is an extension to Tomcat's session manager interface,
  org.apache.catalina.Manager.
  A cluster manager must implement theorg.apache.catalina.ha.ClusterManagerand is solely  responsible
  for how the session is replicated.There are currently two different managers, the
 org.apache.catalina.ha.session.DeltaManagerreplicates deltas of
  session data to all members in the cluster. This implementation is proven and
  works very well, but has a limitation as it requires the cluster members to be
  homogeneous, all nodes must deploy the same applications and be exact
  replicas. Theorg.apache.catalina.ha.session.BackupManageralso
  replicates deltas but only to one backup node. The location of the backup node
  is known to all nodes in the cluster. It also supports heterogeneous
  deployments, so the manager knows at what locations the web application is
  deployed. | 
 | The <Manager> |  | 
  The <Manager>element defined inside the<Cluster>element is the template defined for all web
  applications that are marked<distributable/>in theirweb.xmlfile. However, you can still override the manager
  implementation on a per web application basis, by putting the<Manager>inside the<Context>element
  either in thecontext.xmlfile or theserver.xmlfile. | 
 | Attributes |  | 
  | Common Attributes |  | 
    | Attribute | Description | 
|---|
 | className |  |  | name | The name of this cluster manager, the name is used to identify a
        session manager on a node. The name might get modified by the Clusterelement to make it unique in the container. |  | notifyListenersOnReplication | Set to trueif you wish to have session listeners notified
        when session attributes are being replicated or removed across Tomcat
        nodes in the cluster. |  | expireSessionsOnShutdown | When a web application is being shutdown, Tomcat issues an expire call
        to each session to notify all the listeners. If you wish for all
        sessions to expire on all nodes when a shutdown occurs on one node, set
        this value to true. Default value isfalse. |  | maxInactiveInterval | Deprecated: This should be configured via the
        Context. The initial maximum time interval, in seconds,
        between client requests before a session is invalidated. A negative value
        will result in sessions never timing out. If the attribute is not provided,
        a default of 1800 seconds (30 minutes) is used. This attribute provides the initial value whenever a
        new session is created, but the interval may be dynamically
        varied by a servlet via the
        setMaxInactiveIntervalmethod of theHttpSessionobject. |  | sessionIdLength | The length of session ids created by this Manager, measured in bytes,
        excluding subsequent conversion to a hexadecimal string and
        excluding any JVM route information used for load balancing.
        The default is 16. You should set the length on a nested
        SessionIdGenerator element instead. |  | processExpiresFrequency | Frequency of the session expiration, and related manager operations.
        Manager operations will be done once for the specified amount of
        backgroundProcess calls (i.e., the lower the amount, the more often the
        checks will occur). The minimum value is 1, and the default value is 6.
         |  | secureRandomClass | Name of the Java class that extends
        java.security.SecureRandomto use to generate session IDs.
        If not specified, the default value isjava.security.SecureRandom. |  | secureRandomProvider | Name of the provider to use to create the
        java.security.SecureRandominstances that generate session
        IDs. If an invalid algorithm and/or provider is specified, the Manager
        will use the platform default provider and the default algorithm. If not
        specified, the platform default provider will be used. |  | secureRandomAlgorithm | Name of the algorithm to use to create the
        java.security.SecureRandominstances that generate session
        IDs. If an invalid algorithm and/or provider is specified, the Manager
        will use the platform default provider and the default algorithm. If not
        specified, the default algorithm of SHA1PRNG will be used. If the
        default algorithm is not supported, the platform default will be used.
        To specify that the platform default should be used, do not set the
        secureRandomProvider attribute and set this attribute to the empty
        string. |  | recordAllActions | Flag whether send all actions for session across Tomcat cluster
        nodes. If set to false, if already done something to the same attribute,
        make sure don't send multiple actions across Tomcat cluster nodes.
        In that case, sends only the actions that have been added at last.
        Default is false. | 
 | 
 | org.apache.catalina.ha.session.DeltaManager Attributes |  | 
    | Attribute | Description | 
|---|
 | expireSessionsOnShutdown | When a web application is being shutdown, Tomcat issues an expire call
        to each session to notify all the listeners. If you wish for all
        sessions to expire on all nodes when a shutdown occurs on one node, set
        this value to true.
        Default value isfalse. |  | maxActiveSessions | The maximum number of active sessions that will be created by this
        Manager, or -1 (the default) for no limit. For this manager, all
        sessions are counted as active sessions irrespective if whether or not
        the current node is the primary node for the session. |  | notifySessionListenersOnReplication | Set to trueif you wish to have session listeners notified
        when sessions are created and expired across Tomcat nodes in the
        cluster. |  | notifyContainerListenersOnReplication | Set to trueif you wish to have container listeners notified
        across Tomcat nodes in the cluster. |  | stateTransferTimeout | The time in seconds to wait for a session state transfer to complete
        from another node when a node is starting up.
        Default value is 60seconds. |  | sendAllSessions | Flag whether send sessions as split blocks.
        If set to true, send all sessions as one big block.
        If set tofalse, send sessions as split blocks.
        Default value istrue. |  | sendAllSessionsSize | The number of sessions in a session block message. This value is
        effective only when sendAllSessionsisfalse.
        Default is1000. |  | sendAllSessionsWaitTime | Wait time between sending of session block messages. This value is
        effective only when sendAllSessionsisfalse.
        Default is2000milliseconds. |  | sessionAttributeNameFilter | A regular expression used to filter which session attributes will be
        replicated. An attribute will only be replicated if its name matches
        this pattern. If the pattern is zero length or null, all
        attributes are eligible for replication. The pattern is anchored so the
        session attribute name must fully match the pattern. As an example, the
        value(userName|sessionHistory)will only replicate the
        two session attributes nameduserNameandsessionHistory. If not specified, the default value ofnullwill be used. |  | sessionAttributeValueClassNameFilter | A regular expression used to filter which session attributes will be
        replicated. An attribute will only be replicated if the implementation
        class name of the value matches this pattern. If the pattern is zero
        length or null, all attributes are eligible for
        replication. The pattern is anchored so the fully qualified class name
        must fully match the pattern. If not specified, the default value ofnullwill be used unless aSecurityManageris
        enabled in which case the default will bejava\\.lang\\.(?:Boolean|Integer|Long|Number|String). |  | stateTimestampDrop | When this node sends a GET_ALL_SESSIONSmessage to other
        node, all session messages that are received as a response are queued.
        If this attribute is set totrue, the received session
        messages (except anyGET_ALL_SESSIONSsent by other nodes)
        are filtered by their timestamp. A message is dropped if it is not aGET_ALL_SESSIONSmessage and its timestamp is earlier than
        the timestamp of ourGET_ALL_SESSIONSmessage.
        If set tofalse, all queued session messages are handled.
        Default istrue. |  | warnOnSessionAttributeFilterFailure | If sessionAttributeNameFilter or
        sessionAttributeValueClassNameFilter blocks an
        attribute, should this be logged at WARNlevel? IfWARNlevel logging is disabled then it will be logged atDEBUG. The default value of this attribute isfalseunless aSecurityManageris enabled in
        which case the default will betrue. | 
 | 
 | org.apache.catalina.ha.session.BackupManager Attributes |  | 
    | Attribute | Description | 
|---|
 | mapSendOptions | The backup manager uses a replicated map, this map is sending and
        receiving messages. You can setup the flag for how this map is sending
        messages, the default value is 6(synchronous).Note that if you use asynchronous messaging it is possible for update
        messages for a session to be processed by the receiving node in a
        different order to the order in which they were sent.
 |  | maxActiveSessions | The maximum number of active sessions that will be created by this
        Manager, or -1 (the default) for no limit. For this manager, only
        sessions where the current node is the primary node for the session are
        considered active sessions. |  | rpcTimeout | Timeout for RPC message used for broadcast and transfer state from
        another map.
        Default value is 15000milliseconds. |  | sessionAttributeNameFilter | A regular expression used to filter which session attributes will be
        replicated. An attribute will only be replicated if its name matches
        this pattern. If the pattern is zero length or null, all
        attributes are eligible for replication. The pattern is anchored so the
        session attribute name must fully match the pattern. As an example, the
        value(userName|sessionHistory)will only replicate the
        two session attributes nameduserNameandsessionHistory. If not specified, the default value ofnullwill be used. |  | sessionAttributeValueClassNameFilter | A regular expression used to filter which session attributes will be
        replicated. An attribute will only be replicated if the implementation
        class name of the value matches this pattern. If the pattern is zero
        length or null, all attributes are eligible for
        replication. The pattern is anchored so the fully qualified class name
        must fully match the pattern. If not specified, the default value ofnullwill be used unless aSecurityManageris
        enabled in which case the default will bejava\\.lang\\.(?:Boolean|Integer|Long|Number|String). |  | terminateOnStartFailure | Set to true if you wish to terminate replication map when replication
        map fails to start. If replication map is terminated, associated context
        will fail to start. If you set this attribute to false, replication map
        does not end. It will try to join the map membership in the heartbeat.
        Default value is false. |  | warnOnSessionAttributeFilterFailure | If sessionAttributeNameFilter or
        sessionAttributeValueClassNameFilter blocks an
        attribute, should this be logged at WARNlevel? IfWARNlevel logging is disabled then it will be logged atDEBUG. The default value of this attribute isfalseunless aSecurityManageris enabled in
        which case the default will betrue. |  | accessTimeout | The timeout for a ping message. If a remote map does not respond within
        this timeout period, its regarded as disappeared.
        Default value is 5000milliseconds. | 
 | 
 | 
 | Nested Components |  | 
  All Manager ImplementationsAll Manager implementations allow nesting of a
  <SessionIdGenerator> element. It defines
  the behavior of session id generation.  All implementations
  of the SessionIdGenerator allow the
  following attributes:
   | Attribute | Description | 
|---|
 | sessionIdLength | The length of the session ID may be changed with the
      sessionIdLength attribute.
       | 
 | 
 |