Author: mcaspers
Date: 2011-01-26 21:25:46 -0500 (Wed, 26 Jan 2011)
New Revision: 28638
Modified:
trunk/jmx/docs/reference/en-US/introduction.xml
trunk/jmx/docs/reference/en-US/references.xml
trunk/jmx/docs/reference/en-US/summary.xml
trunk/jmx/docs/reference/en-US/tasks.xml
Log:
General Updates
Modified: trunk/jmx/docs/reference/en-US/introduction.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/introduction.xml 2011-01-27 00:41:36 UTC (rev 28637)
+++ trunk/jmx/docs/reference/en-US/introduction.xml 2011-01-27 02:25:46 UTC (rev 28638)
@@ -1,135 +1,140 @@
<?xml version="1.0" encoding="ISO-8859-1"?>
<chapter id="intruduction">
- <?dbhtml filename="introduction.html"?>
+ <?dbhtml filename="introduction.html"?>
- <title>Introduction</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.
+ <title>Introduction</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>
- <title>What is JMX?</title>
- <para>
-The Java Management Extensions (JMX) technology is a standard part of the Java Platform,
Standard Edition (Java SE platform). The JMX technology was added to the platform in the
Java 2 Platform, Standard Edition (J2SE) 5.0 release.
-</para>
- <para>
-The JMX technology provides a simple, standard way of managing resources such as
applications, devices, and services. Because the JMX technology is dynamic, you can use it
to monitor and manage resources as they are created, installed and implemented. You can
also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM).
-</para>
- <para>
-The JMX specification defines the architecture, design patterns, APIs, and services in
the Java programming language for management and monitoring of applications and networks.
-</para>
- <para>
-Using the JMX technology, a given resource is instrumented by one or more Java objects
known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object
server, known as an MBean server. The MBean server acts as a management agent and can run
on most devices that have been enabled for the Java programming language.
-</para>
-
- <para>
-The specifications define JMX agents that you use to manage any resources that have been
correctly configured for management. A JMX agent consists of an MBean server, in which
MBeans are registered, and a set of services for handling the MBeans. In this way, JMX
agents directly control resources and make them available to remote management
applications.
-</para>
- <para>
-The way in which resources are instrumented is completely independent from the management
infrastructure. Resources can therefore be rendered manageable regardless of how their
management applications are implemented.
-</para>
- <para>
-The JMX technology defines standard connectors (known as JMX connectors) that enable you
to access JMX agents from remote management applications. JMX connectors using different
protocols provide the same management interface. Consequently, a management application
can manage resources transparently, regardless of the communication protocol used. JMX
agents can also be used by systems or applications that are not compliant with the JMX
specification, as long as those systems or applications support JMX agents.
-</para>
-<para>
-<ulink
-
url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html...
more about JMX</ulink>.
-</para>
- </section>
-
- <section>
- <title>What is JMX Tools?</title>
- <para><property>JBoss JMX Tools</property> allow to setup multiple
JMX connections and provide 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 (with Managed Beans) through JMX and its RMI
Connector.</para>
+ <section>
+ <title>What is JMX?</title>
+ <para>
+ The Java Management Extensions (JMX) technology is a standard part of the Java
Platform, Standard Edition (Java SE platform). The JMX technology was added to the
platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release.
+ </para>
+ <para>
+ The JMX technology provides a simple, standard way of managing resources such as
applications, devices, and services. Because the JMX technology is dynamic, you can use it
to monitor and manage resources as they are created, installed and implemented. You can
also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM).
+ </para>
+ <para>
+ The JMX specification defines the architecture, design patterns, APIs, and services in
the Java programming language for management and monitoring of applications and networks.
+ </para>
+ <para>
+ Using the JMX technology, a given resource is instrumented by one or more Java objects
known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object
server, known as an MBean server. The MBean server acts as a management agent and can run
on most devices that have been enabled for the Java programming language.
+ </para>
- <figure>
- <title>JMX Tools</title>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/eclipse-jmx_0.2.png"/>
- </imageobject>
- </mediaobject>
- </figure>
- </section>
+ <para>
+ The specifications define JMX agents that you use to manage any resources that have
been correctly configured for management. A JMX agent consists of an MBean server, in
which MBeans are registered, and a set of services for handling the MBeans. In this way,
JMX agents directly control resources and make them available to remote management
applications.
+ </para>
+ <para>
+ The way in which resources are instrumented is completely independent from the
management infrastructure. Resources can therefore be rendered manageable regardless of
how their management applications are implemented.
+ </para>
+ <para>
+ The JMX technology defines standard connectors (known as JMX connectors) that enable
you to access JMX agents from remote management applications. JMX connectors using
different protocols provide the same management interface. Consequently, a management
application can manage resources transparently, regardless of the communication protocol
used. JMX agents can also be used by systems or applications that are not compliant with
the JMX specification, as long as those systems or applications support JMX agents.
+ </para>
+ <para>
+ <ulink
url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html...
more about JMX</ulink>.
+ </para>
+ </section>
- <section><title>Key Features of JMX Tools</title>
- <para>For a start, we propose you to look through the table of main features of
JBoss JMX Tools:</para>
- <table>
-
- <title>Key Functionality for JBoss JMX Tools</title>
- <tgroup cols="3">
-
- <colspec colnum="1" align="left"
colwidth="2*"/>
- <colspec colnum="2" colwidth="4*"/>
- <colspec colnum="3" align="left"
colwidth="2*"/>
-
- <thead>
- <row>
- <entry>Feature</entry>
- <entry>Benefit</entry>
- <entry>Chapter</entry>
- </row>
- </thead>
-
- <tbody>
-
- <row>
- <entry><para>MBean Explorer</para></entry>
- <entry><para>MBean Explorer is a useful view with a text filter
that displays domains, mbeans, attributes, and operations inside a
connection.</para></entry>
- <entry>
- <xref linkend="mbean_explorer"/>
- </entry>
- </row>
-
- <row>
- <entry><para>MBean Editor</para></entry>
- <entry><para>MBean Editor is a multi-page editor to manage
MBeans.</para></entry>
- <entry>
- <xref linkend="mbean_editor"/>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </section>
-
- <section>
- <title>Requirements and Installation</title>
- <section>
- <title> Requirements</title>
- <para>Requirements to use <property>JBoss JMX Tools</property> are
the following:</para>
-
- <itemizedlist>
- <listitem>
- <para><property>JBoss JMX Tools</property> is developed on
Eclipse 3.4.x milestones</para>
- </listitem>
- <listitem>
- <para><property>JBoss 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>Installation</title>
- <para>Here, we are going to explain how to install the <property>JMX
plugin</property> into
- Eclipse.</para>
+ <section>
+ <title>What is JMX Tools?</title>
+ <para>
+ <productname>JBoss JMX Tools</productname> allows you to setup multiple
JMX connections, and provides a view for exploring the JMX tree and execute operations
directly from within Eclipse.
+ </para>
- <para><property>JBoss JMX Tools</property> is one module of the
<property>JBoss Tools</property>
- project. <property> JBoss JMX Tools</property> has no dependency on any
other part of <property>JBoss
- Tools</property>, and can be downloaded as a standalone Eclipse plugin.
Even though the <property>JMX
- Tools</property> have no dependencies on other plugins, such as
<property>AS Tools</property>,
- <property>JBoss JMX Tools</property> do depend on the JMX Tooling and
even extend it. </para>
+ <para>
+ This chapter covers the basics of working with <productname>JMX
plugin</productname>, which is used to manage Java applications (with Managed Beans)
through JMX and its RMI Connector.
+ </para>
- <para>You can find the <property>JBoss JBoss Tools</property>
plugins over at the <ulink
-
url="http://labs.jboss.com/tools/download.html">download
pages</ulink>. The only
- package you'll need to get is the JBoss JMX Tooling, however the
<property>AS
- Tools</property> would give you a wider experience and more options when
using JMX with JBoss Servers.
- You can find further download and installation instructions on the JBoss Wiki in
the <ulink
-
url="http://www.jboss.org/tools/download/installation">Insta...
- section.</para>
- </section>
- </section>
+ <figure>
+ <title>JMX Tools</title>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="images/eclipse-jmx_0.2.png"/>
+ </imageobject>
+ </mediaobject>
+ </figure>
+ </section>
+
+ <section>
+ <title>Key Features of JMX Tools</title>
+ <para>The table below lists the main features of JBoss JMX Tools:</para>
+ <table>
+
+ <title>Key Functionality for JBoss JMX Tools</title>
+ <tgroup cols="3">
+
+ <colspec colnum="1" align="left" colwidth="2*"/>
+ <colspec colnum="2" colwidth="4*"/>
+ <colspec colnum="3" align="left" colwidth="2*"/>
+
+ <thead>
+ <row>
+ <entry>Feature</entry>
+ <entry>Benefit</entry>
+ <entry>Chapter</entry>
+ </row>
+ </thead>
+
+ <tbody>
+
+ <row>
+ <entry>
+ <para>MBean Explorer</para>
+ </entry>
+ <entry>
+ <para>MBean Explorer is a useful view with a text filter that displays
domains, mbeans, attributes, and operations inside a connection.</para>
+ </entry>
+ <entry>
+ <xref linkend="mbean_explorer"/>
+ </entry>
+ </row>
+
+ <row>
+ <entry>
+ <para>MBean Editor</para>
+ </entry>
+ <entry>
+ <para>MBean Editor is a multi-page editor to manage MBeans.</para>
+ </entry>
+ <entry>
+ <xref linkend="mbean_editor"/>
+ </entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
+
+ <section>
+ <title>Requirements and Installation</title>
+ <section>
+ <title> Requirements</title>
+ <para>Requirements to use <productname>JBoss JMX
Tools</productname> are the following:</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>
+ <productname>JBoss JMX Tools</productname> is developed on Eclipse
3.4.x milestones</para>
+ </listitem>
+ <listitem>
+ <para>
+ <productname>JBoss JMX Tools</productname> 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>Installation</title>
+ <para>Here, we are going to explain how to install the <productname>JMX
plugin</productname> into Eclipse.</para>
+
+ <para>
+ <productname>JBoss JMX Tools</productname> is one module of the
<productname>JBoss Tools</productname> project. <productname> JBoss JMX
Tools</productname> has no dependency on any other part of <productname>JBoss
Tools</productname>, and can be downloaded as a standalone Eclipse plugin. Even
though the <productname>JMX Tools</productname> have no dependencies on other
plugins, such as <productname>AS Tools</productname>, <productname>JBoss
JMX Tools</productname> do depend on the JMX Tooling and even extend it.
+ </para>
+
+ <para>
+ You can find the <productname>JBoss Tools</productname> plugins over at
the <ulink
url="http://labs.jboss.com/tools/download.html">download
pages</ulink>. The only package you will need to get is the JBoss JMX Tooling,
however the <productname>AS Tools</productname> would give you a wider
experience and more options when using JMX with JBoss Servers. You can find further
download and installation instructions on the JBoss Wiki in the <ulink
url="http://www.jboss.org/tools/download/installation">Insta...
section.
+ </para>
+ </section>
+ </section>
</chapter>
\ No newline at end of file
Modified: trunk/jmx/docs/reference/en-US/references.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/references.xml 2011-01-27 00:41:36 UTC (rev 28637)
+++ trunk/jmx/docs/reference/en-US/references.xml 2011-01-27 02:25:46 UTC (rev 28638)
@@ -8,7 +8,7 @@
<title>MBean Explorer</title>
<para>
- The <guilabel>MBean Explorer</guilabel> displays the MBean features (both
attributes and operations) in its hierarchy. Double-clicking on a feature will open a
<property>MBean Editor</property>, displaying the page corresponding to the
feature type and select the feature.
+ The <guilabel>MBean Explorer</guilabel> displays the MBean features (both
attributes and operations) in its hierarchy. Double-clicking on a feature will open an
<property>MBean Editor</property>, displaying the page corresponding to the
feature type and select the feature.
</para>
<figure>
@@ -21,7 +21,7 @@
</figure>
<para>
- Since it is possible to have many MBean Editors opened at the same time, the
<guilabel>MBean Explorer</guilabel> has the Link With Editor button
<inlinemediaobject> <imageobject> <imagedata
fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject>
to synchronize selections between the active <guilabel>MBean Editor</guilabel>
and the <guilabel>MBean Explorer</guilabel> (and vice versa).
+ Since it is possible to have many MBean Editors opened at the same time, the
<guilabel>MBean Explorer</guilabel> has the <guibutton>Link With
Editor</guibutton> button <inlinemediaobject> <imageobject>
<imagedata
fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject>
to synchronize selections between the active <guilabel>MBean Editor</guilabel>
and the <guilabel>MBean Explorer</guilabel> (and vice versa).
</para>
<para>
@@ -29,7 +29,7 @@
</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 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.
+ 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 bean will be displayed. If, however, an attribute
or operation name (a leaf node) matches, only that node and its parents in the tree will
be displayed.
</para>
<figure>
@@ -79,11 +79,11 @@
</itemizedlist>
<para>
- The <guilabel>Attributes</guilabel> and
<guilabel>Operations</guilabel> pages display a list for either the MBean
attributes or operations as well as details for the selection.
+ The <guilabel>Attributes</guilabel> and
<guilabel>Operations</guilabel> pages display a list for either the MBean
attributes or operations, as well as details about 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></inlinemediaobject>in
the right top corner of the editor.
+ 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></inlinemediaobject>
in the right top corner of the editor.
</para>
<figure>
@@ -108,7 +108,7 @@
<section>
<title>Notifications Page</title>
<para>
- One more page in the <guilabel>MBean Editor</guilabel> is the
<guilabel>Notifications</guilabel> page, which gives the possibility to
subscribe or unsubscribe to an MBean to receive its notifications by checking or
unchecking the <guibutton>Subscribe</guibutton> button in the right top
corner.
+ The <guilabel>Notifications</guilabel> page provides the ability to
subscribe or unsubscribe to an MBean to receive its notifications by checking or
unchecking the <guibutton>Subscribe</guibutton> button in the right top
corner.
</para>
<para>The list of notifications is refreshed every time a new notification is
received:</para>
@@ -123,7 +123,7 @@
<note>
<title>Note</title>
- <para>It is only possible to subscribe to MBean that emits notifications (i.e.
they must be a NotificationBroadcaster).</para>
+ <para>It is only possible to subscribe to an MBean that emits notifications
(i.e. they must be a NotificationBroadcaster).</para>
</note>
</section>
Modified: trunk/jmx/docs/reference/en-US/summary.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/summary.xml 2011-01-27 00:41:36 UTC (rev 28637)
+++ trunk/jmx/docs/reference/en-US/summary.xml 2011-01-27 02:25:46 UTC (rev 28638)
@@ -3,29 +3,21 @@
<?dbhtml filename="summary.html"?>
<title>Summary</title>
<para>
- In conclusion, with this document you could easily start with JXM Tools. The
chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss
Instances managing and how to create new JMX connections. The document also includes the
reference of JMX Tools features. If you have questions or suggestions concerned both the
documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use
Jira to report bugs and requests on documentation.
+ This document has provided an overview of the functionality included with JXM Tools,
as well as walking you through the steps on managing Tomcat, Eclipse Equinox or JBoss
Instances and how to create new JMX connections. If you have questions or suggestions
concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users
forum. Please, use Jira to report bugs and requests on documentation.
</para>
<section>
<title>Other relevant resources on the topic</title>
<para>
- All JBoss Developer Studio/JBoss Tools release documentation you can find at
<ulink
url="http://docs.jboss.org/tools">http://docs.jboss.org/tool...
in the corresponding release directory.
+ You can find the JBoss Developer Studio/JBoss Tools release documentation at
<ulink
url="http://docs.jboss.org/tools">http://docs.jboss.org/tool...
in the corresponding release directory.
</para>
<para>
The latest documentation builds are available at <ulink
url="http://download.jboss.org/jbosstools/nightly-docs">http...;.
</para>
- <para>You can find a set of benefits and other extra information
on:</para>
- <itemizedlist>
- <listitem>
- <para>
- <ulink
url="http://www.jboss.org/community/wiki/JBossMX">JBoss
Wiki</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- For more information about JMX technology please visit <ulink
url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamana...
Technology Home Page</ulink>
- </para>
- </listitem>
- </itemizedlist>
+ <para>The JBoss JXM Wiki can be found at <ulink
url="http://www.jboss.org/community/wiki/JBossMX">http://www...
+ <para>
+ For more information about JMX technology please visit <ulink
url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamana...
Technology Home Page</ulink>
+ </para>
+
</section>
</chapter>
\ No newline at end of file
Modified: trunk/jmx/docs/reference/en-US/tasks.xml
===================================================================
--- trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-27 00:41:36 UTC (rev 28637)
+++ trunk/jmx/docs/reference/en-US/tasks.xml 2011-01-27 02:25:46 UTC (rev 28638)
@@ -7,33 +7,29 @@
<title>Quick Start</title>
<para>
- To start using the <property>JMX Tools</property> it's necessary
to open <property>MBean Explorer</property>. Go to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>,
select <guimenuitem>MBean Explorer</guimenuitem> and click the
<guibutton>OK</guibutton> button.
+ To start using the <property>JMX Tools</property> it is necessary to open
<guilabel>MBean Explorer</guilabel>. Select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>,
select <guimenuitem>MBean Explorer</guimenuitem> and click the
<guibutton>OK</guibutton> button.
</para>
<para>
- The <property>MBean Explorer</property> lists all the domains, mbeans,
attributes, and operations inside a connection. When you double-click an 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:
+ The <guilabel>MBean Explorer</guilabel> lists all the domains, MBeans,
attributes, and operations inside a connection. When you double-click an MBean in the
<guilabel>MBean Explorer</guilabel>, it opens a multi-page editor to manage
the MBean. The <guilabel>MBean Editor</guilabel> is composed of these pages:
</para>
<itemizedlist>
<listitem>
<para>
- <emphasis>
- <property>Attributes page</property>,</emphasis> to get/set the
attributes of the MBean</para>
+ <guilabel>Attributes page</guilabel>, to get/set the attributes of the
MBean</para>
</listitem>
<listitem>
<para>
- <emphasis>
- <property>Operations page</property>,</emphasis> to invoke
operations on the MBean</para>
+ <guilabel>Operations page</guilabel>, to invoke operations on the
MBean</para>
</listitem>
<listitem>
<para>
- <emphasis>
- <property>Notifications page</property>,</emphasis> to receive
notifications from the MBean</para>
+ <guilabel>Notifications page</guilabel>, to receive notifications from
the MBean</para>
</listitem>
<listitem>
<para>
- <emphasis>
- <property>Info page</property>,</emphasis> which displays general
information about the MBean </para>
+ <guilabel>Info page</guilabel>, which displays general information about
the MBean </para>
</listitem>
</itemizedlist>
@@ -43,7 +39,7 @@
<title>Managing Application</title>
<para>
- As it's been said earlier in the guide that the JMX technology allows you to
monitor and manage Java applications. In this section we will show you how to get
connected to a sample Java application and run the <code>sayHello()</code>
method remotely from inside of the <property>MBean Explorer</property>.
+ As it has been said earlier in the guide, the JMX technology allows you to monitor and
manage Java applications. In this section we will show you how to get connected to a
sample Java application and run the <code>sayHello()</code> method remotely
from inside of the <guilabel>MBean Explorer</guilabel>.
</para>
<orderedlist>
@@ -51,7 +47,7 @@
<listitem>
<para>
- Save the bundle of JMX API sample classes, <ulink
url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_exampl...;,
to your working directory
+ Save the bundle of JMX API sample classes, <ulink
url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_exampl...;,
to your working directory.
</para>
</listitem>
<listitem>
@@ -78,12 +74,12 @@
</listitem>
<listitem>
<para>
- Now launch the Eclipse IDE, in Eclipse open the <guilabel>MBean
Explorer</guilabel>. Go to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and then select <guimenuitem>MBean Explorer</guimenuitem> and click the
<guibutton>OK</guibutton> button)
+ Now launch the Eclipse IDE, in Eclipse open the <guilabel>MBean
Explorer</guilabel>. Go to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>,
select <guimenuitem>MBean Explorer</guimenuitem>, and then click the
<guibutton>OK</guibutton> button)
</para>
</listitem>
<listitem>
<para>
- Click the <guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <property>MBean Explorer</property> menu bar.
+ Click the <guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <guilabel>MBean Explorer</guilabel> menu bar.
</para>
</listitem>
@@ -115,9 +111,9 @@
<listitem>
<para>
- Now expand the connection you have just created, then open the
<guilabel>com.example</guilabel> package and click the
<code>sayHello()</code> method.
+ Now expand the connection you have just created, open the
<guilabel>com.example</guilabel> package, and click the
<code>sayHello()</code> method.
</para>
- <para>Once the <code>sayHello()</code> method is clicked the
<guilabel>MBean Editor</guilabel> is activated. </para>
+ <para>Once the <code>sayHello()</code> method is selected the
<guilabel>MBean Editor</guilabel> is activated. </para>
</listitem>
@@ -139,7 +135,7 @@
<listitem>
<para>
- The final step is to make sure the application worked as it was expected. Open the
terminal where you launched the application in step 3. Now you see the "hello,
world" message on the screen.
+ The final step is to make sure the application worked as expected. Open the terminal
where you launched the application in step 3. Now you see the "hello, world"
message on the screen.
</para>
</listitem>
</orderedlist>
@@ -155,10 +151,10 @@
Using SSL for authentication is not supported: you need to make sure that the System
property <guilabel>com.sun.management.jmxremote.ssl</guilabel> is set to
false.
</para>
<para>
- More information to manage Tomcat can be found in <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management
documentation</ulink>.
+ More information to manage Tomcat can be found in the <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management
documentation</ulink>.
</para>
<para>
- Instructions to manage remotely Tomcat are available in <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html"&g...
monitoring documentation</ulink>.
+ Instructions to remotely manage Tomcat are available in <ulink
url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html"&g...
monitoring documentation</ulink>.
</para>
@@ -169,9 +165,9 @@
<para>You can manage Equinox through the Equinox monitoring
framework.</para>
<para>
- In this section we will show you how to connect to an Equinox server via JBoss JMX
tools. First off, you need to create a simple servlet and run it on a server. This guide
is not intended to teach you how to build application and run them on the server,
<ulink
url="http://www.eclipse.org/equinox-portal/tutorials/server-side/&qu...
this tutorial </ulink> can be used to give you a better idea of how to build
server-based applications with Eclipse Equinox.
+ In this section we will show you how to connect to an Equinox server via JBoss JMX
tools. First you need to create a simple servlet and run it on a server. The process of
building applications and running them on the server is beyond the scope of this
documentation, however <ulink
url="http://www.eclipse.org/equinox-portal/tutorials/server-side/&qu... this
tutorial </ulink> can be used to give you a better idea of how to build server-based
applications with Eclipse Equinox.
</para>
- <para>Once you have run an application on the server you can connect to it using
JBoss JMX tools.</para>
+ <para>Once you have an application running on the server you can connect to it
using JBoss JMX tools.</para>
<orderedlist>
<listitem>
@@ -189,11 +185,13 @@
</listitem>-->
<listitem>
- <para>Switch to the <property>MBean Explorer</property> by
selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para>
+ <para>
+ Switch to the <guilabel>MBean Explorer</guilabel> by selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and selecting the <guimenuitem>MBean Explorer</guimenuitem> option.
+ </para>
</listitem>
<listitem>
- <para>Click the <guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <property>MBean Explorer</property> menu bar.</para>
+ <para>Click the <guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <property>MBean Explorer</property> menu bar.</para>
</listitem>
<listitem>
@@ -221,15 +219,15 @@
<title>Managing JBoss AS</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:
+ Managing JBoss instances is not supported with the <guilabel>JMX
Tools</guilabel> alone. You must also download and install the <guilabel>AS
Tools</guilabel> portion of the <guilabel>JBoss Tools</guilabel>
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>
<orderedlist>
<listitem>
- <para>Open the <property>Servers</property> view.</para>
+ <para>Open the <guilabel>Servers</guilabel> view.</para>
</listitem>
<listitem>
- <para>Right-click in the view and select
<menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para>
+ <para>Bring up the views context menu and select
<menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para>
</listitem>
<listitem>
@@ -247,7 +245,7 @@
</listitem>
<listitem>
- <para>Start the server by right-clicking it and selecting
<guimenuitem>Start</guimenuitem>.</para>
+ <para>Start the server by right-clicking it and selecting the
<guimenuitem>Start</guimenuitem> option.</para>
</listitem>
<listitem>
<para>Note that once the server is started, the JMX connection can be
expanded.</para>
@@ -261,15 +259,15 @@
<title>Managing JBoss AS Remotely</title>
<para>
- JBoss JMX Tool allow you to easily get access and manage a JBoss AS server remotely.
In order to connect to the instance of JBoss AS remotely you need to run the server or
make sure the server is launched.
+ The JBoss JMX Tools allow you to easily access and manage a JBoss AS server remotely.
In order to connect to the instance of JBoss AS remotely you need to run the server or
make sure the server is launched.
</para>
<orderedlist>
<listitem>
- <para>Go to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open
Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and select the <guimenuitem>JMX perspective.</guimenuitem>
+ <para>Select
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open
Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and select the <guimenuitem>JMX perspective</guimenuitem> option.
</para>
</listitem>
<listitem>
- <para>Switch to the <guilabel>MBean Explorer</guilabel> by going to
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and selecting the <guimenuitem>MBean Explorer</guimenuitem>.</para>
+ <para>Switch to the <guilabel>MBean Explorer</guilabel> by
selecting
<menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show
View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>
and selecting the <guimenuitem>MBean Explorer</guimenuitem>
option.</para>
</listitem>
<listitem>
@@ -279,10 +277,10 @@
</listitem>
<listitem>
- <para>Select the <guilabel>Advanced tab</guilabel> and set the JMX
URL to:</para>
+ <para>Select the <guilabel>Advanced</guilabel> tab and set the JMX
URL to:</para>
<programlisting
role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting>
- <para>Please, note that in this example we connected to the local host.
</para>
+ <para>Please note that in this example we are connected to the local host.
</para>
</listitem>
</orderedlist>
</section>
@@ -294,7 +292,7 @@
<title>Why we should do that?</title>
<para>
- You might be asking yourself why you would 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
uses JBoss classes to do it. This requires that the connection have access to JBoss jars.
+ You might be asking yourself why you would 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
uses JBoss classes to do it. This requires that the connection has access to the JBoss
JARs.
</para>
</section>
@@ -306,11 +304,11 @@
</para>
<para>
- An <code>IConnectionProvider</code> is responsible for creation and
deletion of <code>IConnectionWrapper</code> 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.
+ An <code>IConnectionProvider</code> is responsible for creation and
deletion of <code>IConnectionWrapper</code> objects. It must also keep a list
of listeners that it is expected to notify when a connection is added or removed from its
list.
</para>
<para>
- Each <code>IConnectionWrapper</code> is expected to handle running
arbitrary JMX runnables or getting a "Root" object representing all JMX nodes.
There are some utility methods the <code>IConnectionWrapper</code> can make
use of.
+ Each <code>IConnectionWrapper</code> is expected to be able to run
arbitrary JMX runnables or getting a "Root" object representing all JMX nodes.
There are some utility methods the <code>IConnectionWrapper</code> can make
use of.
</para>
</section>
@@ -327,7 +325,7 @@
<para>
<code>org.jboss.tools.jmx.ui.attribute.controls</code> - allows you to
map class types to some Control to present them in the MBean Editor
</para>
- <para>We hope, this guide helped you to get started with the JBoss JMX Tools.
Besides, for additional information you are welcome on <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
+ <para>We hope this guide helped you to get started with the JBoss JMX Tools.
For additional information you are welcome on the <ulink
url="http://www.jboss.com/index.html?module=bb&op=viewforum&...
forum</ulink>.</para>
</listitem>
</itemizedlist>
</section>
@@ -342,7 +340,7 @@
</para>
<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 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.
+ 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 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>
@@ -352,14 +350,14 @@
<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 the
<guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <guilabel>MBean Explorer</guilabel> menu bar.
+ The first step is the same for both methods - to connect to a MBean Server, click the
<guibutton>New Connection</guibutton> icon
<inlinemediaobject><imageobject><imagedata
fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>
in the <guilabel>MBean Explorer</guilabel> menu bar.
</para>
<para>
- Then to follow the simple one you just need to specify host, port (and optionally
user name and password) and click the <guibutton>OK</guibutton> button.
+ The simple method is to specify the host, port (and optionally user name and
password) and click the <guibutton>OK</guibutton> button.
</para>
<para>
- On the <guilabel>Advanced</guilabel> tab you can set the sever name (it
will be displayed in <guilabel>MBean Explorer</guilabel>), a URL to the remote
server. For example, to connect to JBoss AS you need to set the <guilabel>JMX
URL</guilabel> to
+ On the <guilabel>Advanced</guilabel> tab you can set the sever name (it
will be displayed in <guilabel>MBean Explorer</guilabel>), and a URL to the
remote server. For example, to connect to JBoss AS you need to set the <guilabel>JMX
URL</guilabel> to
</para>
<programlisting
role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting>
<para>If it is required you can enter user name and password for the server
connection. </para>