[jbosstools-commits] JBoss Tools SVN: r22657 - in tags/jbosstools-3.1.1.GA/jmx/docs: reference and 2 other directories.

Author: irooskov(a)redhat.com Date: 2010-06-08 20:08:25 -0400 (Tue, 08 Jun 2010) New Revision: 22657 Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg Log: adding in new ref guide for 3.0.1 Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Author_Group.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>JBoss Tools Team</firstname></author></authorgroup> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Book_Info.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>JMX Tools Reference Guide</title><subtitle>Provides information relating to the JMX Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JMX Tools Reference Guide explains how to use the JMX Tools module to setup multiple JMX connections and explore the JMX tree and execute operations.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Feedback.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<section id="sect-Beginners_Guide-We_Need_Feedback" lang="en-US"> + <title>We Need Feedback!</title> + <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + </indexterm> + <para> + If you find a typographical error in this manual, or if you have thought of a way to make this manual better, we would love to hear from you! Please submit a report in JIRA against JBoss Developer Studio: <ulink url="https://jira.jboss.org/jira/secure/CreateIssue.jspa?pid=1231050... + </para> + <para> + When submitting a bug report, be sure to mention the manual's name and to select the "documentation" component. + </para> + <para> + If you have a suggestion for improving the documentation, try to be as specific as possible when describing it. If you have found an error, please include the section number and some of the surrounding text so we can find it easily. + </para> +</section> + + Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JMX_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,19 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<!-- +<xi:include href="connection.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="how_to.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="extensions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="mbean_explorer.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="mbean_editor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +--> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Preface.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/Revision_History.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/connection.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,58 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="connection" xreflabel="connection"> + <?dbhtml filename="connection.html"?> + + <title>Connections</title> + + <para>The <property>MBean Explorer</property> supports several different types of connections. + The tooling itself comes only with a default connection type, however other + adapters can provide additional connection types that may require additional + or non-spec behavior. Connections can be in either the connected state or + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </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 the 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> + <itemizedlist> + <listitem><para>Simple</para></listitem> + <listitem><para>Advanced</para></listitem> + </itemizedlist> + + <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 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&apos;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> + </section> +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/extensions.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,54 @@ +<?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&apos;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>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 responsible 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> + <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&amp;op=viewforum&... forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/how_to.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,132 @@ +<?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 <property>JMX + plugin</property> users.</para> + + <section> + <title>How to Manage Tomcat</title> + + <para>It&apos;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 + <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/"> + Tomcat management</ulink> documentation.</para> + <para>Instructions to manage remotely Tomcat are available in + <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html."&... monitoring</ulink> 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> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property>Window &gt; Open Perspective &gt; Other</property> + </emphasis> and select the <property>JMX perspective</property></para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property>JMX Server &gt; 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 &gt; Show View &gt; 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> + </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>Servers</property> view</para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property>New &gt; Server</property> + </emphasis></para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property>JBoss Enterprise Middleware</property> + </emphasis> or in <emphasis> + <property>JBoss Community</property> + </emphasis> section, select a server profile</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you&apos;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>Servers</property> view 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> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/collaps_all.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/equinox.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/invokemethod.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbean-explorer-query.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/mbeans.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/new_connection_icon.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png =================================================================== (Binary files differ) Property changes on: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/images/notifications.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/introduction.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,135 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="intruduction" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + + <title>Introduction</title> + <para><property>JBoss Tools</property>&apos; 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> + + <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>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> + <link linkend="mbean_explorer">MBean Explorer</link> + </entry> + </row> + + <row> + <entry><para>MBean Editor</para></entry> + <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> + <entry> + <link linkend="mbean_editor">MBean Editor</link> + </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> + + <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>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&apos;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> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "mbean_editor.xml"> +<!ENTITY connection SYSTEM "connection.xml"> +<!ENTITY how_to SYSTEM "how_to.xml"> +<!ENTITY extensions SYSTEM "extensions.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]> + +<book> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.1.GA + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_gu... version</ulink> + </para> +</abstract> + </bookinfo> + + <toc/> + &introduction; + &tasks; + &references; + &summary; + <!--&connection; + &how_to; + &extensions; + &mbean_explorer; + &mbean_editor;--> + +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/master_output.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,813 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "mbean_editor.xml"> +<!ENTITY connection SYSTEM "connection.xml"> +<!ENTITY how_to SYSTEM "how_to.xml"> +<!ENTITY extensions SYSTEM "extensions.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.1.GA + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_gu... version</ulink> + </para> +</abstract> + </bookinfo> + + <toc></toc> + +<chapter id="intruduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + + <title>Introduction</title> + <para><property moreinfo="none">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 diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">What is JMX?</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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). +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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. +</diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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. +</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> +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. +</diffmk:wrapper></para> +<ulink diffmk:change="added" url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html... diffmk:change="added">Read more about JMX</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + </diffmk:wrapper></section> + + <section> + <title>What is JMX Tools?</title> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> allow to setup multiple JMX connections and provide view + for exploring the JMX tree and execute operations directly from Eclipse.</diffmk:wrapper></para> + + <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property><diffmk:wrapper diffmk:change="changed">, which is + used to manage Java applications (with Managed Beans) through JMX and its RMI Connector.</diffmk:wrapper></para> + + <figure float="0"> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section><title>Key Features of JMX Tools</title> + <para><diffmk:wrapper diffmk:change="changed">For a start, we propose you to look through the table of main features of JBoss JMX Tools:</diffmk:wrapper></para> + <table> + + <title><diffmk:wrapper diffmk:change="changed">Key Functionality for JBoss JMX Tools</diffmk:wrapper></title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <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> + <link linkend="mbean_explorer">MBean Explorer</link> + </entry> + </row> + + <row> + <entry><para>MBean Editor</para></entry> + <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> + <entry> + <link linkend="mbean_editor">MBean Editor</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></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 moreinfo="none">JMX plugin</property> into + Eclipse.</para> + + <para><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JMX Tools</diffmk:wrapper></property> is one module of the <property moreinfo="none">JBoss Tools</property> + project. <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"> JBoss JMX Tools</diffmk:wrapper></property> has no dependency on any other part of <property moreinfo="none">JBoss + Tools</property><diffmk:wrapper diffmk:change="changed">, and can be downloaded as a standalone Eclipse plugin. Even though the </diffmk:wrapper><property moreinfo="none">JMX + Tools</property><diffmk:wrapper diffmk:change="changed"> have no dependencies on other plugins, such as </diffmk:wrapper><property moreinfo="none">AS Tools</property><diffmk:wrapper diffmk:change="added">, + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss JMX Tools</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> do depend on the JMX Tooling and even extend it. </diffmk:wrapper></para> + + <para>You can find the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss JBoss Tools</diffmk:wrapper></property> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink><diffmk:wrapper diffmk:change="changed">. The only + package you'll need to get is the JBoss JMX Tooling, however the </diffmk:wrapper><property moreinfo="none">AS + Tools</property><diffmk:wrapper diffmk:change="changed"> 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 </diffmk:wrapper><ulink url="http://www.jboss.org/tools/download/installation">Insta... + section.</para> + </section> + </section> + +</chapter> +<chapter id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/tasks.xml" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will give you answers on most popular questions asked by <property moreinfo="none">JMX + plugin</property> users.</para> + <section> + <title>Quick Start</title> + + <para>To start using the <property moreinfo="none">JMX Tools</property><diffmk:wrapper diffmk:change="changed"> it's necessary to open + </diffmk:wrapper><property moreinfo="none">MBean Explorer</property>. Go to <emphasis><property moreinfo="none">Window &gt; Show View &gt; Other</property></emphasis> and then select + <property moreinfo="none">MBean Explorer</property> and click <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + + <para>The <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> lists all the domains, mbeans, attributes, and operations inside a + connection. When you double-click a MBean in the </diffmk:wrapper><emphasis><property moreinfo="none">MBean Explorer</property>,</emphasis> it opens a multi-page + editor to manage the MBean. The <property moreinfo="none">MBean Editor</property> is composed of these pages:</para> + + <itemizedlist> + <listitem> + <para><emphasis><property moreinfo="none">Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Operations page</property>,</emphasis> to invoke operations on the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + </listitem> + <listitem> + <para><emphasis><property moreinfo="none">Info page</property>,</emphasis> which displays general information about the MBean </para> + </listitem> + </itemizedlist> + + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Managing Application</diffmk:wrapper></title> + + + +<para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As it's been said earlier in the guide the JMX technology allows 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 </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method remotely from inside of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> +<orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"><diffmk:wrapper diffmk:change="added"> + +http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip + +</diffmk:wrapper><listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Save the bundle of JMX API sample classes, </diffmk:wrapper><ulink diffmk:change="added" url="http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_exampl... diffmk:change="added">jmx_examples.zip</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">, to your working directory</diffmk:wrapper></para></listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Unzip the bundle of sample classes.</diffmk:wrapper></para></listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Compile the example Java classes from within where you unpacked the files directory.</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + javac com/example/*.java + ]]></diffmk:wrapper></programlisting> + +</listitem> +<listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Start the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Main</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> application, specifying the properties that expose Main for remote management:</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +java -Dcom.sun.management.jmxremote.port=9999 \ +-Dcom.sun.management.jmxremote.authenticate=false \ +-Dcom.sun.management.jmxremote.ssl=false \ +com.example.Main + ]]></diffmk:wrapper></programlisting> + +<para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If everything was done correctly you will see the "Waiting for incoming requests..." message on the screen.</diffmk:wrapper></para> + + + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now launch the Eclipse IDE, in Eclipse open the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Go to </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window &gt; Show View &gt; Other</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and then select + </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and click </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added">)</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Connection</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> icon + + </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> + + in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Create JMX Connection</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> dialog, hit </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> and then click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Advanced</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tab. </diffmk:wrapper></para></listitem> + + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX URL</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> input field enter the following URL:</diffmk:wrapper></para> + + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + service:jmx:rmi:///jndi/rmi://:9999/jmxrmi + ]]></diffmk:wrapper></programlisting> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">JMX Connection</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/mbeans.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Press </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to esteblish the connection with the application.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now expand the connection you have just created, then open the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">com.example</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> package and click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method. </diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Once the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> method is clicked the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> is activated. </diffmk:wrapper></para> + + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Editor</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> go to the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Operation Details</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> section and hit the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">sayHello()</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para><para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> You will get the "Operation inoked successfully" message. </diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Ivoking Method via JMX</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/invokemethod.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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. </diffmk:wrapper></para> + </listitem> +</orderedlist> + + + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It's possible to manage Tomcat using <property moreinfo="none">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 moreinfo="none">com.sun.management.jmxremote.ssl</property> + </emphasis> is set to false. </para> + <para><diffmk:wrapper diffmk:change="added">More information to manage Tomcat can be found in </diffmk:wrapper><ulink diffmk:change="added" url="http://tomcat.apache.org/tomcat-6.0-doc/"><diffmk:wr... diffmk:change="added">Tomcat management documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="added">Instructions to manage remotely Tomcat are available in </diffmk:wrapper><ulink diffmk:change="added" url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html"&g... diffmk:change="added">Tomcat's monitoring documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + + + </section> + + <section> + <title>Eclipse Equinox Managing</title> + + <para>You can manage Equinox through the Equinox monitoring framework.</para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In this section we will show you how to connect to an Equinox server via JBoss JMX tools. First off, you need to make for example 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, you can read for example </diffmk:wrapper><ulink diffmk:change="added" url="http://www.eclipse.org/equinox-portal/tutorials/server-side/&qu... diffmk:change="added"> this tutorial </diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> to get a better idea of how to build server-based applications with Eclipse Equinox. </diffmk:wrapper></para> + <para><diffmk:wrapper diffmk:change="changed">Once you have run an application on the server you can connect to it using JBoss JMX tools.</diffmk:wrapper></para> + + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; Other</property> + </emphasis> and select the <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JMX perspective.</diffmk:wrapper></property></para> + </listitem> + + <!--<listitem> + <para>Select <emphasis> + <property>JMX Server &gt; Open Connection</property> + </emphasis> and click <emphasis> + <property>OK</property> + </emphasis></para> + </listitem>--> + + <listitem> + <para>Switch to the <property moreinfo="none">MBean Explorer</property> by going to <emphasis> + <property moreinfo="none">Window &gt; Show View &gt; Other</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> and selecting the MBean Explorer.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para><diffmk:wrapper diffmk:change="changed">Click the </diffmk:wrapper><emphasis> + <property moreinfo="none">New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject> + + in the <property moreinfo="none">MBean Explorer</property><diffmk:wrapper diffmk:change="changed"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Advanced tab</property></emphasis> and set the JMX URL to <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</diffmk:wrapper></property> + </emphasis></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Using JMX Tools to Access Equinox Server</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/equinox.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </listitem> + </orderedlist> + + <para>You now have access to the MBeans exposed by Equinox.</para> + </section> + + + <section> + <title><diffmk:wrapper diffmk:change="changed">Managing JBoss AS</diffmk:wrapper></title> + + <para>Managing JBoss instances is not supported with the <property moreinfo="none">JMX Tools</property> + alone. You must also download and install the <property moreinfo="none">AS Tools</property> portion of + the <property moreinfo="none">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> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem> + <para>Open the <property moreinfo="none"><diffmk:wrapper diffmk:change="added">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property moreinfo="none">New &gt; Server</property> + </emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property moreinfo="none"><diffmk:wrapper diffmk:change="added">JBoss Enterprise Middleware</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> or in </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none">JBoss Community</property> + </emphasis><diffmk:wrapper diffmk:change="changed"> section, select a server version.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para><diffmk:wrapper diffmk:change="changed">If a runtime has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Finish the wizard and note that you have a new entry in both the + <property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Servers</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> view and the </diffmk:wrapper><property moreinfo="none">MBean + Explorer</property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property moreinfo="none">Start</property></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + </listitem> + <listitem> + <para><diffmk:wrapper diffmk:change="changed">Note that once the server is started, the JMX connection can be + expanded.</diffmk:wrapper></para> + </listitem> + </orderedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Managing JBoss AS Remotely</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss JMX Tool allow you to easily get access and mangane JBoss AS server remotely. + In order to get connected to the instance of JBoss AS remotely you need to run the server or make sure the server is lauched. + </diffmk:wrapper></para> + <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Go to </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window &gt; Open Perspective &gt; Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> and select the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX perspective.</diffmk:wrapper></property></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Switch to the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> by going to </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Window &gt; Show View &gt; Other</diffmk:wrapper></property> + </emphasis><diffmk:wrapper diffmk:change="added"> and selecting the MBean Explorer.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New Connection</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> icon + + </diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added"> + + in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> menu + bar.</diffmk:wrapper></para> + </listitem> + + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Select the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Advanced tab</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and set the JMX URL to: </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></diffmk:wrapper></programlisting> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Please, note that in this example we connected to the local host. </diffmk:wrapper></para> + </listitem> + </orderedlist> + </section> + <section id="extensions" xreflabel="extensions"> + <title>Extension Task</title> + <para>This section will outline how to contribute your own Server type with some default + behavior.</para> + + <section> + <title>Why we should do that?</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>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 responsible 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> + <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&amp;op=viewforum&... forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + + </section> + <section id="connection" xreflabel="connection"> + + <title>Connections Creation Task</title> + + <para>The <property moreinfo="none">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 + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </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. </para> + + + <section><title><diffmk:wrapper diffmk:change="changed">Establishing Connection</diffmk:wrapper></title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + + <para><diffmk:wrapper diffmk:change="changed"> The first step is the same for both - to connect to a MBean Server, click the + </diffmk:wrapper><emphasis> + <property moreinfo="none">New Connection</property></emphasis> icon + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/new_connection_icon.png"></imagedata> + </imageobject> + </inlinemediaobject> + + in the <property moreinfo="none">MBean Explorer</property> 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 <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + <para><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Advanced</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> tab you can set the sever name (it will be displayed in </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">MBean Explorer</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">), a url to the remote server. + For example, to connect to JBoss AS you need to set the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JMX URL</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> to + </diffmk:wrapper></para> + <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ +service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector + ]]></diffmk:wrapper></programlisting> + <para><diffmk:wrapper diffmk:change="changed">If it is required you can enter user name and password for the server connection. + </diffmk:wrapper></para> + + + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> + </section> +</chapter> + + + +<chapter id="references" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/references.xml" xreflabel="references"> + <?dbhtml filename="references.html"?> + <title>References</title> + + <section id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The <property moreinfo="none">MBean Explorer</property> displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a <property moreinfo="none">MBean Editor</property>, display the page + corresponding to the feature type and select the feature.</para> + + <figure float="0"> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Since it's possible to have many MBean Editors opened at the same time, the <property moreinfo="none">MBean Explorer</property> + has the Link With Editor button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/link-with-editor_0.2.0.png"></imagedata> + </imageobject> + </inlinemediaobject> + + to synchronize selections between the active <property moreinfo="none">MBean Editor</property> and + the <property moreinfo="none">MBean Explorer</property> (and vice versa).</para> + + <para>The <property moreinfo="none">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 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> + + <figure float="0"> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>The <emphasis> + <property moreinfo="none">Collapse All</property></emphasis> button + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/collaps_all.png"></imagedata> + </imageobject> + </inlinemediaobject> + + on the <property moreinfo="none">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> + + </section> + <section id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure float="0"> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property moreinfo="none">Info</property></emphasis> page </para> + </listitem> + </itemizedlist> + + <para> The <emphasis> + <property moreinfo="none">Attributes</property> + </emphasis> and <emphasis> + <property moreinfo="none">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"></imagedata> + </imageobject> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure float="0"> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0" id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444"></imagedata> + </imageobject> + <textobject> + <phrase> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </phrase> + </textobject> + </mediaobject> + </figure> + <section> + <title>Notifications Page</title> + <para>One more page in the <property moreinfo="none">MBean Editor</property> is the <emphasis> + <property moreinfo="none">Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property moreinfo="none">Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure float="0"> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + + </section> + + </chapter> + + +<chapter xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en-US/summary.xml"> + <?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.</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. + </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... + JMX Technology Home Page</ulink></para> + </listitem> + </itemizedlist> + </section> +</chapter> + <!--&connection; + &how_to; + &extensions; + &mbean_explorer; + &mbean_editor;--> + +</book> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_editor.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property>Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Info</property></emphasis> 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> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <section> + <title>Notifications Page</title> + <para>One more page in the <property>MBean Editor</property> is the <emphasis> + <property>Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property>Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + +</chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/mbean_explorer.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,62 @@ +<?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 <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> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since it&apos;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> + </inlinemediaobject> + + to synchronize selections between the active <property>MBean Editor</property> and + the <property>MBean Explorer</property> (and vice versa).</para> + + <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&apos;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> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> + + + <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> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/references.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="references" xreflabel="references"> + <?dbhtml filename="references.html"?> + <title>References</title> + + <section id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <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> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since it&apos;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> + </inlinemediaobject> + + to synchronize selections between the active <property>MBean Editor</property> and + the <property>MBean Explorer</property> (and vice versa).</para> + + <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&apos;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> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> + + + <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> + + </section> + <section id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property>Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Info</property></emphasis> 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> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <phrase> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </phrase> + </textobject> + </mediaobject> + </figure> + <section> + <title>Notifications Page</title> + <para>One more page in the <property>MBean Editor</property> is the <emphasis> + <property>Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property>Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + + </section> + + </chapter> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/summary.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter> + <?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.</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. + </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... + JMX Technology Home Page</ulink></para> + </listitem> + </itemizedlist> + </section> +</chapter> \ No newline at end of file Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/en-US/tasks.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,412 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="tasks" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will give you answers on most popular questions asked by <property>JMX + plugin</property> users.</para> + <section> + <title>Quick Start</title> + + <para>To start using the <property>JMX Tools</property> it&apos;s necessary to open + <property>MBean Explorer</property>. Go to <emphasis><property>Window &gt; Show View &gt; 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 the domains, mbeans, attributes, and operations inside a + connection. When you double-click 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><emphasis><property>Attributes page</property>,</emphasis> 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> + </listitem> + <listitem> + <para><emphasis><property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Info page</property>,</emphasis> which displays general information about the MBean </para> + </listitem> + </itemizedlist> + + </section> + + <section> + <title>Managing Application</title> + + + +<para>As it's been said earlier in the guide the JMX technology allows 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 <property>sayHello()</property> method remotely from inside of the <property>MBean Explorer</property>.</para> +<orderedlist> + +<!-- http://java.sun.com/docs/books/tutorial/jmx/examples/jmx_examples.zip --> + +<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</para></listitem> +<listitem><para>Unzip the bundle of sample classes.</para></listitem> +<listitem><para>Compile the example Java classes from within where you unpacked the files directory.</para> + + <programlisting role="XML"><![CDATA[ + javac com/example/*.java + ]]></programlisting> + +</listitem> +<listitem><para>Start the <property>Main</property> application, specifying the properties that expose Main for remote management:</para> + + <programlisting role="XML"><![CDATA[ +java -Dcom.sun.management.jmxremote.port=9999 \ +-Dcom.sun.management.jmxremote.authenticate=false \ +-Dcom.sun.management.jmxremote.ssl=false \ +com.example.Main + ]]></programlisting> + +<para>If everything was done correctly you will see the "Waiting for incoming requests..." message on the screen.</para> + + + </listitem> + <listitem><para>Now launch the Eclipse IDE, in Eclipse open the <property>MBean Explorer</property>. Go to <emphasis><property>Window &gt; Show View &gt; Other</property></emphasis> and then select + <property>MBean Explorer</property> and click <emphasis><property>OK</property></emphasis>)</para></listitem> + <listitem> + <para>Click 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>In the <property>Create JMX Connection</property> dialog, hit <property>Next</property> and then click the <property>Advanced</property> tab. </para></listitem> + + + <listitem><para>In the <property>JMX URL</property> input field enter the following URL:</para> + + <programlisting role="XML"><![CDATA[ + service:jmx:rmi:///jndi/rmi://:9999/jmxrmi + ]]></programlisting> + + <figure> + <title>JMX Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbeans.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Press <property>Finish</property> to esteblish the connection with the application.</para> + </listitem> + + <listitem><para>Now expand the connection you have just created, then open the <property>com.example</property> package and click <property>sayHello()</property> method. </para> + <para>Once the <property>sayHello()</property> method is clicked the <property>MBean Editor</property> is activated. </para> + + </listitem> + + <listitem><para>In the <property>MBean Editor</property> go to the <property>Operation Details</property> section and hit the <property>sayHello()</property> button.</para><para> You will get the "Operation inoked successfully" message. </para> + + <figure> + <title>Ivoking Method via JMX</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/invokemethod.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <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. </para> + </listitem> +</orderedlist> + + + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It&apos;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 <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>.</para> + + + </section> + + <section> + <title>Eclipse Equinox Managing</title> + + <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 make for example 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, you can read for example <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/&qu... this tutorial </ulink> to get 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> + + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>Window &gt; Open Perspective &gt; Other</property> + </emphasis> and select the <property>JMX perspective.</property></para> + </listitem> + + <!--<listitem> + <para>Select <emphasis> + <property>JMX Server &gt; Open Connection</property> + </emphasis> and click <emphasis> + <property>OK</property> + </emphasis></para> + </listitem>--> + + <listitem> + <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> + <property>Window &gt; Show View &gt; Other</property> + </emphasis> and selecting the MBean Explorer.</para> + </listitem> + + <listitem> + <para>Click 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> + + <figure> + <title>Using JMX Tools to Access Equinox Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/equinox.png"/> + </imageobject> + </mediaobject> + </figure> + + </listitem> + </orderedlist> + + <para>You now have access to the MBeans exposed by Equinox.</para> + </section> + + + <section> + <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: </para> + <orderedlist> + <listitem> + <para>Open the <property>Servers</property> view.</para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property>New &gt; Server</property> + </emphasis>.</para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property>JBoss Enterprise Middleware</property> + </emphasis> or in <emphasis> + <property>JBoss Community</property> + </emphasis> section, select a server version.</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you&apos;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>Servers</property> view 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> + </orderedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + + <section> + <title>Managing JBoss AS Remotely</title> + + <para>JBoss JMX Tool allow you to easily get access and mangane JBoss AS server remotely. + In order to get connected to the instance of JBoss AS remotely you need to run the server or make sure the server is lauched. + </para> + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>Window &gt; Open Perspective &gt; Other</property> + </emphasis> and select the <property>JMX perspective.</property></para> + </listitem> + <listitem> + <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> + <property>Window &gt; Show View &gt; Other</property> + </emphasis> and selecting the MBean Explorer.</para> + </listitem> + + <listitem> + <para>Click 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: </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> + </listitem> + </orderedlist> + </section> + <section id="extensions" xreflabel="extensions"> + <title>Extension Task</title> + <para>This section will outline how to contribute your own Server type with some default + behavior.</para> + + <section> + <title>Why we should do that?</title> + + <para>You might be asking yourself why you&apos;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>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 responsible 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> + <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&amp;op=viewforum&... forum</ulink>.</para> + </listitem> + </itemizedlist> + </section> + + </section> + <section id="connection" xreflabel="connection"> + + <title>Connections Creation Task</title> + + <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 + the disconnected state. Some connection types (such as the default connection type) + allow you to control the current state. Other connection types may not. </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. </para> + + + <section><title>Establishing 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 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 and password) and click <emphasis> + <property>OK</property>.</emphasis></para> + <para>On the <property>Advanced</property> tab you can set the sever name (it will be displayed in <property>MBean Explorer</property>), a url to the remote server. + For example, to connect to JBoss AS you need to set the <property>JMX URL</property> 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> + + + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> + </section> +</chapter> + Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/pom.xml 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,179 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>jmx-tools-ref-guide-en-US</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>JMX_Tools_Reference_Guide</name> + + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>${pom.basedir}/target/docbook/staging/css/com/css</cssdir> + </properties> + </profile> + <profile> + <id>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.2.1</version> + <extensions>true</extensions> + + <dependencies> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-jdocbook-style</artifactId> + <type>jdocbook-style</type> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + + + </dependencies> + + <configuration> + <sourceDocumentName>${master}</sourceDocumentName> + <sourceDirectory>${pom.basedir}</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${project.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <!-- needed for uri-resolvers; can be ommitted if using 'current' uri scheme --> + <!-- could also locate the docbook dependency and inspect its version... --> + <docbookVersion>1.72.0</docbookVersion> + </options> + + </configuration> + </plugin> + <plugin> + <artifactId>maven-clean-plugin</artifactId> + <version>2.4</version> + <executions> + <execution> + <id>clean</id> + <phase>package</phase> + <goals> + <goal>clean</goal> + </goals> + </execution> + </executions> + <configuration> + <excludeDefaultDirectories>true</excludeDefaultDirectories> + <filesets> + <fileset> + <directory>${pom.basedir}/target/docbook/publish/en-US/</directory> + <includes> + <include>html/org/</include> + <include>html/org/</include> + <include>html_single/org/</include> + <include>html_single/org/</include> + <include>eclipse/org/</include> + <include>eclipse/org/</include> + </includes> + <followSymlinks>false</followSymlinks> + </fileset> + </filesets> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> + <!-- Copy the dist to the local checkout of the JBoss maven2 repo ${maven.repository.root} --> + <!-- It is anticipated that ${maven.repository.root} be set in user's settings.xml --> + <!-- todo : replace this with direct svn access once the svnkit providers are available --> + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <stylesdir>classpath:/xslt</stylesdir> + <cssdir>${pom.basedir}/target/docbook/staging/css/org/css</cssdir> + <master>master.xml</master> + </properties> +</project> Added: tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg =================================================================== --- tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg (rev 0) +++ tags/jbosstools-3.1.1.GA/jmx/docs/reference/publican.cfg 2010-06-09 00:08:25 UTC (rev 22657) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +