Author: smukhina Date: 2009-01-22 09:25:26 -0500 (Thu, 22 Jan 2009) New Revision: 13188 Added: trunk/jmx/docs/reference/en/modules/connection.xml trunk/jmx/docs/reference/en/modules/how_to.xml trunk/jmx/docs/reference/en/modules/mbean_explorer.xml Modified: trunk/jmx/docs/reference/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-528 missing modules are added to guide build and master.xml Modified: trunk/jmx/docs/reference/en/master.xml =================================================================== --- trunk/jmx/docs/reference/en/master.xml 2009-01-22 14:23:34 UTC (rev 13187) +++ trunk/jmx/docs/reference/en/master.xml 2009-01-22 14:25:26 UTC (rev 13188) @@ -4,17 +4,11 @@ [<!ENTITY introduction SYSTEM "modules/introduction.xml"> <!ENTITY mbean_editor SYSTEM "modules/mbean_editor.xml"> -<!--ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> +<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> <!ENTITY connection SYSTEM "modules/connection.xml"> <!ENTITY how_to SYSTEM "modules/how_to.xml"> -<!ENTITY runtimes_servers SYSTEM "modules/runtimes_servers.xml"> -<!ENTITY perspective SYSTEM "modules/perspective.xml"> -<!ENTITY webtools SYSTEM "modules/webtools.xml"> -<!ENTITY modules SYSTEM "modules/modules.xml"> -<!ENTITY tptp_support SYSTEM "modules/tptp_support.xml"--> - <!ENTITY seamlink "../../seam/html_single/index.html"> <!ENTITY aslink "../../as/html_single/index.html"> <!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> @@ -62,8 +56,8 @@ <toc/> &introduction; &mbean_editor; -<!-- &mbean_explorer; + &mbean_explorer; &connection; &how_to; ---> + </book> Added: trunk/jmx/docs/reference/en/modules/connection.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/connection.xml (rev 0) +++ trunk/jmx/docs/reference/en/modules/connection.xml 2009-01-22 14:25:26 UTC (rev 13188) @@ -0,0 +1,21 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="connection" xreflabel="connection"> + <?dbhtml filename="connection.html"?> + + <title>Connection</title> + <para> There are two ways to connect to an application with remote management enabled:</para> + <para> The first step is the same for both - to connect to a MBean Server - click on the + Connect... icon () in the MBean Explorer menu bar, </para> + <para>Then to follow the simple one you just need to specify host, port (and optionally user + name &amp; password) and click OK</para> + <para>The default JMX URL is service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi </para> + + <para> In case you need to connect to an application which has not used the "standard" JMX URL + (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify + explicitly a JMX URL in the Advanced Tab of the JMX Connection window </para> + + <note> + <title>Note</title> + <para>only JMX URL based on RMI are supported </para> + </note> +</chapter> \ No newline at end of file Added: trunk/jmx/docs/reference/en/modules/how_to.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/how_to.xml (rev 0) +++ trunk/jmx/docs/reference/en/modules/how_to.xml 2009-01-22 14:25:26 UTC (rev 13188) @@ -0,0 +1,36 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="how_to" xreflabel="how_to"> + <?dbhtml filename="how_to.html"?> + <title>How to ...</title> + <para>This chapter will give you answers on most popular questions asked by JMX plugin users</para> + + <section> + <title>How to Manage Tomcat </title> + <para>It's possible to manage Tomcat using eclipse-jmx</para> + <para> Currently, eclipse-jmx is able to connect to Tomcat without authentication or with password-based authentication.</para> + <para> Using SSL for authentication is not supported: you need to make sure that the System property com.sun.management.jmxremote.ssl is set to false. + </para> + <para> More information to manage Tomcat can be found in Tomcat management documentation </para> + <para> Instructions to manage remotely Tomcat are available in Tomcat's monitoring documentation.</para> + + </section> + + <section> + <title>How to manage Eclipse Equinox using eclipse-jmx</title> + + <para> You can manage Equinox using eclipse-jmx through Equinox monitoring framework.</para> + <para> Once you have installed Equinox monitoring framework and restarted Eclipse:</para> + <itemizedlist> + <listitem><para> Go to Window > Open Perspective > Other... and select the JMX Resource Management perspective</para></listitem> + <listitem><para> Select JMX Server > Open Connection and click on OK</para></listitem> + <listitem><para> Switch to eclipse-jmx perspective by going to Window > Open Perspective > Other... and selecting the JMX perspective</para></listitem> + <listitem><para> click on the Connect... icon () in the MBean Explorer menu bar </para></listitem> + <listitem><para> select the Advanced tab and set the JMX URL to service:jmx:rmi:///jndi/rmi://:8118/jmxserver </para></listitem> + </itemizedlist> + <para> You now have access to the MBeans exposed by Equinox. </para> + </section> + + + + +</chapter> \ No newline at end of file Added: trunk/jmx/docs/reference/en/modules/mbean_explorer.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/mbean_explorer.xml (rev 0) +++ trunk/jmx/docs/reference/en/modules/mbean_explorer.xml 2009-01-22 14:25:26 UTC (rev 13188) @@ -0,0 +1,41 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The MBean explorer displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a MBean Editor, display the page + corresponding to the feature type and select the feature.</para> + + <figure> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since It's possible to have many MBean Editors opened at the same time, the MBean Explorer + has a Link With Editor checkbox to synchronize selections between the active MBean Editor and + the MBean explorer(and vice versa) </para> + + <figure> + <title>Linking with Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/link-with-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The MBean Explorer has also a filter text that can be used to filter among all the MBeans + the few ones, which interest you.</para> + + <para>For example, if you are only interested by MBeans related to memory, typing memo will show + only the MBeans registered under an ObjectName, which contains memo: </para> + + <para>A Collapse All button on the MBean Explorer toolbar is used to collapse all the MBeans and + display only the domains. It is also possible to double click on a node to expand/collapse it. </para> + +</chapter>