From b616eb2bd3bdf2e96444ec2531ad163d5a7b1b16 Mon Sep 17 00:00:00 2001
From: fhanik <fhanik@13f79535-47bb-0310-9956-ffa450edef68>
Date: Mon, 13 Aug 2007 17:04:52 +0000
Subject: [PATCH] Added in backup manager

git-svn-id: https://svn.apache.org/repos/asf/tomcat/trunk@565420 13f79535-47bb-0310-9956-ffa450edef68
---
 .../catalina/ha/session/mbeans-descriptors.xml     | 184 +++++++++++++++++++--
 1 file changed, 173 insertions(+), 11 deletions(-)

diff --git a/java/org/apache/catalina/ha/session/mbeans-descriptors.xml b/java/org/apache/catalina/ha/session/mbeans-descriptors.xml
index 28567f725..e4356f48d 100644
--- a/java/org/apache/catalina/ha/session/mbeans-descriptors.xml
+++ b/java/org/apache/catalina/ha/session/mbeans-descriptors.xml
@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE mbeans-descriptors PUBLIC
-   "-//Apache Software Foundation//DTD Model MBeans Configuration File"
-   "http://jakarta.apache.org/commons/dtds/mbeans-descriptors.dtd">
+"-//Apache Software Foundation//DTD Model MBeans Configuration File"
+"http://jakarta.apache.org/commons/dtds/mbeans-descriptors.dtd">
 <mbeans-descriptors>
   <mbean
     name="JvmRouteBinderValve"
@@ -74,7 +74,7 @@
     <attribute
       name="algorithm"
       description="The message digest algorithm to be used when generating
-                       session identifiers"
+session identifiers"
       type="java.lang.String"/>
     <attribute
       name="randomFile"
@@ -88,23 +88,23 @@
     <attribute
       name="distributable"
       description="The distributable flag for Sessions created by this
-                       Manager"
+Manager"
       type="boolean"/>
     <attribute
       name="entropy"
       description="A String initialization parameter used to increase the
-                       entropy of the initialization of our random number
-                       generator"
+entropy of the initialization of our random number
+generator"
       type="java.lang.String"/>
     <attribute
       name="maxActiveSessions"
       description="The maximum number of active Sessions allowed, or -1
-                       for no limit"
+for no limit"
       type="int"/>
     <attribute
       name="maxInactiveInterval"
       description="The default maximum inactive interval for Sessions
-                       created by this Manager"
+created by this Manager"
       type="int"/>
     <attribute
       name="processExpiresFrequency"
@@ -113,12 +113,12 @@
     <attribute
       name="sessionIdLength"
       description="The session id length (in bytes) of Sessions
-                       created by this Manager"
+created by this Manager"
       type="int"/>
     <attribute
       name="name"
       description="The descriptive name of this Manager implementation
-                       (for logging)"
+(for logging)"
       type="java.lang.String"
       writeable="false"/>
     <attribute
@@ -339,7 +339,7 @@
       impact="ACTION"
       returnType="void">    </operation>
   </mbean>
-<mbean
+  <mbean
     name="SimpleTcpReplicationManager"
     className="org.apache.catalina.mbeans.ClassNameMBean"
     description="Clustered implementation of the Manager interface"
@@ -385,4 +385,166 @@
       type="java.lang.String"
       writeable="false"/>
   </mbean>
+  <mbean
+    name="BackupManager"
+    description="Cluster Manager implementation of the Manager interface"
+    domain="Catalina"
+    group="Manager"
+    type="org.apache.catalina.ha.session.BackupManager">
+    <attribute
+      name="algorithm"
+      description="The message digest algorithm to be used when generating
+session identifiers"
+      type="java.lang.String"/>
+    <attribute
+      name="randomFile"
+      description="File source of random - /dev/urandom or a pipe"
+      type="java.lang.String"/>
+    <attribute
+      name="className"
+      description="Fully qualified class name of the managed object"
+      type="java.lang.String"
+      writeable="false"/>
+    <attribute
+      name="distributable"
+      description="The distributable flag for Sessions created by this
+Manager"
+      type="boolean"/>
+    <attribute
+      name="entropy"
+      description="A String initialization parameter used to increase the
+entropy of the initialization of our random number
+generator"
+      type="java.lang.String"/>
+    <attribute
+      name="maxActiveSessions"
+      description="The maximum number of active Sessions allowed, or -1
+for no limit"
+      type="int"/>
+    <attribute
+      name="maxInactiveInterval"
+      description="The default maximum inactive interval for Sessions
+created by this Manager"
+      type="int"/>
+    <attribute
+      name="processExpiresFrequency"
+      description="The frequency of the manager checks (expiration and passivation)"
+      type="int"/>
+    <attribute
+      name="sessionIdLength"
+      description="The session id length (in bytes) of Sessions
+created by this Manager"
+      type="int"/>
+    <attribute
+      name="name"
+      description="The descriptive name of this Manager implementation
+(for logging)"
+      type="java.lang.String"
+      writeable="false"/>
+    <attribute
+      name="pathname"
+      description="Path name of the disk file in which active sessions"
+      type="java.lang.String"/>
+    <attribute
+      name="activeSessions"
+      description="Number of active primary sessions at this moment"
+      type="int"
+      writeable="false"/>
+    <attribute
+      name="activeSessionsFull"
+      description="Number of active sessions at this moment"
+      type="int"
+      writeable="false"/>
+    <attribute
+      name="sessionCounter"
+      description="Total number of sessions created by this manager"
+      type="int"/>
+    <attribute
+      name="maxActive"
+      description="Maximum number of active sessions so far"
+      type="int"/>
+    <attribute
+      name="sessionMaxAliveTime"
+      description="Longest time an expired session had been alive"
+      type="int"/>
+    <attribute
+      name="sessionAverageAliveTime"
+      description="Average time an expired session had been alive"
+      type="int"/>
+    <attribute
+      name="rejectedSessions"
+      description="Number of sessions we rejected due to maxActive beeing reached"
+      type="int"/>
+    <attribute
+      name="expiredSessions"
+      description="Number of sessions that expired ( doesn't include explicit invalidations )"
+      type="int"/>
+    <attribute
+      name="processingTime"
+      description="Time spent doing housekeeping and expiration"
+      type="long"/>
+    <attribute
+      name="duplicates"
+      description="Number of duplicated session ids generated"
+      type="int"/>
+    <attribute
+      name="expireSessionsOnShutdown"
+      is="true"
+      description="exipre all sessions cluster wide as one node goes down"
+      type="boolean"/>
+    <attribute
+      name="notifyListenersOnReplication"
+      is="true"
+      description="Send session attribute change events on backup nodes"
+      type="boolean"/>
+    <attribute
+      name="mapSendOptions"
+      description="mapSendOptions"
+      type="int"
+      writeable="false"/>
+    <operation
+      name="listSessionIds"
+      description="Return the list of active primary session ids"
+      impact="ACTION"
+      returnType="java.lang.String">    </operation>
+    <operation
+      name="listSessionIdsFull"
+      description="Return the list of active session ids"
+      impact="ACTION"
+      returnType="java.lang.String">    </operation>
+    <operation
+      name="getSessionAttribute"
+      description="Return a session attribute"
+      impact="ACTION"
+      returnType="java.lang.String">
+      <parameter
+        name="sessionId"
+        description="Id of the session"
+        type="java.lang.String"/>
+      <parameter
+        name="key"
+        description="key of the attribute"
+        type="java.lang.String"/>
+    </operation>
+    <operation
+      name="expireSession"
+      description="Expire a session"
+      impact="ACTION"
+      returnType="void">
+      <parameter
+        name="sessionId"
+        description="Id of the session"
+        type="java.lang.String"/>
+    </operation>
+    <operation
+      name="getLastAccessedTime"
+      description="Get the last access time"
+      impact="ACTION"
+      returnType="java.lang.String">
+      <parameter
+        name="sessionId"
+        description="Id of the session"
+        type="java.lang.String"/>
+    </operation>
+  </mbean>
 </mbeans-descriptors>
-- 
2.11.0