Author: smukhina Date: 2008-12-17 09:24:38 -0500 (Wed, 17 Dec 2008) New Revision: 12642 Added: trunk/jmx/docs/reference/en/modules/mbean_editor.xml Modified: trunk/jmx/docs/reference/en/modules/introduction.xml Log: https://jira.jboss.org/jira/browse/JBDS-528 text from wiki is converted to xml (not structured yet) Modified: trunk/jmx/docs/reference/en/modules/introduction.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/introduction.xml 2008-12-17 14:19:13 UTC (rev 12641) +++ trunk/jmx/docs/reference/en/modules/introduction.xml 2008-12-17 14:24:38 UTC (rev 12642) @@ -1,8 +1,55 @@ <?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="intruduction" > +<chapter id="intruduction" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <title>Introduction</title> - <para>This chapter covers the basics of working with JMX plugin.</para> + <para>This chapter covers the basics of working with JMX plugin, which is used to manage Java applications through JMX and its RMI Connector.</para> - <para></para> -</chapter> + <para>To start using it, it's necessary to open JMX perspective. Go to Window > Open Perspective > Other... and then select JMX and click OK </para> + + <para>The JMX perspective is composed of a single view - MBean Explorer which lists the mbeans. When you double-click on a MBean in the MBean Explorer view, it opens a multi-page editor to manage the MBean. The MBeanEditor is composed of 3 pages:</para> + + <orderedlist> + <listitem><para> Attributes to get/set the attributes of the MBean</para></listitem> + <listitem><para>Operations to invoke operations on the MBean</para></listitem> + <listitem><para> Notifications to receive notifications from the MBean</para></listitem> + <listitem><para> Info which displays general information about the MBean </para></listitem> + </orderedlist> + +<para>There is a button to update the MBean attribute value (if it is writable)</para> + + <section id="Connection"> + <title>Connection</title> + <para>To connect to a MBean Server - click on the Connect... icon () in the MBean Explorer menu bar, then set the name Host and port and click on OK.</para> + <para>The default JMX URL is service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi </para> + <para> Also you can alternatively type a complete 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> + </section> + + <section id="MBeanExporter"> + + <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> + <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> + + <!-- screens -http://code.google.com/p/eclipse-jmx/wiki/NewAndNoteworthy_0_1_2 --> + <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> + + </section> + + <section id="OpenMBeanAction"> + <title>Open MBean Action </title> + <para>A Navigation action helps opening MBeans in a MBean Editor. This action is available either through the menu Navigate > Open MBean... or using the key shortcut Ctrl + Shift + M (&#8984;+ Shift + M on Mac OS X)</para> + </section> + + + </section> + +</chapter> \ No newline at end of file Added: trunk/jmx/docs/reference/en/modules/mbean_editor.xml =================================================================== --- trunk/jmx/docs/reference/en/modules/mbean_editor.xml (rev 0) +++ trunk/jmx/docs/reference/en/modules/mbean_editor.xml 2008-12-17 14:24:38 UTC (rev 12642) @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + <!-- images -http://code.google.com/p/eclipse-jmx/wiki/NewAndNoteworthy_0_2_0 --> + + <para>The MBean Editor is composed of several pages:</para> + <orderedlist><listitem><para>the Attributes page</para></listitem> + <listitem><para>the Operations page</para></listitem> + <listitem><para>the Info page </para></listitem> + </orderedlist> + + <para> The Attributes &amp; Operations pages display a list for either the MBean attributes or operations as well as details for the selection.</para> + + <para> It is possible to toggle the layout between the list and the details either vertically (by default) or horizontally.</para> + + <section> + <title>Notifications Page</title> + <!-- images could be found here - http://code.google.com/p/eclipse-jmx/wiki/NewAndNoteworthy_0_2_1--> + <!-- also so usefull info could be found here http://code.google.com/p/eclipse-jmx/wiki/ReleaseNotes_0_2_1 --> + <para>One more page in MBean Editor is a Notifications Page, which gives the possibility to subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. unchecking) the Subscribe checkbox. </para> + <para>The list of notifications is refreshed every time a new notification is received:</para> + + <note><title>Note</title> + <para>It is only possible to subscribe to MBean which emits notifications (they must be NotificationBroadcaster).</para></note> + + </section> + <section id="AttributeDisplayExtensionPoints"> + <title>Attribute Display Extension Points</title> + + <para>The value of the MBean attributes which are displayed in the MBean Editor is now contributed through 2 extension points:</para> + <orderedlist> + <listitem><para>net.jmesnil.jmx.ui.attribute.controls</para></listitem> + <listitem><para>net.jmesnil.jmx.ui.attribute.bindings</para> </listitem> + </orderedlist> + <para>This means that you can now contribute new display for MBean attributes (see some use cases and a simple example in net.jmesnil.jmx.ui.test.interactive plugin.xml)</para> + + </section> + </chapter> \ No newline at end of file