amyroh 2003/02/03 15:03:55
Modified: webapps/tomcat-docs index.xml project.xml
Added: webapps/tomcat-docs mbeans-descriptor-howto.xml
Log:
Add mbeans-descriptor-howto documentation. The question comes up
often on tomcat-user and tomcat-dev. It is currently documented in server.xml
as comment. However, it disappears when you use the admin tool and press
"Save Changes". We can just point to this page if the question arises from
now on.
Revision Changes Path
1.19 +2 -1 jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml
Index: index.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/index.xml,v
retrieving revision 1.18
retrieving revision 1.19
diff -u -r1.18 -r1.19
--- index.xml 12 Jan 2003 17:26:46 -0000 1.18
+++ index.xml 3 Feb 2003 23:03:55 -0000 1.19
@@ -89,6 +89,8 @@
<li><a href="manager-howto.html"><strong>Manager App HOW-TO</strong></a> -
Operating the <code>Manager</code> web app to deploy, undeploy, and
redeploy applications while Tomcat is running.</li>
+<li><a href="mbeans-descriptor-howto.html"><strong>MBean Descriptor
HOW-TO</strong></a> -
+ Configuring MBean descriptors files for custom components.</li>
<li><a href="proxy-howto.html"><strong>Proxy Support HOW-TO</strong></a> -
Configuring Tomcat 4 to run behind a proxy server (or a web server
functioning as a proxy server).</li>
@@ -167,4 +169,3 @@
</body>
</document>
-
1.20 +2 -0 jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml
Index: project.xml
===================================================================
RCS file: /home/cvs/jakarta-tomcat-4.0/webapps/tomcat-docs/project.xml,v
retrieving revision 1.19
retrieving revision 1.20
diff -u -r1.19 -r1.20
--- project.xml 10 Jan 2003 15:52:19 -0000 1.19
+++ project.xml 3 Feb 2003 23:03:55 -0000 1.20
@@ -37,6 +37,8 @@
<item name="JNDI Resources HOW-TO" href="jndi-resources-howto.html"/>
<item name="JSP Engine Config HOW-TO" href="jasper-howto.html"/>
<item name="Manager App HOW-TO" href="manager-howto.html"/>
+ <item name="MBean Descriptor HOW-TO"
+ href="mbeans-descriptor-howto.html"/>
<item name="Proxy Support HOW-TO" href="proxy-howto.html"/>
<item name="Realm HOW-TO" href="realm-howto.html"/>
<item name="Security Mgr. HOW-TO" href="security-manager-howto.html"/>
1.1
jakarta-tomcat-4.0/webapps/tomcat-docs/mbeans-descriptor-howto.xml
Index: mbeans-descriptor-howto.xml
===================================================================
<?xml version="1.0"?>
<!DOCTYPE document [
<!ENTITY project SYSTEM "project.xml">
]>
<document url="mbean-descriptor-howto.html">
&project;
<properties>
<author email="[EMAIL PROTECTED]">Amy Roh</author>
<title>MBean Descriptor How To</title>
</properties>
<body>
<section name="Introduction">
<p>Tomcat 4 uses JMX MBeans as the technology for implementing
manageability of Tomcat.</p>
<p>The descriptions of JMX MBeans for Catalina are in the
org.apache.catalina.mbeans.mbeans-descriptor.xml file.</p>
<p>You will need to add MBean descriptions for your custom components
in order to avoid a "ManagedBean is not found" exception.</p>
</section>
<section name="Including your own mbean-descriptor files">
<p>You may configure custom components (e.g. Valves/Realms) by including
your own mbean-descriptor file(s), and setting the "descriptors"
attribute to point to a ';' separated list of paths (in the ClassLoader sense)
of files to add to the default list under ServerLifecycleListener definition
in server.xml.</p>
<source>
<Listener className="org.apache.catalina.mbeans.ServerLifecycleListener"
debug="0"
descriptors="/com/myfirm/mypackage/mbean-descriptor.xml"/>
</source>
</section>
<section name="Adding MBean description to Catalina's mbean-descriptors.xml">
<p>You may also add MBean descriptions for custom components in
org.apache.catalina.mbeans.mbeans-descriptor.xml file.</p>
<source>
<mbean name="LDAPRealm"
className="org.apache.catalina.mbeans.ClassNameMBean"
description="Custom LDAPRealm"
domain="Catalina"
group="Realm"
type="com.myfirm.mypackage.LDAPRealm">
<attribute name="className"
description="Fully qualified class name of the managed object"
type="java.lang.String"
writeable="false"/>
<attribute name="debug"
description="The debugging detail level for this component"
type="int"/>
.
.
.
</mbean>
</source>
</section>
</body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
