Author: ochikvina
Date: 2009-02-20 03:55:54 -0500 (Fri, 20 Feb 2009)
New Revision: 13694
Modified:
trunk/jmx/docs/reference/en/modules/connection.xml
trunk/jmx/docs/reference/en/modules/extensions.xml
trunk/jmx/docs/reference/en/modules/how_to.xml
trunk/jmx/docs/reference/en/modules/introduction.xml
trunk/jmx/docs/reference/en/modules/mbean_editor.xml
trunk/jmx/docs/reference/en/modules/mbean_explorer.xml
Log:
https://jira.jboss.org/jira/browse/JBDS-563 - updating the chapters: structure,
highlighting;
Modified: trunk/jmx/docs/reference/en/modules/connection.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/connection.xml 2009-02-20 08:55:09 UTC (rev
13693)
+++ trunk/jmx/docs/reference/en/modules/connection.xml 2009-02-20 08:55:54 UTC (rev
13694)
@@ -4,7 +4,7 @@
<title>Connections</title>
- <para>The MBean Explorer supports several different types of connections.
+ <para>The <property>MBean Explorer</property> supports several
different types of connections.
The tooling itself comes only with a default connection type, however other
adopters can provide additional connection types that may require additional
or non-spec behavior. Connections can be in either the connected state or
@@ -13,27 +13,42 @@
<para>Similarly, some connection types may be able to be created, and others
may not.
The default connection type, for example, can be created and deleted by you
- at will. The ASTools connection type, which represents a JBoss server, does
not
+ at will. The AS Tools connection type, which represents a JBoss server, does
not
allow you this level of control. A JBoss JMX connection is created when a JBoss
server is created
in the server's view, and deleted when said server is deleted. The JMX
connection for
this server is in the connected state only when the server is started.
</para>
<section><title>The Default 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> The first step is the same for both - to connect to a MBean Server,
click on the
+ <emphasis>
+ <property>New Connection</property></emphasis> icon
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/new_connection_icon.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ in the <property>MBean Explorer</property> menu bar.</para>
+
<para>Then to follow the simple one you just need to specify host, port (and
optionally user
- name & password) and click OK</para>
- <para>The default JMX URL is
service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi </para>
+ name and password) and click <emphasis>
+ <property>OK</property>.</emphasis></para>
+
+ <para>The default JMX URL is <emphasis>
+
<property>service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></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>
+ <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>
+ <para>Only JMX URL based on RMI are supported.</para>
</note>
</section>
</chapter>
Modified: trunk/jmx/docs/reference/en/modules/extensions.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/extensions.xml 2009-02-20 08:55:09 UTC (rev
13693)
+++ trunk/jmx/docs/reference/en/modules/extensions.xml 2009-02-20 08:55:54 UTC (rev
13694)
@@ -1,32 +1,52 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<chapter id="extensions" xreflabel="extensions">
- <?dbhtml filename="extensions"?>
- <title>Extension API</title>
- <para>This chapter will outline how to contribute your own Server type with
some default behavior</para>
-
- <section>
- <title>Why??</title>
- <para>You might be asking yourself why you'd need to extend this
framework if JMX is a standard.
- Perhaps you want a connection to be automatically created after some
specific action,
- or perhaps you want your connection wizard to do more than simply set a host
and port.
- JBoss, for example, requires setting some credentials on the client machine,
but
- using JBoss classes to do it. This requires that the connection have access
to
- JBoss jars.</para>
- </section>
+<chapter id="extensions" xreflabel="extensions">
+ <?dbhtml filename="extensions"?>
+ <title>Extension API</title>
+ <para>This chapter will outline how to contribute your own Server type with some
default
+ behavior.</para>
- <section><title>Core Extensions</title>
- <para>To create your own JMX Connection type, you must use the
org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This point takes
one child, a connectionProvider with a class that implements
org.jboss.tools.jmx.core.IConnectionProvider.</para>
- <para>An IConnectionProvider is resposnbile for creation and deletion of
IConnectionWrapper objects. It must also keep a list of listeners that it is expected to
inform when a connection is added or removed from its list. </para>
- <para>Each IConnectionWrapper is expected to handle running arbitrary JMX
runnables or getting a "Root" object representing all JMX nodes. There are some
utility methods the IConnectionWrapper can make use of.</para>
+ <section>
+ <title>Why??</title>
+
+ <para>You might be asking yourself why you'd need to extend this
framework if JMX is
+ a standard. Perhaps you want a connection to be automatically created after some
specific
+ action, or perhaps you want your connection wizard to do more than simply set a
host and
+ port. JBoss, for example, requires setting some credentials on the client
machine, but
+ using JBoss classes to do it. This requires that the connection have access to
JBoss
+ jars.</para>
</section>
-
- <section><title>UI Extensions</title>
- <para>There are two extension points currently approved for use in the
UI</para>
- <itemizedlist>
- <listitem><para>org.jboss.tools.jmx.ui.providerUI - provide an
icon, id, displayable name, and wizardPage class for creation of new
connections</para></listitem>
- <listitem><para>org.jboss.tools.jmx.ui.attribute.controls - allows
you to map class types to some Control to present them in the MBean
Editor</para></listitem>
- </itemizedlist>
+ <section>
+ <title>Core Extensions</title>
+
+ <para>To create your own JMX Connection type, you must use the
+ org.jboss.tools.jmx.core.MBeanServerConnectionProvider extension point. This
point takes
+ one child, a connectionProvider with a class that implements
+ org.jboss.tools.jmx.core.IConnectionProvider.</para>
+
+ <para>An IConnectionProvider is resposnbile for creation and deletion of
IConnectionWrapper
+ objects. It must also keep a list of listeners that it is expected to inform
when a
+ connection is added or removed from its list. </para>
+
+ <para>Each IConnectionWrapper is expected to handle running arbitrary JMX
runnables or getting
+ a "Root" object representing all JMX nodes. There are some utility
methods the
+ IConnectionWrapper can make use of.</para>
</section>
+
+ <section>
+ <title>UI Extensions</title>
+ <para>There are two extension points currently approved for use in the
UI</para>
+ <itemizedlist>
+ <listitem>
+ <para>org.jboss.tools.jmx.ui.providerUI - provide an icon, id,
displayable name, and
+ wizardPage class for creation of new connections</para>
+ </listitem>
+ <listitem>
+ <para>org.jboss.tools.jmx.ui.attribute.controls - allows you to map
class types to some
+ Control to present them in the MBean Editor</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
</chapter>
Modified: trunk/jmx/docs/reference/en/modules/how_to.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/how_to.xml 2009-02-20 08:55:09 UTC (rev 13693)
+++ trunk/jmx/docs/reference/en/modules/how_to.xml 2009-02-20 08:55:54 UTC (rev 13694)
@@ -1,55 +1,130 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<chapter id="how_to" xreflabel="how_to">
+<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>
-
+ <para>This chapter will give you answers on most popular questions asked by
<property>JMX
+ plugin</property> 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>
-
+ <title>How to Manage Tomcat</title>
+
+ <para>It's possible to manage Tomcat using <property>JMX
Tools</property>.</para>
+
+ <para>Currently, JMX Tooling 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 <emphasis>
+ <property>com.sun.management.jmxremote.ssl</property>
+ </emphasis> 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</title>
-
- <para> You can manage Equinox through the Equinox monitoring
framework.</para>
- <para> Once you have installed the Equinox monitoring framework and
restarted Eclipse:</para>
+
+ <para>You can manage Equinox through the Equinox monitoring
framework.</para>
+ <para>Once you have installed the 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 the MBean explorer by going to
Window > Show View > Other... and selecting the MBean
Explorer</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>
+ <listitem>
+ <para>Go to <emphasis>
+ <property>Window > Open Perspective >
Other</property>
+ </emphasis> and select the <property>JMX
perspective</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Select <emphasis>
+ <property>JMX Server > Open
Connection</property>
+ </emphasis> and click on <emphasis>
+ <property>OK</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>Switch to the <property>MBean Explorer</property>
by going to <emphasis>
+ <property>Window > Show View >
Other</property>
+ </emphasis> and selecting the MBean Explorer</para>
+ </listitem>
+
+ <listitem>
+ <para>Click on the <emphasis>
+ <property>New Connection</property></emphasis> icon
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata
fileref="images/new_connection_icon.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ in the <property>MBean Explorer</property> menu
+ bar </para>
+ </listitem>
+
+ <listitem>
+ <para>Select the <emphasis>
+ <property>Advanced tab</property></emphasis> and
set the JMX URL to <emphasis>
+
<property>service:jmx:rmi:///jndi/rmi://:8118/jmxserver</property>
+ </emphasis></para>
+ </listitem>
</itemizedlist>
- <para> You now have access to the MBeans exposed by Equinox. </para>
+
+ <para>You now have access to the MBeans exposed by Equinox.</para>
</section>
-
-
- <section>
- <title>Managing JBoss Instances</title>
- <para>Managing JBoss instnaces is not supported with the JMX Tools alone.
- You must also download and install the ASTools portion of the JBossTools
distribution.
- Even after installing the proper tooling, you cannot create a JBoss JMX
connection yourself
- or through the Connection Wizard. The first step is to create a JBoss Server.
- The full instructions for this can be found in the AS Tools section, however,
- the short summary is: </para>
- <itemizedlist>
- <listitem><para>Open the JBoss Servers View or the Servers
View</para></listitem>
- <listitem><para>Right-click in the view and select New ->
Server</para></listitem>
- <listitem><para>In the "JBoss, a division of Red Hat"
section, select a server version</para></listitem>
- <listitem><para>If a runtime has not yet been created, you'll
be prompted for the server's home directory, JDK, and
configuration.</para></listitem>
- <listitem><para>Finish the wizard and note that you have a new
entry in both the Server View and the MBean Explorer</para></listitem>
- <listitem><para>Start the server by right-clicking it and selecting
Start</para></listitem>
- <listitem><para>Note that once the server is started, the JMX
connection can be expanded</para></listitem>
- </itemizedlist>
-
- <para>Now you can explore MBeans exposed by a JBoss instance</para>
- </section>
-
+
+
+ <section>
+ <title>Managing JBoss Instances</title>
+
+ <para>Managing JBoss instances is not supported with the
<property>JMX Tools</property>
+ alone. You must also download and install the <property>AS
Tools</property> portion of
+ the <property>JBoss Tools</property> distribution. Even after
installing the proper
+ tooling, you cannot create a JBoss JMX connection yourself or through the
Connection
+ Wizard. The first step is to create a JBoss Server. The full instructions for
this can
+ be found in the AS Tools section, however, the short summary is:
</para>
+ <itemizedlist>
+ <listitem>
+ <para>Open the <property>JBoss Servers View</property>
or the <property>Servers
+ View</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Right-click in the view and select <emphasis>
+ <property>New > Server</property>
+ </emphasis></para>
+ </listitem>
+
+ <listitem>
+ <para>In the <emphasis>
+ <property>JBoss Community</property>
+ </emphasis> section, select a server version</para>
+ </listitem>
+
+ <listitem>
+ <para>If a runtime has not yet been created, you'll be
prompted for the
+ server's home directory, JDK, and configuration</para>
+ </listitem>
+
+ <listitem>
+ <para>Finish the wizard and note that you have a new entry in both
the
+ <property>JBoss Server View</property> and the
<property>MBean
+ Explorer</property></para>
+ </listitem>
+
+ <listitem>
+ <para>Start the server by right-clicking it and selecting
<emphasis>
+ <property>Start</property></emphasis></para>
+ </listitem>
+ <listitem>
+ <para>Note that once the server is started, the JMX connection can
be
+ expanded</para>
+ </listitem>
+ </itemizedlist>
+
+ <para>Now you can explore MBeans exposed by a JBoss instance.</para>
+ </section>
+
</chapter>
Modified: trunk/jmx/docs/reference/en/modules/introduction.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/introduction.xml 2009-02-20 08:55:09 UTC (rev
13693)
+++ trunk/jmx/docs/reference/en/modules/introduction.xml 2009-02-20 08:55:54 UTC (rev
13694)
@@ -1,12 +1,15 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="intruduction" xreflabel="introduction">
<?dbhtml filename="introduction.html"?>
-
+
<title>Introduction</title>
-
- <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><property>JMX Tools</property> allows to setup multiple JMX
connections and provides view
+ for exploring the JMX tree and execute operations directly from
Eclipse.</para>
+
+ <para>This chapter covers the basics of working with <property>JMX
plugin</property>, which is
+ used to manage Java applications through JMX and its RMI Connector.</para>
+
<figure>
<title>JMX Tools</title>
<mediaobject>
@@ -15,62 +18,76 @@
</imageobject>
</mediaobject>
</figure>
-
+
<section>
<title> Requirements </title>
- <para> Requirements to use JMX Tools are the following: </para>
-
+ <para>Requirements to use <property>JMX Tools</property> are the
following:</para>
+
<itemizedlist>
<listitem>
- <para> JMX Tools is developed on Eclipse 3.4.x milestones.</para>
+ <para><property>JMX Tools</property> is developed on Eclipse
3.4.x milestones</para>
</listitem>
<listitem>
- <para> JMX Tools requires that Eclipse is run on a JDK 1.5.0 or above (due
to dependencies
- on JMX packages which were introduced in Java 1.5.0)</para>
+ <para><property>JMX Tools</property> requires that Eclipse is
run on a JDK 1.5.0 or above
+ (due to dependencies on JMX packages which were introduced in Java
1.5.0)</para>
</listitem>
</itemizedlist>
</section>
-
- <section><title>History</title>
- <para>JBossTools' JMX Tools project is a fork of <ulink
url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</...;, a
project by Jeff Mesnil. It was forked with permission. </para>
+
+ <section>
+ <title>History</title>
+ <para><property>JBoss Tools</property>' JMX project is a
fork of <ulink
+
url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</...;, a
project by Jeff Mesnil.
+ It was forked with permission. </para>
</section>
<section>
<title>Installation</title>
- <para>Here, we are going to explain how to install the JMX plugins into
Eclipse.</para>
+ <para>Here, we are going to explain how to install the <property>JMX
plugin</property> into
+ Eclipse.</para>
- <para>JMX Tools is one module of the JBoss Tools project. JMX Tools has no
dependency on any other part of JBossTools, and can be downloaded standalone. Even though
the JMX Tools have no dependencies, other plugins, such as ASTools, do depend on the JMX
Tooling and even extend it. </para>
+ <para><property>JMX Tools</property> is one module of the
<property>JBoss Tools</property>
+ project. <property>JMX Tools</property> has no dependency on any other
part of <property>JBoss
+ Tools</property>, and can be downloaded standalone. Even though the
<property>JMX
+ Tools</property> have no dependencies, other plugins, such as
<property>AS Tools</property>,
+ do depend on the JMX Tooling and even extend it. </para>
- <para>You can find the JBossTools plugins over at the <ulink
url="http://labs.jboss.com/tools/download/index.html">download
pages</ulink>. The only package you'll need to get is the JMX Tooling, however
the AS Tools would give you a more full experience when using JMX with JBoss Servers.
-You can find further download and installation instructions on the JBoss Wiki in the
<ulink
url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal...
section.</para>
+ <para>You can find the <property>JBoss Tools</property> plugins
over at the <ulink
+
url="http://labs.jboss.com/tools/download/index.html">download
pages</ulink>. The only
+ package you'll need to get is the JMX Tooling, however the
<property>AS
+ Tools</property> would give you a more full experience when using JMX with
JBoss Servers.
+ You can find further download and installation instructions on the JBoss Wiki in
the <ulink
+
url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal...
+ section.</para>
</section>
-
+
<section>
- <title>Quick Start</title>
-
- <para>To start using the JMX Tools, it's necessary to open MBean explorer.
Go to Window > Show View >
- Other... and then select MBean Explorer and click OK </para>
-
- <para>The MBean Explorer lists all of the domains, mbeans, attributes, and
operations inside a connection.
- 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 these pages:</para>
-
+ <title>Quick Start</title>
+
+ <para>To start using the <property>JMX Tools</property>,
it's necessary to open
+ <property>MBean Explorer</property>. Go to
<emphasis><property>Window > Show View >
Other</property></emphasis> and then select
+ <property>MBean Explorer</property> and click
<emphasis><property>OK</property>.</emphasis></para>
+
+ <para>The <property>MBean Explorer</property> lists all of the
domains, mbeans, attributes, and operations inside a
+ connection. When you double-click on a MBean in the
<emphasis><property>MBean Explorer</property>,</emphasis> it opens
a multi-page
+ editor to manage the MBean. The <property>MBean Editor</property> is
composed of these pages:</para>
+
<itemizedlist>
<listitem>
- <para> Attributes page, to get/set the attributes of the
MBean</para>
+ <para><emphasis><property>Attributes
page</property>,</emphasis> to get/set the attributes of the
MBean</para>
</listitem>
<listitem>
- <para>Operations page, to invoke operations on the MBean</para>
+ <para><emphasis><property>Operations
page</property>,</emphasis> to invoke operations on the MBean</para>
</listitem>
<listitem>
- <para> Notifications page, to receive notifications from the
MBean</para>
+ <para><emphasis><property>Notifications
page</property>,</emphasis> to receive notifications from the
MBean</para>
</listitem>
<listitem>
- <para> Info page, which displays general information about the MBean
</para>
+ <para><emphasis><property>Info
page</property>,</emphasis> which displays general information about the MBean
</para>
</listitem>
</itemizedlist>
-
- </section>
-
+
+ </section>
+
</chapter>
Modified: trunk/jmx/docs/reference/en/modules/mbean_editor.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/mbean_editor.xml 2009-02-20 08:55:09 UTC (rev
13693)
+++ trunk/jmx/docs/reference/en/modules/mbean_editor.xml 2009-02-20 08:55:54 UTC (rev
13694)
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
-<chapter id="mbean_editor" xreflabel="mbean_editor">
+<chapter id="mbean_editor" xreflabel="mbean_editor">
<?dbhtml filename="mbean_editor.html"?>
-
+
<title>MBean Editor</title>
-
+
<figure>
<title>MBean Editor Pages</title>
<mediaobject>
@@ -12,26 +12,39 @@
</imageobject>
</mediaobject>
</figure>
-
- <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 & 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>
-
- <figure>
- <title>Layout Buttons</title>
- <mediaobject>
+
+ <para>The <property>MBean Editor</property> is composed of several
pages:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>the Attributes page</para>
+ </listitem>
+ <listitem>
+ <para>the Operations page</para>
+ </listitem>
+ <listitem>
+ <para>the Info page </para>
+ </listitem>
+ </itemizedlist>
+
+ <para> The <emphasis>
+ <property>Attributes</property>
+ </emphasis> and <emphasis>
+ <property>Operations</property>
+ </emphasis> 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 with the help of the special icons
+
+ <inlinemediaobject>
<imageobject>
<imagedata
fileref="images/mbean-editor-layout-buttons_0.2.0.png"/>
</imageobject>
- </mediaobject>
- </figure>
-
+ </inlinemediaobject>
+
+ in the right top corner of the editor.</para>
+
<figure>
<title>MBean Editor Horizontal Layout</title>
<mediaobject>
@@ -40,15 +53,21 @@
</imageobject>
</mediaobject>
</figure>
-
+
<section>
- <title>Notifications Page</title>
- <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>
-
+ <title>Notifications Page</title>
+ <para>One more page in the <property>MBean Editor</property> 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>
</chapter>
Modified: trunk/jmx/docs/reference/en/modules/mbean_explorer.xml
===================================================================
--- trunk/jmx/docs/reference/en/modules/mbean_explorer.xml 2009-02-20 08:55:09 UTC (rev
13693)
+++ trunk/jmx/docs/reference/en/modules/mbean_explorer.xml 2009-02-20 08:55:54 UTC (rev
13694)
@@ -3,8 +3,8 @@
<?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
+ <para>The <property>MBean Explorer</property> displays the MBean
features (both attributes and operations) in its
+ hierarchy. Double-clicking on a feature will open a <property>MBean
Editor</property>, display the page
corresponding to the feature type and select the feature.</para>
<figure>
@@ -16,25 +16,24 @@
</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>
+ <para>Since it's possible to have many MBean Editors opened at the
same time, the <property>MBean Explorer</property>
+ has the Link With Editor button
+
+ <inlinemediaobject>
<imageobject>
<imagedata fileref="images/link-with-editor_0.2.0.png"/>
</imageobject>
- </mediaobject>
- </figure>
+ </inlinemediaobject>
+
+ to synchronize selections between the active <property>MBean
Editor</property> and
+ the <property>MBean Explorer</property> (and vice
versa).</para>
- <para>The MBean Explorer has also a filter text that can be used to filter
among all the MBeans
+ <para>The <property>MBean Explorer</property> 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
any node (domain, mbean, attribute, or operation) that matches that text, as well
as
- that node's parents and children. So if an MBean matches, all attributes and
operations from
+ that node's parents and children. So if an MBean matches, all attributes
and operations from
that bean will show. If, however, an attribute or operation name (a leaf node)
matches,
only that node and its parents in the tree will show.</para>
@@ -48,7 +47,16 @@
</figure>
- <para>A Collapse All button on the MBean Explorer toolbar is used to collapse
all the MBeans and
+ <para>The <emphasis>
+ <property>Collapse All</property></emphasis> button
+
+ <inlinemediaobject>
+ <imageobject>
+ <imagedata fileref="images/collaps_all.png"/>
+ </imageobject>
+ </inlinemediaobject>
+
+ on the <property>MBean Explorer</property> 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>