[jbosstools-commits] JBoss Tools SVN: r20781 - in branches/jbosstools-3.1.x/jmx/docs/reference: en-US and 1 other directories.

Author: irooskov(a)redhat.com Date: 2010-03-11 19:30:28 -0500 (Thu, 11 Mar 2010) New Revision: 20781 Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/jmx/docs/reference/en/ Modified: branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml Log: modified to build with publican Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JMX_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,104 @@ +<?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 Tools?</title> + <para><property>JMX Tools</property> allows to setup multiple JMX connections and provides view + for exploring the JMX tree and execute operations directly from Eclipse.</para> + + <para>This chapter covers the basics of working with <property>JMX plugin</property>, which is + used to manage Java applications through JMX and its RMI Connector.</para> + + <figure> + <title>JMX Tools</title> + <mediaobject> + <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 JMX Tools:</para> + <table> + + <title>Key Functionality for 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>JMX Tools</property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property>JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property>JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above + (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <property>JMX plugin</property> into + Eclipse.</para> + + <para><property>JMX Tools</property> is one module of the <property>JBoss Tools</property> + project. <property>JMX Tools</property> has no dependency on any other part of <property>JBoss + Tools</property>, and can be downloaded standalone. Even though the <property>JMX + Tools</property> have no dependencies, other plugins, such as <property>AS Tools</property>, + do depend on the JMX Tooling and even extend it. </para> + + <para>You can find the <property>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 JMX Tooling, however the <property>AS + Tools</property> would give you a more full experience when using JMX with JBoss Servers. + You can find further download and installation instructions on the JBoss Wiki in the <ulink + url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal... + section.</para> + </section> + </section> +</chapter> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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.0.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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,634 @@ +<?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 "modules/introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "modules/mbean_editor.xml"> +<!ENTITY connection SYSTEM "modules/connection.xml"> +<!ENTITY how_to SYSTEM "modules/how_to.xml"> +<!ENTITY extensions SYSTEM "modules/extensions.xml"> +<!ENTITY tasks SYSTEM "modules/tasks.xml"> +<!ENTITY references SYSTEM "modules/references.xml"> +<!ENTITY summary SYSTEM "modules/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.0.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/modules/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> + <title>What is JMX Tools?</title> + <para><property moreinfo="none">JMX Tools</property> allows to setup multiple JMX connections and provides view + for exploring the JMX tree and execute operations directly from Eclipse.</para> + + <para>This chapter covers the basics of working with <property moreinfo="none">JMX plugin</property>, which is + used to manage Java applications through JMX and its RMI Connector.</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>For a start, we propose you to look through the table of main features of JMX Tools:</para> + <table> + + <title>Key Functionality for JMX Tools</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">JMX Tools</property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property moreinfo="none">JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property moreinfo="none">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 moreinfo="none">JMX plugin</property> into + Eclipse.</para> + + <para><property moreinfo="none">JMX Tools</property> is one module of the <property moreinfo="none">JBoss Tools</property> + project. <property moreinfo="none">JMX Tools</property> has no dependency on any other part of <property moreinfo="none">JBoss + Tools</property>, and can be downloaded standalone. Even though the <property moreinfo="none">JMX + Tools</property> have no dependencies, other plugins, such as <property moreinfo="none">AS Tools</property>, + do depend on the JMX Tooling and even extend it. </para> + + <para>You can find the <property moreinfo="none">JBoss Tools</property> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only + package you'll need to get is the JMX Tooling, however the <property moreinfo="none">AS + Tools</property> would give you a more full experience when using JMX with JBoss Servers. + You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">Instal... + section.</para> + </section> + </section> +</chapter> + + +<chapter id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jmx/docs/reference/en/modules/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>, it's necessary to open + <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> lists all of the domains, mbeans, attributes, and operations inside a + connection. When you double-click on a MBean in the <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> + <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>More information to manage Tomcat can be found in Tomcat management + documentation.</para> + <para>Instructions to manage remotely Tomcat are available in Tomcat's monitoring + documentation.</para> + + </section> + + <section> + <title>Eclipse Equinox Managing</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 moreinfo="none">Window &gt; Open Perspective &gt; Other</property> + </emphasis> and select the <property moreinfo="none">JMX perspective</property></para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JMX Server &gt; Open Connection</property> + </emphasis> and click on <emphasis> + <property moreinfo="none">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> and selecting the MBean Explorer</para> + </listitem> + + <listitem> + <para>Click on the <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> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Advanced tab</property></emphasis> and set the JMX URL to <emphasis> + <property moreinfo="none">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 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> + <itemizedlist> + <listitem> + <para>Open the <property moreinfo="none">JBoss Servers View</property> or the <property moreinfo="none">Servers + View</property></para> + </listitem> + + <listitem> + <para>Right-click in the view and select <emphasis> + <property moreinfo="none">New &gt; Server</property> + </emphasis></para> + </listitem> + + <listitem> + <para>In the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> section, select a server version</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you'll be prompted for the + server's home directory, JDK, and configuration</para> + </listitem> + + <listitem> + <para>Finish the wizard and note that you have a new entry in both the + <property moreinfo="none">JBoss Server View</property> and the <property moreinfo="none">MBean + Explorer</property></para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property moreinfo="none">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> + <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>The Default Connection</title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + + <para> The first step is the same for both - to connect to a MBean Server, click on the + <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>The default JMX URL is <emphasis> + <property moreinfo="none">service:jmx:rmi:///jndi/rmi://localhost:3000/jmxrmi</property>.</emphasis></para> + + <para>In case you need to connect to an application which has not used the "standard" JMX URL + (e.g. Eclipse Equinox), you need chose more advance way, where it's necessary to specify + explicitly a JMX URL in the Advanced tab of the JMX Connection window.</para> + + <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/modules/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 diffmk:change="added" float="0" id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Visual Page Editor</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444"></imagedata> + </imageobject> + <textobject diffmk:change="added"> + <phrase diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </diffmk:wrapper></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/modules/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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,259 @@ +<?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 of the domains, mbeans, attributes, and operations inside a + connection. When you double-click on a MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page + editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages:</para> + + <itemizedlist> + <listitem> + <para><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>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 Tomcat management + documentation.</para> + <para>Instructions to manage remotely Tomcat are available in Tomcat&apos;s monitoring + documentation.</para> + + </section> + + <section> + <title>Eclipse Equinox Managing</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>JBoss Servers View</property> or the <property>Servers + View</property></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 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>JBoss Server View</property> and the <property>MBean + Explorer</property></para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting <emphasis> + <property>Start</property></emphasis></para> + </listitem> + <listitem> + <para>Note that once the server is started, the JMX connection can be + expanded</para> + </listitem> + </itemizedlist> + + <para>Now you can explore MBeans exposed by a JBoss instance.</para> + </section> + <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>The Default Connection</title> + + <para> There are two ways to connect to an application with remote management enabled:</para> + + <para> The first step is the same for both - to connect to a MBean Server, click on the + <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> + </section> +</chapter> + Modified: branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-12 00:27:27 UTC (rev 20780) +++ branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -20,11 +20,20 @@ <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>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir> + </properties> + </profile> <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <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> @@ -88,9 +97,9 @@ <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +