Thread: [Ejtools-cvs] applications/jmx.browser/xdocs manual.xml,NONE,1.1 faq.xml,1.2,1.3

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

Update of /cvsroot/ejtools/applications/jmx.browser/xdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv11709/jmx.browser/xdocs

Modified Files:
	faq.xml 
Added Files:
	manual.xml 
Log Message:
Add more javadocs.
Adjust some things.


--- NEW FILE: manual.xml ---
<?xml version="1.0"?>
<!--
# ================================================================================
# EJTools, the Enterprise Java Tools
# 
# Distributable under LGPL license.
# See terms of license at gnu.org.
#
# $Revision: 1.1 $
# ================================================================================
-->
<document>
    <properties>
        <title>JMX Browser</title>
    </properties>
    <body>
        <section name="Manuals">
            <p>The EJTools JMX Browser manual is available under three forms :<ul>
                    <li>A large HTML file : browse <a href="manual/large.html">here</a>
                    </li>
                    <li>Chuncked HTML files : browse <a href="manual/index.html">here</a>
                    </li>
                    <li>PDF document : download <a href="manual/large.html">here</a>
                    </li>
                </ul>
            </p>
        </section>
    </body>
</document>

Index: faq.xml
===================================================================
RCS file: /cvsroot/ejtools/applications/jmx.browser/xdocs/faq.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** faq.xml	3 May 2003 21:05:20 -0000	1.2
--- faq.xml	13 Dec 2003 22:15:08 -0000	1.3
***************
*** 1,140 ****
! <?xml version="1.0"?>
! <!--
! # ================================================================================
! # EJTools, the Enterprise Java Tools
! # 
! # Distributable under LGPL license.
! # See terms of license at gnu.org.
! #
! # $Revision$
! # ================================================================================
! -->
! <document>
!    <properties>
!       <title>JMX Browser</title>
!    </properties>
!    <body>
!       <section name="JMX Browser FAQs">
!          <faqs>
!             <faq-section name="General">
!                <entry type="question">What is JMX ?</entry>
!                <entry type="answer">
!                   <p>JMX is for Java Management eXtension. It is an API dedicated to the management of server and can be connected in different ways through some adapters (SNMP for example). For more information, go <a href="http://java.sun.com/products/JavaManagement/index.html">here</a>.</p>
!                </entry>
!                <entry type="question">What can I do with this browser ?</entry>
!                <entry type="answer">
!                   <p>This tool allows the developper and the administrator of a J2EE Server to control the J2EE Server via the JMX API.</p>
!                </entry>
!                <entry type="question">How do I use it ?</entry>
!                <entry type="answer">
!                   <p>If you want to use the Web-based version, deploy it into a J2EE Server. It must be a J2EE 1.3 compliant Application Server and must provide a JMX server inside it. See application servers FAQ for more details.</p>
!                   <p>If you want to use the Swing-based version, the JMX implementation you want to connect must has a way to access it remotely (RMI, IIOP, etc). See applications servers/JMX implementations FAQ for more details.</p>
!                </entry>
!             </faq-section>
!             <!-- ======================================== -->
!             <!-- Web based Browser -->
!             <!-- ======================================== -->
!             <faq-section name="Web Based JMX Browser on...">
!                <entry type="question">JBoss Server 3.x</entry>
!                <entry type="answer">
!                   <p>It is pretty simple : put the jmx.browser.war file into the deploy directory. That's it.</p>
!                   <p>If you want to use the Custom Views features, simply put the jmx.browser.sar file and your *.jmxml files into the deploy directory. That's it.</p>
!                </entry>
!                <entry type="question">Apache Tomcat 4.1.x</entry>
!                <entry type="answer">
!                   <p>There are two ways to do under Tomcat :</p>
!                   <ol>
!                      <li>Put the jmx.browser.war file under the webapps directory of the Tomcat installation. Move the mx4j-jmx.jar file from the server/lib directory to the common/lib directory. This will make the JMX classes visible from a standard Web application.</li>
!                      <li>Unwar the jmx.browser.war file under the server/webapps directory of the Tomcat installation. Create a privileged xml file under the webapps directory like the admin.xml one or the manager.xml one. The browser will run as a privileged Web application</li>
!                   </ol>
!                </entry>
!                <entry type="question">WebLogic Server 7.0</entry>
!                <entry type="answer">
!                   <p>Well, this server has not been tested, but feedback is welcomed.</p>
!                </entry>
!                <entry type="question">Another application server</entry>
!                <entry type="answer">
!                   <p>Well, <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feeback</a> is welcomed if you don't see your favorite server here.</p>
!                </entry>
!             </faq-section>
!             <faq-section name="Web Based JMX Browser : issues">
!                <entry type="question">Why do I see sometimes in MBean detail "unloadable class" ?</entry>
!                <entry type="answer">
!                   <p>That's mean the class returned by the MBean information cannot be loaded by the browser. As the browser runs on the server it is mostly due to misspelling in the class name.</p>
!                </entry>
!             </faq-section>
!             <!-- ======================================== -->
!             <!-- Swing based Browser -->
!             <!-- ======================================== -->
!             <faq-section name="Swing Based JMX Browser with...">
!                <entry type="question">JBoss Server 3.x</entry>
!                <entry type="answer">
!                   <p>Make sure the RMI adaptor is deployed into the JBoss server (jmx-rmi-adaptor.sar into the deploy directory).</p>
!                   <p>Copy the jbossall-client.jar (from JBOSS_HOME/client) and the jboss-jmx.jar (from JBOSS_HOME/lib) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                   <p>If you are using a JDK1.3, copy the jnet.jar, jcert.jar and jsse.jar (from JBOSS_HOME/client) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">WebLogic Server 7.0</entry>
!                <entry type="answer">
!                   <p>This server has not been fully tested. The main issue is about notification reception : the  JMX Browser doesn't implements a WebLogic interface needed to receive the notifications.</p>
!                   <p>If you want to use it, copy the weblogic.jar (from BEA_HOME/weblogic700/server/lib) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">MX4J 1.1.1</entry>
!                <entry type="answer">
!                   <p>There are two ways to connect to a MX4J implementation :</p>
!                   <ol>
!                      <li>With the JRMP connector (see <a href="http://mx4j.sourceforge.net/docs/bk01ch03s16.html">here</a> for more details about the setup of the mx4j implementation)</li>
!                      <li>With the IIOP connector (see <a href="http://mx4j.sourceforge.net/docs/bk01ch03s16.html">here</a> for more details about the setup of the mx4j implementation)</li>
!                   </ol>
!                   <p>Copy the mx4j-jmx.jar and mx4j-tools.jar (from MX4J distribution) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">Pramati Server 3.0</entry>
!                <entry type="answer">
!                   <p>This server has not been fully tested, and was put in stand by for license reasons.</p>
!                </entry>
!                <entry type="question">Tivoli TMX4J 2.1</entry>
!                <entry type="answer">
!                   <p>This implementation has not been fully tested, and was put in stand by for license reasons.</p>
!                </entry>
!                <entry type="question">Sun JDMK 1.1</entry>
!                <entry type="answer">
!                   <p>Well, this implementation has not been tested, but feedback is welcomed.</p>
!                </entry>
!                <entry type="question">Another application server or JMX implementation.</entry>
!                <entry type="answer">
!                   <p>Well, <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feeback</a> is welcomed if you don't see your favorite server or your favorite JMX implementation here.</p>
!                </entry>
!             </faq-section>
!             <faq-section name="Swing Based JMX Browser : issues">
!                <entry type="question">When a MBean is unregistered, it doesn't disappear from the tree view ?</entry>
!                <entry type="answer">
!                   <p>You have to refresh the server view to make it disappears.</p>
!                </entry>
!                <entry type="question">What are the date format supported ?</entry>
!                <entry type="answer">
!                   <p>There are five formats supported :</p>
!                   <ul>
!                      <li>"yyyy-MM-dd HH:mm:ss z"</li>
!                      <li>"yyyy-MM-dd HH:mm:ss"</li>
!                      <li>"yyyy-MM-dd HH:mm"</li>
!                      <li>"yyMMdd HH:mm:ss"</li>
!                      <li>"yyMMdd HH:mm"</li>
!                   </ul>
!                   <p>If you need more formats, just fill a <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feature request</a>.</p>
!                </entry>
!                <entry type="question">How do I create an empty graph window ?</entry>
!                <entry type="answer">
!                   <p>You can't create an empty graph window. A window is created when you want to graph a numerical value.</p>
!                </entry>
!                <entry type="question">Can I plot numerical values from different servers in the same graph window ?</entry>
!                <entry type="answer">
!                   <p>Yes, it's possible. The graph window doesn't know about one or several servers. The fact is that the JMX connection name does'nt appear in the numerical value plotted, so if you have two numerical values from two different server with the same name, you won't see any difference except the color.</p>
!                </entry>
!                <entry type="question">How is choosed the color for a plotted numerical value ?</entry>
!                <entry type="answer">
!                   <p>It is a simple color rotation. If you think it must be enhanced, post a <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feature request</a>.</p>
!                </entry>
!             </faq-section>
!          </faqs>
!       </section>
!    </body>
! </document>
--- 1,140 ----
! <?xml version="1.0"?>
! <!--
! # ================================================================================
! # EJTools, the Enterprise Java Tools
! # 
! # Distributable under LGPL license.
! # See terms of license at gnu.org.
! #
! # $Revision$
! # ================================================================================
! -->
! <document>
!    <properties>
!       <title>JMX Browser</title>
!    </properties>
!    <body>
!       <section name="JMX Browser FAQs">
!          <faqs>
!             <faq-section name="General">
!                <entry type="question">What is JMX ?</entry>
!                <entry type="answer">
!                   <p>JMX is for Java Management eXtension. It is an API dedicated to the management of server and can be connected in different ways through some adapters (SNMP for example). For more information, go <a href="http://java.sun.com/products/JavaManagement/index.html">here</a>.</p>
!                </entry>
!                <entry type="question">What can I do with this browser ?</entry>
!                <entry type="answer">
!                   <p>This tool allows the developper and the administrator of a J2EE Server to control the J2EE Server via the JMX API.</p>
!                </entry>
!                <entry type="question">How do I use it ?</entry>
!                <entry type="answer">
!                   <p>If you want to use the Web-based version, deploy it into a J2EE Server. It must be a J2EE 1.3 compliant Application Server and must provide a JMX server inside it. See application servers FAQ for more details.</p>
!                   <p>If you want to use the Swing-based version, the JMX implementation you want to connect must has a way to access it remotely (RMI, IIOP, etc). See applications servers/JMX implementations FAQ for more details.</p>
!                </entry>
!             </faq-section>
!             <!-- ======================================== -->
!             <!-- Web based Browser -->
!             <!-- ======================================== -->
!             <faq-section name="Web Based JMX Browser on...">
!                <entry type="question">JBoss Server 3.x</entry>
!                <entry type="answer">
!                   <p>It is pretty simple : put the jmx.browser.war file into the deploy directory. That's it.</p>
!                   <p>If you want to use the Custom Views features, simply put the jmx.browser.sar file and your *.jmxml files into the deploy directory. That's it.</p>
!                </entry>
!                <entry type="question">Apache Tomcat 4.1.x</entry>
!                <entry type="answer">
!                   <p>There are two ways to do under Tomcat :</p>
!                   <ol>
!                      <li>Put the jmx.browser.war file under the webapps directory of the Tomcat installation. Move the mx4j-jmx.jar file from the server/lib directory to the common/lib directory. This will make the JMX classes visible from a standard Web application.</li>
!                      <li>Unwar the jmx.browser.war file under the server/webapps directory of the Tomcat installation. Create a privileged xml file under the webapps directory like the admin.xml one or the manager.xml one. The browser will run as a privileged Web application</li>
!                   </ol>
!                </entry>
!                <entry type="question">WebLogic Server 7.0</entry>
!                <entry type="answer">
!                   <p>Well, this server has not been tested, but feedback is welcomed.</p>
!                </entry>
!                <entry type="question">Another application server</entry>
!                <entry type="answer">
!                   <p>Well, <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feeback</a> is welcomed if you don't see your favorite server here.</p>
!                </entry>
!             </faq-section>
!             <faq-section name="Web Based JMX Browser : issues">
!                <entry type="question">Why do I see sometimes in MBean detail "unloadable class" ?</entry>
!                <entry type="answer">
!                   <p>That's mean the class returned by the MBean information cannot be loaded by the browser. As the browser runs on the server it is mostly due to misspelling in the class name.</p>
!                </entry>
!             </faq-section>
!             <!-- ======================================== -->
!             <!-- Swing based Browser -->
!             <!-- ======================================== -->
!             <faq-section name="Swing Based JMX Browser with...">
!                <entry type="question">JBoss Server 3.x</entry>
!                <entry type="answer">
!                   <p>Make sure the RMI adaptor is deployed into the JBoss server (jmx-rmi-adaptor.sar into the deploy directory).</p>
!                   <p>Copy the jbossall-client.jar (from JBOSS_HOME/client) and the jboss-jmx.jar (from JBOSS_HOME/lib) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                   <p>If you are using a JDK1.3, copy the jnet.jar, jcert.jar and jsse.jar (from JBOSS_HOME/client) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">WebLogic Server 7.0</entry>
!                <entry type="answer">
!                   <p>This server has not been fully tested. The main issue is about notification reception : the  JMX Browser doesn't implements a WebLogic interface needed to receive the notifications.</p>
!                   <p>If you want to use it, copy the weblogic.jar (from BEA_HOME/weblogic700/server/lib) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">MX4J 1.1.1</entry>
!                <entry type="answer">
!                   <p>There are two ways to connect to a MX4J implementation :</p>
!                   <ol>
!                      <li>With the JRMP connector (see <a href="http://mx4j.sourceforge.net/docs/bk01ch03s16.html">here</a> for more details about the setup of the mx4j implementation)</li>
!                      <li>With the IIOP connector (see <a href="http://mx4j.sourceforge.net/docs/bk01ch03s16.html">here</a> for more details about the setup of the mx4j implementation)</li>
!                   </ol>
!                   <p>Copy the mx4j-jmx.jar and mx4j-tools.jar (from MX4J distribution) into the lib/ext directory of the JMX Browser and launch the browser.</p>
!                </entry>
!                <entry type="question">Pramati Server 3.0</entry>
!                <entry type="answer">
!                   <p>This server has not been fully tested, and was put in stand by for license reasons.</p>
!                </entry>
!                <entry type="question">Tivoli TMX4J 2.1</entry>
!                <entry type="answer">
!                   <p>This implementation has not been fully tested, and was put in stand by for license reasons.</p>
!                </entry>
!                <entry type="question">Sun JDMK 1.1</entry>
!                <entry type="answer">
!                   <p>Well, this implementation has not been tested, but feedback is welcomed.</p>
!                </entry>
!                <entry type="question">Another application server or JMX implementation.</entry>
!                <entry type="answer">
!                   <p>Well, <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feeback</a> is welcomed if you don't see your favorite server or your favorite JMX implementation here.</p>
!                </entry>
!             </faq-section>
!             <faq-section name="Swing Based JMX Browser : issues">
!                <entry type="question">When a MBean is unregistered, it doesn't disappear from the tree view ?</entry>
!                <entry type="answer">
!                   <p>You have to refresh the server view to make it disappears.</p>
!                </entry>
!                <entry type="question">What are the date format supported ?</entry>
!                <entry type="answer">
!                   <p>There are five formats supported :</p>
!                   <ul>
!                      <li>"yyyy-MM-dd HH:mm:ss z"</li>
!                      <li>"yyyy-MM-dd HH:mm:ss"</li>
!                      <li>"yyyy-MM-dd HH:mm"</li>
!                      <li>"yyMMdd HH:mm:ss"</li>
!                      <li>"yyMMdd HH:mm"</li>
!                   </ul>
!                   <p>If you need more formats, just fill a <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feature request</a>.</p>
!                </entry>
!                <entry type="question">How do I create an empty graph window ?</entry>
!                <entry type="answer">
!                   <p>You can't create an empty graph window. A window is created when you want to graph a numerical value.</p>
!                </entry>
!                <entry type="question">Can I plot numerical values from different servers in the same graph window ?</entry>
!                <entry type="answer">
!                   <p>Yes, it's possible. The graph window doesn't know about one or several servers. The fact is that the JMX connection name does'nt appear in the numerical value plotted, so if you have two numerical values from two different server with the same name, you won't see any difference except the color.</p>
!                </entry>
!                <entry type="question">How is choosed the color for a plotted numerical value ?</entry>
!                <entry type="answer">
!                   <p>It is a simple color rotation. If you think it must be enhanced, post a <a href="https://sourceforge.net/tracker/?group_id=49088&amp;atid=455075">feature request</a>.</p>
!                </entry>
!             </faq-section>
!          </faqs>
!       </section>
!    </body>
! </document>

Thread: [Ejtools-cvs] applications/jmx.browser/xdocs manual.xml,NONE,1.1 faq.xml,1.2,1.3

ejtools-cvs