Author: irooskov(a)redhat.com Date: 2011-07-17 22:11:21 -0400 (Sun, 17 Jul 2011) New Revision: 32979 Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Feedback.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Preface.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/invokemethod.png branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/mbeans.png branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/new_connection_icon.png branches/jbosstools-3.2.x/jmx/docs/reference/en-US/introduction.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/master.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/references.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/summary.xml branches/jbosstools-3.2.x/jmx/docs/reference/en-US/tasks.xml branches/jbosstools-3.2.x/jmx/docs/reference/pom.xml Log: updated for GA Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Book_Info.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Book_Info.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -5,9 +5,9 @@ <title>JMX Tools Reference Guide</title> <subtitle>Provides information relating to the JMX Tools module.</subtitle> <productname>JBoss Developer Studio</productname> - <productnumber>4.0</productnumber> - <edition>4.0.0</edition> - <pubsnumber>4</pubsnumber> + <productnumber>4.1</productnumber> + <edition>4.1.0</edition> + <pubsnumber>1</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> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Feedback.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Feedback.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Feedback.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,20 +1,92 @@ <?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "../Document_Conventions.ent"> +%BOOK_ENTITIES; +]> +<appendix id="sect_JBoss-Getting_Help_and_Giving_Feedback" lang="en-US"> + <title>Getting Help and Giving Feedback</title> + <section id="sect_JBoss-Do_You_Need_Help"> + <title>Do You Need Help?</title> + <indexterm> + <primary>help</primary> + <secondary>getting help</secondary> -<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> + </indexterm> + <para> + If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at <ulink url="http://access.redhat.com" />. Through the customer portal, you can: + </para> + <itemizedlist> + <listitem> + <para> + search or browse through a knowledgebase of technical support articles about Red Hat products. + </para> + </listitem> + <listitem> + <para> + submit a support case to Red Hat Global Support Services (GSS). + </para> + </listitem> + <listitem> + <para> + access other product documentation. + </para> + + </listitem> + + </itemizedlist> + <para> + Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at <ulink url="https://www.redhat.com/mailman/listinfo" />. Click on the name of any mailing list to subscribe to that list or to access the list archives. + </para> + + </section> + + <section id="jboss-feedback"> + <title>Give us Feedback</title> + <!-- NOTE: You will need the following entities defined in your .ent file. + You will need to replace _YOUR_PRODUCT_HERE_, _YOUR_COMPONENT_ + and _YOUR_SUMMARY_ - entities are not replaced in URLs. + <!ENTITY PRODUCT "JBoss Product Name"> + <!ENTITY BZCOMPONENT "doc-triage"> + <!ENTITY BZURL "<ulink url='https://bugzilla.example.com/enter_bug.cgi?product=_YOUR_PRODUCT... + + These entities should not affect translated documents, since Bugzilla is not localised. + --> <indexterm> + <primary>feedback</primary> + <secondary>contact information for this manual</secondary> + + </indexterm> + <para> + If you find a typographical error, or know how this guide can be improved, we would love to hear from you. Submit a report in Bugzilla against the product <literal>&BZPRODUCT;</literal> and the component <literal>&BZCOMPONENT;</literal>. The following link will take you to a pre-filled bug report for this product: &BZURL;. + </para> + <para> + Fill out the following template in Bugzilla's <literal>Description</literal> field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly. + </para> + +<screen>Document URL: + + +Section Number and Name: + + +Describe the issue: + + +Suggestions for improvement: + + +Additional information: + + +</screen> + <para> + Be sure to give us your name so that you can receive full credit for reporting the issue. + </para> + + </section> + + +</appendix> + + Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,4 +1,7 @@ <!ENTITY PRODUCT "JBoss"> <!ENTITY BOOKID "JMX_Tools_Reference_Guide"> -<!ENTITY YEAR "2010"> +<!ENTITY YEAR "2011"> <!ENTITY HOLDER "Red Hat"> +<!ENTITY BZPRODUCT "JBoss Developer Studio"> +<!ENTITY BZCOMPONENT "JMX Tools Reference Guide"> +<!ENTITY BZURL "<ulink url='https://bugzilla.redhat.com/enter_bug.cgi?product=JBoss&perc... Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -15,5 +15,6 @@ <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="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </book> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Preface.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Preface.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -8,9 +8,5 @@ <para> This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information. To get more information on these conventions please refer to the <guilabel>Document Conventions</guilabel> manual, which can be found on the <ulink url="http://docs.redhat.com/docs/en-US/JBoss_Developer_Studio/index.... Hat Documentation</ulink> website under the <guilabel>JBoss Developer Studio</guilabel> section. </para> - <!--<xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> - <xi:include 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:fallback> - </xi:include>--> </preface> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Revision_History.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/Revision_History.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -2,31 +2,51 @@ <!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>1</revnumber><date>Wed Jun 09 2010</date> - <author> - <firstname>JBoss Tools</firstname><surname>Documentation Team&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Two new sections added and general updates</member> - </simplelist> - </revdescription> - </revision> - <revision> - <revnumber>0</revnumber><date>Fri Nov 20 2009</date> - <author> - <firstname&gt;Isaac&lt;/firstname&gt;&lt;surname&gt;Rooskov&lt;/surname&gt;&lt;email&gt;irooskov(a)redhat.com&lt;/email&gt; - </author> - <revdescription> - <simplelist> - <member>Initial creation of book by publican</member> - </simplelist> - </revdescription> - </revision> - </revhistory> - </simpara> + <title>Revision History</title> + <simpara> + <revhistory> + <revision> + <revnumber>2</revnumber> + <date>Thu Jan 20 2011</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;mcaspers(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>General updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>1</revnumber> + <date>Wed Jun 09 2010</date> + <author> + <firstname>JBoss Tools</firstname> + <surname>Documentation Team</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Two new sections added and general updates</member> + </simplelist> + </revdescription> + </revision> + <revision> + <revnumber>0</revnumber> + <date>Fri Nov 20 2009</date> + <author> + <firstname>Isaac</firstname> + <surname>Rooskov</surname> + <email&gt;irooskov(a)redhat.com&lt;/email&gt; + </author> + <revdescription> + <simplelist> + <member>Initial creation of book by publican</member> + </simplelist> + </revdescription> + </revision> + </revhistory> + </simpara> </appendix> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/invokemethod.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/mbeans.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/images/new_connection_icon.png =================================================================== (Binary files differ) Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/introduction.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/introduction.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,135 +1,140 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="intruduction"> - <?dbhtml filename="introduction.html"?> + <?dbhtml filename="introduction.html"?> - <title>Introduction</title> - <para><property>JBoss Tools</property>&apos; JMX project is a fork of <ulink - url="http://code.google.com/p/eclipse-jmx/">eclipse-jmx</...;, a project by Jeff Mesnil. + <title>Introduction</title> + <para> + <property>JBoss Tools</property>&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> + <section> + <title>What is JMX?</title> + <para> + The Java Management Extensions (JMX) technology is a standard part of the Java Platform, Standard Edition (Java SE platform). The JMX technology was added to the platform in the Java 2 Platform, Standard Edition (J2SE) 5.0 release. + </para> + <para> + The JMX technology provides a simple, standard way of managing resources such as applications, devices, and services. Because the JMX technology is dynamic, you can use it to monitor and manage resources as they are created, installed and implemented. You can also use the JMX technology to monitor and manage the Java Virtual Machine (Java VM). + </para> + <para> + The JMX specification defines the architecture, design patterns, APIs, and services in the Java programming language for management and monitoring of applications and networks. + </para> + <para> + Using the JMX technology, a given resource is instrumented by one or more Java objects known as Managed Beans, or MBeans. These MBeans are registered in a core-managed object server, known as an MBean server. The MBean server acts as a management agent and can run on most devices that have been enabled for the Java programming language. + </para> - <figure> - <title>JMX Tools</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/eclipse-jmx_0.2.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + <para> + The specifications define JMX agents that you use to manage any resources that have been correctly configured for management. A JMX agent consists of an MBean server, in which MBeans are registered, and a set of services for handling the MBeans. In this way, JMX agents directly control resources and make them available to remote management applications. + </para> + <para> + The way in which resources are instrumented is completely independent from the management infrastructure. Resources can therefore be rendered manageable regardless of how their management applications are implemented. + </para> + <para> + The JMX technology defines standard connectors (known as JMX connectors) that enable you to access JMX agents from remote management applications. JMX connectors using different protocols provide the same management interface. Consequently, a management application can manage resources transparently, regardless of the communication protocol used. JMX agents can also be used by systems or applications that are not compliant with the JMX specification, as long as those systems or applications support JMX agents. + </para> + <para> + <ulink url="http://java.sun.com/docs/books/tutorial/jmx/overview/index.html... more about JMX</ulink>. + </para> + </section> - <section><title>Key Features of JMX Tools</title> - <para>For a start, we propose you to look through the table of main features of JBoss JMX Tools:</para> - <table> - - <title>Key Functionality for JBoss JMX Tools</title> - <tgroup cols="3"> - - <colspec colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="4*"/> - <colspec colnum="3" align="left" colwidth="2*"/> - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - <entry>Chapter</entry> - </row> - </thead> - - <tbody> - - <row> - <entry><para>MBean Explorer</para></entry> - <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry> - <entry> - <xref linkend="mbean_explorer"/> - </entry> - </row> - - <row> - <entry><para>MBean Editor</para></entry> - <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> - <entry> - <xref linkend="mbean_editor"/> - </entry> - </row> - </tbody> - </tgroup> - </table> - </section> - - <section> - <title>Requirements and Installation</title> - <section> - <title> Requirements</title> - <para>Requirements to use <property>JBoss JMX Tools</property> are the following:</para> - - <itemizedlist> - <listitem> - <para><property>JBoss JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> - </listitem> - <listitem> - <para><property>JBoss JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above - (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> - </listitem> - </itemizedlist> - </section> - <section> - <title>Installation</title> - <para>Here, we are going to explain how to install the <property>JMX plugin</property> into - Eclipse.</para> + <section> + <title>What is JMX Tools?</title> + <para> + <productname>JBoss JMX Tools</productname> allows you to setup multiple JMX connections, and provides a view for exploring the JMX tree and execute operations directly from within Eclipse. + </para> - <para><property>JBoss JMX Tools</property> is one module of the <property>JBoss Tools</property> - project. <property> JBoss JMX Tools</property> has no dependency on any other part of <property>JBoss - Tools</property>, and can be downloaded as a standalone Eclipse plugin. Even though the <property>JMX - Tools</property> have no dependencies on other plugins, such as <property>AS Tools</property>, - <property>JBoss JMX Tools</property> do depend on the JMX Tooling and even extend it. </para> + <para> + This chapter covers the basics of working with <productname>JMX plugin</productname>, which is used to manage Java applications (with Managed Beans) through JMX and its RMI Connector. + </para> - <para>You can find the <property>JBoss JBoss Tools</property> plugins over at the <ulink - url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only - package you&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> + <figure> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Key Features of JMX Tools</title> + <para>The table below lists the main features of JBoss JMX Tools:</para> + <table> + + <title>Key Functionality for JBoss JMX Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>MBean Explorer</para> + </entry> + <entry> + <para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para> + </entry> + <entry> + <xref linkend="mbean_explorer"/> + </entry> + </row> + + <row> + <entry> + <para>MBean Editor</para> + </entry> + <entry> + <para>MBean Editor is a multi-page editor to manage MBeans.</para> + </entry> + <entry> + <xref linkend="mbean_editor"/> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <productname>JBoss JMX Tools</productname> are the following:</para> + + <itemizedlist> + <listitem> + <para> + <productname>JBoss JMX Tools</productname> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para> + <productname>JBoss JMX Tools</productname> requires that Eclipse is run on a JDK 1.5.0 or above (due to dependencies on JMX packages which were introduced in Java 1.5.0) + </para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <productname>JMX plugin</productname> into Eclipse.</para> + + <para> + <productname>JBoss JMX Tools</productname> is one module of the <productname>JBoss Tools</productname> project. <productname> JBoss JMX Tools</productname> has no dependency on any other part of <productname>JBoss Tools</productname>, and can be downloaded as a stand alone Eclipse plugin. Even though the <productname>JMX Tools</productname> have no dependencies on other plugins, such as <productname>AS Tools</productname>, <productname>JBoss JMX Tools</productname> do depend on the JMX Tooling and even extend it. + </para> + + <para> + You can find the <productname>JBoss Tools</productname> plugins over at the <ulink url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only package you will need to get is the JBoss JMX Tooling, however the <productname>AS Tools</productname> would give you a wider experience and more options when using JMX with JBoss Servers. You can find further download and installation instructions on the JBoss Wiki in the <ulink url="http://www.jboss.org/tools/download/installation">Insta... section. + </para> + </section> + </section> </chapter> \ No newline at end of file Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/master.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/master.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -52,12 +52,12 @@ <releaseinfo> Version: 1.1.1.GA </releaseinfo> -<abstract> +<!--<abstract> <title/> <para> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_gu... version</ulink> </para> -</abstract> +</abstract>--> </bookinfo> <toc/> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/references.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/references.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/references.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,170 +1,133 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="references"> - <?dbhtml filename="references.html"?> - <title>References</title> - - <section id="mbean_explorer" xreflabel="mbean_explorer"> - <?dbhtml filename="mbean_explorer.html"?> + <?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 <guilabel>MBean Explorer</guilabel> displays the MBean features (both attributes and operations) in its hierarchy. Double-clicking on a feature will open an <property>MBean Editor</property>, displaying the page corresponding to the feature type and select the feature. + </para> + + <figure> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Since it is possible to have many MBean Editors opened at the same time, the <guilabel>MBean Explorer</guilabel> has the <guibutton>Link With Editor</guibutton> button <inlinemediaobject> <imageobject> <imagedata fileref="images/link-with-editor_0.2.0.png"/></imageobject></inlinemediaobject> to synchronize selections between the active <guilabel>MBean Editor</guilabel> and the <guilabel>MBean Explorer</guilabel> (and vice versa). + </para> + + <para> + The <guilabel>MBean Explorer</guilabel> has also a filter that can be used to filter the available MBeans to show those that 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 be displayed. If, however, an attribute or operation name (a leaf node) matches, only that node and its parents in the tree will be displayed. + </para> + + <figure> + <title>Query Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-query.png"/> + </imageobject> + </mediaobject> + </figure> - <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> + + <para> + The <guibutton>Collapse All</guibutton> 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 or 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 <guilabel>Attributes</guilabel> page</para> + </listitem> + <listitem> + <para>the <guilabel>Operations</guilabel> page</para> + </listitem> + <listitem> + <para>the <guilabel>Notifications</guilabel> page </para> + </listitem> + <listitem> + <para>the <guilabel>Info</guilabel> page </para> + </listitem> + </itemizedlist> + + <para> + The <guilabel>Attributes</guilabel> and <guilabel>Operations</guilabel> pages display a list for either the MBean attributes or operations, as well as details about the selection. + </para> + + <para> + It is possible to toggle the layout between the list and the details either vertically (by default) or horizontally with the help of the special icons <inlinemediaobject><imageobject><imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/></imageobject></inlinemediaobject> in the right top corner of the editor. + </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> + The <guilabel>Notifications</guilabel> page provides the ability to subscribe or unsubscribe to an MBean to receive its notifications by checking or unchecking the <guibutton>Subscribe</guibutton> button in the right top corner. + </para> + <para>The list of notifications is refreshed every time a new notification is received:</para> + + <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 an MBean that emits notifications (i.e. they must be a NotificationBroadcaster).</para> + </note> + + </section> + + </section> + +</chapter> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/summary.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/summary.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,32 +1,23 @@ <?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> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para> + This document has provided an overview of the functionality included with JXM Tools, as well as walking you through the steps on managing Tomcat, Eclipse Equinox or JBoss Instances and how to create new JMX connections. If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome to JBoss Tools Users forum. Please, use Jira to report bugs and requests on documentation. + </para> + + <section> + <title>Other relevant resources on the topic</title> + <para> + You can find the JBoss Developer Studio/JBoss Tools release documentation at <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/tool... in the corresponding release directory. + </para> + <para> + The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http...;. + </para> + <para>The JBoss JXM Wiki can be found at <ulink url="http://www.jboss.org/community/wiki/JBossMX">http://www... + <para> + For more information about JMX technology please visit <ulink url="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamana... Technology Home Page</ulink> + </para> + + </section> </chapter> \ No newline at end of file Modified: branches/jbosstools-3.2.x/jmx/docs/reference/en-US/tasks.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/en-US/tasks.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/en-US/tasks.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,162 +1,187 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="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> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will provide answers to common questions asked by <property>JMX plugin</property> users.</para> + <section> + <title>Quick Start</title> + <para> + To start using the <property>JMX Tools</property> it is necessary to open <guilabel>MBean Explorer</guilabel>. Select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem> and click the <guibutton>OK</guibutton> button. + </para> + <para> + The <guilabel>MBean Explorer</guilabel> lists all the domains, MBeans, attributes, and operations inside a connection. When you double-click an MBean in the <guilabel>MBean Explorer</guilabel>, it opens a multi-page editor to manage the MBean. The <guilabel>MBean Editor</guilabel> is composed of these pages: + </para> -<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> + <itemizedlist> + <listitem> + <para> + <guilabel>Attributes page</guilabel>, to get/set the attributes of the MBean</para> + </listitem> + <listitem> + <para> + <guilabel>Operations page</guilabel>, to invoke operations on the MBean</para> + </listitem> + <listitem> + <para> + <guilabel>Notifications page</guilabel>, to receive notifications from the MBean</para> + </listitem> + <listitem> + <para> + <guilabel>Info page</guilabel>, which displays general information about the MBean </para> + </listitem> + </itemizedlist> + </section> + + <section> + <title>Managing Application</title> + + <para> + As it has been said earlier in the guide, the JMX technology allows you to monitor and manage Java applications. In this section we will show you how to get connected to a sample Java application and run the <code>sayHello()</code> method remotely from inside of the <guilabel>MBean Explorer</guilabel>. + </para> + <orderedlist> + <!-- 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> + <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> + <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> + </listitem> + <listitem> + <para>Start the <code>Main</code> application, specifying the properties that expose <code>Main</code> for remote management:</para> - <programlisting role="XML"><![CDATA[ + <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> + ]]></programlisting> + + <para>If everything was done correctly you will see the <screen>Waiting for incoming requests...</screen> message on the screen.</para> -<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 <guilabel>MBean Explorer</guilabel>. Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>, select <guimenuitem>MBean Explorer</guimenuitem>, and then click the <guibutton>OK</guibutton> button) + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar. + </para> + </listitem> + <listitem> + <para> + In the <guilabel>Create JMX Connection</guilabel> dialog, click the <guibutton>Next</guibutton> button and then click the <guilabel>Advanced</guilabel> tab. + </para> + </listitem> - </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> + <listitem> + <para>In the <guilabel>JMX URL</guilabel> input field enter the following URL:</para> + <programlisting role="XML"><![CDATA[service:jmx:rmi:///jndi/rmi://:9999/jmxrmi]]></programlisting> - </section> - <section> - <title>Tomcat Managing</title> + <figure> + <title>JMX Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbeans.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Click the <guibutton>Finish</guibutton> button to establish the connection with the application.</para> + </listitem> + + <listitem> + <para> + Now expand the connection you have just created, open the <guilabel>com.example</guilabel> package, and click the <code>sayHello()</code> method. + </para> + <para>Once the <code>sayHello()</code> method is selected the <guilabel>MBean Editor</guilabel> is activated. </para> + + </listitem> + + <listitem> + <para> + In the <guilabel>MBean Editor</guilabel> go to the <guilabel>Operation Details</guilabel> section and click the <code>sayHello()</code> button. + </para> + <para> You will get the "Operation invoked successfully" message. </para> + + <figure> + <title>Invoking 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 expected. Open the terminal where you launched the application in step 3. You should see output similar to the following: + </para> + + <screen>[matthew@localhost jmx_examples]$ java -Dcom.sun.management.jmxremote.port=9999 \ +> -Dcom.sun.management.jmxremote.authenticate=false \ +> -Dcom.sun.management.jmxremote.ssl=false \ +> com.example.Main +Waiting for incoming requests... +hello, world</screen> + </listitem> + </orderedlist> + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It is 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 <guilabel>com.sun.management.jmxremote.ssl</guilabel> is set to false. + </para> + <para> + More information to manage Tomcat can be found in the <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/">Tomcat management documentation</ulink>. + </para> + <para> + Instructions to remotely manage Tomcat are available in <ulink url="http://tomcat.apache.org/tomcat-6.0-doc/monitoring.html"&g... monitoring documentation</ulink>. + </para> - <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> + + </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 you need to create a simple servlet and run it on a server. The process of building applications and running them on the server is beyond the scope of this documentation, however <ulink url="http://www.eclipse.org/equinox-portal/tutorials/server-side/&qu... this tutorial </ulink> can be used to give you a better idea of how to build server-based applications with Eclipse Equinox. + </para> + <para>Once you have an application running on the server you can connect to it using JBoss JMX tools.</para> + + <orderedlist> + <listitem> + <para> + Go to <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective</guimenuitem>. + </para> + </listitem> <!--<listitem> <para>Select <emphasis> @@ -165,248 +190,189 @@ <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> + <listitem> + <para> + Switch to the <guilabel>MBean Explorer</guilabel> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem> option. + </para> + </listitem> + + <listitem> + <para>Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <property>MBean Explorer</property> menu bar.</para> + </listitem> + + <listitem> + <para> + Select the <guilabel>Advanced tab</guilabel> and set the JMX URL to <guilabel>service:jmx:rmi:///jndi/rmi://:8118/jmxserver.</guilabel> + </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</title> + + <para> + Managing JBoss instances is not supported with the <guilabel>JMX Tools</guilabel> alone. You must also download and install the <guilabel>AS Tools</guilabel> portion of the <guilabel>JBoss Tools</guilabel> distribution. Even after installing the proper tooling, you cannot create a JBoss JMX connection yourself or through the Connection Wizard. The first step is to create a JBoss Server. The full instructions for this can be found in the AS Tools section, however, the short summary is: + </para> + <orderedlist> + <listitem> + <para>Open the <guilabel>Servers</guilabel> view.</para> + </listitem> + + <listitem> + <para>Bring up the views context menu and select <menuchoice><guimenuitem>New</guimenuitem><guimenuitem>Server</guimenuitem></menuchoice>.</para> + </listitem> + + <listitem> + <para>In the <guilabel>JBoss Enterprise Middleware</guilabel> or in <guilabel>JBoss Community</guilabel> section, select a server version.</para> + </listitem> + + <listitem> + <para>If a runtime has not yet been created, you will 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 <guilabel>Servers</guilabel> view and the <guilabel>MBean Explorer</guilabel>. + </para> + </listitem> + + <listitem> + <para>Start the server by right-clicking it and selecting the <guimenuitem>Start</guimenuitem> option.</para> + </listitem> + <listitem> + <para>Note that once the server is started, the JMX connection can be expanded.</para> + </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. + <section> + <title>Managing JBoss AS Remotely</title> + + <para> + The JBoss JMX Tools allow you to easily access and manage a JBoss AS server remotely. In order to connect to the instance of JBoss AS remotely you need to run the server or make sure the server is launched. </para> - <orderedlist> - <listitem> - <para>Go to <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> + <orderedlist> + <listitem> + <para>Select <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and select the <guimenuitem>JMX perspective</guimenuitem> option. + </para> + </listitem> + <listitem> + <para>Switch to the <guilabel>MBean Explorer</guilabel> by selecting <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice> and selecting the <guimenuitem>MBean Explorer</guimenuitem> option.</para> + </listitem> + + <listitem> + <para> + Click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject>in the <guilabel>MBean Explorer</guilabel> menu bar. + </para> + </listitem> + + <listitem> + <para>Select the <guilabel>Advanced</guilabel> tab and set the JMX URL to:</para> + <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting> + + <para>Please note that in this example we are 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 would need to extend this framework if JMX is a standard. Perhaps you want a connection to be automatically created after some specific action, or perhaps you want your connection wizard to do more than simply set a host and port. JBoss, for example, requires setting some credentials on the client machine, but uses JBoss classes to do it. This requires that the connection has access to the JBoss JARs. + </para> + </section> + + <section> + <title>Core Extensions</title> + + <para> + To create your own JMX Connection type, you must use the <code>org.jboss.tools.jmx.core.MBeanServerConnectionProvider</code> extension point. This point takes one child, a connectionProvider with a class that implements <code>org.jboss.tools.jmx.core.IConnectionProvider</code>. + </para> + + <para> + An <code>IConnectionProvider</code> is responsible for creation and deletion of <code>IConnectionWrapper</code> objects. It must also keep a list of listeners that it is expected to notify when a connection is added or removed from its list. + </para> + + <para> + Each <code>IConnectionWrapper</code> is expected to be able to run arbitrary JMX runnables or getting a "Root" object representing all JMX nodes. There are some utility methods the <code>IConnectionWrapper</code> can make use of. + </para> + </section> + + <section> + <title>UI Extensions</title> + <para>There are two extension points currently approved for use in the UI</para> + <itemizedlist> + <listitem> + <para> + <code>org.jboss.tools.jmx.ui.providerUI</code> - provide an icon, id, displayable name, and wizardPage class for creation of new connections + </para> + </listitem> + <listitem> + <para> + <code>org.jboss.tools.jmx.ui.attribute.controls</code> - allows you to map class types to some Control to present them in the MBean Editor + </para> + <para>We hope this guide helped you to get started with the JBoss JMX Tools. For additional information you are welcome on the <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 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>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> + + <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 methods - to connect to a MBean Server, click the <guibutton>New Connection</guibutton> icon <inlinemediaobject><imageobject><imagedata fileref="images/new_connection_icon.png"/></imageobject></inlinemediaobject> in the <guilabel>MBean Explorer</guilabel> menu bar. + </para> + + <para> + The simple method is to specify the host, port (and optionally user name and password) and click the <guibutton>OK</guibutton> button. + </para> + <para> + On the <guilabel>Advanced</guilabel> tab you can set the sever name (it will be displayed in <guilabel>MBean Explorer</guilabel>), and a URL to the remote server. For example, to connect to JBoss AS you need to set the <guilabel>JMX URL</guilabel> to + </para> + <programlisting role="XML"><![CDATA[service:jmx:rmi://localhost/jndi/rmi://localhost:1090/jmxconnector]]></programlisting> + <para>If it is required you can enter user name and password for the server connection. </para> + <note> + <title>Note</title> + <para>Only JMX URL based on RMI are supported.</para> + </note> + </section> + </section> </chapter> Modified: branches/jbosstools-3.2.x/jmx/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.2.x/jmx/docs/reference/pom.xml 2011-07-18 02:08:54 UTC (rev 32978) +++ branches/jbosstools-3.2.x/jmx/docs/reference/pom.xml 2011-07-18 02:11:21 UTC (rev 32979) @@ -1,7 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> -<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"> +<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> @@ -10,229 +8,232 @@ <packaging>jdocbook</packaging> <name>${bookname}-(${translation})</name> - <properties> - <translation>en-US</translation> - <docname>JMX_Tools_Reference_Guide</docname> - <bookname>JMX Tools Reference Guide</bookname> - </properties> - - <profiles> + <properties> + <translation>en-US</translation> + <docname>JMX_Tools_Reference_Guide</docname> + <bookname>JMX Tools Reference Guide</bookname> + </properties> + <profiles> + <!-- mvn compile --> - <profile> - <id>all</id> - <activation> - <activeByDefault>true</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>all</id> + <activation> + <activeByDefault>true</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.4</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <useRelativeImageUris>true</useRelativeImageUris> + </options> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml --> - <profile> - <id>html</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>html</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Phtml-single --> - <profile> - <id>html-single</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - </plugin> + <profile> + <id>html-single</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Ppdf --> - <profile> - <id>pdf</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${docname}.pdf</finalName> - </format> - </formats> - </configuration> - </plugin> + <profile> + <id>pdf</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${docname}.pdf</finalName> + </format> + </formats> + </configuration> + </plugin> </plugins> </build> </profile> <!-- mvn compile -Peclipse --> - <profile> - <id>eclipse</id> - <activation> - <activeByDefault>false</activeByDefault> - </activation> - <build> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <configuration> - <formats> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - </configuration> - </plugin> - </plugins> - </build> - </profile> + <profile> + <id>eclipse</id> + <activation> + <activeByDefault>false</activeByDefault> + </activation> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <configuration> + <formats> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + </configuration> + </plugin> + </plugins> + </build> + </profile> - </profiles> - <build> - <pluginManagement> - <plugins> - <plugin> - <groupId>org.jboss.maven.plugins</groupId> - <artifactId>maven-jdocbook-plugin</artifactId> - <version>2.3.3</version> - <extensions>true</extensions> - <dependencies> - <dependency> - <groupId>org.jboss.pressgang</groupId> - <artifactId>pressgang-xslt</artifactId> - <version>1.2.0</version> - </dependency> - <dependency> - <groupId>org.jboss</groupId> - <artifactId>jbossorg-jdocbook-style</artifactId> - <version>1.1.1</version> - <type>jdocbook-style</type> - </dependency> - </dependencies> - <configuration> - <sourceDirectory>${project.basedir}</sourceDirectory> + </profiles> + <build> + <pluginManagement> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.3.3</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>org.jboss.pressgang</groupId> + <artifactId>pressgang-xslt</artifactId> + <version>1.2.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.1</version> + <type>jdocbook-style</type> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${project.basedir}</sourceDirectory> <!-- <sourceDocumentName>${docname}.xml</sourceDocumentName> --> - <sourceDocumentName>master.xml</sourceDocumentName> - <masterTranslation>en-US</masterTranslation> - <imageResource> - <directory>${project.basedir}/en-US</directory> - <includes> - <include>images/**/*</include> - </includes> - </imageResource> - <formats> - <format> - <formatName>pdf</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> - <finalName>${pdf.name}</finalName> - </format> - <format> - <formatName>html</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>html_single</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - <format> - <formatName>eclipse</formatName> - <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> - <finalName>index.html</finalName> - </format> - </formats> - <options> - <xincludeSupported>true</xincludeSupported> - <xmlTransformerType>saxon</xmlTransformerType> - <docbookVersion>1.72.0</docbookVersion> - <localeSeparator>-</localeSeparator> - <transformerParameters> - <property> - <name>javax.xml.parsers.DocumentBuilderFactory</name> - <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> - </property> - <property> - <name>javax.xml.parsers.SAXParserFactory</name> - <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> - </property> - </transformerParameters> - </options> - </configuration> - </plugin> - </plugins> - </pluginManagement> - </build> + <sourceDocumentName>master.xml</sourceDocumentName> + <masterTranslation>en-US</masterTranslation> + <imageResource> + <directory>${project.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/pdf.xsl</stylesheetResource> + <finalName>${pdf.name}</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/xhtml-single.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>classpath:/xslt/org/jboss/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> + <docbookVersion>1.72.0</docbookVersion> + <localeSeparator>-</localeSeparator> + <transformerParameters> + <property> + <name>javax.xml.parsers.DocumentBuilderFactory</name> + <value>org.apache.xerces.jaxp.DocumentBuilderFactoryImpl</value> + </property> + <property> + <name>javax.xml.parsers.SAXParserFactory</name> + <value>org.apache.xerces.jaxp.SAXParserFactoryImpl</value> + </property> + </transformerParameters> + </options> + </configuration> + </plugin> + </plugins> + </pluginManagement> + </build> </project>