March 2010 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r20639 - branches/jbosstools-3.1.x/birt/docs/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-04 05:56:34 -0500 (Thu, 04 Mar 2010) New Revision: 20639 Modified: branches/jbosstools-3.1.x/birt/docs/en/master.xml branches/jbosstools-3.1.x/birt/docs/en/master_output.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/birt/docs/en/master.xml =================================================================== --- branches/jbosstools-3.1.x/birt/docs/en/master.xml 2010-03-04 10:31:39 UTC (rev 20638) +++ branches/jbosstools-3.1.x/birt/docs/en/master.xml 2010-03-04 10:56:34 UTC (rev 20639) @@ -53,14 +53,14 @@ <copyright> <year>2008</year> - <year>2009</year> + <year>2009</year> <year>2010</year> <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.CR1 + Version: 1.1.0.GA </releaseinfo> @@ -81,4 +81,4 @@ &links; -</book> +</book> Modified: branches/jbosstools-3.1.x/birt/docs/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/birt/docs/en/master_output.xml 2010-03-04 10:31:39 UTC (rev 20638) +++ branches/jbosstools-3.1.x/birt/docs/en/master_output.xml 2010-03-04 10:56:34 UTC (rev 20639) @@ -1,6 +1,6 @@ <?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" +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V5.0//EN" +"http://www.docbook.org/xml/5.0/dtd/docbook.dtd" [ <!ENTITY introduction SYSTEM "modules/introduction.xml"> @@ -9,162 +9,170 @@ <!ENTITY birt_reports_deployment SYSTEM "modules/birt_reports_deployment.xml"> <!ENTITY framework SYSTEM "modules/framework.xml"> <!ENTITY tasks SYSTEM "modules/tasks.xml"> -<!ENTITY links SYSTEM "modules/links.xml"> - -<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> +<!ENTITY links SYSTEM "modules/links.xml"> +]><book xmlns="http://docbook.org/ns/docbook" xmlns:diffmk="http://diffmk.sf.net/ns/diff" xmlns:xlink="http://www.w3.org/1999/xlink"> <bookinfo> - <title><diffmk:wrapper diffmk:change="changed">JBoss BIRT Integration User Guide</diffmk:wrapper></title> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration User Guide</title> <corpauthor> - <inlinemediaobject> - <imageobject role="fo"> - <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + <inlinemediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject role="fo" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> - <imageobject role="html"> - <imagedata></imagedata> + <imageobject role="html" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </inlinemediaobject> </corpauthor> - <author diffmk:change="added"><firstname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Michael</diffmk:wrapper></firstname><surname diffmk:change="added"><diffmk:wrapper diffmk:change="added">Sorokin</diffmk:wrapper></surname><email diffmk:change="added"><diffmk:wrapper diffmk:change="added">msorokin(a)exadel.com</diffmk:wrapper></email></author> - <author><firstname>Anastasiya</firstname><surname>Bogachuk</surname><email>abogachuk(a)exadel.com</email></author> - <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Michael</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sorokin</surname><email xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">msorokin(a)exadel.com</email></author> + <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Anastasiya</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Bogachuk</surname><email xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">abogachuk(a)exadel.com</email></author> + <author xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><firstname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Olga</firstname><surname xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Chikvina</surname></author> - <othercredit diffmk:change="added"> + <othercredit xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <contrib diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + <contrib xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Special thanks to Snjezana Peco - </diffmk:wrapper></contrib> + </contrib> </othercredit> + + + + + + + + + - <copyright> - <year>2008</year> - <year>2009</year> - <holder>JBoss by Red Hat</holder> + <copyright xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <year xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">2008</year> + <year xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">2009</year> + <year xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">2010</year> + <holder xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss by Red Hat</holder> </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.CR1 + <releaseinfo xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.GA </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> +<abstract xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"></title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jboss_birt_plugin_re...">PDF version</ulink> </para> </abstract> </bookinfo> - <toc></toc> + <toc xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"></toc> -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/introduction.xml"> +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/introduction.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <?dbhtml filename="introduction.html"?> <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>JBoss</keyword> - <keyword>JBoss Tools</keyword> - <keyword>JBDS</keyword> - <keyword>BIRT Plugin</keyword> + <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Developer Studio</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBDS</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Plugin</keyword> </keywordset> </chapterinfo> - <title>Introduction</title> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Introduction</title> - <section> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>What is BIRT?</title> - <para>BIRT plugin is an Eclipse-based open source reporting system for web applications + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">What is BIRT?</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT plugin is an Eclipse-based open source reporting system for web applications based on Java and J2EE. BIRT consists of two main components: a report designer based on Eclipse, and a runtime component that can be added to your app server. BIRT also offers a charting engine that lets you add charts to your own Web application.</para> - <para>With the help of BIRT you can generate a great number of reports to be used in your + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">With the help of BIRT you can generate a great number of reports to be used in your application:</para> - <itemizedlist> - <listitem> - <para>Lists</para> + <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Lists</para> </listitem> - <listitem> - <para>Charts</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Charts</para> </listitem> - <listitem> - <para>Crosstabs, or cross-tabulation, or matrix</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Crosstabs, or cross-tabulation, or matrix</para> </listitem> - <listitem> - <para>Letters and Documents</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Letters and Documents</para> </listitem> - <listitem> - <para>Compound Reports</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Compound Reports</para> </listitem> </itemizedlist> - <para>You can find more detailed information on the BIRT plugin, its report types and + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can find more detailed information on the BIRT plugin, its report types and anatomy on the <ulink url="http://www.eclipse.org/birt/phoenix/intro/">BIRT Homepage</ulink>.</para> - <para>To understand the basic BIRT concepts and to know how to create a basic BIRT report, + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To understand the basic BIRT concepts and to know how to create a basic BIRT report, refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT - Tutorials</ulink>. What extensions <property moreinfo="none">JBoss Tools</property> provides for + Tutorials</ulink>. What extensions <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> provides for Eclipse BIRT you'll find out in the next sections.</para> </section> - <section> - <title>JBoss BIRT Integration Functionality Overview</title> + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration Functionality Overview</title> - <para><diffmk:wrapper diffmk:change="added"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> The key feature of JBoss BIRT Integration is the JBoss BIRT Integration Framework, which allows to integrate a BIRT report into Seam/JSF container. The framework API reference is in the - </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter of the guide. - </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + <link linkend="framework" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</link> chapter of the guide. + </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - This guide also covers functionality of </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="added"> module which assists in + This guide also covers functionality of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> module which assists in integration with BIRT. - The integration plug-in allows you to visually configure </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (specify a Hibernate configuration or JNDI URL), + The integration plug-in allows you to visually configure <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> (specify a Hibernate configuration or JNDI URL), compose HQL queries with syntax-highlighting, content-assist, formatting as well as other functionalities available in the HQL editor. - </diffmk:wrapper></para> + </para> - <para><diffmk:wrapper diffmk:change="changed"> - To enable </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="changed"> integration with BIRT you are intended to + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + To enable <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> integration with BIRT you are intended to have the next: - </diffmk:wrapper></para> - <itemizedlist> - <listitem> - <para>Eclipse with <property moreinfo="none">JBoss Tools</property> - installed (how to install <property moreinfo="none">JBoss Tools</property> on Eclipse, what - dependences and versions requirements are needed reed in the <ulink diffmk:change="added" url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">JBoss Tools Installation</ulink> section)</para> + </para> + <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse with <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> + installed (how to install <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</property> on Eclipse, what + dependences and versions requirements are needed reed in the <ulink url="#JBossToolsInstall">JBoss Tools Installation</ulink> section)</para> </listitem> - <listitem> - <para>BIRT Report Designer (BIRT Report Designer 2.3.2 + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Designer (BIRT Report Designer 2.3.2 you can download from <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/...">Eclipse downloads site</ulink>)</para> </listitem> - <listitem> - <para>BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Web Tools Integration ( BIRT WTP Integration 2.3.2 you can download from <ulink url="http://www.eclipse.org/downloads/download.php?file=/birt/downloads/drops/...">Eclipse downloads site</ulink>)</para> </listitem> </itemizedlist> - <note> - <title>Note:</title> - <para>Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in + <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Note:</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Versions of BIRT framework and BIRT WTP integration should be no less than RC4 in order to the BIRT facet works correctly.</para> </note> </section> @@ -175,101 +183,105 @@ -<chapter diffmk:change="added" id="tasks" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="tasks"> +<chapter id="tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/tasks.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xreflabel="tasks"> <?dbhtml filename="tasks.html"?> <chapterinfo> - <keywordset> + <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword> - <keyword>JBoss</keyword> - <keyword><diffmk:wrapper diffmk:change="changed">JBoss Tools</diffmk:wrapper></keyword> - <keyword><diffmk:wrapper diffmk:change="changed">BIRT Integration</diffmk:wrapper></keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword> </keywordset> </chapterinfo> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Tasks</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> In this chapter of the guide you will find information on the tasks that you can perform integrating BIRT. The required version of BIRT is 2.3.2 or greater.</diffmk:wrapper></para> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tasks</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> In this chapter of the guide you will find information on the tasks that you can perform integrating BIRT. The required version of BIRT is 2.3.2 or greater.</para> -<section diffmk:change="added" id="birt_integration_with_seam" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_integration_with_seam.xml"> - <title>Adding BIRT Functionality to Standard Seam Web Project</title> +<section id="birt_integration_with_seam" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/birt_integration_with_seam.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</title> - <para><diffmk:wrapper diffmk:change="changed">In this section you'll know how to integrate BIRT into a Seam web project. </diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In this section you'll know how to integrate BIRT into a Seam web project. </para> - <para><diffmk:wrapper diffmk:change="added">You are supposed to have Seam runtime and JBoss Application Server downloaded and + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You are supposed to have Seam runtime and JBoss Application Server downloaded and extracted on your hard drive. You can download Seam from the - </diffmk:wrapper><ulink diffmk:change="added" url="http://seamframework.org/Download"><diffmk:wrapper diffmk:change="added">Seam Framework</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> web page and - JBoss Application Server from </diffmk:wrapper><ulink diffmk:change="added" url="http://jboss.org/jbossas/downloads/"><diffmk:wrapper diffmk:change="added">JBoss Application Server</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> official site. + <ulink url="http://seamframework.org/Download">Seam Framework</ulink> web page and + JBoss Application Server from <ulink url="http://jboss.org/jbossas/downloads/">JBoss Application Server</ulink> official site. - </diffmk:wrapper></para> + </para> <tip> <title>Tip:</title> - <para><diffmk:wrapper diffmk:change="changed">We used </diffmk:wrapper><ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Seam 2.0.1 GA</ulink> and <ulink url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i...">JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para> + <para>We used <ulink + url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i..." + >JBoss Seam 2.0.1 GA</ulink> and <ulink + url="http://sourceforge.net/project/showfiles.php?group_id=22866&package_i..." + >JBoss Application Server 4.2.2 GA</ulink> in examples of this guide.</para> </tip> - <section id="creatin_project_with_birt"> - <title>Creating Seam Web Project with Birt Facet</title> + <section id="creatin_project_with_birt" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project with Birt Facet</title> - <para><diffmk:wrapper diffmk:change="changed">We recommend to open </diffmk:wrapper><property moreinfo="none">Seam perspective</property> by going to <emphasis> - <property moreinfo="none">Window > Open Perspective > Other > Seam</property></emphasis><diffmk:wrapper diffmk:change="changed"> , this way you will have all the tools to work with Seam at hand. - To create a new Seam Web project navigate to </diffmk:wrapper><emphasis> - <property moreinfo="none">File > New > Seam Web Project</property> - </emphasis><diffmk:wrapper diffmk:change="changed">. Otherwise you should go to </diffmk:wrapper><emphasis> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We recommend to open <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam perspective</property> by going to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Window > Open Perspective > Other > Seam</property></emphasis> , this way you will have all the tools to work with Seam at hand. + To create a new Seam Web project navigate to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Seam Web Project</property> + </emphasis>. Otherwise you should go to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <property moreinfo="none">File > New > Other > Seam > Seam Web + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Other > Seam > Seam Web Project</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> if </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Seam</diffmk:wrapper></property><diffmk:wrapper diffmk:change="changed"> perspective is not active.</diffmk:wrapper></para> + </emphasis> if <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam</property> perspective is not active.</para> - <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> + <orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the first wizard page enter the project name, then specify the target runtime and + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the first wizard page enter the project name, then specify the target runtime and target server. We recommend to use JBoss AS server and runtime environment to ensure best performance. - </diffmk:wrapper></para> + </para> - <figure float="0" id="CreatingSeamWebProject"> - <title>Creating Seam Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/testBirtProject.png"></imagedata> + <figure id="CreatingSeamWebProject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/testBirtProject.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> group choose the version of </diffmk:wrapper><emphasis> - <property moreinfo="none">Seam</property> - </emphasis><diffmk:wrapper diffmk:change="added"> framework you are planning to use in your application. In this guide we used Seam 2.2. </diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuration</property></emphasis> group choose the version of <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam</property> + </emphasis> framework you are planning to use in your application. In this guide we used Seam 2.2. </para> </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> button - and enable the </diffmk:wrapper><emphasis> - <property moreinfo="none">Birt Reporting Runtime Component</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> facet by checking the appropriate option.</diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Modify</property></emphasis> button + and enable the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Birt Reporting Runtime Component</property> + </emphasis> facet by checking the appropriate option.</para> - <figure float="0"> - <title>Adding the Birt Reporting Runtime Component Facet </title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/addingBirtFacet.png"></imagedata> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding the Birt Reporting Runtime Component Facet </title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/addingBirtFacet.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> - <para><diffmk:wrapper diffmk:change="changed">Alternatively you can just choose the </diffmk:wrapper><emphasis> - <property moreinfo="none">JBoss BIRT Integration Web Project</property> - </emphasis><diffmk:wrapper diffmk:change="added"> configuration from the drop-down list in the </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Configuration</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> group </diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Alternatively you can just choose the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integration Web Project</property> + </emphasis> configuration from the drop-down list in the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuration</property></emphasis> group </para> - <figure float="0"> - <title>Choosing the JBoss BIRT Integration Web Project Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png"></imagedata> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Choosing the JBoss BIRT Integration Web Project Configuration</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/projectBirtConfiguration.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> @@ -277,21 +289,21 @@ </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">You may leave the next two pages with default values, just press </diffmk:wrapper><emphasis><property moreinfo="none">Next</property></emphasis><diffmk:wrapper diffmk:change="added"> to proceed. - </diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You may leave the next two pages with default values, just press <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Next</property></emphasis> to proceed. + </para> </listitem> - <listitem diffmk:change="added"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis><property moreinfo="none">Birt Configuration</property></emphasis><diffmk:wrapper diffmk:change="changed"> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now. - </diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Birt Configuration</property></emphasis> page you can modify the BIRT deployment settings, which you can edit afterwards in the web.xml of the generated project. Let's keep the default values for now. + </para> - <figure float="0"> - <title>Configuring BIRT Deployment Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/birtDeploymentSettings.png"></imagedata> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuring BIRT Deployment Settings</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/birtDeploymentSettings.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> @@ -300,23 +312,23 @@ </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="changed">You can also leave the </diffmk:wrapper><emphasis><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">JSF Capabilities</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> page with default values. </diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can also leave the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JSF Capabilities</property></emphasis> page with default values. </para> </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">On the </diffmk:wrapper><emphasis diffmk:change="added"> - <property moreinfo="none">Seam Facet</property> - </emphasis><diffmk:wrapper diffmk:change="added"> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the </diffmk:wrapper><link diffmk:change="added" linkend="CreatingSeamWebProject"><diffmk:wrapper diffmk:change="added">Creating Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> figure). </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> When creating a Seam project with BIRT capabilities you can use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> connection profile to work with the BIRT sample database.</diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam Facet</property> + </emphasis> page you should specify the Seam runtime and Connection profile. Please note, that the Seam runtime must be of the version you initially specified in the project settings (See the <link linkend="CreatingSeamWebProject" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Seam Web Project</link> figure). </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> When creating a Seam project with BIRT capabilities you can use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Classic Models Sample Database</property> connection profile to work with the BIRT sample database.</para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For more details on how to configure database connection for a Seam project please read the - </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.html#seamF..."><diffmk:wrapper diffmk:change="added">Configure Seam Facet Settings</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> chapter of Seam Dev Tools Reference Guide.</diffmk:wrapper></para> - <figure float="0"> - <title>Configuring the Seam Facet settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/birt_integration_with_seam/seamFacet.png"></imagedata> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">For more details on how to configure database connection for a Seam project please read the + <ulink url="http://docs.jboss.org/tools/3.0.0.GA/en/seam/html_single/index.html#seamF...">Configure Seam Facet Settings</ulink> chapter of Seam Dev Tools Reference Guide.</para> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Configuring the Seam Facet settings</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/seamFacet.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> @@ -324,75 +336,75 @@ </listitem> - <listitem diffmk:change="added"> - <para>Hit <emphasis> - <property moreinfo="none">Finish</property> - </emphasis><diffmk:wrapper diffmk:change="changed"> to create the project with BIRT functionality enabled.</diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hit <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property> + </emphasis> to create the project with BIRT functionality enabled.</para> </listitem> </orderedlist> </section> - <section id="integration"> - <title>Integration with Seam</title> -<para><diffmk:wrapper diffmk:change="changed"> + <section id="integration" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Integration with Seam</title> +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> In the previous section you have created a Seam project with BIRT capabilities. Now you can create a simple kick start project to see that everything is configured correctly. -</diffmk:wrapper></para> +</para> - <orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> - <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">Now create a BIRT report file and insert test data into the file. - Name the report file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, the report should print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table of the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT Classic Models Sample Database</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">, namely: customer number (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CUSTOMERNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">), - contact person first name ( </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTFIRSTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) , - contact person last name (</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.CONTACTLASTNAME</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">) and - contact person phone number(</diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">CLASSICMODELS.CUSTOMERS.PHONE</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added">). - </diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="added">The title of the report should be set via </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">reportTitle</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> parameter</diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="added"> - As this guide is primarily focused on the BIRT integration and not the BIRT technology itself we will not show the steps required to make the report. If you do not feel strong about creating a BIRT report file please read </diffmk:wrapper><ulink diffmk:change="added" url="http://eclipse.org/birt/phoenix/tutorial/"><diffmk:wrapper diffmk:change="added">BIRT documentation</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. - </diffmk:wrapper></para> - <para><diffmk:wrapper diffmk:change="added">You can download the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property> <ulink diffmk:change="added" url="files/helloBirt.rptdesign"><diffmk:wrapper diffmk:change="added">here</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> and copy it to the WebContent folder of your Seam project.</diffmk:wrapper></para> + <orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now create a BIRT report file and insert test data into the file. + Name the report file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property>, the report should print the data from the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS</code> table of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Classic Models Sample Database</property>, namely: customer number (<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CUSTOMERNAME</code>), + contact person first name ( <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CONTACTFIRSTNAME</code>) , + contact person last name (<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.CONTACTLASTNAME</code>) and + contact person phone number(<code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">CLASSICMODELS.CUSTOMERS.PHONE</code>). + </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The title of the report should be set via <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">reportTitle</code> parameter</para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + As this guide is primarily focused on the BIRT integration and not the BIRT technology itself we will not show the steps required to make the report. If you do not feel strong about creating a BIRT report file please read <ulink url="http://eclipse.org/birt/phoenix/tutorial/">BIRT documentation</ulink>. + </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can download the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property> <ulink url="files/helloBirt.rptdesign">here</ulink> and copy it to the WebContent folder of your Seam project.</para> </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added"> - When you are done with the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.rptdesign</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file, you should create a </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file that will contain the BIRT report you have just created. - </diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + When you are done with the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.rptdesign</property> file, you should create a <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">.xhtml</property> file that will contain the BIRT report you have just created. + </para> - <para><diffmk:wrapper diffmk:change="added"> - The JBoss BIRT Integration framework provides 2 components represented as </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> and </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the </diffmk:wrapper><link diffmk:change="added" linkend="framework"><diffmk:wrapper diffmk:change="added">JBoss BIRT Integraion Framework API Reference</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter. + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The JBoss BIRT Integration framework provides 2 components represented as <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> and <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tags. The jboss-seam-birt.jar library implements the functionality of the components. To find more information about the framework pleas read the <link linkend="framework" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</link> chapter. To use that tags on the page you need to declare the tag library and define the name space like this: - </diffmk:wrapper></para> + </para> - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ xmlns:b="http://jboss.com/products/seam/birt" - ]]></diffmk:wrapper></programlisting> + ]]></programlisting> - <para><diffmk:wrapper diffmk:change="changed"> - The </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> is a container for a BIRT report, that helps you integrate the report into Seam environment. - You can manage the properties of the report using the attributes of the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag. - </diffmk:wrapper></listitem> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> is a container for a BIRT report, that helps you integrate the report into Seam environment. + You can manage the properties of the report using the attributes of the <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> tag. + </para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - The </diffmk:wrapper><emphasis diffmk:change="added" role="bold"> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass. + The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tag describes report parameters. To set a parameter you need to specify it's name the value you want to pass. You can use EL expressions to bind the representation layer with back-end logic. - </diffmk:wrapper></para> + </para> - </orderedlist> + </listitem> - <listitem diffmk:change="added"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <para><diffmk:wrapper diffmk:change="added">Create the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file in the WebContent with the following content: </diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Create the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.xhtml</property> file in the WebContent with the following content: </para> - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[... + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[... <!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <ui:composition xmlns="http://www.w3.org/1999/xhtml" @@ -410,315 +422,321 @@ </rich:panel> </ui:define> </ui:composition> -...]]></diffmk:wrapper></programlisting> +...]]></programlisting> - <para><diffmk:wrapper diffmk:change="changed">From this listing above you see that the title of the report is set via </diffmk:wrapper> <property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:param></diffmk:wrapper></property></para><diffmk:wrapper diffmk:change="added"> by setting the parameter name and defining the </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">"value"</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="changed"> attribute with the "Customers Contacts" value.</diffmk:wrapper></listitem> - <listitem> - <para><diffmk:wrapper diffmk:change="added">We have created a Seam project and inserted the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> report into the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">helloBirt.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> view file.</diffmk:wrapper></para> - - -<para><diffmk:wrapper diffmk:change="added">To see that the application works correctly and as you expect, you need to launch it on the server.</diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">From this listing above you see that the title of the report is set via <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> by setting the parameter name and defining the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">"value"</property></emphasis> attribute with the "Customers Contacts" value.</para> + + </listitem> + + + + + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We have created a Seam project and inserted the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt</property> report into the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">helloBirt.xhtml</property> view file.</para> + + +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To see that the application works correctly and as you expect, you need to launch it on the server.</para> </listitem> - <listitem><para><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> (If it is not open navigate to </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Windows > Show View > Other > JBoss Server View </diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">), select the server the application is deployed to and hit the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Start</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. </diffmk:wrapper></para></listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added">When the server is started, open your favourite browser and point it to </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/helloBirt.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> .</diffmk:wrapper></para> - - -<figure float="0"> - <title><diffmk:wrapper diffmk:change="changed">Integrating BIRT into Seam Project</diffmk:wrapper></title> - <mediaobject> - <imageobject> - <imagedata diffmk:change="added" fileref="images/birt_integration_with_seam/helloBirtproject.png"></imagedata> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Server View </property> (If it is not open navigate to <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Windows > Show View > Other > JBoss Server View </property>), select the server the application is deployed to and hit the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Start</property> button. </para></listitem> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When the server is started, open your favourite browser and point it to <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/HelloBirt/helloBirt.seam</code> .</para> + + +<figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Integrating BIRT into Seam Project</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_integration_with_seam/helloBirtproject.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> -</figure> +</figure> </listitem> - </section> - </section> - <section id="hibernate_datasource"> + </orderedlist> + + </section> +</section> + +<section id="hibernate_datasource" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/hibernate_datasource.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <title>Using Hibernate ODA Data Source</title> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Using Hibernate ODA Data Source</title> - <para>The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The JBoss BIRT Integration feature includes the Hibernate ODA Data Source which is completely integrated with Hibernate Tools. You can use it the way as you would use any of BIRT ODA drivers. </para> -<orderedlist> - <listitem> - <para>First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis> - <property>File > New > Seam Generate Entities</property> - </emphasis> in the <property>Seam perspective</property>. More details on the Seam Generate - Entities please read <ulink - url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..." - >Seam Dev Tools Reference guide</ulink>). - In this guide we will use the <property>Employees</property> table of the <property>DATAMODELS</property> database. +<orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">First, you need to reverse engineer from the database to generate Seam entities. You can perform this operation going to <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Seam Generate Entities</property> + </emphasis> in the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Seam perspective</property>. More details on the Seam Generate + Entities please read <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">Seam Dev Tools Reference guide</ulink>). + In this guide we will use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Employees</property> table of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">DATAMODELS</property> database. </para> - <tip> - <title>Tip:</title> - <para>Before performing Seam Generate Entities, you should have a connection profile - adjusted and connected to a database. How to do this see in the <ulink - url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..." - >CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference + <tip xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tip:</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Before performing Seam Generate Entities, you should have a connection profile + adjusted and connected to a database. How to do this see in the <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">CRUD Database Application</ulink> chapter of the Seam Dev Tools Reference guide.</para> - <para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> If you followed the steps described in the - <link linkend="birt_integration_with_seam">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, - you would have a connection profile already configured. + <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, + you would have a connection profile already configured. </para> </tip> </listitem> - <listitem> -<para> - Next you should create a new BIRT report file ( <emphasis>><property>File > New > Other > Business Intelligence and Reporting - Tools > Report</property></emphasis>) to represent the data from the <property>Employees</property> table. Call the file <property>employees.rptdesign</property>. + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + Next you should create a new BIRT report file ( <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">File > New > Other > Business Intelligence and Reporting + Tools > Report</property></emphasis>) to represent the data from the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Employees</property> table. Call the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">employees.rptdesign</property>. </para> </listitem> -<listitem> - - - <para>Now switch to the <property>BIRT Report Design</property> perspective.</para> +<listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now switch to the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Design</property> perspective.</para> </listitem> - <listitem> - <para>In the <property>Data Explorer</property> view right-click the <emphasis> - <property>Data Source</property> - </emphasis> node and choose <emphasis> - <property>New Data Source</property>.</emphasis></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer</property> view right-click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Source</property> + </emphasis> node and choose <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Source</property>.</emphasis></para> - <figure> - <title>Creating a New Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/creatingDataSource.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a New Data Source</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/creatingDataSource.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem> - <para>The wizard will prompt you to select data source type. Choose <emphasis> - <property>Hibernate Data Source</property> - </emphasis> and give it a meaningful name, for instance <emphasis> - <property>HibernateDataSource</property> - </emphasis>. Hit <emphasis> - <property>Next</property> to proceed.</emphasis></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The wizard will prompt you to select data source type. Choose <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> + </emphasis> and give it a meaningful name, for instance <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSource</property> + </emphasis>. Hit <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Next</property> to proceed.</emphasis></para> - <figure> - <title>Creating Hibernate Data Source</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating Hibernate Data Source</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/hibernateDataSource.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem> - <para>On the next wizard's dialog you can leave the everything with default values, press the <emphasis> - <property>Test Connection</property> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">On the next wizard's dialog you can leave the everything with default values, press the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Test Connection</property> </emphasis> button to verify that the connection is established successfully.</para> - - <para> - The <property>Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL. - + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> enables you to specify a Hibernate Configuration or JNDI URL. + </para> - <figure> - <title>Hibernate Data Source Profile</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source Profile</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/connectionSuccessful.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem> - <para>Press <emphasis> - <property>Finish</property> - </emphasis> to complete <property>New Data Source</property> wizard.</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Press <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property> + </emphasis> to complete <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Source</property> wizard.</para> </listitem> + + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you need to configure a new Hibernate ODA data set. Launch the + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Set</property> wizard. In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer View</property> + right-click the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Set</property> + </emphasis> node and select <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">New Data Set</property>.</emphasis></para> - <listitem> - <para>Now you need to configure a new Hibernate ODA data set. Launch the - <property>New Data Set</property> wizard. In the <property>Data Explorer View</property> - right-click the <emphasis> - <property>Data Set</property> - </emphasis> node and select <emphasis> - <property>New Data Set</property>.</emphasis></para> - </listitem> - <listitem> - <para>Select <property>HibernateDataSource</property> as target data source and type in the new data set name. - Call it <property>HibernateDataSet</property>.</para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Select <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSource</property> as target data source and type in the new data set name. + Call it <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property>.</para> - <figure> - <title>Creating a Hibernate ODA Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a Hibernate ODA Data Set</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/addingHibernateODADataset.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <para>The next dialog of the wizard will help you compose a query for the new data set.</para> - <para>We will make a report that will print all employees in the database who has Sales Rep job title.</para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The next dialog of the wizard will help you compose a query for the new data set.</para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We will make a report that will print all employees in the database who has Sales Rep job title.</para> - <programlisting role="SQL"><![CDATA[... + <programlisting role="SQL" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[... select jobtitle, firstname, lastname, email from Employees as employees where employees.jobtitle = 'Sales Rep' -...]]></programlisting> - - - - <para> - +...]]></programlisting> + + + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + To validate the - entered query you can press the <emphasis> - <property>Test query</property> + entered query you can press the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Test query</property> </emphasis> button. All the HQL features like syntax highlighting, content assist, formatting, drag-and-drop, etc., are available to facilitate query composing.</para> - <figure> - <title>Composing query for Data Set</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/testingQuery.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Composing query for Data Set</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/testingQuery.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> - <listitem> - - <para>Pressing <property>Finish</property> will call the <property>Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set. - If everything looks good, hit <property>Ok</property> to generate a new data set. + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Pressing <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Finish</property> will call the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Edit Data Set</property> dialog where you can adjust the parameters of the data set and preview the resulted set. + If everything looks good, hit <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Ok</property> to generate a new data set. </para> </listitem> - <listitem> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you can insert the data set items of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property> into the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">employees.rptdesign</property>.</para> + - <para>Now you can insert the data set items of <property>HibernateDataSet</property> into the <property>employees.rptdesign</property>.</para> - - - <tip> - <title>Tip:</title> - <para>If you don't know how to do this we suggest that you refer to the <ulink - url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> + <tip xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Tip:</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">If you don't know how to do this we suggest that you refer to the <ulink url="http://www.eclipse.org/birt/phoenix/tutorial/">Eclipse BIRT Tutorial</ulink>.</para> </tip> + - -<para>You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code>where</code> clause. </para> - <para>To specify the job title on-the-fly your query should look like this:</para> - <programlisting role="XML"><![CDATA[ +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You can also use parameters in the query to add dynamics to your report. In the previous example we hardcoded the selection criterion in the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">where</code> clause. </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To specify the job title on-the-fly your query should look like this:</para> + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ select jobtitle,firstname, lastname,email from Employees as employees where employees.jobtitle = ? -]]></programlisting> - - <para>The question mark represents a data set input parameter, which is not the same as a report parameter. - Now you need to define an new report parameter to pass the data to the report, call it <code>JobTitle</code>. - - - +]]></programlisting> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The question mark represents a data set input parameter, which is not the same as a report parameter. + Now you need to define an new report parameter to pass the data to the report, call it <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JobTitle</code>. + + + The dataset parameter can be linked to a report parameter. - In the <property>Data Explorer</property> view click the Data Set node to open it and right-click - on the data set you created previously( in our case it is <property>HibernateDataSet</property>), - choose <property>Edit</property> and navigate to the <property>Parameters</property> section. - Declare a new data set parameter, name it <code>jobtitle</code> and map it to the already existing <code>JobTitle</code> report parameter. + In the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Data Explorer</property> view click the Data Set node to open it and right-click + on the data set you created previously( in our case it is <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">HibernateDataSet</property>), + choose <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Edit</property> and navigate to the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Parameters</property> section. + Declare a new data set parameter, name it <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">jobtitle</code> and map it to the already existing <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JobTitle</code> report parameter. </para> </listitem> - <listitem> - <para>You report is ready, you can view it by clicking on the <property>Preview</property> tab of the <property>BIRT Report Designer</property> editor. </para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You report is ready, you can view it by clicking on the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Preview</property> tab of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Report Designer</property> editor. </para> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">You will be prompted to assign a value to the report parameter. For instance you can enter "Sales Rep". </para> - <para>You will be prompted to assign a value to the report parameter. For instance you can enter "Sales Rep". </para> - - <figure> - <title>Resulted Dynamic Report</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/finalReport.png"/> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Resulted Dynamic Report</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/hibernate_datasource/finalReport.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> </orderedlist> </section> - <section diffmk:change="added" id="birt_reports_deployment" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/birt_reports_deployment.xml"> - <title><diffmk:wrapper diffmk:change="changed">Creating a Dynamic BIRT Report</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> - and </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Using Hibernate ODA Data Sourc</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> sections tell how to integrate a BIRT report into + +<section id="birt_reports_deployment" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/birt_reports_deployment.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Creating a Dynamic BIRT Report</title> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link> + and <link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Using Hibernate ODA Data Sourc</link> sections tell how to integrate a BIRT report into a Seam web project and how to use Hibernate data source to generate a dynamic report. - In this section we will create a Seam web project that can make a dynamic report using the parameters that are defined on a web page.</diffmk:wrapper></para> + In this section we will create a Seam web project that can make a dynamic report using the parameters that are defined on a web page.</para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We will use the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">PRODUCTS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> table of </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">DATAMODELS</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> database for the purpose of this demo project. - In the first place, you need to generate Seam entities like we did in the previous chapter (</diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> ). The demo application will generate a report about the company's products, whereas it will allow to specify a product line. </diffmk:wrapper></para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We will use the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">PRODUCTS</property> table of <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">DATAMODELS</property> database for the purpose of this demo project. + In the first place, you need to generate Seam entities like we did in the previous chapter (<link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate ODA Data Source</link> ). The demo application will generate a report about the company's products, whereas it will allow to specify a product line. </para> -<orderedlist continuation="restarts" diffmk:change="added" inheritnum="ignore"> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The next step is to create a Java class that will store the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> variable and its assessors, register the class in faces.config.xml. - The variable will be needed to pass dynamic data to the report via report parameters, therefore it has to be of session scope.</diffmk:wrapper></para> +<orderedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The next step is to create a Java class that will store the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> variable and its assessors, register the class in faces.config.xml. + The variable will be needed to pass dynamic data to the report via report parameters, therefore it has to be of session scope.</para> </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added"> - - - The report will print the data from the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">Products</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> table, hence you need to create a report file first. - You can use either the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">BIRT JDBC Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Hibernate Data Source</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> data source to create the data set for this project. If you want to use the latter please read the previous chapter </diffmk:wrapper><link diffmk:change="added" linkend="hibernate_datasource"><diffmk:wrapper diffmk:change="added">Hibernate ODA Data Source</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. -</diffmk:wrapper></para> - - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + + The report will print the data from the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products</code> table, hence you need to create a report file first. + You can use either the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT JDBC Data Source</property> or <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate Data Source</property> data source to create the data set for this project. If you want to use the latter please read the previous chapter <link linkend="hibernate_datasource" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Hibernate ODA Data Source</link>. +</para> + + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> The data set should have at least the following data set items: product vendor, product name, quantity in stock and buy price. The data is retrieved from the database with this query : - </diffmk:wrapper></para> - - - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + </para> + + + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ SELECT productvedor, productname, quantityinstock, buyprice -FROM Products as products +FROM Products as products -]]></diffmk:wrapper></programlisting> +]]></programlisting> </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Make a table in the report and put each data set item into a column.</diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Make a table in the report and put each data set item into a column.</para> </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">As it was stated in the beginning of the chapter the report will be dynamic, therefore you need to declare a report parameter first, let it be </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> and to add the parameter to the query. BIRT offers rich JavaScript API, so you can modify the query programmatically like this:</diffmk:wrapper></para> -<programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">As it was stated in the beginning of the chapter the report will be dynamic, therefore you need to declare a report parameter first, let it be <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> and to add the parameter to the query. BIRT offers rich JavaScript API, so you can modify the query programmatically like this:</para> +<programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <xml-property name="queryText"><![CDATA[ SELECT productvedor, productname, quantityinstock, buyprice -FROM Products as products +FROM Products as products ]]></xml-property> <method name="beforeOpen"><![CDATA[ queryString = " ORDER BY products."+reportContext.getParameterValue("sortOrder")+" "+"DESC"; this.queryText = this.queryText+queryString; ]]></method> - -</diffmk:wrapper></programlisting> + +</programlisting> </listitem> - <listitem diffmk:change="added"> -<para><diffmk:wrapper diffmk:change="changed">The report is ready. You can preview it to make sure it works properly. </diffmk:wrapper></para> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The report is ready. You can preview it to make sure it works properly. </para> </listitem> - <listitem diffmk:change="added"> <para><diffmk:wrapper diffmk:change="added">To set the report parameter you should create an </diffmk:wrapper><property moreinfo="none">.xhtml</property><diffmk:wrapper diffmk:change="added"> view page, call it </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. On the page you can set the value of the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> Java bean variable and press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button to open another view page that will display the resulted report. - </diffmk:wrapper></para> - - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The source code of the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> should be the following:</diffmk:wrapper></para> - - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">To set the report parameter you should create an <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">.xhtml</property> view page, call it <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property>. On the page you can set the value of the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> Java bean variable and press the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Generate Report</property> button to open another view page that will display the resulted report. + </para> + + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The source code of the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property> should be the following:</para> + + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ <!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <ui:composition xmlns="http://www.w3.org/1999/xhtml" @@ -731,7 +749,7 @@ <ui:define name="body"> <rich:panel> <f:facet name="header">BIRT Report Generator</f:facet> - <a4j:form ajaxSubmit="true" reRender="criterion"> + <a4j:form ajaxSubmit="true" reRender="criterion"> <table> <tr> <td>Select sort order criterion:</td> @@ -742,384 +760,417 @@ </h:selectOneMenu> </td> </tr> - </table> + </table> </a4j:form> <s:button view="/#{!empty reportParameters.order ? 'Products' : 'ProductsReport'}.xhtml" id="generate" value="Generate Report" />  </rich:panel> </ui:define> -</ui:composition> -]]></diffmk:wrapper></programlisting> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The logic of the file is quite simple, when the sort order criterion is select the value of </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">yourJavaBean.sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> - is set automatically via Ajax and the report is ready to be generated.</diffmk:wrapper></para> +</ui:composition> +]]></programlisting> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The logic of the file is quite simple, when the sort order criterion is select the value of <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">yourJavaBean.sortOrder</code> + is set automatically via Ajax and the report is ready to be generated.</para> </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added">Now you need to create the web page that will print the report, name the file </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">ProductsReport.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. - The file to output the report should have the following content:</diffmk:wrapper></para> - - - <para><diffmk:wrapper diffmk:change="added"> - As you know from the </diffmk:wrapper><link diffmk:change="added" linkend="birt_integration_with_seam"><diffmk:wrapper diffmk:change="added">Adding BIRT Functionality to Standard Seam Web Project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> chapter, before using the BIRT Integration framework tags on the page you need to declare the tag library and specify the name space with this line: - </diffmk:wrapper></para> - - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Now you need to create the web page that will print the report, name the file <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">ProductsReport.xhtml</property>. + The file to output the report should have the following content:</para> + +<programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ +<!DOCTYPE composition PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<ui:composition xmlns="http://www.w3.org/1999/xhtml" + xmlns:s="http://jboss.com/products/seam/taglib" + xmlns:ui="http://java.sun.com/jsf/facelets" + xmlns:f="http://java.sun.com/jsf/core" + xmlns:h="http://java.sun.com/jsf/html" xmlns:b="http://jboss.com/products/seam/birt" -]]></diffmk:wrapper></programlisting> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> - The dynamics to the report adds this line: - </diffmk:wrapper></para> - <programlisting diffmk:change="added" format="linespecific" role="XML"><diffmk:wrapper diffmk:change="added"><![CDATA[ + xmlns:rich="http://richfaces.org/rich" template="layout/template.xhtml"> + <ui:define name="body"> + <rich:panel> + <f:facet name="header">Products Report</f:facet> + <b:birt designType="embed" designName="products.rptdesign" + embeddable="true" masterpage="true"> + <b:param name="sortOrder" value="#{yourJavaBean.sortOrder}" /> + </b:birt> + </rich:panel> +</ui:define> +</ui:composition> +]]></programlisting> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + As you know from the <link linkend="birt_integration_with_seam" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Adding BIRT Functionality to Standard Seam Web Project</link> chapter, before using the BIRT Integration framework tags on the page you need to declare the tag library and specify the name space with this line: + </para> + + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ + xmlns:b="http://jboss.com/products/seam/birt" +]]></programlisting> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The dynamics to the report adds this line: + </para> + <programlisting role="XML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[ <b:param name="sortOrder" value="#{yourJavaBean.sortOrder}" /> -]]></diffmk:wrapper></programlisting> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">We bound the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">sortOrder</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> report parameter to Java Bean variable </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">value="#{yourJavaBean.sortOrder}"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> using EL expression, and the value to the variable is assigned in the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Products.xhtml</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> file. </diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By default if you embed a report into HTML page the HTML-format report contains the <html>, - <head>, <body> etc., tags. However if your HTML page already has those tags, you can rid of them using the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">embeddable="true"</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> attribute of - - the </diffmk:wrapper><emphasis diffmk:change="added" role="bold"><property moreinfo="none"><diffmk:wrapper diffmk:change="changed"><b:birt></diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> component.</diffmk:wrapper></para> +]]></programlisting> + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">We bound the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">sortOrder</code> report parameter to Java Bean variable <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">value="#{yourJavaBean.sortOrder}"</code> using EL expression, and the value to the variable is assigned in the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Products.xhtml</property> file. </para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">By default if you embed a report into HTML page the HTML-format report contains the <html>, + <head>, <body> etc., tags. However if your HTML page already has those tags, you can rid of them using the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">embeddable="true"</code> attribute of + + the <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> component.</para> </listitem> - <listitem diffmk:change="added"> - <para><diffmk:wrapper diffmk:change="added">Deploy the project onto the server and open your browser to see the report is successfully generated. You should navigate to - - </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/yourProjectName/Products.seam</diffmk:wrapper></code><diffmk:wrapper diffmk:change="added"> to select the criterion and press the </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Generate Report</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. You will be redirected to the </diffmk:wrapper><code diffmk:change="added"><diffmk:wrapper diffmk:change="added">http://localhost:8080/HelloBirt/ProductsReport.seam</diffmk:wrapper></code> - - </para> - <figure float="0"> - <title><diffmk:wrapper diffmk:change="changed">Dynamic Report</diffmk:wrapper></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/hibernate_datasource/finalReport.png"/> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Deploy the project onto the server and open your browser to see the report is successfully generated. You should navigate to + + <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/yourProjectName/Products.seam</code> to select the criterion and press the <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Generate Report</property> button. You will be redirected to the <code xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">http://localhost:8080/HelloBirt/ProductsReport.seam</code> + + </para> + <figure xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Dynamic Report</title> + <mediaobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imageobject xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <imagedata fileref="images/birt_reports_deployment/productReport.png" xmlns="http://docbook.org/ns/docbook"></imagedata> </imageobject> </mediaobject> </figure> </listitem> </orderedlist> - <para><diffmk:wrapper diffmk:change="changed">Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Thus, a Seam project that includes the BIRT facet can be deployed as any project. If you define the Hibernate ODA driver, the JBoss BIRT engine will use JNDI URL that has to be bound to either Hibernate Session Factory or Hibernate Entity Manager Factory. If you don't specify the JNDI URL property, our engine will try the following JNDI - URLs:</diffmk:wrapper></para> - <itemizedlist> - <listitem> - <para> - <emphasis>java:/<project_name></emphasis> + URLs:</para> + <itemizedlist xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/<project_name></emphasis> </para> </listitem> - <listitem> - <para> - <emphasis>java:/<project_name>EntityManagerFactory</emphasis> + <listitem xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/<project_name>EntityManagerFactory</emphasis> </para> </listitem> </itemizedlist> - <para>When creating a Seam EAR project, Hibernate Entity Manager Factory is bound to - <emphasis>java:/{projectName}EntityManagerFactory</emphasis><diffmk:wrapper diffmk:change="changed">. All you need to do is + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When creating a Seam EAR project, Hibernate Entity Manager Factory is bound to + <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/{projectName}EntityManagerFactory</emphasis>. All you need to do is to use the Hibernate Configuration created automatically. You can use default values for the - Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</diffmk:wrapper></para> + Hibernate Configuration and JNDI URL within the BIRT Hibernate Data Source.</para> - <para><diffmk:wrapper diffmk:change="changed">When using a Seam WAR project, neither HSF nor HEMF aren't bound to JNDI by + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">When using a Seam WAR project, neither HSF nor HEMF aren't bound to JNDI by default. You have to do this manually. For instance, HSF can be bound to JNDI by adding the - following property to the </diffmk:wrapper><emphasis> - <property moreinfo="none">persistence.xml</property></emphasis> file:</para> + following property to the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">persistence.xml</property></emphasis> file:</para> - <programlisting format="linespecific" role="XHTML"><![CDATA[<property name="hibernate.session_factory_name" value="java:/projectname"/> + <programlisting role="XHTML" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><![CDATA[<property name="hibernate.session_factory_name" value="java:/projectname"/> ]]></programlisting> - <para>And you can use <emphasis>java:/projectname</emphasis> as the JNDI URL property when creating a BIRT + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">And you can use <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">java:/projectname</emphasis> as the JNDI URL property when creating a BIRT Hibernate Data Source.</para> - <note> - <title>Note:</title> - <para>If you want to test this feature using PDE Runtime, you need to add <emphasis> - <property moreinfo="none">osgi.dev=bin</property> - </emphasis> to the <emphasis> - <property moreinfo="none">WebContent/WEB-INF/platform/configuration/config.ini</property> + <note xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Note:</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">If you want to test this feature using PDE Runtime, you need to add <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">osgi.dev=bin</property> + </emphasis> to the <emphasis xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">WebContent/WEB-INF/platform/configuration/config.ini</property> </emphasis> file.</para> </note> - - <para><diffmk:wrapper diffmk:change="changed">In conclusion, the main goal of this document is to get you to know with a full feature set - that </diffmk:wrapper><property moreinfo="none">JBoss BIRT Tools</property> provide. Thus if you have some questions, - comments or suggestions on the topic, please feel free to ask in the <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">JBoss + + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">In conclusion, the main goal of this document is to get you to know with a full feature set + that <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Tools</property> provide. Thus if you have some questions, + comments or suggestions on the topic, please feel free to ask in the + <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">JBoss Tools Forum</ulink>. You can also influence on how you want to see JBoss Tools docs in - future leaving your vote on the article <ulink url="http://www.jboss.org/community/docs/DOC-10795">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.</para> + future leaving your vote on the article <ulink + url="http://www.jboss.org/community/docs/DOC-10795">Overview of the improvements required by JBossTools/JBDS Docs users</ulink>.</para> </section> - </chapter> -<chapter diffmk:change="added" id="framework" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/tasks.xml" xreflabel="framework"> + +</chapter> + + +<chapter id="framework" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/framework.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <?dbhtml filename="framework.html"?> <chapterinfo> - <keywordset> + <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <keyword>Eclipse</keyword> - <keyword>JBoss</keyword> - <keyword>JBoss Tools</keyword> - <keyword>BIRT Integration</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword> </keywordset> </chapterinfo> - <title>JBoss BIRT Integraion Framework API Reference</title> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss BIRT Integraion Framework API Reference</title> -<section> - - <title> - <emphasis role="bold"> <property><b:birt></property></emphasis> Component +<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> Component </title> - - - -<para> - The <emphasis role="bold"> <property><b:birt></property></emphasis> component servers to integrate a BIRT report into Seam/JSF container. - The <emphasis role="bold"> <property><b:birt></property></emphasis> tag recognizes most of the parameters described on the BIRT + + + +<para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> component servers to integrate a BIRT report into Seam/JSF container. + The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> tag recognizes most of the parameters described on the BIRT <ulink url="http://www.eclipse.org/birt/phoenix/deploy/viewerUsage2.2.php#parameters">Report Viewer Parameters</ulink> page, though it has attributes of its own. - + </para> - - - <table> - <title><emphasis role="bold"> <property><b:birt></property></emphasis> Component Reference</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Attribute</entry> - <entry>Correspondance to BIRT Report Viewer parameters</entry> - <entry>Description/</entry> - + + + <table xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:birt></property></emphasis> Component Reference</title> + <tgroup cols="3" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <thead xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Attribute</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Correspondance to BIRT Report Viewer parameters</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Description/</entry> + </row> </thead> - <tbody> - <row> - <entry>designType</entry> - <entry> - </entry> - <entry>Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed. - If the attribute is set to embed the component is used for - embeddable html. This type ignores all the attributes except designName + <tbody xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">designType</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - </entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Corresponds to the BIRT servlet mappings. Possible values are run, frameset, preview and embed. + If the attribute is set to embed the component is used for + embeddable html. This type ignores all the attributes except designName and masterpage. </entry> - </row> - <row> - <entry>embeddable</entry> - <entry> - </entry> - <entry>A BIRT report occupies the whole page by default. It contains the <html>, + </row> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">embeddable</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - </entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">A BIRT report occupies the whole page by default. It contains the <html>, <head>, <body> etc., tags. Embedded report can be a part of another page. It doesn't contain the above mentioned tags. Only HTML report can be embedded.</entry> - </row> - <row> - <entry>designName</entry> - <entry>__report</entry> - <entry>Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview</entry> - </row> - - <row> - <entry>format</entry> - <entry>__format</entry> - <entry>Specifies the desired output format, such as pdf, html, doc, ppt, or xls.</entry> - </row> - - <row> - <entry>title</entry> - <entry>__title</entry> - <entry>Sets the report title.</entry> - </row> - - <row> - <entry>showtitle</entry> - <entry>__showtitle</entry> - <entry>Determines if the report title is shown in the frameset viewer. Defaults to true.</entry> - </row> - - <row> - <entry>toolbar</entry> - <entry>__toolbar</entry> - <entry> - + </row> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">designName</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__report</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sets the name of the report design to process. This can be an absolute path or relative to the working folder. Valid values are run, frameset and preview</entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">format</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__format</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies the desired output format, such as pdf, html, doc, ppt, or xls.</entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">title</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__title</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Sets the report title.</entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">showtitle</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__showtitle</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Determines if the report title is shown in the frameset viewer. Defaults to true.</entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">toolbar</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__toolbar</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + Determines if the report toolbar is shown in the frameset viewer.Defaults to true. Valid values are true and false.</entry> - </row> - - - - <row> - <entry>navigationbar</entry> - <entry>__navigationbar</entry> - <entry> - + </row> + + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">navigationbar</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__navigationbar</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + Determines if the navigation bar is shown in the frameset viewer. Defaults to true. Valid values are true and false.</entry> - </row> - - - <row> - <entry>document</entry> - <entry>__document</entry> - <entry> + </row> + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">document</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__document</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Sets the name for the rptdocument. The document is created when the report engine separates run and render tasks, and - is used to support features like table of contents and pagination. + is used to support features like table of contents and pagination. This setting can be an absolute path or relative to the working folder. If no document parameter is used, a unique document is created in the document folder. </entry> - </row> - - <row> - <entry>locale</entry> - <entry>__locale</entry> - <entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">locale</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__locale</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies the locale for the specific operation. Note that this will override the default locale. </entry> - </row> - <row> - <entry>svg</entry> - <entry>__svg</entry> - <entry> + </row> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">svg</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__svg</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies whether SVG is supported. </entry> - </row> - - - - <row> - <entry>page</entry> - <entry>__page</entry> - <entry> + </row> + + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">page</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__page</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies specific page to render. </entry> - </row> - - - <row> - <entry>pagerange</entry> - <entry>__pagerange</entry> - <entry> + </row> + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">pagerange</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__pagerange</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies page range to render. Eg 1-4,7. </entry> - </row> - - - <row> - <entry>masterpage</entry> - <entry>__masterpage</entry> - <entry> - + </row> + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">masterpage</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__masterpage</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + Indicates that the report master page should be used or not. Validvalues are true and false. </entry> </row> - - - <row> - <entry>overwrite</entry> - <entry>__overwrite</entry> - <entry> - - This setting if set to true will force an overwrite of the existing report document. + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">overwrite</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__overwrite</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + + This setting if set to true will force an overwrite of the existing report document. </entry> </row> - - <row> - <entry>bookmark</entry> - <entry>__bookmark</entry> - <entry> - + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">bookmark</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__bookmark</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + Specifies a specific bookmark within the report to load. The viewer will automatically load the appropriate page. </entry> </row> - - - - <row> - <entry>rtl</entry> - <entry>__rtl</entry> - <entry> + + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">rtl</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__rtl</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies whether to display the report in right to left format. This setting defaults to false. </entry> </row> - - - - <row> - <entry>fittopage</entry> - <entry>__fittopage</entry> - <entry> + + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">fittopage</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__fittopage</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies whether PDF generation should fit content to a page. Valid values are true and false. </entry> </row> - - - <row> - <entry>resourceFolder</entry> - <entry>__resourceFolder</entry> - <entry> + + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">resourceFolder</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">__resourceFolder</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> Specifies the resource folder to use. This setting will override the default setting in the web.xml. The resource folder is used to locate libraries, images, and resource files. </entry> </row> - + </tbody> </tgroup> </table> - + </section> - - <section> - <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title> - <para> - The <emphasis role="bold"> <property><b:param></property></emphasis> tag describes report parameter. + + <section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> Component</title> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + The <emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> tag describes report parameter. </para> - - <table> - <title><emphasis role="bold"> <property><b:param></property></emphasis> Component</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Attribute</entry> - - <entry>Description</entry> + + <table xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><emphasis role="bold" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <property xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><b:param></property></emphasis> Component</title> + <tgroup cols="2" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <thead xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Attribute</entry> + + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Description</entry> </row> </thead> - <tbody> - <row> - <entry>name</entry> - <entry>The parameter name. Required.</entry> - </row> - <row> - <entry>value</entry> - <entry>The parameter value. Required.</entry> - </row> - - <row> - <entry>isnull</entry> - <entry>Specifies that a report parameter has a null value</entry> - </row> - <row> - <entry>islocale</entry> - <entry>Specifies whether the parameter is localized</entry> - </row> - + <tbody xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">name</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The parameter name. Required.</entry> + </row> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">value</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The parameter value. Required.</entry> + </row> + + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">isnull</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies that a report parameter has a null value</entry> + </row> + <row xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">islocale</entry> + <entry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Specifies whether the parameter is localized</entry> + </row> + </tbody> - + </tgroup> </table> </section> + + + + + + </chapter> -<chapter diffmk:change="added" id="birt_plugin_rel_resources" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/birt/docs/en/modules/links.xml" xreflabel="birt_plugin_rel_resources"> + + +<chapter id="birt_plugin_rel_resources" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/birt/docs/en/modules/links.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xreflabel="birt_plugin_rel_resources"> <?dbhtml filename="links.html"?> - <chapterinfo diffmk:change="added"> - <keywordset diffmk:change="added"> + <chapterinfo> + <keywordset xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> - <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">Eclipse</diffmk:wrapper></keyword> - <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss</diffmk:wrapper></keyword> - <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Tools</diffmk:wrapper></keyword> - <keyword diffmk:change="added"><diffmk:wrapper diffmk:change="added">BIRT Integration</diffmk:wrapper></keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Eclipse</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">JBoss Tools</keyword> + <keyword xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">BIRT Integration</keyword> </keywordset> </chapterinfo> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Other Relevant Resources on the Topic</diffmk:wrapper></title> + <title xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">Other Relevant Resources on the Topic</title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All JBoss Developer Studio/JBoss Tools release documentation you can find at </diffmk:wrapper><ulink diffmk:change="added" url="http://docs.jboss.org/tools/"><diffmk:wrapper diffmk:change="added">http://docs.jboss.org/tools</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> in the corresponding release directory.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The latest documentation builds are available at </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/nightly-docs/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/nightly-docs</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added">. + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">All JBoss Developer Studio/JBoss Tools release documentation you can find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>. -</diffmk:wrapper></para> +</para> </chapter>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20638 - branches/jbosstools-3.1.x/jmx/docs/reference/en/modules.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-04 05:31:39 -0500 (Thu, 04 Mar 2010) New Revision: 20638 Removed: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/connection.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/extensions.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/how_to.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_editor.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_explorer.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Deleted: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/connection.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/connection.xml 2010-03-04 10:26:02 UTC (rev 20637) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/connection.xml 2010-03-04 10:31:39 UTC (rev 20638) @@ -1,54 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="connection" xreflabel="connection"> - <?dbhtml filename="connection.html"?> - - <title>Connections</title> - - <para>The <property>MBean Explorer</property> supports several different types of connections. - The tooling itself comes only with a default connection type, however other - 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's necessary to specify - explicitly a JMX URL in the Advanced tab of the JMX Connection window.</para> - - <note> - <title>Note</title> - <para>Only JMX URL based on RMI are supported.</para> - </note> - </section> -</chapter> Deleted: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/extensions.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/extensions.xml 2010-03-04 10:26:02 UTC (rev 20637) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/extensions.xml 2010-03-04 10:31:39 UTC (rev 20638) @@ -1,54 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="extensions" xreflabel="extensions"> - <?dbhtml filename="extensions"?> - <title>Extension API</title> - <para>This chapter will outline how to contribute your own Server type with some default - behavior.</para> - - <section> - <title>Why??</title> - - <para>You might be asking yourself why you'd need to extend this framework if JMX is - a standard. Perhaps you want a connection to be automatically created after some specific - action, or perhaps you want your connection wizard to do more than simply set a host and - port. JBoss, for example, requires setting some credentials on the client machine, but - using JBoss classes to do it. This requires that the connection have access to JBoss - jars.</para> - </section> - - <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&op=viewforum&f=201">JBoss forum</ulink>.</para> - </listitem> - </itemizedlist> - </section> - -</chapter> Deleted: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/how_to.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/how_to.xml 2010-03-04 10:26:02 UTC (rev 20637) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/how_to.xml 2010-03-04 10:31:39 UTC (rev 20638) @@ -1,130 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="how_to" xreflabel="how_to"> - <?dbhtml filename="how_to.html"?> - <title>How to ...</title> - <para>This chapter will give you answers on most popular questions asked by <property>JMX - plugin</property> users.</para> - - <section> - <title>How to Manage Tomcat</title> - - <para>It's possible to manage Tomcat using <property>JMX Tools</property>.</para> - - <para>Currently, JMX Tooling is able to connect to Tomcat without authentication or with - password-based authentication.</para> - <para>Using SSL for authentication is not supported: you need to make sure that the System - property <emphasis> - <property>com.sun.management.jmxremote.ssl</property> - </emphasis> is set to false. </para> - <para>More information to manage Tomcat can be found in Tomcat management - documentation.</para> - <para>Instructions to manage remotely Tomcat are available in Tomcat's monitoring - documentation.</para> - - </section> - - <section> - <title>How to manage Eclipse Equinox</title> - - <para>You can manage Equinox through the Equinox monitoring framework.</para> - <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para> - - <itemizedlist> - <listitem> - <para>Go to <emphasis> - <property>Window > Open Perspective > Other</property> - </emphasis> and select the <property>JMX perspective</property></para> - </listitem> - - <listitem> - <para>Select <emphasis> - <property>JMX Server > Open Connection</property> - </emphasis> and click on <emphasis> - <property>OK</property> - </emphasis></para> - </listitem> - - <listitem> - <para>Switch to the <property>MBean Explorer</property> by going to <emphasis> - <property>Window > Show View > Other</property> - </emphasis> and selecting the MBean Explorer</para> - </listitem> - - <listitem> - <para>Click on the <emphasis> - <property>New Connection</property></emphasis> icon - - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/new_connection_icon.png"/> - </imageobject> - </inlinemediaobject> - - in the <property>MBean Explorer</property> menu - bar </para> - </listitem> - - <listitem> - <para>Select the <emphasis> - <property>Advanced tab</property></emphasis> and set the JMX URL to <emphasis> - <property>service:jmx:rmi:///jndi/rmi://:8118/jmxserver</property> - </emphasis></para> - </listitem> - </itemizedlist> - - <para>You now have access to the MBeans exposed by Equinox.</para> - </section> - - - <section> - <title>Managing JBoss Instances</title> - - <para>Managing JBoss instances is not supported with the <property>JMX Tools</property> - alone. You must also download and install the <property>AS Tools</property> portion of - the <property>JBoss Tools</property> distribution. Even after installing the proper - tooling, you cannot create a JBoss JMX connection yourself or through the Connection - Wizard. The first step is to create a JBoss Server. The full instructions for this can - be found in the AS Tools section, however, the short summary is: </para> - <itemizedlist> - <listitem> - <para>Open the <property>JBoss Servers View</property> or the <property>Servers - View</property></para> - </listitem> - - <listitem> - <para>Right-click in the view and select <emphasis> - <property>New > Server</property> - </emphasis></para> - </listitem> - - <listitem> - <para>In the <emphasis> - <property>JBoss Community</property> - </emphasis> section, select a server version</para> - </listitem> - - <listitem> - <para>If a runtime has not yet been created, you'll be prompted for the - server's home directory, JDK, and configuration</para> - </listitem> - - <listitem> - <para>Finish the wizard and note that you have a new entry in both the - <property>JBoss Server View</property> and the <property>MBean - Explorer</property></para> - </listitem> - - <listitem> - <para>Start the server by right-clicking it and selecting <emphasis> - <property>Start</property></emphasis></para> - </listitem> - <listitem> - <para>Note that once the server is started, the JMX connection can be - expanded</para> - </listitem> - </itemizedlist> - - <para>Now you can explore MBeans exposed by a JBoss instance.</para> - </section> - -</chapter> Deleted: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_editor.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_editor.xml 2010-03-04 10:26:02 UTC (rev 20637) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_editor.xml 2010-03-04 10:31:39 UTC (rev 20638) @@ -1,91 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="mbean_editor" xreflabel="mbean_editor"> - <?dbhtml filename="mbean_editor.html"?> - - <title>MBean Editor</title> - - <figure> - <title>MBean Editor Pages</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/mbean-editor_0.2.0.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The <property>MBean Editor</property> is composed of several pages:</para> - - <itemizedlist> - <listitem> - <para>the <emphasis> - <property>Attributes</property></emphasis> page</para> - </listitem> - <listitem> - <para>the <emphasis> - <property>Operations</property></emphasis> page</para> - </listitem> - <listitem> - <para>the <emphasis> - <property>Notifications</property></emphasis> page </para> - </listitem> - <listitem> - <para>the <emphasis> - <property>Info</property></emphasis> page </para> - </listitem> - </itemizedlist> - - <para> The <emphasis> - <property>Attributes</property> - </emphasis> and <emphasis> - <property>Operations</property> - </emphasis> pages display a list for either the MBean attributes or operations as well as - details for the selection.</para> - - <para> It is possible to toggle the layout between the list and the details either vertically - (by default) or horizontally with the help of the special icons - - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/> - </imageobject> - </inlinemediaobject> - - in the right top corner of the editor.</para> - - <figure> - <title>MBean Editor Horizontal Layout</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> - </imageobject> - </mediaobject> - </figure> - - <section> - <title>Notifications Page</title> - <para>One more page in the <property>MBean Editor</property> is the <emphasis> - <property>Notifications</property></emphasis> page, which gives the possibility to - subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. - unchecking) the <emphasis> - <property>Subscribe</property></emphasis> button in the right top corner. </para> - <para>The list of notifications is refreshed every time a new notification is - received:</para> - - <figure> - <title>MBean Editor Notifications Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/notifications.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note</title> - <para>It is only possible to subscribe to MBean, which emits notifications (they must be - NotificationBroadcaster).</para> - </note> - - </section> - -</chapter> Deleted: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_explorer.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_explorer.xml 2010-03-04 10:26:02 UTC (rev 20637) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/mbean_explorer.xml 2010-03-04 10:31:39 UTC (rev 20638) @@ -1,62 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="mbean_explorer" xreflabel="mbean_explorer"> - <?dbhtml filename="mbean_explorer.html"?> - - <title>MBean Explorer</title> - <para>The <property>MBean Explorer</property> displays the MBean features (both attributes and operations) in its - hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, display the page - corresponding to the feature type and select the feature.</para> - - <figure> - <title>MBean Explorer Features</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/mbean-explorer-features.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Since it'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's parents and children. So if an MBean matches, all attributes and operations from - that bean will show. If, however, an attribute or operation name (a leaf node) matches, - only that node and its parents in the tree will show.</para> - - <figure> - <title>Query Filter</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/mbean-explorer-query.png"/> - </imageobject> - </mediaobject> - </figure> - - - <para>The <emphasis> - <property>Collapse All</property></emphasis> button - - <inlinemediaobject> - <imageobject> - <imagedata fileref="images/collaps_all.png"/> - </imageobject> - </inlinemediaobject> - - on the <property>MBean Explorer</property> toolbar is used to collapse all the MBeans and - display only the domains. It is also possible to double click on a node to expand/collapse it. </para> - -</chapter>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20637 - in branches/jbosstools-3.1.x/jmx/docs/reference: en and 1 other directories.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2010-03-04 05:26:02 -0500 (Thu, 04 Mar 2010) New Revision: 20637 Modified: branches/jbosstools-3.1.x/jmx/docs/reference/en/master.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/master_output.xml branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/references.xml branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml Log: <html><head><meta name="qrichtext" content="1" /></head><body style="font-size:9pt;font-family:Sans Serif"> <p>https://jira.jboss.org/jira/browse/JBDS-1107 -Updated docs source files here with the ones for JBDS 3.0.0 GA release. </p> <p></p> </body></html> Modified: branches/jbosstools-3.1.x/jmx/docs/reference/en/master.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/master.xml 2010-03-04 07:56:48 UTC (rev 20636) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/master.xml 2010-03-04 10:26:02 UTC (rev 20637) @@ -50,7 +50,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.CR1 + Version: 1.1.0.GA </releaseinfo> <abstract> <title/> Modified: branches/jbosstools-3.1.x/jmx/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/master_output.xml 2010-03-04 07:56:48 UTC (rev 20636) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/master_output.xml 2010-03-04 10:26:02 UTC (rev 20637) @@ -8,8 +8,9 @@ <!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"> @@ -23,594 +24,611 @@ <!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.CR1 - </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink> - </para> -</abstract> - - </bookinfo> - - - <toc></toc> - -<chapter id="intruduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/introduction.xml" xreflabel="introduction"> - <?dbhtml filename="introduction.html"?> - - <title>Introduction</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> - <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>History</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</ulink>, a project by Jeff Mesnil. - It was forked with permission. </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 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>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">InstallingJBossTools</ulink> - section.</para> - </section> - - - <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 > Show View > 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>Other relevant resources on the topic</title> - - <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> - - </itemizedlist> - - - - </section> - -</chapter> - - -<chapter id="mbean_explorer" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/mbean_explorer.xml" 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> - -</chapter> - - -<chapter id="mbean_editor" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/mbean_editor.xml" 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> - - <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> - -</chapter> - - -<chapter id="connection" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/connection.xml" xreflabel="connection"> - <?dbhtml filename="connection.html"?> - - <title>Connections</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> -</chapter> - - -<chapter id="how_to" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/how_to.xml" xreflabel="how_to"> - <?dbhtml filename="how_to.html"?> - <title>How to ...</title> - <para>This chapter will give you answers on most popular questions asked by <property moreinfo="none">JMX - plugin</property> users.</para> - - <section> - <title>How to Manage Tomcat</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>How to manage Eclipse Equinox</title> - - <para>You can manage Equinox through the Equinox monitoring framework.</para> - <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para> - - <itemizedlist> - <listitem> - <para>Go to <emphasis> - <property moreinfo="none">Window > Open Perspective > Other</property> - </emphasis> and select the <property moreinfo="none">JMX perspective</property></para> - </listitem> - - <listitem> - <para>Select <emphasis> - <property moreinfo="none">JMX Server > 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 > Show View > 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 > 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> - -</chapter> - - -<chapter id="extensions" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/jmx/docs/reference/en/modules/extensions.xml" xreflabel="extensions"> - <?dbhtml filename="extensions"?> - <title>Extension API</title> - <para>This chapter will outline how to contribute your own Server type with some default - behavior.</para> - - <section> - <title>Why??</title> - - <para>You might be asking yourself why you'd need to extend this framework if JMX is - a standard. Perhaps you want a connection to be automatically created after some specific - action, or perhaps you want your connection wizard to do more than simply set a host and - port. JBoss, for example, requires setting some credentials on the client machine, but - using JBoss classes to do it. This requires that the connection have access to JBoss - jars.</para> - </section> - - <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&op=viewforum&f=201">JBoss forum</ulink>.</para> - </listitem> - </itemizedlist> - </section> - -</chapter> - -</book> +]><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_guide/pdf/JM...">PDF 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</ulink>, 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">InstallingJBossTools</ulink> + 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 > Show View > 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 > Open Perspective > Other</property> + </emphasis> and select the <property moreinfo="none">JMX perspective</property></para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JMX Server > 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 > Show View > 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 > 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&op=viewforum&f=201">JBoss 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/tools</ulink> in the corresponding release directory. + </para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs">http://download.jboss.org/jbosstools/nightly-docs</ulink>. </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/javamanagement/"> + JMX Technology Home Page</ulink></para> + </listitem> + </itemizedlist> + </section> +</chapter> +  + +</book> Modified: branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/references.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/references.xml 2010-03-04 07:56:48 UTC (rev 20636) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en/modules/references.xml 2010-03-04 10:26:02 UTC (rev 20637) @@ -125,7 +125,19 @@ </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> Modified: branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-04 07:56:48 UTC (rev 20636) +++ branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-04 10:26:02 UTC (rev 20637) @@ -20,20 +20,11 @@ <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_output.xml</master> + <master>master.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>

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20636 - in trunk: jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette and 2 other directories.

by jbosstools-commits＠lists.jboss.org

Author: dmaliarevich Date: 2010-03-04 02:56:48 -0500 (Thu, 04 Mar 2010) New Revision: 20636 Modified: trunk/common/plugins/org.jboss.tools.common.model.ui/src/org/jboss/tools/common/model/ui/editors/dnd/DropWizard.java trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/DataTableWizard.java trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/OutputLinkWizard.java trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/PanelGridWizard.java trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/SelectItemsWizard.java trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/ReferenceWizardPage.java trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/VpeResourcesDialog.java trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeEditAnyDialog.java Log: Images for some Drop From Palette Dialogs and Wizards were added. Modified: trunk/common/plugins/org.jboss.tools.common.model.ui/src/org/jboss/tools/common/model/ui/editors/dnd/DropWizard.java =================================================================== --- trunk/common/plugins/org.jboss.tools.common.model.ui/src/org/jboss/tools/common/model/ui/editors/dnd/DropWizard.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/common/plugins/org.jboss.tools.common.model.ui/src/org/jboss/tools/common/model/ui/editors/dnd/DropWizard.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -15,6 +15,7 @@ import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.jface.wizard.Wizard; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.editors.dnd.composite.TagProposalsComposite; /** @@ -31,6 +32,8 @@ */ public DropWizard() { setWindowTitle(DropWizardMessages.Wizard_Window_Title); + setDefaultPageImageDescriptor(ModelUIImages + .getImageDescriptor(ModelUIImages.WIZARD_DEFAULT)); } public void setCommand(IDropCommand command) { Modified: trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/DataTableWizard.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/DataTableWizard.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/DataTableWizard.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -17,6 +17,7 @@ import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.jface.wizard.Wizard; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.editors.dnd.*; import org.jboss.tools.common.model.ui.editors.dnd.composite.TagProposalsComposite; import org.jboss.tools.jst.jsp.jspeditor.dnd.PaletteDropCommand; @@ -31,6 +32,8 @@ public DataTableWizard () { setWindowTitle(DropWizardMessages.Wizard_Window_Title); + setDefaultPageImageDescriptor(ModelUIImages + .getImageDescriptor(ModelUIImages.WIZARD_DEFAULT)); } Modified: trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/OutputLinkWizard.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/OutputLinkWizard.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/OutputLinkWizard.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -16,6 +16,7 @@ import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.jface.wizard.Wizard; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.editors.dnd.*; import org.jboss.tools.common.model.ui.editors.dnd.composite.*; import org.jboss.tools.jst.jsp.jspeditor.dnd.PaletteDropCommand; @@ -31,6 +32,8 @@ public OutputLinkWizard (){ setWindowTitle(DropWizardMessages.Wizard_Window_Title); + setDefaultPageImageDescriptor(ModelUIImages + .getImageDescriptor(ModelUIImages.WIZARD_DEFAULT)); } public boolean canFinish() { Modified: trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/PanelGridWizard.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/PanelGridWizard.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/PanelGridWizard.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -15,6 +15,7 @@ import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.jface.wizard.Wizard; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.editors.dnd.*; import org.jboss.tools.common.model.ui.editors.dnd.composite.*; import org.jboss.tools.jst.jsp.jspeditor.dnd.PaletteDropCommand; @@ -32,6 +33,8 @@ */ public PanelGridWizard() { setWindowTitle(DropWizardMessages.Wizard_Window_Title); + setDefaultPageImageDescriptor(ModelUIImages + .getImageDescriptor(ModelUIImages.WIZARD_DEFAULT)); } public void setCommand(IDropCommand command) { Modified: trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/SelectItemsWizard.java =================================================================== --- trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/SelectItemsWizard.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/jsf/plugins/org.jboss.tools.jsf.ui/src/org/jboss/tools/jsf/ui/wizard/palette/SelectItemsWizard.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -16,6 +16,7 @@ import org.eclipse.jface.wizard.IWizardPage; import org.eclipse.jface.wizard.Wizard; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.editors.dnd.*; import org.jboss.tools.common.model.ui.editors.dnd.composite.*; import org.jboss.tools.jst.jsp.jspeditor.dnd.PaletteDropCommand; @@ -32,6 +33,8 @@ public SelectItemsWizard() { setWindowTitle(DropWizardMessages.Wizard_Window_Title); + setDefaultPageImageDescriptor(ModelUIImages + .getImageDescriptor(ModelUIImages.WIZARD_DEFAULT)); } public boolean canFinish() { Modified: trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeEditAnyDialog.java =================================================================== --- trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeEditAnyDialog.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/vpe/plugins/org.jboss.tools.vpe/src/org/jboss/tools/vpe/editor/template/VpeEditAnyDialog.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -41,7 +41,7 @@ import org.eclipse.swt.widgets.Label; import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.Text; -import org.jboss.tools.common.model.ui.ModelUIPlugin; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.jst.jsp.JspEditorPlugin; import org.jboss.tools.jst.jsp.outline.cssdialog.CSSStyleDialog; import org.jboss.tools.jst.jsp.outline.cssdialog.common.Constants; @@ -50,9 +50,6 @@ import org.jboss.tools.vpe.editor.Message; import org.jboss.tools.vpe.editor.template.expression.VpeExpressionBuilderException; import org.jboss.tools.vpe.messages.VpeUIMessages; -import org.jboss.tools.vpe.resref.Activator; -import org.jboss.tools.vpe.resref.core.Messages; -import org.osgi.framework.Bundle; import org.w3c.dom.DOMException; import org.w3c.dom.Document; @@ -71,7 +68,6 @@ private Text txtValue; private Text txtStyle; private VpeEditAnyDialogValidator templateVerifier; - private final String DIALOG_TITLE_IMAGE_PATH = "/images/xstudio/wizards/EclipseDefault.png"; //$NON-NLS-1$ public VpeEditAnyDialog(Shell shell, VpeAnyData data) { super(shell); @@ -84,23 +80,10 @@ /* * Setting dialog Title, Message, Image. */ - Bundle bundle = Platform.getBundle(ModelUIPlugin.PLUGIN_ID); - URL url = null; - if (null != bundle) { - try { - url = FileLocator.resolve(bundle.getEntry(DIALOG_TITLE_IMAGE_PATH)); - } catch (IOException e) { - Activator.getDefault().logError( - NLS.bind(Messages.VRD_TITLE_IMAGE_CANNOT_BE_RESOLVED, - url), e); - } - } - if (null != url) { - ImageDescriptor image = ImageDescriptor.createFromURL(url); - setTitleImage(image.createImage(null)); - } getShell().setText(VpeUIMessages.TEMPLATE); setTitle(VpeUIMessages.TAG_ATTRIBUTES); + setTitleImage(ModelUIImages.getImageDescriptor( + ModelUIImages.WIZARD_DEFAULT).createImage(null)); setMessage(VpeUIMessages.UNKNOWN_TAGS_DIALOG_DESCRIPTION); /* Modified: trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/ReferenceWizardPage.java =================================================================== --- trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/ReferenceWizardPage.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/ReferenceWizardPage.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -1,13 +1,7 @@ package org.jboss.tools.vpe.resref.core; -import java.io.IOException; -import java.net.URL; - -import org.eclipse.core.runtime.FileLocator; -import org.eclipse.core.runtime.Platform; import org.eclipse.jface.resource.ImageDescriptor; import org.eclipse.jface.wizard.WizardPage; -import org.eclipse.osgi.util.NLS; import org.eclipse.swt.SWT; import org.eclipse.swt.events.SelectionEvent; import org.eclipse.swt.events.SelectionListener; @@ -18,10 +12,8 @@ import org.eclipse.swt.widgets.Group; import org.eclipse.swt.widgets.Layout; import org.eclipse.swt.widgets.Listener; -import org.jboss.tools.common.model.ui.ModelUIPlugin; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.resref.core.ResourceReference; -import org.jboss.tools.vpe.resref.Activator; -import org.osgi.framework.Bundle; public abstract class ReferenceWizardPage extends WizardPage implements SelectionListener, Listener { @@ -31,7 +23,6 @@ protected Object fileLocation = null; protected ResourceReferenceValidator validator = null; - private static final String PAGE_TITLE_IMAGE_PATH = "/images/xstudio/wizards/EclipseDefault.png"; //$NON-NLS-1$ private Button pageRadioButton; private Button folderRadioButton; private Button projectRadioButton; @@ -45,22 +36,7 @@ } public static ImageDescriptor getImageDescriptor() { - Bundle bundle = Platform.getBundle(ModelUIPlugin.PLUGIN_ID); - URL url = null; - ImageDescriptor image = null; - if (null != bundle) { - try { - url = FileLocator.resolve(bundle.getEntry(PAGE_TITLE_IMAGE_PATH)); - } catch (IOException e) { - Activator.getDefault().logError( - NLS.bind(Messages.VRD_TITLE_IMAGE_CANNOT_BE_RESOLVED, - url), e); - } - } - if (null != url) { - image = ImageDescriptor.createFromURL(url); - } - return image; + return ModelUIImages.getImageDescriptor(ModelUIImages.WIZARD_DEFAULT); } /** Modified: trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/VpeResourcesDialog.java =================================================================== --- trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/VpeResourcesDialog.java 2010-03-04 04:21:20 UTC (rev 20635) +++ trunk/vpe/plugins/org.jboss.tools.vpe.resref/src/org/jboss/tools/vpe/resref/core/VpeResourcesDialog.java 2010-03-04 07:56:48 UTC (rev 20636) @@ -29,10 +29,8 @@ import org.eclipse.swt.widgets.Shell; import org.eclipse.swt.widgets.TabFolder; import org.eclipse.swt.widgets.TabItem; -import org.jboss.tools.common.model.ui.ModelUIPlugin; +import org.jboss.tools.common.model.ui.ModelUIImages; import org.jboss.tools.common.model.ui.action.CommandBar; -import org.jboss.tools.vpe.resref.Activator; -import org.osgi.framework.Bundle; public class VpeResourcesDialog extends TitleAreaDialog { @@ -44,7 +42,6 @@ RelativeFolderReferenceComposite relFolder = null; CommandBar commandBar = new CommandBar(); - private final String DIALOG_TITLE_IMAGE_PATH = "/images/xstudio/wizards/EclipseDefault.png"; //$NON-NLS-1$ private final int DIALOG_WIDTH = 400; private final int DIALOG_HEIGHT = 300; @@ -71,24 +68,10 @@ @Override protected Control createDialogArea(Composite parent) { - - Bundle bundle = Platform.getBundle(ModelUIPlugin.PLUGIN_ID); - URL url = null; - if (null != bundle) { - try { - url = FileLocator.resolve(bundle.getEntry(DIALOG_TITLE_IMAGE_PATH)); - } catch (IOException e) { - Activator.getDefault().logError( - NLS.bind(Messages.VRD_TITLE_IMAGE_CANNOT_BE_RESOLVED, - url), e); - } - } - if (null != url) { - ImageDescriptor image = ImageDescriptor.createFromURL(url); - setTitleImage(image.createImage(null)); - } getShell().setText(Messages.VRD_DEFAULT_WINDOW_TITLE); setTitle(Messages.VRD_DEFAULT_TITLE); + setTitleImage(ModelUIImages.getImageDescriptor( + ModelUIImages.WIZARD_DEFAULT).createImage(null)); setMessage(Messages.VRD_PAGE_DESIGN_OPTIONS_ABOUT); Composite composite = new Composite(parent, SWT.NONE);

14 years, 10 months

1
0
0 / 0

Representatives Wanted

by Shirley Fitzpatrick

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20635 - in trunk/as/docs/reference: en-US and 7 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-03 23:21:20 -0500 (Wed, 03 Mar 2010) New Revision: 20635 Added: trunk/as/docs/reference/en-US/ trunk/as/docs/reference/en-US/Author_Group.xml trunk/as/docs/reference/en-US/Book_Info.xml trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml trunk/as/docs/reference/en-US/Preface.xml trunk/as/docs/reference/en-US/Revision_History.xml trunk/as/docs/reference/en-US/images/ trunk/as/docs/reference/en-US/images/favicon.ico trunk/as/docs/reference/en-US/images/jbosstools_logo.png trunk/as/docs/reference/en-US/images/modules/ trunk/as/docs/reference/en-US/images/modules/modules_1.png trunk/as/docs/reference/en-US/images/modules/modules_2.png trunk/as/docs/reference/en-US/images/modules/modules_3.png trunk/as/docs/reference/en-US/images/modules/modules_4.png trunk/as/docs/reference/en-US/images/modules/modules_5.png trunk/as/docs/reference/en-US/images/modules/modules_6.png trunk/as/docs/reference/en-US/images/modules/modules_7.png trunk/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png trunk/as/docs/reference/en-US/images/perspective/ trunk/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png trunk/as/docs/reference/en-US/images/perspective/filesets1.png trunk/as/docs/reference/en-US/images/perspective/filesets2.png trunk/as/docs/reference/en-US/images/perspective/filesets2_a.png trunk/as/docs/reference/en-US/images/perspective/filesets3.png trunk/as/docs/reference/en-US/images/perspective/filesets4.png trunk/as/docs/reference/en-US/images/perspective/filesets5.png trunk/as/docs/reference/en-US/images/perspective/perspective_1.png trunk/as/docs/reference/en-US/images/perspective/perspective_10.png trunk/as/docs/reference/en-US/images/perspective/perspective_11.png trunk/as/docs/reference/en-US/images/perspective/perspective_12.png trunk/as/docs/reference/en-US/images/perspective/perspective_13.png trunk/as/docs/reference/en-US/images/perspective/perspective_14.png trunk/as/docs/reference/en-US/images/perspective/perspective_15.png trunk/as/docs/reference/en-US/images/perspective/perspective_16.png trunk/as/docs/reference/en-US/images/perspective/perspective_17.png trunk/as/docs/reference/en-US/images/perspective/perspective_18.png trunk/as/docs/reference/en-US/images/perspective/perspective_19.png trunk/as/docs/reference/en-US/images/perspective/perspective_2.png trunk/as/docs/reference/en-US/images/perspective/perspective_20.png trunk/as/docs/reference/en-US/images/perspective/perspective_21.png trunk/as/docs/reference/en-US/images/perspective/perspective_21a.png trunk/as/docs/reference/en-US/images/perspective/perspective_22.png trunk/as/docs/reference/en-US/images/perspective/perspective_23.png trunk/as/docs/reference/en-US/images/perspective/perspective_23a.png trunk/as/docs/reference/en-US/images/perspective/perspective_23b.png trunk/as/docs/reference/en-US/images/perspective/perspective_23c.png trunk/as/docs/reference/en-US/images/perspective/perspective_24.png trunk/as/docs/reference/en-US/images/perspective/perspective_24a.png trunk/as/docs/reference/en-US/images/perspective/perspective_25.png trunk/as/docs/reference/en-US/images/perspective/perspective_26.png trunk/as/docs/reference/en-US/images/perspective/perspective_3.png trunk/as/docs/reference/en-US/images/perspective/perspective_4.png trunk/as/docs/reference/en-US/images/perspective/perspective_5.png trunk/as/docs/reference/en-US/images/perspective/perspective_6.png trunk/as/docs/reference/en-US/images/perspective/perspective_7.png trunk/as/docs/reference/en-US/images/perspective/perspective_8.png trunk/as/docs/reference/en-US/images/perspective/perspective_9.png trunk/as/docs/reference/en-US/images/perspective/projectarchives_error.png trunk/as/docs/reference/en-US/images/perspective/server_classpaths.png trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png trunk/as/docs/reference/en-US/images/quick_start/ trunk/as/docs/reference/en-US/images/quick_start/hotkeys.png trunk/as/docs/reference/en-US/images/quick_start/publish_button.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_1.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_2.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_3.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_4a.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_4b.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_5.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_6.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_7.png trunk/as/docs/reference/en-US/images/quick_start/quick_start_8.png trunk/as/docs/reference/en-US/images/runtimes_servers/ trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png trunk/as/docs/reference/en-US/images/tptp_support/ trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png trunk/as/docs/reference/en-US/images/webtools/ trunk/as/docs/reference/en-US/images/webtools/webtools_1.png trunk/as/docs/reference/en-US/images/webtools/webtools_2.png trunk/as/docs/reference/en-US/images/webtools/webtools_3.png trunk/as/docs/reference/en-US/images/webtools/webtools_4.png trunk/as/docs/reference/en-US/images/webtools/webtools_5.png trunk/as/docs/reference/en-US/master.xml trunk/as/docs/reference/en-US/master_output.xml trunk/as/docs/reference/en-US/modules.xml trunk/as/docs/reference/en-US/perspective.xml trunk/as/docs/reference/en-US/quick_start.xml trunk/as/docs/reference/en-US/runtimes_servers.xml trunk/as/docs/reference/en-US/tptp_support.xml trunk/as/docs/reference/en-US/webtools.xml trunk/as/docs/reference/publican.cfg Removed: trunk/as/docs/reference/en/ Modified: trunk/as/docs/reference/pom.xml Log: book updated to build with publican and maven Added: trunk/as/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/as/docs/reference/en-US/Author_Group.xml (rev 0) +++ trunk/as/docs/reference/en-US/Author_Group.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,7 @@ +<?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>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> </authorgroup> Added: trunk/as/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/as/docs/reference/en-US/Book_Info.xml (rev 0) +++ trunk/as/docs/reference/en-US/Book_Info.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -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>JBoss Server Manager Reference Guide</title><subtitle>Provides information relating to the JBoss Server Manager.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JBoss Server Manager Reference Guide explains how to use the JBoss Server Manager to configure, start, stop the server, to know deployment and archiving processes.</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><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent =================================================================== --- trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent (rev 0) +++ trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JBoss_Server_Manager_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml =================================================================== --- trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml (rev 0) +++ trunk/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,14 @@ +<?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="quick_start.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="runtimes_servers.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="perspective.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="webtools.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="modules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tptp_support.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: trunk/as/docs/reference/en-US/Preface.xml =================================================================== --- trunk/as/docs/reference/en-US/Preface.xml (rev 0) +++ trunk/as/docs/reference/en-US/Preface.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -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><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:include></xi:fallback></xi:include></preface> Added: trunk/as/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/as/docs/reference/en-US/Revision_History.xml (rev 0) +++ trunk/as/docs/reference/en-US/Revision_History.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -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(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/as/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_6.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_7.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets2_a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets2_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/filesets5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/filesets5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_10.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_11.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_12.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_13.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_14.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_15.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_16.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_17.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_18.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_19.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_20.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_21.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_21a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_21a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_22.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_23.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_23a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_23a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_23b.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_23b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_23c.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_23c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_24.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_24.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_24a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_24a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_25.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_25.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_26.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_26.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_6.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_7.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_8.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/perspective_9.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/perspective_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/projectarchives_error.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/projectarchives_error.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/server_classpaths.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/server_classpaths.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/hotkeys.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/hotkeys.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/publish_button.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/publish_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_4a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_4a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_4b.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_4b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_6.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_7.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/quick_start/quick_start_8.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/quick_start/quick_start_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/webtools/webtools_1.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/webtools/webtools_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/webtools/webtools_2.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/webtools/webtools_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/webtools/webtools_3.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/webtools/webtools_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/webtools/webtools_4.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/webtools/webtools_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/images/webtools/webtools_5.png =================================================================== (Binary files differ) Property changes on: trunk/as/docs/reference/en-US/images/webtools/webtools_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/as/docs/reference/en-US/master.xml =================================================================== --- trunk/as/docs/reference/en-US/master.xml (rev 0) +++ trunk/as/docs/reference/en-US/master.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,75 @@ +<?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 quick_start SYSTEM "quick_start.xml"> +<!ENTITY runtimes_servers SYSTEM "runtimes_servers.xml"> +<!ENTITY perspective SYSTEM "perspective.xml"> +<!ENTITY webtools SYSTEM "webtools.xml"> +<!ENTITY modules SYSTEM "modules.xml"> +<!ENTITY tptp_support SYSTEM "tptp_support.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>JBoss Server Manager Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 2.1.0.GA + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc/> + &quick_start; + &runtimes_servers; + &perspective; + &webtools; + &modules; + &tptp_support; + +</book> Added: trunk/as/docs/reference/en-US/master_output.xml =================================================================== --- trunk/as/docs/reference/en-US/master_output.xml (rev 0) +++ trunk/as/docs/reference/en-US/master_output.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,2361 @@ +<?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 quick_start SYSTEM "modules/quick_start.xml"> +<!ENTITY runtimes_servers SYSTEM "modules/runtimes_servers.xml"> +<!ENTITY perspective SYSTEM "modules/perspective.xml"> +<!ENTITY webtools SYSTEM "modules/webtools.xml"> +<!ENTITY modules SYSTEM "modules/modules.xml"> +<!ENTITY tptp_support SYSTEM "modules/tptp_support.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>JBoss Server Manager 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> + + <author><firstname>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Rob</firstname><surname>Stryker</surname><email>rob.stryker(a)jboss.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + + <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: 2.1.0.GA + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc></toc> + +<chapter id="quick_start" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/quick_start.xml"> + <title>Quick Start with JBoss Server</title> + + <para>This chapter covers the basics of working with the <property moreinfo="none">JBoss Server</property>.</para> + + <section id="JBoss_server_key_features"> + <title>Key Features of JBoss Server</title> + <para>For a start, we propose you to look through the table of main features of JBoss Server:</para> + + <table> + + <title>Key Functionality for JBoss AS and Archive 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>JBoss AS plugin</para></entry> + <entry><para>Using WTP, JBoss AS plugin allows working with the server in run or debug mode. You can easily install runtimes and servers, copy the existing runtime configuration or configure it up to your needs.</para></entry> + <entry> + <link linkend="runtimes_servers">runtimes and servers</link> + </entry> + </row> + + <row> + <entry><para>JBoss AS Perspective</para></entry> + <entry><para>It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives View and JBoss Server View for that purpose. </para></entry> + <entry> + <link linkend="perspective">JBoss AS perspective</link> + </entry> + </row> + + <row> + <entry><para>Modules Deployment</para></entry> + <entry><para>A number of ways, provided by WTP and JBoss Tools, to deploy either a project or a single file on the server.</para></entry> + <entry> + <link linkend="modules">deploying modules</link> + </entry> + </row> + + <row> + <entry><para>TPTP Support</para></entry> + <entry><para>Test and Performance Tools Platform (TPTP) profiling.</para></entry> + <entry> + <link linkend="tptp_support">TPTP support</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <para>If you + already have installed JBoss server and runtime you can quickly learn how to configure, start, + stop the server, to know deployment and archiving processes. How to install runtimes and servers + read in the <link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> + chapter.</para> + + <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property> via + <emphasis><property moreinfo="none">Window > Open Perspective > Other > JBoss + AS</property>.</emphasis></para> + </section> + + <section id="starting"> + <title>Starting JBoss Server</title> + + <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. You can control the server + behaviour with the help of a special toolbar in the <property moreinfo="none">JBoss Server View</property> + where you could <emphasis> + <property moreinfo="none">start</property> + </emphasis> it in a regular or debug mode, <emphasis> + <property moreinfo="none">stop</property> + </emphasis> it or <emphasis> + <property moreinfo="none">restart</property> + </emphasis> it and <emphasis> + <property moreinfo="none">publish</property> + </emphasis> to the server.</para> + + <figure float="0"> + <title>JBoss Server Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To launch the server click the green-with-white-arrow icon on the <property moreinfo="none">JBoss Server + View </property>or right click server name in this view and select <emphasis> + <property moreinfo="none">Start</property>. </emphasis> If this view is not open, select + <emphasis><property moreinfo="none">Window > Show View > Other > Server > + JBoss Server View</property>.</emphasis></para> + + <figure float="0"> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="stopping"> + <title>Stopping JBoss Server</title> + + <para>To stop the server, click the <emphasis> + <property moreinfo="none">Stop</property> + </emphasis> icon in the <property moreinfo="none">JBoss Server View</property> or right click the server name + and press <emphasis><property moreinfo="none">Stop</property>.</emphasis></para> + + <figure float="0"> + <title>Stop JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When the server is stopped you will see <emphasis> + <property moreinfo="none">Stopped</property> + </emphasis> state next to its name in the square brackets.</para> + <para>Learn more about the <property moreinfo="none">JBoss Server View</property> + <link linkend="JBossServerView">here</link>.</para> + </section> + + <section id="archiving"> + + <title>Project Archiving</title> + + <para><property moreinfo="none">JBoss Tools</property> comes with our own archives tool. The Project Archives + plugin consists primarily of a view to set up each packaging configuration <emphasis>( + <property moreinfo="none">Window > Show View > Other > JBoss Tools > Project archives</property>). + </emphasis></para> + <para>Right clicking in the <property moreinfo="none">Project archives view</property> you can create War, + EJB War, EAR or JAR archive.</para> + + <figure float="0"> + <title>Archive Creating</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Using the context menu on the item you can initiate a <emphasis><property moreinfo="none">full build</property></emphasis> on + archive, <emphasis><property moreinfo="none">edit</property>,</emphasis> <emphasis><property moreinfo="none">delete</property></emphasis> or + <emphasis><property moreinfo="none">publish</property></emphasis> it.</para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you wish, you can assign a hotkey for the Build Project Archive action. A key binding can be added + by navigating to <emphasis> + <property moreinfo="none">Window > Preferences > General > Keys</property>.</emphasis></para> + + <figure float="0"> + <title>Setting the Hotkey for Build Project Archive Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/hotkeys.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To perform the building of the project archives, select the project in the <property moreinfo="none">Package Explorer</property> view and execute the hotkey combination + you assigned for this action.</para> + + <para>Learn more about the <property moreinfo="none">Project Archives View</property> + <link linkend="Project_archivesView">here</link>.</para> + </section> + + <section id="deployment"> + <title>Deploying an Application to a Server</title> + + <para>There are two times to deploy your application:</para> + <itemizedlist> + <listitem> + <para>While creating it</para> + </listitem> + <listitem> + <para>After it already exists</para> + </listitem> + </itemizedlist> + + <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project + wizards, the one of wizards steps has a <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> and <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> sections. You can deploy the application through the appropriate selection in + these sections.</para> + + <figure float="0"> + <title>Runtime and Server Sections in the New Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Runtime and Server Sections in the Import Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can deploy an existing application to a server by right-clicking the target defined + server in the <property moreinfo="none">JBoss Servers View</property> and then selecting <emphasis><property moreinfo="none">Add and + Remove Projects</property></emphasis> from the context menu.</para> + + <figure float="0"> + <title>Add and Remove Projects From the Context Menu.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If this application is not assigned to a server, it will be in the left-hand available + projects list. Clicking on the <property moreinfo="none">Add ></property> button will add it to the right-hand + configured projects list and deploy the application to this server.</para> + + <figure float="0"> + <title>Modifying The Projects that are Configured on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="publishing"> + <title>Publishing to JBoss Server</title> + <para>The publishing of all the modules added to a Server is performed automatically when starting a Server.</para> + <para>The automatic publish of the changes made to the workspace is turned on by default in order to permanently keep + the workspace in sync with the publish folder. If you need to control when to publish the changes, + just disable the automatic publish in the <link linkend="server_editor">Server Editor</link> and use the <emphasis> + <property moreinfo="none">Publish to Server</property></emphasis> (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/quick_start/publish_button.png"></imagedata> + </imageobject> + </inlinemediaobject>) button which initiates an incremental publish. + </para> + + <para>Here, we have just performed the basic steps you should know to quick start with JBoss + server. In fact, there are more functionalities which you can make use of. Further we will + talk about them in detail.</para> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink url="http://docs.jboss.org/tools/2.1.0.GA">on JBoss Tools release documentation page</ulink>.</para> + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly builds documentation page</ulink>.</para> + + <para>Find out the answers on the frequently asked questions about JBoss AS 5 usage in the + <ulink url="http://www.jboss.org/community/wiki/jboss5faq">JBoss5FAQ</ulink>. + </para> + + <para>The information on how to monitor a remote JBoss Server from Eclipse you can find in the following + <ulink url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFromEclipse">wiki article</ulink>.</para> + </section> + +</chapter> + + +<chapter id="runtimes_servers" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/runtimes_servers.xml" xreflabel="runtimes_servers"> + <?dbhtml filename="runtimes_servers.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Runtimes and Servers in the JBoss AS plugin</title> + + <para>In this chapter we will discuss how to install runtimes and servers.</para> + + <para>First of all it's necessary to mention that the JBoss AS plugin makes use of WTP. + This includes starting and stopping servers in run or debug mode. It also includes targeting WTP + projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the + proper jars from a specific server are added to the project's classpath + properly.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we should create + our <property moreinfo="none">runtime</property> and <property moreinfo="none">server</property> instances.</para> + + <section> + <title>Runtimes</title> + <para>In <property moreinfo="none">JBoss Tools</property>, the main purpose of Server Runtimes is to point to a + server installation somewhere on disk. In our case, this will be a JBoss installation, and it + can then be used for two primary purposes:</para> + <itemizedlist> + <listitem> + <para>it provides classpath additions to WTP projects that require them.</para> + </listitem> + <listitem> + <para>for <property moreinfo="none">JBoss server</property> at least, it provides information necessary for + the starting and stopping of the server, it tells which jars to run and which + configuration to use.</para> + </listitem> + </itemizedlist> + + <section id="InstNewRuntime"> + <title>Installing a New Runtime</title> + <para>You can install runtimes into eclipse from the <emphasis> + <property moreinfo="none">Window > Preferences </property> + </emphasis> menu, and then select <emphasis> + <property moreinfo="none">Server > Runtime Environments</property> + </emphasis> from the categories available on the left.</para> + <figure float="0"> + <title>Installed Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>From this preference page you can see all declared runtimes and their types as well. + Here, it's possible to edit or remove existing runtimes as well as add a new + one.</para> + + <para>To create a JBoss runtime click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button and choose a necessary type of runtime from the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category.</para> + + <figure float="0"> + <title>Adding a Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now there is a separation between .org servers (the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> + <property moreinfo="none">JBoss Enterprise Middleware</property> + </emphasis> category).</para> + </note> + + <para>As you can see, <property moreinfo="none">JBoss Tools</property> provide its own adapters such as JBoss + 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that is a safer + incremental deployment, which prevents partial deployments to be picked up by the server. It + means that scanning for auto-deployment is suspended while files are being copied to the + deployment location and resumed when the copy is completed.</para> + + <note> + <title>Note:</title> + <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> + </note> + + <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath + for WTP projects. It is used solely by its server type for the purpose of setting up a + deploy directory for users who don't wish to make use of starting, stopping, or + debugging their projects inside eclipse.</para> + + <figure float="0" id="add_runtime_figure"> + <title>Adding a JBoss 4.2 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes all the available options of the currant wizard + page.</para> + <table> + <title>Server Runtime Wizard Parameters</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The name of a new Runtime for a chosen server. We suggest that you + don't leave a default value. It's better to give descriptive + names that will help to distinguish one runtime from another.</para> + </entry> + </row> + + <row> + <entry> + <para>Home directory</para> + </entry> + <entry> + <para>The path to a directory where the runtime is installed.</para> + </entry> + </row> + + <row> + <entry> + <para>JRE</para> + </entry> + <entry> + <para>The proper Java Runtime Environment. Because of the open-source nature of + JBoss, a user is likely to want to modify and repackage some of the + configuration-specific jboss jars and create their own configuration. Thus, rather + than forcing you to copy his entire JBoss installation, the structure of the + wizard allows to create only a new configuration instead.</para> + </entry> + </row> + + <row> + <entry> + <para>Directory</para> + </entry> + <entry> + <para>The path to a directory where the configurations are installed.</para> + </entry> + </row> + <row> + <entry> + <para>Configuration</para> + </entry> + <entry> + <para>The list of configurations (all, default, minimal) that is updated as soon as + you browse to a valid runtime installation folder.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>As a result of having each runtime represent a specific configuration rather than the + server installation as a whole, it is very likely you'll create several different + runtimes to test each of your configurations. It becomes important to ensure your runtimes, + and later your servers, are given descriptive names that help you to remember which is + which.</para> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to see your new runtime in the list.</para> + <note> + <title>Note:</title> + <para>If you edit the configuration of a runtime, the changes don't affect the settings of the servers that currently use the runtime. + To apply the changes to them also,you should double right click the server, <emphasis> + <property moreinfo="none">Overview>Runtime Environment</property> </emphasis> + ,make sure that necessary configuration is chosen,click <emphasis><property moreinfo="none">Finish</property> </emphasis> and then <emphasis><property moreinfo="none">Save</property></emphasis> button.</para> + </note> + </section> + <section id="CopyRuntime"> + <title>Copying the existing runtime configuration</title> + <para>While installing a new runtime you can copy the configuration from the existing one. + To do this you should perform all the steps in the <link linkend="InstNewRuntime">previous</link> section except pressing <emphasis> + <property moreinfo="none">Finish</property></emphasis> + in the New Server Runtime Environment menu . + </para> + <para>Make sure that you browse to a valid runtime folder and can see the list of configurations (all, default, minimal) in the Configuration section . + Then choose necessary Configuration from the list and click <emphasis> + <property moreinfo="none">Copy</property></emphasis>.The next dialog should appear. + </para> + <figure float="0"> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Change the name Click on <emphasis> + <property moreinfo="none">Browse</property></emphasis> and select your configuration location or leave as it's if you want it to be located together with other runtime configurations. + </para> + <figure float="0"> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click<emphasis> + <property moreinfo="none"> Ok </property></emphasis>and you should see the next wizard with the just added copied configuration. + + </para> + <figure float="0"> + <title>Runtime with copied configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> and you will see your new runtime in the list. + </para> + <para>You can also change a configuration of existing runtime to a copied one in the same way from the <emphasis> + <property moreinfo="none"> Window > Preferences </property></emphasis> + menu <emphasis> + <property moreinfo="none">Server > Runtime Environments </property></emphasis> + and clicking <emphasis> + <property moreinfo="none">Edit</property></emphasis>. + </para> + </section> + </section> + <section> + <title>Servers</title> + <para>WTP servers are eclipse-representations of a backing server installation. They are used to + start or stop servers, deploy to servers, or debug code that will run on the server. They keep + track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy + those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server + Wizard</link> section). </para> + <para>Servers can be started or stopped with different <link linkend="com_line_arg">command-line + arguments</link>. They are often backed by a runtime object representing that server's + location.</para> + + <section> + <title>Creating a New Server</title> + + <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis> + <property moreinfo="none">File > New > Other... </property> + </emphasis> and then <emphasis> + <property moreinfo="none">Server</property> + </emphasis>. This should show the wizard like below.</para> + <figure float="0"> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>A server object is that keeps track of things like command line arguments when starting + or stopping, and runtimes keep track of the location of the installation. Thus, each server + instance must be backed by an appropriate runtime. </para> + + <para> <emphasis><property moreinfo="none"> New server wizard </property></emphasis> allows to name the server appropriately in the <emphasis><property moreinfo="none">Server name field </property></emphasis>or you can use a generated default name.If it's nessecary to restore the default name,after you defined yours, click the Reset default button(<inlinemediaobject> <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4d.png"></imagedata> + </imageobject></inlinemediaobject>). + From the list of already declared runtimes in the combo box below the view it's + possible to select which runtime you want your server to be backed by. If there is no + runtime that matches your needs just press the <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> link nearby to bring up the wizard for creating a new runtime (see the <link linkend="add_runtime_figure">Installing a New Runtime section</link>). To configure the already installed + runtimes you should go to server preferences that you can easily do by pressing the <emphasis> + <property moreinfo="none">Configure runtime environments...</property></emphasis> link.</para> + + <para>If the server you want to create doesn't have any installed runtime yet, the combo box + and the links are absent.</para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case the next page in the wizard which has the same form as in <link linkend="add_runtime_figure">the previous section</link> will ask you to create the + associated runtime.</para> + <para>Either way, after targeting your server to a runtime, the final screen in this wizard is + largely confirmational, giving you a chance to verify that you've selected the + appropriate runtime. </para> + + <figure float="0"> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to complete the process of the server creation.</para> + <para>Now that we've created our runtimes and servers, we can dwell on all services + and tools that JBoss Server Manager provides.</para> + + <para>We hope, this guide helped you to get started with the JBoss Tools server manager. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> + </section> + + +</chapter> + + +<chapter id="perspective" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/perspective.xml" xreflabel="perspective"> + <?dbhtml filename="perspective.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JBoss AS Perspective</title> + + <para>This chapter tells how to manage installed <property moreinfo="none">JBoss Server</property> via + <property moreinfo="none">JBoss AS perspective</property>.</para> + + <para>The <property moreinfo="none">JBoss AS perspective</property> is similar to the <property moreinfo="none">Java + perspective</property>, but it contains a few additional views. Two of the additional + views are standard views, specifically the <property moreinfo="none">Console view</property> and the + <property moreinfo="none">Properties view</property>. The other two views that are added are the + <property moreinfo="none">Project archives view</property> and the <property moreinfo="none">JBoss Server + View</property>.</para> + + <section id="JBossServerView" role="updated"> + <?dbhtml filename="JBossServerView.html"?> + <title>The JBoss Server View</title> + + <para>The <property moreinfo="none">JBoss Server View</property> is built on Common Navigator Framework + allowing extensions and is using label decorators what makes the UI enough compact + without loosing the vital information.</para> + + <para>Let's have a look at the <property moreinfo="none">JBoss Server View</property> and inspect + in detail all parts it consists of. </para> + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="jbossserver_view_toolbar"> + <title>JBoss Server View Toolbar</title> + <para>In the right top corner of the <property moreinfo="none">JBoss Server View</property> there is a + special toolbar which provides a quick access to starting a server (in the debug + mode, run mode, or profile mode), restarting a server, stopping a server and a + possibility to publish to a server.</para> + + <figure float="0"> + <title>The JBoss Server View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In order to debug your applications or EJB's that are deployed to the server, you + must start the server in debug mode. By starting the server in debug mode, eclipse + will allow you to set breakpoints on code in your workspace and step through the + code.</para> + + <para><emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button allows to enable profiling actions for your application. For more + details on how to start using TPTP profiling with <property moreinfo="none">JBoss Tools</property> + refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> + + <para><emphasis> + <property moreinfo="none">Publish to the server</property> + </emphasis> button will republish any modules where it has determined the workspace + is out of sync with the server. It will attempt to do an incremental publish if it + turns out that the module in question is capable of doing one.</para> + + </section> + + <section id="jbossserver_view_structure"> + <title>JBoss Server View Structure</title> + <para>The <property moreinfo="none">JBoss Server View</property> displays all declared servers as well + as their current states (that is whether they are started or stopped) and statuses + in the square brackets next to a server name.</para> + + <figure float="0"> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The following table lists possible server statuses.</para> + + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center">Status</entry> + + <entry align="center">Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry align="center"> + <para>Republish</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + awaiting</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Publishing...</para> + </entry> + + <entry align="center"> + <para>The status which shows if changes are being updated</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Synchronized</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + in-sync</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para>You can control a server behavior as well as adjust some server preferences with + the help of the context menu commands.</para> + + <figure float="0"> + <title>Context Menu Commands</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>All available context menu commands are described in the following table.</para> + <table> + <title>Server Properties through the Context Menu</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>New Server</para> + </entry> + <entry> + <para>The option allows to define a new server</para> + </entry> + </row> + + <row> + <entry> + <para>Open</para> + </entry> + <entry> + <para>The option opens the Server editor</para> + </entry> + </row> + + <row> + <entry> + <para>Show in</para> + </entry> + <entry> + <para>This option gives an easy access to the next views: Console, + Debug view, Server Log or MBean Explorer</para> + </entry> + </row> + + <row> + <entry> + <para>Delete</para> + </entry> + <entry> + <para>Standard option that allows to delete the chosen server</para> + </entry> + </row> + + <row> + <entry> + <para>Start</para> + </entry> + <entry> + <para>The action for stating a server in a run mode</para> + </entry> + </row> + + <row> + <entry> + <para>Debug</para> + </entry> + <entry> + <para>The action for stating a server in a debug mode</para> + </entry> + </row> + + <row> + <entry> + <para>Stop</para> + </entry> + <entry> + <para>The action for stopping a declared server</para> + </entry> + </row> + + <row> + <entry> + <para>Publish</para> + </entry> + <entry> + <para>The action for synchronizing the publish information between + the server and workspace</para> + </entry> + </row> + + <row> + <entry> + <para>Explore</para> + </entry> + <entry> + <para>This action uses the native OS file explorer to browse the + deploy destination. Note: The option is also available for + deployed resources/projects (see the figure below).</para> + </entry> + </row> + + <row> + <entry> + <para>Add and Remove Projects</para> + </entry> + <entry> + <para>The option allows to publish a new project to the server (if + its type is supported)</para> + </entry> + </row> + + <row> + <entry> + <para>Monitoring</para> + </entry> + <entry> + <para>Possibility to add ports to be monitored on the current + server</para> + </entry> + </row> + + <row> + <entry> + <para>Properties</para> + </entry> + <entry> + <para>Opens the window to adjust the current server + preferences</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Under the server element in the <property moreinfo="none">JBoss Server View</property>, you can + see currently deployed to the server modules and some server extensions which + provide the additional information on the server.</para> + + <para>The context menu for any module allows you to remove it from the server, force a + full or incremental republish upon it.</para> + + <figure float="0"> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="filesets"> + <title>Filesets</title> + + <para>The <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property> is intended + for files filtering.</para> + + <para>To add a new file filter, right-click the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category and select <emphasis> + <property moreinfo="none">Create File Filter</property>.</emphasis></para> + <para id="filefilterWiz">The <property moreinfo="none">New File + Filter wizard</property> should appear.</para> + + <figure float="0"> + <title>Creating a New File Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard asks you to enter the filter name and add includes and excludes + patterns. The preview box underneath gives a list of files matched to the + defined patterns (see the figures bellow).</para> + <para>In order to set up a default fileset relative to the concrete configuration of the server runtime, use the following variable: + <literal moreinfo="none">${jboss_config}</literal>, i. e. you should type in the <emphasis> + <property moreinfo="none">Root Directory</property></emphasis> something like <literal moreinfo="none">server/${jboss_config}/</literal>. + This is implemented in order you can modify the runtime's configuration and not have to manually update paths.</para> + <figure float="0"> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice, that the <emphasis> + <property moreinfo="none">Browse</property></emphasis> button still returns an absolute path:</para> + + <figure float="0"> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After the filter is created, you can observe it by expanding the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category in the <property moreinfo="none">JBoss Server View</property>.</para> + + <para>It's possible now to edit files directly from the <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> category. Double clicking on a file from <emphasis> + <property moreinfo="none">Filesets</property> + </emphasis> opens up the editor automatically or you can use the <emphasis> + <property moreinfo="none">Edit File</property> + </emphasis> context menu command.</para> + + <figure float="0"> + <title>Direct Editing from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To delete a file filter (or just a file) from the <emphasis> + <property moreinfo="none">Filesets</property>,</emphasis> right-click a file filter (or the + unnecessary file) and select the <emphasis> + <property moreinfo="none">Delete File Filter</property> + </emphasis> + <emphasis>(<property moreinfo="none">Delete File</property>)</emphasis> command.</para> + + <figure float="0"> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If you want to set filesets for some server types, you should open + <emphasis><property moreinfo="none">Window>Preferences</property></emphasis> + and then select <emphasis><property moreinfo="none">Server > Default Filesets</property></emphasis> + from the categories available on the left.</para> + + <figure float="0"> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this preference page you can add a fileset + to any server type or to all servers at once.To do this you should select the server type in the combo box and click <emphasis><property moreinfo="none">Add fileset...</property></emphasis> button. + In the opened <property moreinfo="none">New File + Filter wizard</property> follow the steps described <link linkend="filefilterWiz">before</link> and finally click <emphasis><property moreinfo="none">Apply</property></emphasis> button on the preference page.</para> + <para>The defined file filter will be automatically added to new servers during creation.</para> + + + </section> + + <section id="xml_configuration"> + <title>XML Configuration</title> + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category allows you to quickly browse to descriptor files in your + server's deploy directory and check or change the values. Basically, <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> includes XML XPaths where an xpath is a path used to access some + specific part of an xml document. </para> + + <note> + <title>Note:</title> + <para>You are assumed to be familiar with XPath. If not, we highly suggested + that you look through an appropriate manual or tutorial on the topic.</para> + </note> + + <para>The <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category itself contains only a list of categories. <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> are provided by default and is filled with many of the most commonly + used ports in the <property moreinfo="none">JBoss Server</property>.</para> + + <figure float="0"> + <title>XML Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + +  + + <para>By right-clicking on <emphasis> + <property moreinfo="none">XML Configuration</property>, </emphasis> you can create a new + category. Besides, context menu for <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis> category makes possible to disable it. You can disable any category + in the bottom part of the <emphasis> + <property moreinfo="none">JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property moreinfo="none">Inactive Categories</property> + </emphasis> afterwards to re-enable.</para> + + <figure float="0"> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By right-clicking on <emphasis> + <property moreinfo="none">Ports</property> + </emphasis> or any other category in <emphasis> + <property moreinfo="none">XML Configuration</property> + </emphasis>, you can create a new xpath.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After that, the dialog shown below will appear.</para> + + <figure float="0"> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The goal here is to get an end result where the XPath matches up with a + necessary property. With that in mind, let's look how it works. If the + property you want to reach is the value of the <emphasis>name</emphasis> + attribute in the element <code><mbean></code>, then your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + + <programlisting format="linespecific" role="XML"><![CDATA[... +<server> +... + <mbean code="org.jboss.ejb.EJBDeployer" + name="jboss.ejb:service=EJBDeployer" xmbean-dd=""> + +  + <xmbean> + <description> + The EJBDeployer responsible for ejb jar deployment</description> + ... + </xmbean> + </mbean> +</server> +]]></programlisting> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Notice, when you type the fields autocomplete to help you locate exactly + what xpath you're looking for.</para> + </tip> + + <para>Then, on the other hand, if your desired field is the text of an element + <code><description></code>, your <emphasis> + <property moreinfo="none">XPath Patten</property> + </emphasis> should end with <emphasis>description</emphasis> and <emphasis> + <property moreinfo="none">Attribute Name</property> + </emphasis> field should be left blank. When finished, click <emphasis> + <property moreinfo="none">Preview</property> + </emphasis> to see how many matches you have for that particular XPath.</para> + + <figure float="0"> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="dragndrop_to_jboss_server_view"> + <title>Drag-n-Drop to JBoss Server View</title> + + <para>Starting from 2.0.0.CR2 version of <property moreinfo="none">JBoss AS Tools</property> the + <property moreinfo="none">JBoss Server View</property> supports drag-n-drop of deployable and + runnable projects/resources.</para> + + <figure float="0"> + <title>Dragging to the JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/dnd_toJBossServerView.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With drag-n-drop the following actions can be performed:</para> + + <itemizedlist> + <listitem> + <para>dragging a project to a server will deploy it to the server and run it by + showing the main page in a browser</para> + </listitem> + + <listitem> + <para>dragging an <emphasis> + <property moreinfo="none">.xhtml</property> + </emphasis> file from <emphasis> + <property moreinfo="none">WebContent</property> + </emphasis> will do the same and show the corresponding page in a + browser</para> + </listitem> + + <listitem> + <para>dragging a deployable resource (i.e. a datasource (<emphasis> + <property moreinfo="none">-ds.xml</property> + </emphasis>) file that has been made deployable) will simply deploy that + resource directly to the server</para> + </listitem> + </itemizedlist> + + <para>In short, the feature does the same thing as if you used the <emphasis> + <property moreinfo="none">Run On Server</property> + </emphasis> option or <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> option in the context menu of the server.</para> + </section> + + <section id="server_log"> + <title>Server Log View</title> + + <para>You can monitor the current server behavior with the help of the <property moreinfo="none">Server + Log</property>. To open a server in the <property moreinfo="none">Server Log view</property> you + should right-click on the server and follow to <emphasis> + <property moreinfo="none">Open in > Server Log</property>.</emphasis></para> + + <para>The <emphasis> + <property moreinfo="none">Server Log</property> + </emphasis> shows relevant information to your server's startup, shutdown, + and publish processes. This allows you to keep an eye on what's going on + (such as automatic incremental deployment if you have it enabled).</para> + + <figure float="0"> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Server Log</property> toolbar contains several icons that perform + the following actions:</para> + + <table> + <title>Server Log Toolbar Icons</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Export Log</para> + </entry> + <entry> + <para>Possibility to export the log into a text file</para> + </entry> + </row> + + <row> + <entry> + <para>Clear Log Viewer</para> + </entry> + <entry> + <para>The option clears the current server log</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Log</para> + </entry> + <entry> + <para>Click to delete the server log</para> + </entry> + </row> + + <row> + <entry> + <para>Open Log</para> + </entry> + <entry> + <para>Click to open the server log text file</para> + </entry> + </row> + + <row> + <entry> + <para>Restore Log</para> + </entry> + <entry> + <para>Click to restore the server log</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + </section> + + <section id="server_editor"> + <title>Server Editor</title> + <para>By double-clicking on any server, an editor window will appear allowing you to + edit parts of that server.</para> + + <figure float="0"> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On the figure you can see that a username/password is available in the UI when + configuring the server. If you get a SecurityException when trying to launch the + server, it is most likely because your server is protected and hence you need to + fill the username/password fields with appropriate values.</para> + </tip> + + <para>Under the <emphasis> + <property moreinfo="none">Publishing</property></emphasis> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</para> + + <para>It should be pointed out that our server adapter by default tries to automatically + detect the ports it needs for integrating with a <property moreinfo="none">JBoss Server</property>. + Sometimes it can though be relevant to override this automatic detection if you are + using some custom configuration. For this purposes the <emphasis> + <property moreinfo="none">Server Ports</property> + </emphasis> section in the <property moreinfo="none">Server editor</property> is provided where the + port settings are configurable. Click the <emphasis> + <property moreinfo="none">Configure...</property> + </emphasis> link to bring up the wizard for adjusting the settings for the + ports.</para> + + <figure float="0"> + <title>Server Ports Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property moreinfo="none">Edit XPath</property> + </emphasis> button for the chosen port to configure its XPath's values.</para> + + <figure float="0"> + <title>XPath Pattern for a Server Port</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Server editor</property> you are able to edit the timeouts and the server pollers to use.</para> + + <note> + <title>Note:</title> + <para>By default, the Startup poller is set to JMX Poller (see the <emphasis> + <property moreinfo="none">Server Polling</property></emphasis> section). If you change the Startup poller + to Timeout Poller (it may need in case, for example, you're using the minimal configuration for your server), this will do no polling at all and will only set the server + state to <emphasis> + <property moreinfo="none">"Started"</property></emphasis> after your startup timeout is reached.</para> + </note> + + <para id="com_line_arg"><property moreinfo="none">Server editor</property> makes it also possible to + modify the server's launch configuration. It's just after clicking <emphasis> + <property moreinfo="none">Open launch configuration</property> + </emphasis> link. In the open window there are the tabs for setting command line + arguments, main, classpaths and other things that are relevant to launching the + server.</para> + + <figure float="0"> + <title>Launch Configuration Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>The first tab shows the Jboss server arguments</para> + <para>Look up <ulink url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html">AS Installation Guide </ulink> to find parameters which can be specified for <property moreinfo="none">JBoss + Server</property>.</para> + + <note> + <title>Note:</title> + <para>Please note, that the Launch Configurations for JBoss Servers are enough + strict in enforcing the configured values in the server in order to avoid + inconsistencies between server's and their configured runtime.</para> + + <para>For example, if you change the launch configuration program arguments to + <emphasis>"-c myConfig"</emphasis> but do not change the + targeted runtime configuration, then your program arguments will be ignored. The + server runtime "wins" so to speak. This ensures consistency + and if you change the location of the runtime, your launch configurations will + automatically pick that up.</para> + + <para>Values are not controlled by the server and its runtime setup will be passed + on unaltered.</para> + </note> + + <para>On the second tab you find the main class used for launching JBoss AS (default is org.jboss.Main), you can change it, if necessary. </para> + + <para>Until 3.0.0.GA release of <property moreinfo="none">JBoss Tools</property>, the servers classpath + was readonly, but that caused problems for users wanting to add their own jars in + the startup classpath. That is relevant if you need to patch the server, add a + custom charset or other tweaks that require early access to the classpath.</para> + + <para>Now all servers have a custom 'server runtime classpath + container', which is there by default and point to the default jars in + JBoss. You can now adjust the classpath. Then just make sure this container is there + if you want the classpath to be picked up.</para> + + <figure float="0"> + <title>Server Classpaths</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/server_classpaths.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If for some reason you have a launch configuration without this container, <emphasis> + <property moreinfo="none">Restore Default Entries</property> + </emphasis> should add it properly. Also, <emphasis> + <property moreinfo="none">Restore Default Entries</property> + </emphasis> will also remove any extra entries you added yourself.</para> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + Documentation</ulink>.</para> + </section> + </section> + + <section id="Project_archivesView" role="updated"> + <title>Project Archives View</title> + <para>Every application, whether Plain Old Java, J2EE, or some other language altogether, + needs to be packaged in some way. In Java-related projects, many people use ANT. </para> + <note> + <title>Note:</title> + <para>Those who use ANT will appreciate how the Project Archives Ant task is now + improved: it supports variables and gives more informative error/logging messages + when something goes wrong.</para> + </note> + + <para>But <property moreinfo="none">JBoss Tools</property> come with our own Archives tool with a bit easier + and less-verbose XML and a handy user interface. The Project Archives plugin consists + primarily of a view, that is <property moreinfo="none">Project Archives view</property>, to set up each + packaging configuration.</para> + <para>So far, let's look through all functionality that the <property moreinfo="none">Project + Archives view</property> provides.</para> + + <section id="archives_overview"> + <title>Overview</title> + + <para>The packaging configuration for each project is stored in the project's root + folder, and is in a file named <emphasis> + <property moreinfo="none">.packages</property> + </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is + neither required nor recommended, and using the UI is the official way of modifying + your packaging structure.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>A project's configuration contains archives. As you can see on the image + above a project can contain more than one archive. Internal archives and filesets + can be directly inside of an archive, or in some sub-folder of that archive.</para> + + <para>In the upper right corner of the view you can see an icon which, when clicked, + will build the selected top-level archive. Additionally, you can select <emphasis> + <property moreinfo="none">Project > Build Packages</property> + </emphasis> when a project is selected in the <property moreinfo="none">Packages View</property> to + build all declared packages in that project's <emphasis> + <property moreinfo="none">.packages</property> + </emphasis> file. This will execute a full build on all declared archives.</para> + </section> + + <section id="Creating_Archive"> + <title>Creating an Archive</title> + + <para>When you open the <property moreinfo="none">Project archives view</property> for the first time, + it asks you to select the project for what you want to create an archive.</para> + + <figure float="0"> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When creating a new archive for selected project, you have some different options + at your disposal. You need right-click inside the view and select <emphasis> + <property moreinfo="none">New Archive</property> + </emphasis> to see your archive type options.</para> + + <figure float="0"> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you see only JAR from the list of available archive types, you should + verify whether AS Tools plugins/features are in place. EAR, EJB JAR and WAR + options are contributed by the AS Tools independently from webtools and the + virtual project model. Thus, without them only JAR will show up.</para> + </note> + + <para><property moreinfo="none">JAR</property> is the standard archive type, and does very little + configuration, leaving most of the work up to you. You can customize the name, add + folders, filesets, and inner jars to it.</para> + + <para>The other types, for the most part, simply start off with a default setting, + usually the jar with some specific children based on an expected structure of the + project. For example, if the project is a Dynamic Web Project, and you create a + <property moreinfo="none">WAR</property> archive, the archive will be created with a few + filesets relevant to the known structure of the project.</para> + + <para>Here is the first page of all New archive wizards. It is the same for any archive + type and the only page in the <property moreinfo="none">New Jar wizard</property>.</para> + <figure float="0"> + <title>New WAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The page is pretty simple. First it asks to set the name of your new archive and a + destination.</para> + + <para>The destination of an archive can be anywhere on the file system, anywhere in the + workspace, inside some other archive, or inside a folder declared inside an archive. + Select the necessary checkbox (either <emphasis> + <property moreinfo="none">workspace</property> + </emphasis> or <emphasis> + <property moreinfo="none"> file system</property> + </emphasis>) for marking the destination as related to either workspace or file + system. You can browse to workspace or filesystem destinations by clicking on their + respective buttons. To select a destination inside some other archive, you'll need + to press the <emphasis> + <property moreinfo="none">Workspace</property> + </emphasis> button. At the bottom of the list, you'll see archives that + have been declared in the workspace.</para> + + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also in the wizard for creating a new archive you can choose whether an archive to + be compressed or exploded into a folder (without compression). You need just select + proper chechbox in the <emphasis> + <property moreinfo="none">Archive type</property> + </emphasis> section.</para> + <para>If a build or incremental update fails Project Archives will show an error + dialog:</para> + <figure float="0"> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/projectarchives_error.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click in <emphasis> + <property moreinfo="none">Details</property> + </emphasis> to see detailed information about what caused the error.</para> + + <para>In the <property moreinfo="none">Package Explorer</property> you can observe the created + archive.</para> + <figure float="0"> + <title>The Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you use the exploded type of archiving, instead of a single file archive the + result put into a folder is displayed in the <property moreinfo="none">Package + Explorer</property>.</para> + <figure float="0"> + <title>The Exploded Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <section id="CreatingaFolder"> + <title>Creating a Folder</title> + <para>Creating a folder is much easier. You simply right-click on an archive or + folder you want your new folder to be a child under. The only piece of required + information is naming the file.</para> + </section> + <section id="CreatingaFileSet"> + <title>Creating a FileSet</title> + <para>To create a new fileset, you click on an available target location such as an + archive, a nested archive, or a folder within an archive, and select <emphasis> + <property moreinfo="none">New Fileset</property>. </emphasis></para> + <para>The <property moreinfo="none">New Fileset wizard</property> requires a destination (where the + files will go), and a root directory (or where the files are coming from). The + source can be anywhere in the workspace or from the filesystem at large.</para> + + <figure float="0"> + <title>Adding a New FileSet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Below that, the fileset requires only an includes pattern and an excludes + pattern. As you type in either of these fields, the preview viewer should update + itself with which files are matched.</para> + + <para>You can create a Fileset with flattening or without it. Look at the difference + on the figure below.</para> + + <figure float="0"> + <title>The FileSet with flattening and without it</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="CreatingaUserLibrariesFileSet"> + <title>Creating User Library FileSet</title> + + <para>If you use user libraries in your projects you can also refer to these from project archives and have all the .jar/.zip files they refer included into the archive.</para> + <para>To add a new user libraries file set, call the right-click menu on the necessary archive and choose " New User Libraries FileSet" item</para> + + <figure float="0"> + <title>Adding New User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can edit the existing user libraries as well using "User Libraries Fileset Wizard". Call the right-click menu on the library fileset and choose "Edit Fileset " item</para> + + <figure float="0"> + <title>Editing User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + + <section id="View_Actions"> + <title>Archive Actions</title> + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The context menu on the items in the view is extendable, but there are several + that come standard.</para> + + <table> + <title>Context Menu on the Item</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Build Archive (Full)</para> + </entry> + + <entry> + <para>The action enabled only on top-level archives, which initiates + a full build on that archive</para> + </entry> + </row> + + <row> + <entry> + <para>Edit Archive</para> + </entry> + + <entry> + <para>Standard action that brings up the wizard associated with that + particular node type and allows the details to be changed</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Archive</para> + </entry> + + <entry> + <para>Deleting node is standard action with deletion not needing an + explanation</para> + </entry> + </row> + + <row> + <entry> + <para>Publish To Server</para> + </entry> + + <entry> + <para>The action means the ability to publish to a declared + server</para> + </entry> + </row> + + <row> + <entry> + <para>Edit publish settings</para> + </entry> + + <entry> + <para>Gives possibility to edit an archive publish settings</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <note diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When editing an archive, it is also updated in all folders and other archives where it is nested.</diffmk:wrapper></para> + </note> + </section> + + <section id="PublishToServer"> + <title>Publishing to Server</title> + <para>Finally, you'll need to publish your application to a server. Here, we + show you how to do it with the help of <emphasis> + <property moreinfo="none">Archives View</property>. </emphasis></para> + + <figure float="0"> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <emphasis> + <property moreinfo="none">Publish To Server</property>. </emphasis> To simply publish once, you + just select the server(s) that you want, and finish. If you want the <emphasis> + <property moreinfo="none">Publish to Server</property> + </emphasis> action on that particular Archive to publish always to that set of + servers, then check the appropriate checkbox. And finally, to enable automatic + publishing upon build events, check the last checkbox.</para> + <para>The automatic publishing feature is nice if, for example, your package's + destination (where it is built) is a temporary folder and you want the archive + published to several servers. If you only really want your archive published to one + server, it might be easier to have the archive's destination folder be the deploy + folder of the server.</para> + </section> + <section id="rel_res_links_archiving"> + <title>Relevant Resources Links</title> + <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> + to find more on how to build your applications with help of Ant.</para> + + <para>We also recommend you to watch the <ulink url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm">movie</ulink> which demonstrates a powerful archiving functionality in + <property moreinfo="none">JBoss Tools</property>.</para> + + <para>At this point, you are guessed to be familiar with <property moreinfo="none">JBoss AS + perspective</property> and your next step now is to explore how to work with + different kinds of projects.</para> + </section> + + </section> + + +</chapter> + + +<chapter id="webtools" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/webtools.xml"> + <title>Projects</title> + <para>The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web + Project, EJB Project, or EAR project. Web projects of <property moreinfo="none">JBoss Tools</property> are + Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this + chapter we are going to tell you about facets the main benefit of which to provide proper + structuring and packaging for any type of project.</para> + + <section> + <title>Faceted Projects Overview</title> + <para>The idea behind faceted projects is that each project can accept units of + functionality, or facets, which can be added or removed by the user. Most often, these + facets either add to the project's classpath, enable a builder, or watch the project in + some other fashion. Generally, every project concerned has at least one facet when + it's created. As an example, a Web project has a WebDoclet facet, or an EJB + Project has an EJB Module facet as prerequisites.</para> + + <para> WTP projects have undergone some criticism as being + <emphasis>over-engineered</emphasis> or too restrictive in their design. WTP projects + are set up in a tree-relationship to each other, where one project can be a child of + another. For example, an EAR project may have a Web Project child, an EJB project child, + or other types.</para> + + <para> However, the benefit of this is that the structure of your projects is then known, + and packaging it up *should* be trivial. Apparently, if your project is non-standard, or + you feel too confined by such rigid structural requirements, you can still choose to + package your project using the <link linkend="Project_archivesView">Archives + plugin</link>.</para> + </section> + + + <section> + <title>Adding Facets to a Project</title> + + <para>In this section we're going to consider the facets added by <property moreinfo="none">JBoss + Tools</property> and show how you can configure them in a project: add new ones or + modify already existing configuration of the facets.</para> + + <para>One way to configure the facets is doing it while organizing a new project. To + demonstrate this let's create a new <property moreinfo="none">Dynamic Web Project</property> by + selecting <emphasis> + <property moreinfo="none">File > New > Other...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Web > Dynamic Web Project</property>. </emphasis></para> + <figure float="0"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> and you will see Dynamic Web Project page like on the figure below.</para> + + <para> The first page of most WTP projects allows you to target a specific runtime, + representing a server's library location. It will also provide you the ability to add + this project to an EAR project, and select a preselected default set of facets, called + a configuration, rather than manually select each facet you might want.</para> + <para> Selecting the runtime, again, allows the project to install the proper classpaths to + the project so it knows what code to compile against.</para> + + <figure float="0" id="dyn_web_project"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis> + <property moreinfo="none">Modify</property> + </emphasis> button next to <property moreinfo="none">Configuration</property> section in order to open + the wizard which allows you to modify a chosen configuration. The wizard looks as + follows.</para> + + <figure float="0" id="project_facets"> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here part of the listed facets are those which are provided by WTP. Some of them are + added by <property moreinfo="none">JBoss Tools</property>. They are:</para> + <itemizedlist> + <listitem> + <para>BIRT Charting Runtime Component</para> + </listitem> + <listitem> + <para>BIRT Reporting Runtime Component</para> + </listitem> + <listitem> + <para>JBoss ESB</para> + </listitem> + <listitem> + <para>JBoss Portlets</para> + </listitem> + <listitem> + <para>JBoss Web Services</para> + </listitem> + <listitem> + <para>Seam</para> + </listitem> + </itemizedlist> + + <para>On this wizard page you can enable or disable any facet as well as change it version. + What you should note here is that some facets or facets versions may conflict with each + other. In case of incompatibility you'll be prompted about this in the combo + box underneath.</para> + <figure float="0"> + <title>Facet Constraints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When switching on the <emphasis> + <property moreinfo="none">Runtimes</property> + </emphasis> tab on the right you'll see the current server Runtime.</para> + <figure float="0"> + <title>Runtimes on the Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> + <property moreinfo="none">Make Primary</property> + </emphasis> button after enabling it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">OK</property> + </emphasis> will save the chosen configuration of the facets and return you to the <link linkend="dyn_web_project">Dynamic Web Project wizard</link>. Further pages in the + wizard are specific to either the project type or the facets selected.</para> + + + <para>If you need to configure the facets for the existing project, you should bring up the + context menu for selected project and click <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Project Facets</property>. </emphasis> This will bring up the familiar + <link linkend="project_facets">Project Facets wizard</link>, where you can create + your own custom facets configuration.</para> + + <para></para> + + </section> + <section id="rel_resources_links"> + <title>Relevant Resources Links</title> + + <para>More on the WTP facets you can read in the <ulink url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jst.j2ee.do...">eclipse help</ulink>.</para> + </section> +</chapter> + + +<chapter id="modules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/modules.xml"> + <title>Deploying Modules</title> + + <para>In this chapter it will be described how to deploy modules onto the server.</para> + <para> First of all it is necessary to say that deploying to a server is mostly painless. There + are several ways to do it provided by WTP, and some additional methods provided by JBoss + Tools. These methods are described further in this chapter.</para> + + <section> + <title>Deploying on the Package Explorer</title> + + <para>On the package explorer it is possible to publish either a project to a server or just + a single file. Let's look at how to do this.</para> + <section id="run_on_server_wizard"> + <title>Deploying with Run On Server Wizard</title> + <para> The first WTP method is to right-click on a project, such as a Dynamic Web + project, EJB project, or EAR project and then select <emphasis> + <property moreinfo="none">Run As > Run on Server</property> + </emphasis>. The resulting dialog allows you to select which supporting server the + project can be published to.</para> + <figure float="0"> + <title>Define a New Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to see add or remove projects page where you can choose projects + to configure them on server.</para> + <figure float="0" id="add_rem_proj"> + <title>Add or Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This page of the wizard also allows to undeploy modules from the server. For that + choose proper module(s) from the right and click <emphasis> + <property moreinfo="none"> < Remove</property> + </emphasis>. The modules will be completely undeployed after restarting your server + or republishing.</para> + <para>Generally, for the JBoss AS Server Adapters, publishing using this method will + force a default, best-guess, packaging configuration for your project. This + best-guess does not publish incrementally, but instead repackages your entire + project into a <emphasis> + <property moreinfo="none">.war</property> + </emphasis>, <emphasis> + <property moreinfo="none">.jar</property> + </emphasis>, or <emphasis> + <property moreinfo="none">.ear</property> + </emphasis> as appropriate, and then copies that file into the proper deploy + directory. For quicker smarter deployment, you will need to create archives using + the <link linkend="Project_archivesView">Project Archives view</link> and customize + packaging yourself.</para> + + + + </section> + + <section id="single_file_deployment"> + <?dbhtml filename="DeployToServer.html"?> + <title>Deploying single files</title> + + <para>Sometimes it becomes necessary to deploy one or more files to a server. For + that in order not to do a full republish in the context menu of files a <emphasis><property moreinfo="none">Deploy To Server</property></emphasis> + option is provided that allows a single file deployment. To deploy these non-WTP files/projects + right click on the file (<emphasis> + <property moreinfo="none">-ds.xml</property></emphasis>, <emphasis> + <property moreinfo="none">.ear</property></emphasis>, <emphasis> + <property moreinfo="none">.jar</property></emphasis> etc.) and select <emphasis> + <property moreinfo="none">Deploy To Server</property> + </emphasis> and it will be automatically deployed.</para> + <figure float="0"> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The deployed files are listed side-by-side with other modules that are deployed to + the server.</para> + + <figure float="0"> + <title>Deployed files on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + <section> + <title>Deploying with JBoss Server View</title> + <para>As it has been already mentioned <property moreinfo="none">JBoss Server View</property> contains two + parts: the top part that displays all defined servers and the bottom part which provides + categories with additional information. Thus, in this section we suggest two more ways + to deploy resources onto the server.</para> + <section> + <title>Top part of JBoss Server View</title> + <para>In the top part of the <property moreinfo="none">JBoss Servers View</property> like in the Servers + View you should right click on a server and select the <emphasis> + <property moreinfo="none">Add and Remove Projects</property> + </emphasis> menu item.</para> + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing + you to either publish projects or modules to a server, or remove them from the + server. If the selected module is a project like a Dynamic Web project, EJB project, + or EAR project, it will be published as through <emphasis> + <property moreinfo="none">Run on Server</property> + </emphasis> wizard, with a best-guess full package. If, however, the selected + element is an archive from the <link linkend="Project_archivesView">Project Archives + view</link>, it will be published according to the rules of that module + type.</para> + </section> + + <section> + <title>Bottom part of JBoss Server View</title> + <para>In the bottom part of <emphasis> + <property moreinfo="none">JBoss Server View</property> + </emphasis> there is a category called <emphasis> + <property moreinfo="none">Modules</property> + </emphasis> which should display all currently-published modules on the server. + Right-clicking on the desired module and selecting <emphasis> + <property moreinfo="none">Full Publish</property> + </emphasis> will force a full rebuild of the entire module.</para> + <figure float="0"> + <title>Full Publish</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here, <emphasis> + <property moreinfo="none">Incremental Publish</property> + </emphasis> is meant to enable publishing of only those parts where changes have + been made.</para> + </section> + </section> + <section> + <title>Deploying with Project Archives View</title> + <para>In the <property moreinfo="none">Project Archives View</property> you can right-click on any declared + archive and select the <emphasis> + <property moreinfo="none">Publish To Server</property> + </emphasis> element. For more on this subject, see <link linkend="PublishToServer">Publishing to Server</link> in the Project Archives View section.</para> + <figure float="0"> + <title>Publish to Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> The only way to ensure an <emphasis> + <property moreinfo="none">Incremental Build</property> + </emphasis>, such as changes to one <emphasis> + <property moreinfo="none">.jsp</property>, </emphasis> + <emphasis> + <property moreinfo="none">.html</property>, </emphasis> or <emphasis> + <property moreinfo="none">.class</property> + </emphasis> file, is to enable the builder for that project. This is done by either + changing the global preferences for the <property moreinfo="none">Archives View</property>, or by + enabling project-specific preferences and ensuring the builder is on.</para> + + <para>You can also use the "Finger touch" button for a quick restart of the project without restarting the server:</para> + <figure float="0"> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_8_finger_touch.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</para> + + + <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a + server.</para> + </section> +</chapter> + + +<chapter id="tptp_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/as/docs/reference/en/modules/tptp_support.xml"> + <title>TPTP Support</title> + <para>This chapter provides an overview on how to enable TPTP Profiling for <property moreinfo="none">JBoss + AS</property> adapters in <property moreinfo="none">JBoss Tools</property>.</para> + + <section> + <title>TPTP Profiling</title> + + <para>To get TPTP profiling work on <property moreinfo="none">JBoss Application Server</property> you should + first download <ulink url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/TPTP-4.5.0...">TPTP 4.5.0 Runtime</ulink> and install it, i. e. just add the content of <emphasis> + <property moreinfo="none">plugins/features</property> + </emphasis> folders from downloaded directory to the same folders in your eclipse + installation directory.</para> + + <para>And now all profile actions should work for you. To start <property moreinfo="none">JBoss + AS</property> in profiling mode use <emphasis> + <property moreinfo="none">Start the server in profiling mode</property> + </emphasis> button or <emphasis> + <property moreinfo="none">Profile As > Profile on Server</property> + </emphasis> option in the context menu of the project.</para> + + <figure float="0"> + <title>Start the Server in Profiling mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To enable TPTP features in your workbench use <property moreinfo="none">Profiling and Logging + Perspective</property> that you can find in the list of proposed perspectives: <emphasis> + <property moreinfo="none">Window > Open Perspective > Other…</property> + </emphasis> + </para> + + <figure float="0"> + <title>Profiling and Logging Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>All additional information on TPTP(Test and Performance Tools Platform) you can find + in <ulink url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quicktour/quic...">eclipse documentation</ulink>.</para> + <para>In summary, this reference should help you to start with <ulink url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know with functionality + for work with it.</para> + </section> +</chapter> + + +</book> Added: trunk/as/docs/reference/en-US/modules.xml =================================================================== --- trunk/as/docs/reference/en-US/modules.xml (rev 0) +++ trunk/as/docs/reference/en-US/modules.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,198 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="modules"> + <title>Deploying Modules</title> + + <para>In this chapter it will be described how to deploy modules onto the server.</para> + <para> First of all it is necessary to say that deploying to a server is mostly painless. There + are several ways to do it provided by WTP, and some additional methods provided by JBoss + Tools. These methods are described further in this chapter.</para> + + <section> + <title>Deploying on the Package Explorer</title> + + <para>On the package explorer it is possible to publish either a project to a server or just + a single file. Let's look at how to do this.</para> + <section id="run_on_server_wizard"> + <title>Deploying with Run On Server Wizard</title> + <para> The first WTP method is to right-click on a project, such as a Dynamic Web + project, EJB project, or EAR project and then select <emphasis> + <property>Run As > Run on Server</property> + </emphasis>. The resulting dialog allows you to select which supporting server the + project can be published to.</para> + <figure> + <title>Define a New Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property>Next</property> + </emphasis> button to see add or remove projects page where you can choose projects + to configure them on server.</para> + <figure id="add_rem_proj"> + <title>Add or Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>This page of the wizard also allows to undeploy modules from the server. For that + choose proper module(s) from the right and click <emphasis> + <property> < Remove</property> + </emphasis>. The modules will be completely undeployed after restarting your server + or republishing.</para> + <para>Generally, for the JBoss AS Server Adapters, publishing using this method will + force a default, best-guess, packaging configuration for your project. This + best-guess does not publish incrementally, but instead repackages your entire + project into a <emphasis> + <property>.war</property> + </emphasis>, <emphasis> + <property>.jar</property> + </emphasis>, or <emphasis> + <property>.ear</property> + </emphasis> as appropriate, and then copies that file into the proper deploy + directory. For quicker smarter deployment, you will need to create archives using + the <link linkend="Project_archivesView">Project Archives view</link> and customize + packaging yourself.</para> + + + + </section> + + <section id="single_file_deployment"> + <?dbhtml filename="DeployToServer.html"?> + <title>Deploying single files</title> + + <para>Sometimes it becomes necessary to deploy one or more files to a server. For + that in order not to do a full republish in the context menu of files a <emphasis><property>Deploy To Server</property></emphasis> + option is provided that allows a single file deployment. To deploy these non-WTP files/projects + right click on the file (<emphasis> + <property>-ds.xml</property></emphasis>, <emphasis> + <property>.ear</property></emphasis>, <emphasis> + <property>.jar</property></emphasis> etc.) and select <emphasis> + <property>Deploy To Server</property> + </emphasis> and it will be automatically deployed.</para> + <figure> + <title>Deploy to Sever</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The deployed files are listed side-by-side with other modules that are deployed to + the server.</para> + + <figure> + <title>Deployed files on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_7.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + <section> + <title>Deploying with JBoss Server View</title> + <para>As it has been already mentioned <property>JBoss Server View</property> contains two + parts: the top part that displays all defined servers and the bottom part which provides + categories with additional information. Thus, in this section we suggest two more ways + to deploy resources onto the server.</para> + <section> + <title>Top part of JBoss Server View</title> + <para>In the top part of the <property>JBoss Servers View</property> like in the Servers + View you should right click on a server and select the <emphasis> + <property>Add and Remove Projects</property> + </emphasis> menu item.</para> + <figure> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This will bring up a <link linkend="add_rem_proj">familiar dialog</link> allowing + you to either publish projects or modules to a server, or remove them from the + server. If the selected module is a project like a Dynamic Web project, EJB project, + or EAR project, it will be published as through <emphasis> + <property>Run on Server</property> + </emphasis> wizard, with a best-guess full package. If, however, the selected + element is an archive from the <link linkend="Project_archivesView">Project Archives + view</link>, it will be published according to the rules of that module + type.</para> + </section> + + <section> + <title>Bottom part of JBoss Server View</title> + <para>In the bottom part of <emphasis> + <property>JBoss Server View</property> + </emphasis> there is a category called <emphasis> + <property>Modules</property> + </emphasis> which should display all currently-published modules on the server. + Right-clicking on the desired module and selecting <emphasis> + <property>Full Publish</property> + </emphasis> will force a full rebuild of the entire module.</para> + <figure> + <title>Full Publish</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here, <emphasis> + <property>Incremental Publish</property> + </emphasis> is meant to enable publishing of only those parts where changes have + been made.</para> + </section> + </section> + <section> + <title>Deploying with Project Archives View</title> + <para>In the <property>Project Archives View</property> you can right-click on any declared + archive and select the <emphasis> + <property>Publish To Server</property> + </emphasis> element. For more on this subject, see <link linkend="PublishToServer">Publishing to Server</link> in the Project Archives View section.</para> + <figure> + <title>Publish to Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para> The only way to ensure an <emphasis> + <property>Incremental Build</property> + </emphasis>, such as changes to one <emphasis> + <property>.jsp</property>, </emphasis> + <emphasis> + <property>.html</property>, </emphasis> or <emphasis> + <property>.class</property> + </emphasis> file, is to enable the builder for that project. This is done by either + changing the global preferences for the <property>Archives View</property>, or by + enabling project-specific preferences and ensuring the builder is on.</para> + + <para>You can also use the "Finger touch" button for a quick restart of the project without restarting the server:</para> + <figure> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/modules/modules_8_finger_touch.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR, jboss-esb.xml in ESB projects).</para> + + + <para>The last chapter covers a variety of methods on how you can deploy needed modules onto a + server.</para> + </section> +</chapter> Added: trunk/as/docs/reference/en-US/perspective.xml =================================================================== --- trunk/as/docs/reference/en-US/perspective.xml (rev 0) +++ trunk/as/docs/reference/en-US/perspective.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,1247 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="perspective" xreflabel="perspective" role="updated"> + <?dbhtml filename="perspective.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JBoss AS Perspective</title> + + <para>This chapter tells how to manage installed <property>JBoss Server</property> via + <property>JBoss AS perspective</property>.</para> + + <para>The <property>JBoss AS perspective</property> is similar to the <property>Java + perspective</property>, but it contains a few additional views. Two of the additional + views are standard views, specifically the <property>Console view</property> and the + <property>Properties view</property>. The other two views that are added are the + <property>Project archives view</property> and the <property>JBoss Server + View</property>.</para> + + <section id="JBossServerView" role="updated"> + <?dbhtml filename="JBossServerView.html"?> + <title>The JBoss Server View</title> + + <para>The <property>JBoss Server View</property> is built on Common Navigator Framework + allowing extensions and is using label decorators what makes the UI enough compact + without loosing the vital information.</para> + + <para>Let's have a look at the <property>JBoss Server View</property> and inspect + in detail all parts it consists of. </para> + <figure> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <section id="jbossserver_view_toolbar"> + <title>JBoss Server View Toolbar</title> + <para>In the right top corner of the <property>JBoss Server View</property> there is a + special toolbar which provides a quick access to starting a server (in the debug + mode, run mode, or profile mode), restarting a server, stopping a server and a + possibility to publish to a server.</para> + + <figure> + <title>The JBoss Server View Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In order to debug your applications or EJB's that are deployed to the server, you + must start the server in debug mode. By starting the server in debug mode, eclipse + will allow you to set breakpoints on code in your workspace and step through the + code.</para> + + <para><emphasis> + <property>Start the server in profiling mode</property> + </emphasis> button allows to enable profiling actions for your application. For more + details on how to start using TPTP profiling with <property>JBoss Tools</property> + refer to <link linkend="tptp_support">TPTP Support</link> chapter.</para> + + <para><emphasis> + <property>Publish to the server</property> + </emphasis> button will republish any modules where it has determined the workspace + is out of sync with the server. It will attempt to do an incremental publish if it + turns out that the module in question is capable of doing one.</para> + + </section> + + <section id="jbossserver_view_structure"> + <title>JBoss Server View Structure</title> + <para>The <property>JBoss Server View</property> displays all declared servers as well + as their current states (that is whether they are started or stopped) and statuses + in the square brackets next to a server name.</para> + + <figure> + <title>The JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The following table lists possible server statuses.</para> + + <table> + <title>Server Publish Status</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + + <thead> + <row> + <entry align="center">Status</entry> + + <entry align="center">Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry align="center"> + <para>Republish</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + awaiting</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Publishing...</para> + </entry> + + <entry align="center"> + <para>The status which shows if changes are being updated</para> + </entry> + </row> + <row> + <entry align="center"> + <para>Synchronized</para> + </entry> + + <entry align="center"> + <para>The status which allows you to see if changes are + in-sync</para> + </entry> + </row> + </tbody> + </tgroup> + </table> + + <para>You can control a server behavior as well as adjust some server preferences with + the help of the context menu commands.</para> + + <figure> + <title>Context Menu Commands</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>All available context menu commands are described in the following table.</para> + <table> + <title>Server Properties through the Context Menu</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>New Server</para> + </entry> + <entry> + <para>The option allows to define a new server</para> + </entry> + </row> + + <row> + <entry> + <para>Open</para> + </entry> + <entry> + <para>The option opens the Server editor</para> + </entry> + </row> + + <row> + <entry> + <para>Show in</para> + </entry> + <entry> + <para>This option gives an easy access to the next views: Console, + Debug view, Server Log or MBean Explorer</para> + </entry> + </row> + + <row> + <entry> + <para>Delete</para> + </entry> + <entry> + <para>Standard option that allows to delete the chosen server</para> + </entry> + </row> + + <row> + <entry> + <para>Start</para> + </entry> + <entry> + <para>The action for stating a server in a run mode</para> + </entry> + </row> + + <row> + <entry> + <para>Debug</para> + </entry> + <entry> + <para>The action for stating a server in a debug mode</para> + </entry> + </row> + + <row> + <entry> + <para>Stop</para> + </entry> + <entry> + <para>The action for stopping a declared server</para> + </entry> + </row> + + <row> + <entry> + <para>Publish</para> + </entry> + <entry> + <para>The action for synchronizing the publish information between + the server and workspace</para> + </entry> + </row> + + <row> + <entry> + <para>Explore</para> + </entry> + <entry> + <para>This action uses the native OS file explorer to browse the + deploy destination. Note: The option is also available for + deployed resources/projects (see the figure below).</para> + </entry> + </row> + + <row> + <entry> + <para>Add and Remove Projects</para> + </entry> + <entry> + <para>The option allows to publish a new project to the server (if + its type is supported)</para> + </entry> + </row> + + <row> + <entry> + <para>Monitoring</para> + </entry> + <entry> + <para>Possibility to add ports to be monitored on the current + server</para> + </entry> + </row> + + <row> + <entry> + <para>Properties</para> + </entry> + <entry> + <para>Opens the window to adjust the current server + preferences</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>Under the server element in the <property>JBoss Server View</property>, you can + see currently deployed to the server modules and some server extensions which + provide the additional information on the server.</para> + + <para>The context menu for any module allows you to remove it from the server, force a + full or incremental republish upon it.</para> + + <figure> + <title>Modules Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <section id="filesets"> + <title>Filesets</title> + + <para>The <emphasis> + <property>Filesets</property> + </emphasis> category in the <property>JBoss Server View</property> is intended + for files filtering.</para> + + <para>To add a new file filter, right-click the <emphasis> + <property>Filesets</property> + </emphasis> category and select <emphasis> + <property>Create File Filter</property>.</emphasis></para> + <para id="filefilterWiz">The <property>New File + Filter wizard</property> should appear.</para> + + <figure> + <title>Creating a New File Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard asks you to enter the filter name and add includes and excludes + patterns. The preview box underneath gives a list of files matched to the + defined patterns (see the figures bellow).</para> + <para>In order to set up a default fileset relative to the concrete configuration of the server runtime, use the following variable: + <literal>${jboss_config}</literal>, i. e. you should type in the <emphasis> + <property>Root Directory</property></emphasis> something like <literal>server/${jboss_config}/</literal>. + This is implemented in order you can modify the runtime's configuration and not have to manually update paths.</para> + <figure> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2_a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Notice, that the <emphasis> + <property>Browse</property></emphasis> button still returns an absolute path:</para> + + <figure> + <title>New File Filter Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After the filter is created, you can observe it by expanding the <emphasis> + <property>Filesets</property> + </emphasis> category in the <property>JBoss Server View</property>.</para> + + <para>It's possible now to edit files directly from the <emphasis> + <property>Filesets</property> + </emphasis> category. Double clicking on a file from <emphasis> + <property>Filesets</property> + </emphasis> opens up the editor automatically or you can use the <emphasis> + <property>Edit File</property> + </emphasis> context menu command.</para> + + <figure> + <title>Direct Editing from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To delete a file filter (or just a file) from the <emphasis> + <property>Filesets</property>,</emphasis> right-click a file filter (or the + unnecessary file) and select the <emphasis> + <property>Delete File Filter</property> + </emphasis> + <emphasis>(<property>Delete File</property>)</emphasis> command.</para> + + <figure> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you want to set filesets for some server types, you should open + <emphasis><property>Window>Preferences</property></emphasis> + and then select <emphasis><property>Server > Default Filesets</property></emphasis> + from the categories available on the left.</para> + + <figure> + <title>Deleting the File from the Filesets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/filesets5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On this preference page you can add a fileset + to any server type or to all servers at once.To do this you should select the server type in the combo box and click <emphasis><property>Add fileset...</property></emphasis> button. + In the opened <property>New File + Filter wizard</property> follow the steps described <link linkend="filefilterWiz">before</link> and finally click <emphasis><property>Apply</property></emphasis> button on the preference page.</para> + <para>The defined file filter will be automatically added to new servers during creation.</para> + + + </section> + + <section id="xml_configuration"> + <title>XML Configuration</title> + <para>The <emphasis> + <property>XML Configuration</property> + </emphasis> category allows you to quickly browse to descriptor files in your + server's deploy directory and check or change the values. Basically, <emphasis> + <property>XML Configuration</property> + </emphasis> includes XML XPaths where an xpath is a path used to access some + specific part of an xml document. </para> + + <note> + <title>Note:</title> + <para>You are assumed to be familiar with XPath. If not, we highly suggested + that you look through an appropriate manual or tutorial on the topic.</para> + </note> + + <para>The <emphasis> + <property>XML Configuration</property> + </emphasis> category itself contains only a list of categories. <emphasis> + <property>Ports</property> + </emphasis> are provided by default and is filled with many of the most commonly + used ports in the <property>JBoss Server</property>.</para> + + <figure> + <title>XML Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_14.png"/> + </imageobject> + </mediaobject> + </figure> + + +  + + <para>By right-clicking on <emphasis> + <property>XML Configuration</property>, </emphasis> you can create a new + category. Besides, context menu for <emphasis> + <property>XML Configuration</property> + </emphasis> category makes possible to disable it. You can disable any category + in the bottom part of the <emphasis> + <property>JBoss Server View</property>.</emphasis> Look for them in the <emphasis> + <property>Inactive Categories</property> + </emphasis> afterwards to re-enable.</para> + + <figure> + <title>Adding New Category</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_15.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>By right-clicking on <emphasis> + <property>Ports</property> + </emphasis> or any other category in <emphasis> + <property>XML Configuration</property> + </emphasis>, you can create a new xpath.</para> + + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_16.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After that, the dialog shown below will appear.</para> + + <figure> + <title>Adding New XPath</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_17.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The goal here is to get an end result where the XPath matches up with a + necessary property. With that in mind, let's look how it works. If the + property you want to reach is the value of the <emphasis>name</emphasis> + attribute in the element <code><mbean></code>, then your <emphasis> + <property>XPath Patten</property> + </emphasis>should end with <emphasis>mbean</emphasis> and your <emphasis> + <property>Attribute Name</property> + </emphasis> should be <emphasis>name</emphasis> like on the next figure.</para> + + <programlisting role="XML"><![CDATA[... +<server> +... + <mbean code="org.jboss.ejb.EJBDeployer" + name="jboss.ejb:service=EJBDeployer" xmbean-dd=""> + +  + <xmbean> + <description> + The EJBDeployer responsible for ejb jar deployment</description> + ... + </xmbean> + </mbean> +</server> +]]></programlisting> + + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_18.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Notice, when you type the fields autocomplete to help you locate exactly + what xpath you're looking for.</para> + </tip> + + <para>Then, on the other hand, if your desired field is the text of an element + <code><description></code>, your <emphasis> + <property>XPath Patten</property> + </emphasis> should end with <emphasis>description</emphasis> and <emphasis> + <property>Attribute Name</property> + </emphasis> field should be left blank. When finished, click <emphasis> + <property>Preview</property> + </emphasis> to see how many matches you have for that particular XPath.</para> + + <figure> + <title>XPath Preview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_19.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + <section id="dragndrop_to_jboss_server_view"> + <title>Drag-n-Drop to JBoss Server View</title> + + <para>Starting from 2.0.0.CR2 version of <property>JBoss AS Tools</property> the + <property>JBoss Server View</property> supports drag-n-drop of deployable and + runnable projects/resources.</para> + + <figure> + <title>Dragging to the JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/dnd_toJBossServerView.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>With drag-n-drop the following actions can be performed:</para> + + <itemizedlist> + <listitem> + <para>dragging a project to a server will deploy it to the server and run it by + showing the main page in a browser</para> + </listitem> + + <listitem> + <para>dragging an <emphasis> + <property>.xhtml</property> + </emphasis> file from <emphasis> + <property>WebContent</property> + </emphasis> will do the same and show the corresponding page in a + browser</para> + </listitem> + + <listitem> + <para>dragging a deployable resource (i.e. a datasource (<emphasis> + <property>-ds.xml</property> + </emphasis>) file that has been made deployable) will simply deploy that + resource directly to the server</para> + </listitem> + </itemizedlist> + + <para>In short, the feature does the same thing as if you used the <emphasis> + <property>Run On Server</property> + </emphasis> option or <emphasis> + <property>Add and Remove Projects</property> + </emphasis> option in the context menu of the server.</para> + </section> + + <section id="server_log"> + <title>Server Log View</title> + + <para>You can monitor the current server behavior with the help of the <property>Server + Log</property>. To open a server in the <property>Server Log view</property> you + should right-click on the server and follow to <emphasis> + <property>Open in > Server Log</property>.</emphasis></para> + + <para>The <emphasis> + <property>Server Log</property> + </emphasis> shows relevant information to your server's startup, shutdown, + and publish processes. This allows you to keep an eye on what's going on + (such as automatic incremental deployment if you have it enabled).</para> + + <figure> + <title>Event Log Actions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Server Log</property> toolbar contains several icons that perform + the following actions:</para> + + <table> + <title>Server Log Toolbar Icons</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Export Log</para> + </entry> + <entry> + <para>Possibility to export the log into a text file</para> + </entry> + </row> + + <row> + <entry> + <para>Clear Log Viewer</para> + </entry> + <entry> + <para>The option clears the current server log</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Log</para> + </entry> + <entry> + <para>Click to delete the server log</para> + </entry> + </row> + + <row> + <entry> + <para>Open Log</para> + </entry> + <entry> + <para>Click to open the server log text file</para> + </entry> + </row> + + <row> + <entry> + <para>Restore Log</para> + </entry> + <entry> + <para>Click to restore the server log</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + </section> + + <section id="server_editor"> + <title>Server Editor</title> + <para>By double-clicking on any server, an editor window will appear allowing you to + edit parts of that server.</para> + + <figure> + <title>Preferences Page for the Chosen Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On the figure you can see that a username/password is available in the UI when + configuring the server. If you get a SecurityException when trying to launch the + server, it is most likely because your server is protected and hence you need to + fill the username/password fields with appropriate values.</para> + </tip> + + <para>Under the <emphasis> + <property>Publishing</property></emphasis> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</para> + + <para>It should be pointed out that our server adapter by default tries to automatically + detect the ports it needs for integrating with a <property>JBoss Server</property>. + Sometimes it can though be relevant to override this automatic detection if you are + using some custom configuration. For this purposes the <emphasis> + <property>Server Ports</property> + </emphasis> section in the <property>Server editor</property> is provided where the + port settings are configurable. Click the <emphasis> + <property>Configure...</property> + </emphasis> link to bring up the wizard for adjusting the settings for the + ports.</para> + + <figure> + <title>Server Ports Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property>Edit XPath</property> + </emphasis> button for the chosen port to configure its XPath's values.</para> + + <figure> + <title>XPath Pattern for a Server Port</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property>Server editor</property> you are able to edit the timeouts and the server pollers to use.</para> + + <note> + <title>Note:</title> + <para>By default, the Startup poller is set to JMX Poller (see the <emphasis> + <property>Server Polling</property></emphasis> section). If you change the Startup poller + to Timeout Poller (it may need in case, for example, you're using the minimal configuration for your server), this will do no polling at all and will only set the server + state to <emphasis> + <property>"Started"</property></emphasis> after your startup timeout is reached.</para> + </note> + + <para id="com_line_arg"><property>Server editor</property> makes it also possible to + modify the server's launch configuration. It's just after clicking <emphasis> + <property>Open launch configuration</property> + </emphasis> link. In the open window there are the tabs for setting command line + arguments, main, classpaths and other things that are relevant to launching the + server.</para> + + <figure> + <title>Launch Configuration Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_7.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>The first tab shows the Jboss server arguments</para> + <para>Look up <ulink + url="http://docs.jboss.org/jbossas/guides/installguide/r1/en/html/start-stop.html" + >AS Installation Guide </ulink> to find parameters which can be specified for <property>JBoss + Server</property>.</para> + + <note> + <title>Note:</title> + <para>Please note, that the Launch Configurations for JBoss Servers are enough + strict in enforcing the configured values in the server in order to avoid + inconsistencies between server's and their configured runtime.</para> + + <para>For example, if you change the launch configuration program arguments to + <emphasis>"-c myConfig"</emphasis> but do not change the + targeted runtime configuration, then your program arguments will be ignored. The + server runtime "wins" so to speak. This ensures consistency + and if you change the location of the runtime, your launch configurations will + automatically pick that up.</para> + + <para>Values are not controlled by the server and its runtime setup will be passed + on unaltered.</para> + </note> + + <para>On the second tab you find the main class used for launching JBoss AS (default is org.jboss.Main), you can change it, if necessary. </para> + + <para>Until 3.0.0.GA release of <property>JBoss Tools</property>, the servers classpath + was readonly, but that caused problems for users wanting to add their own jars in + the startup classpath. That is relevant if you need to patch the server, add a + custom charset or other tweaks that require early access to the classpath.</para> + + <para>Now all servers have a custom 'server runtime classpath + container', which is there by default and point to the default jars in + JBoss. You can now adjust the classpath. Then just make sure this container is there + if you want the classpath to be picked up.</para> + + <figure> + <title>Server Classpaths</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/server_classpaths.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If for some reason you have a launch configuration without this container, <emphasis> + <property>Restore Default Entries</property> + </emphasis> should add it properly. Also, <emphasis> + <property>Restore Default Entries</property> + </emphasis> will also remove any extra entries you added yourself.</para> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>Find more about XPath in the <ulink url="http://www.w3.org/TR/xpath20/">XPath + Documentation</ulink>.</para> + </section> + </section> + + <section id="Project_archivesView" role="updated"> + <title>Project Archives View</title> + <para>Every application, whether Plain Old Java, J2EE, or some other language altogether, + needs to be packaged in some way. In Java-related projects, many people use ANT. </para> + <note> + <title>Note:</title> + <para>Those who use ANT will appreciate how the Project Archives Ant task is now + improved: it supports variables and gives more informative error/logging messages + when something goes wrong.</para> + </note> + + <para>But <property>JBoss Tools</property> come with our own Archives tool with a bit easier + and less-verbose XML and a handy user interface. The Project Archives plugin consists + primarily of a view, that is <property>Project Archives view</property>, to set up each + packaging configuration.</para> + <para>So far, let's look through all functionality that the <property>Project + Archives view</property> provides.</para> + + <section id="archives_overview"> + <title>Overview</title> + + <para>The packaging configuration for each project is stored in the project's root + folder, and is in a file named <emphasis> + <property>.packages</property> + </emphasis>, which has a fairly simple XML structure. Modifying the file by hand is + neither required nor recommended, and using the UI is the official way of modifying + your packaging structure.</para> + + <figure> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>A project's configuration contains archives. As you can see on the image + above a project can contain more than one archive. Internal archives and filesets + can be directly inside of an archive, or in some sub-folder of that archive.</para> + + <para>In the upper right corner of the view you can see an icon which, when clicked, + will build the selected top-level archive. Additionally, you can select <emphasis> + <property>Project > Build Packages</property> + </emphasis> when a project is selected in the <property>Packages View</property> to + build all declared packages in that project's <emphasis> + <property>.packages</property> + </emphasis> file. This will execute a full build on all declared archives.</para> + </section> + + <section id="Creating_Archive"> + <title>Creating an Archive</title> + + <para>When you open the <property>Project archives view</property> for the first time, + it asks you to select the project for what you want to create an archive.</para> + + <figure> + <title>Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_21a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>When creating a new archive for selected project, you have some different options + at your disposal. You need right-click inside the view and select <emphasis> + <property>New Archive</property> + </emphasis> to see your archive type options.</para> + + <figure> + <title>Create an Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_22.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you see only JAR from the list of available archive types, you should + verify whether AS Tools plugins/features are in place. EAR, EJB JAR and WAR + options are contributed by the AS Tools independently from webtools and the + virtual project model. Thus, without them only JAR will show up.</para> + </note> + + <para><property>JAR</property> is the standard archive type, and does very little + configuration, leaving most of the work up to you. You can customize the name, add + folders, filesets, and inner jars to it.</para> + + <para>The other types, for the most part, simply start off with a default setting, + usually the jar with some specific children based on an expected structure of the + project. For example, if the project is a Dynamic Web Project, and you create a + <property>WAR</property> archive, the archive will be created with a few + filesets relevant to the known structure of the project.</para> + + <para>Here is the first page of all New archive wizards. It is the same for any archive + type and the only page in the <property>New Jar wizard</property>.</para> + <figure> + <title>New WAR Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The page is pretty simple. First it asks to set the name of your new archive and a + destination.</para> + + <para>The destination of an archive can be anywhere on the file system, anywhere in the + workspace, inside some other archive, or inside a folder declared inside an archive. + Select the necessary checkbox (either <emphasis> + <property>workspace</property> + </emphasis> or <emphasis> + <property> file system</property> + </emphasis>) for marking the destination as related to either workspace or file + system. You can browse to workspace or filesystem destinations by clicking on their + respective buttons. To select a destination inside some other archive, you'll need + to press the <emphasis> + <property>Workspace</property> + </emphasis> button. At the bottom of the list, you'll see archives that + have been declared in the workspace.</para> + + <figure> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Also in the wizard for creating a new archive you can choose whether an archive to + be compressed or exploded into a folder (without compression). You need just select + proper chechbox in the <emphasis> + <property>Archive type</property> + </emphasis> section.</para> + <para>If a build or incremental update fails Project Archives will show an error + dialog:</para> + <figure> + <title>Selecting the destination in the workspace</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/projectarchives_error.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click in <emphasis> + <property>Details</property> + </emphasis> to see detailed information about what caused the error.</para> + + <para>In the <property>Package Explorer</property> you can observe the created + archive.</para> + <figure> + <title>The Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you use the exploded type of archiving, instead of a single file archive the + result put into a folder is displayed in the <property>Package + Explorer</property>.</para> + <figure> + <title>The Exploded Archive in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_23c.png"/> + </imageobject> + </mediaobject> + </figure> + + <section id="CreatingaFolder"> + <title>Creating a Folder</title> + <para>Creating a folder is much easier. You simply right-click on an archive or + folder you want your new folder to be a child under. The only piece of required + information is naming the file.</para> + </section> + <section id="CreatingaFileSet"> + <title>Creating a FileSet</title> + <para>To create a new fileset, you click on an available target location such as an + archive, a nested archive, or a folder within an archive, and select <emphasis> + <property>New Fileset</property>. </emphasis></para> + <para>The <property>New Fileset wizard</property> requires a destination (where the + files will go), and a root directory (or where the files are coming from). The + source can be anywhere in the workspace or from the filesystem at large.</para> + + <figure> + <title>Adding a New FileSet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Below that, the fileset requires only an includes pattern and an excludes + pattern. As you type in either of these fields, the preview viewer should update + itself with which files are matched.</para> + + <para>You can create a Fileset with flattening or without it. Look at the difference + on the figure below.</para> + + <figure> + <title>The FileSet with flattening and without it</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_24a.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="CreatingaUserLibrariesFileSet"> + <title>Creating User Library FileSet</title> + + <para>If you use user libraries in your projects you can also refer to these from project archives and have all the .jar/.zip files they refer included into the archive.</para> + <para>To add a new user libraries file set, call the right-click menu on the necessary archive and choose " New User Libraries FileSet" item</para> + + <figure> + <title>Adding New User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can edit the existing user libraries as well using "User Libraries Fileset Wizard". Call the right-click menu on the library fileset and choose "Edit Fileset " item</para> + + <figure> + <title>Editing User Library Fileset</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/userlibraryfileset2.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + </section> + + <section id="View_Actions"> + <title>Archive Actions</title> + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_25.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The context menu on the items in the view is extendable, but there are several + that come standard.</para> + + <table> + <title>Context Menu on the Item</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Build Archive (Full)</para> + </entry> + + <entry> + <para>The action enabled only on top-level archives, which initiates + a full build on that archive</para> + </entry> + </row> + + <row> + <entry> + <para>Edit Archive</para> + </entry> + + <entry> + <para>Standard action that brings up the wizard associated with that + particular node type and allows the details to be changed</para> + </entry> + </row> + + <row> + <entry> + <para>Delete Archive</para> + </entry> + + <entry> + <para>Deleting node is standard action with deletion not needing an + explanation</para> + </entry> + </row> + + <row> + <entry> + <para>Publish To Server</para> + </entry> + + <entry> + <para>The action means the ability to publish to a declared + server</para> + </entry> + </row> + + <row> + <entry> + <para>Edit publish settings</para> + </entry> + + <entry> + <para>Gives possibility to edit an archive publish settings</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <note> + <title>Note:</title> + <para>When editing an archive, it is also updated in all folders and other archives where it is nested.</para> + </note> + </section> + + <section id="PublishToServer"> + <title>Publishing to Server</title> + <para>Finally, you'll need to publish your application to a server. Here, we + show you how to do it with the help of <emphasis> + <property>Archives View</property>. </emphasis></para> + + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/perspective/perspective_26.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The dialog above appears after selecting <emphasis> + <property>Publish To Server</property>. </emphasis> To simply publish once, you + just select the server(s) that you want, and finish. If you want the <emphasis> + <property>Publish to Server</property> + </emphasis> action on that particular Archive to publish always to that set of + servers, then check the appropriate checkbox. And finally, to enable automatic + publishing upon build events, check the last checkbox.</para> + <para>The automatic publishing feature is nice if, for example, your package's + destination (where it is built) is a temporary folder and you want the archive + published to several servers. If you only really want your archive published to one + server, it might be easier to have the archive's destination folder be the deploy + folder of the server.</para> + </section> + <section id="rel_res_links_archiving"> + <title>Relevant Resources Links</title> + <para>Refer to <ulink url="http://ant.apache.org/manual/index.html">Ant manual</ulink> + to find more on how to build your applications with help of Ant.</para> + + <para>We also recommend you to watch the <ulink + url="http://docs.jboss.org/tools/movies/demos/archiving/archiving.htm" + >movie</ulink> which demonstrates a powerful archiving functionality in + <property>JBoss Tools</property>.</para> + + <para>At this point, you are guessed to be familiar with <property>JBoss AS + perspective</property> and your next step now is to explore how to work with + different kinds of projects.</para> + </section> + + </section> + + +</chapter> Added: trunk/as/docs/reference/en-US/quick_start.xml =================================================================== --- trunk/as/docs/reference/en-US/quick_start.xml (rev 0) +++ trunk/as/docs/reference/en-US/quick_start.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,294 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="quick_start" role="updated"> + <title>Quick Start with JBoss Server</title> + + <para>This chapter covers the basics of working with the <property>JBoss Server</property>.</para> + + <section id="JBoss_server_key_features"> + <title>Key Features of JBoss Server</title> + <para>For a start, we propose you to look through the table of main features of JBoss Server:</para> + + <table> + + <title>Key Functionality for JBoss AS and Archive 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>JBoss AS plugin</para></entry> + <entry><para>Using WTP, JBoss AS plugin allows working with the server in run or debug mode. You can easily install runtimes and servers, copy the existing runtime configuration or configure it up to your needs.</para></entry> + <entry> + <link linkend="runtimes_servers">runtimes and servers</link> + </entry> + </row> + + <row> + <entry><para>JBoss AS Perspective</para></entry> + <entry><para>It makes managing installed JBoss Server quite easy and includes the standard Console and Properties views, and specially added Project archives View and JBoss Server View for that purpose. </para></entry> + <entry> + <link linkend="perspective">JBoss AS perspective</link> + </entry> + </row> + + <row> + <entry><para>Modules Deployment</para></entry> + <entry><para>A number of ways, provided by WTP and JBoss Tools, to deploy either a project or a single file on the server.</para></entry> + <entry> + <link linkend="modules">deploying modules</link> + </entry> + </row> + + <row> + <entry><para>TPTP Support</para></entry> + <entry><para>Test and Performance Tools Platform (TPTP) profiling.</para></entry> + <entry> + <link linkend="tptp_support">TPTP support</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + <para>If you + already have installed JBoss server and runtime you can quickly learn how to configure, start, + stop the server, to know deployment and archiving processes. How to install runtimes and servers + read in the <link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link> + chapter.</para> + + <para>To start working with JBoss AS, select a <property>JBoss AS Perspective</property> via + <emphasis><property>Window > Open Perspective > Other > JBoss + AS</property>.</emphasis></para> + </section> + + <section id="starting"> + <title>Starting JBoss Server</title> + + <para>Starting <property>JBoss Server</property> is quite simple. You can control the server + behaviour with the help of a special toolbar in the <property>JBoss Server View</property> + where you could <emphasis> + <property>start</property> + </emphasis> it in a regular or debug mode, <emphasis> + <property>stop</property> + </emphasis> it or <emphasis> + <property>restart</property> + </emphasis> it and <emphasis> + <property>publish</property> + </emphasis> to the server.</para> + + <figure> + <title>JBoss Server Toolbar</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To launch the server click the green-with-white-arrow icon on the <property>JBoss Server + View </property>or right click server name in this view and select <emphasis> + <property>Start</property>. </emphasis> If this view is not open, select + <emphasis><property>Window > Show View > Other > Server > + JBoss Server View</property>.</emphasis></para> + + <figure> + <title>Start JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_2.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="stopping"> + <title>Stopping JBoss Server</title> + + <para>To stop the server, click the <emphasis> + <property>Stop</property> + </emphasis> icon in the <property>JBoss Server View</property> or right click the server name + and press <emphasis><property>Stop</property>.</emphasis></para> + + <figure> + <title>Stop JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>When the server is stopped you will see <emphasis> + <property>Stopped</property> + </emphasis> state next to its name in the square brackets.</para> + <para>Learn more about the <property>JBoss Server View</property> + <link linkend="JBossServerView">here</link>.</para> + </section> + + <section id="archiving"> + + <title>Project Archiving</title> + + <para><property>JBoss Tools</property> comes with our own archives tool. The Project Archives + plugin consists primarily of a view to set up each packaging configuration <emphasis>( + <property>Window > Show View > Other > JBoss Tools > Project archives</property>). + </emphasis></para> + <para>Right clicking in the <property>Project archives view</property> you can create War, + EJB War, EAR or JAR archive.</para> + + <figure> + <title>Archive Creating</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Using the context menu on the item you can initiate a <emphasis><property>full build</property></emphasis> on + archive, <emphasis><property>edit</property>,</emphasis> <emphasis><property>delete</property></emphasis> or + <emphasis><property>publish</property></emphasis> it.</para> + + <figure> + <title>Context Menu on the Item</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you wish, you can assign a hotkey for the Build Project Archive action. A key binding can be added + by navigating to <emphasis> + <property>Window > Preferences > General > Keys</property>.</emphasis></para> + + <figure> + <title>Setting the Hotkey for Build Project Archive Action</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/hotkeys.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>To perform the building of the project archives, select the project in the <property>Package Explorer</property> view and execute the hotkey combination + you assigned for this action.</para> + + <para>Learn more about the <property>Project Archives View</property> + <link linkend="Project_archivesView">here</link>.</para> + </section> + + <section id="deployment"> + <title>Deploying an Application to a Server</title> + + <para>There are two times to deploy your application:</para> + <itemizedlist> + <listitem> + <para>While creating it</para> + </listitem> + <listitem> + <para>After it already exists</para> + </listitem> + </itemizedlist> + + <para>When you create a new project (Seam, JSF or Struts) with the New Project or Import Project + wizards, the one of wizards steps has a <emphasis> + <property>Target Runtime</property> + </emphasis> and <emphasis> + <property>Target Server</property> + </emphasis> sections. You can deploy the application through the appropriate selection in + these sections.</para> + + <figure> + <title>Runtime and Server Sections in the New Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4a.png"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Runtime and Server Sections in the Import Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_4b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can deploy an existing application to a server by right-clicking the target defined + server in the <property>JBoss Servers View</property> and then selecting <emphasis><property>Add and + Remove Projects</property></emphasis> from the context menu.</para> + + <figure> + <title>Add and Remove Projects From the Context Menu.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If this application is not assigned to a server, it will be in the left-hand available + projects list. Clicking on the <property>Add ></property> button will add it to the right-hand + configured projects list and deploy the application to this server.</para> + + <figure> + <title>Modifying The Projects that are Configured on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/quick_start/quick_start_6.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="publishing"> + <title>Publishing to JBoss Server</title> + <para>The publishing of all the modules added to a Server is performed automatically when starting a Server.</para> + <para>The automatic publish of the changes made to the workspace is turned on by default in order to permanently keep + the workspace in sync with the publish folder. If you need to control when to publish the changes, + just disable the automatic publish in the <link linkend="server_editor">Server Editor</link> and use the <emphasis> + <property>Publish to Server</property></emphasis> (<inlinemediaobject> + <imageobject> + <imagedata fileref="images/quick_start/publish_button.png"/> + </imageobject> + </inlinemediaobject>) button which initiates an incremental publish. + </para> + + <para>Here, we have just performed the basic steps you should know to quick start with JBoss + server. In fact, there are more functionalities which you can make use of. Further we will + talk about them in detail.</para> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <para>All JBoss Developer Studio/JBoss Tools documentation you can find <ulink + url="http://docs.jboss.org/tools/2.1.0.GA">on JBoss Tools release documentation page</ulink>.</para> + <para>The latest documentation builds are available <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly builds documentation page</ulink>.</para> + + <para>Find out the answers on the frequently asked questions about JBoss AS 5 usage in the + <ulink url="http://www.jboss.org/community/wiki/jboss5faq">JBoss5FAQ</ulink>. + </para> + + <para>The information on how to monitor a remote JBoss Server from Eclipse you can find in the following + <ulink url="http://www.jboss.org/community/wiki/MonitorARemoteJbossServerFromEclipse">wiki article</ulink>.</para> + </section> + +</chapter> Added: trunk/as/docs/reference/en-US/runtimes_servers.xml =================================================================== --- trunk/as/docs/reference/en-US/runtimes_servers.xml (rev 0) +++ trunk/as/docs/reference/en-US/runtimes_servers.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,342 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="runtimes_servers" xreflabel="runtimes_servers"> + <?dbhtml filename="runtimes_servers.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Runtimes and Servers in the JBoss AS plugin</title> + + <para>In this chapter we will discuss how to install runtimes and servers.</para> + + <para>First of all it's necessary to mention that the JBoss AS plugin makes use of WTP. + This includes starting and stopping servers in run or debug mode. It also includes targeting WTP + projects, such as Dynamic Web Projects, to certain server runtimes in order to ensure that the + proper jars from a specific server are added to the project's classpath + properly.</para> + <para>In order to get started creating, running, and debugging J2EE applications, we should create + our <property>runtime</property> and <property>server</property> instances.</para> + + <section> + <title>Runtimes</title> + <para>In <property>JBoss Tools</property>, the main purpose of Server Runtimes is to point to a + server installation somewhere on disk. In our case, this will be a JBoss installation, and it + can then be used for two primary purposes:</para> + <itemizedlist> + <listitem> + <para>it provides classpath additions to WTP projects that require them.</para> + </listitem> + <listitem> + <para>for <property>JBoss server</property> at least, it provides information necessary for + the starting and stopping of the server, it tells which jars to run and which + configuration to use.</para> + </listitem> + </itemizedlist> + + <section id="InstNewRuntime"> + <title>Installing a New Runtime</title> + <para>You can install runtimes into eclipse from the <emphasis> + <property>Window > Preferences </property> + </emphasis> menu, and then select <emphasis> + <property>Server > Runtime Environments</property> + </emphasis> from the categories available on the left.</para> + <figure> + <title>Installed Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>From this preference page you can see all declared runtimes and their types as well. + Here, it's possible to edit or remove existing runtimes as well as add a new + one.</para> + + <para>To create a JBoss runtime click <emphasis> + <property>Add</property> + </emphasis> button and choose a necessary type of runtime from the <emphasis> + <property>JBoss Community</property> + </emphasis> category.</para> + + <figure> + <title>Adding a Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now there is a separation between .org servers (the <emphasis> + <property>JBoss Community</property> + </emphasis> category) and product server that comes with JBoss EAP in JBDS ( the <emphasis> + <property>JBoss Enterprise Middleware</property> + </emphasis> category).</para> + </note> + + <para>As you can see, <property>JBoss Tools</property> provide its own adapters such as JBoss + 3.2, 4.0, 4.2 and 5.0 as well. The last one comes with its own new feature, that is a safer + incremental deployment, which prevents partial deployments to be picked up by the server. It + means that scanning for auto-deployment is suspended while files are being copied to the + deployment location and resumed when the copy is completed.</para> + + <note> + <title>Note:</title> + <para>Currently we recommend you to use a fully supported JBoss 4.2 server adapter.</para> + </note> + + <para>You'll also note a Deploy-Only Runtime type. This type provides no classpath + for WTP projects. It is used solely by its server type for the purpose of setting up a + deploy directory for users who don't wish to make use of starting, stopping, or + debugging their projects inside eclipse.</para> + + <figure id="add_runtime_figure"> + <title>Adding a JBoss 4.2 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The following table describes all the available options of the currant wizard + page.</para> + <table> + <title>Server Runtime Wizard Parameters</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + <thead> + <row> + <entry align="center"> + <para>Name</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + <row> + <entry> + <para>Name</para> + </entry> + <entry> + <para>The name of a new Runtime for a chosen server. We suggest that you + don't leave a default value. It's better to give descriptive + names that will help to distinguish one runtime from another.</para> + </entry> + </row> + + <row> + <entry> + <para>Home directory</para> + </entry> + <entry> + <para>The path to a directory where the runtime is installed.</para> + </entry> + </row> + + <row> + <entry> + <para>JRE</para> + </entry> + <entry> + <para>The proper Java Runtime Environment. Because of the open-source nature of + JBoss, a user is likely to want to modify and repackage some of the + configuration-specific jboss jars and create their own configuration. Thus, rather + than forcing you to copy his entire JBoss installation, the structure of the + wizard allows to create only a new configuration instead.</para> + </entry> + </row> + + <row> + <entry> + <para>Directory</para> + </entry> + <entry> + <para>The path to a directory where the configurations are installed.</para> + </entry> + </row> + <row> + <entry> + <para>Configuration</para> + </entry> + <entry> + <para>The list of configurations (all, default, minimal) that is updated as soon as + you browse to a valid runtime installation folder.</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + <para>As a result of having each runtime represent a specific configuration rather than the + server installation as a whole, it is very likely you'll create several different + runtimes to test each of your configurations. It becomes important to ensure your runtimes, + and later your servers, are given descriptive names that help you to remember which is + which.</para> + + <para>Press <emphasis> + <property>Finish</property> + </emphasis> to see your new runtime in the list.</para> + <note> + <title>Note:</title> + <para>If you edit the configuration of a runtime, the changes don't affect the settings of the servers that currently use the runtime. + To apply the changes to them also,you should double right click the server, <emphasis> + <property>Overview>Runtime Environment</property> </emphasis> + ,make sure that necessary configuration is chosen,click <emphasis><property>Finish</property> </emphasis> and then <emphasis><property>Save</property></emphasis> button.</para> + </note> + </section> + <section id="CopyRuntime"> + <title>Copying the existing runtime configuration</title> + <para>While installing a new runtime you can copy the configuration from the existing one. + To do this you should perform all the steps in the <link linkend="InstNewRuntime">previous</link> section except pressing <emphasis> + <property>Finish</property></emphasis> + in the New Server Runtime Environment menu . + </para> + <para>Make sure that you browse to a valid runtime folder and can see the list of configurations (all, default, minimal) in the Configuration section . + Then choose necessary Configuration from the list and click <emphasis> + <property>Copy</property></emphasis>.The next dialog should appear. + </para> + <figure> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Change the name Click on <emphasis> + <property>Browse</property></emphasis> and select your configuration location or leave as it's if you want it to be located together with other runtime configurations. + </para> + <figure> + <title>Copy the existing configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click<emphasis> + <property> Ok </property></emphasis>and you should see the next wizard with the just added copied configuration. + + </para> + <figure> + <title>Runtime with copied configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4c.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Press <emphasis> + <property>Finish</property> + </emphasis> and you will see your new runtime in the list. + </para> + <para>You can also change a configuration of existing runtime to a copied one in the same way from the <emphasis> + <property> Window > Preferences </property></emphasis> + menu <emphasis> + <property>Server > Runtime Environments </property></emphasis> + and clicking <emphasis> + <property>Edit</property></emphasis>. + </para> + </section> + </section> + <section> + <title>Servers</title> + <para>WTP servers are eclipse-representations of a backing server installation. They are used to + start or stop servers, deploy to servers, or debug code that will run on the server. They keep + track of the modules (jars, wars, etc) you deploy to the server and also allow you to undeploy + those modules (see <link linkend="run_on_server_wizard">Deploying with Run On Server + Wizard</link> section). </para> + <para>Servers can be started or stopped with different <link linkend="com_line_arg">command-line + arguments</link>. They are often backed by a runtime object representing that server's + location.</para> + + <section> + <title>Creating a New Server</title> + + <para>There are many ways to get to the new server wizard. One way is to use the old standard <emphasis> + <property>File > New > Other... </property> + </emphasis> and then <emphasis> + <property>Server</property> + </emphasis>. This should show the wizard like below.</para> + <figure> + <title>Adding a JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>A server object is that keeps track of things like command line arguments when starting + or stopping, and runtimes keep track of the location of the installation. Thus, each server + instance must be backed by an appropriate runtime. </para> + + <para> <emphasis><property> New server wizard </property></emphasis> allows to name the server appropriately in the <emphasis><property>Server name field </property></emphasis >or you can use a generated default name.If it's nessecary to restore the default name,after you defined yours, click the Reset default button(<inlinemediaobject> <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_4d.png"/> + </imageobject></inlinemediaobject>). + From the list of already declared runtimes in the combo box below the view it's + possible to select which runtime you want your server to be backed by. If there is no + runtime that matches your needs just press the <emphasis> + <property>Add...</property> + </emphasis> link nearby to bring up the wizard for creating a new runtime (see the <link + linkend="add_runtime_figure">Installing a New Runtime section</link>). To configure the already installed + runtimes you should go to server preferences that you can easily do by pressing the <emphasis> + <property>Configure runtime environments...</property></emphasis> link.</para> + + <para>If the server you want to create doesn't have any installed runtime yet, the combo box + and the links are absent.</para> + + <figure> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In this case the next page in the wizard which has the same form as in <link + linkend="add_runtime_figure">the previous section</link> will ask you to create the + associated runtime.</para> + <para>Either way, after targeting your server to a runtime, the final screen in this wizard is + largely confirmational, giving you a chance to verify that you've selected the + appropriate runtime. </para> + + <figure> + <title>Installed Server Runtime Environments</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtimes_servers/runtimes_servers_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Press <emphasis> + <property>Finish</property> + </emphasis> to complete the process of the server creation.</para> + <para>Now that we've created our runtimes and servers, we can dwell on all services + and tools that JBoss Server Manager provides.</para> + + <para>We hope, this guide helped you to get started with the JBoss Tools server manager. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> + </section> + + +</chapter> Added: trunk/as/docs/reference/en-US/tptp_support.xml =================================================================== --- trunk/as/docs/reference/en-US/tptp_support.xml (rev 0) +++ trunk/as/docs/reference/en-US/tptp_support.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,60 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="tptp_support"> + <title>TPTP Support</title> + <para>This chapter provides an overview on how to enable TPTP Profiling for <property>JBoss + AS</property> adapters in <property>JBoss Tools</property>.</para> + + <section> + <title>TPTP Profiling</title> + + <para>To get TPTP profiling work on <property>JBoss Application Server</property> you should + first download <ulink + url="http://www.eclipse.org/downloads/download.php?file=/tptp/4.5.0/TPTP-4.5.0..." + >TPTP 4.5.0 Runtime</ulink> and install it, i. e. just add the content of <emphasis> + <property>plugins/features</property> + </emphasis> folders from downloaded directory to the same folders in your eclipse + installation directory.</para> + + <para>And now all profile actions should work for you. To start <property>JBoss + AS</property> in profiling mode use <emphasis> + <property>Start the server in profiling mode</property> + </emphasis> button or <emphasis> + <property>Profile As > Profile on Server</property> + </emphasis> option in the context menu of the project.</para> + + <figure> + <title>Start the Server in Profiling mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To enable TPTP features in your workbench use <property>Profiling and Logging + Perspective</property> that you can find in the list of proposed perspectives: <emphasis> + <property>Window > Open Perspective > Other…</property> + </emphasis> + </para> + + <figure> + <title>Profiling and Logging Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/tptp_support/tptp_support_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Relevant Resources Links</title> + <para>All additional information on TPTP(Test and Performance Tools Platform) you can find + in <ulink + url="http://www.eclipse.org/tptp/home/downloads/4.5.0/documents/quicktour/quic..." + >eclipse documentation</ulink>.</para> + <para>In summary, this reference should help you to start with <ulink + url="http://www.jboss.org/jbossas">JBoss AS</ulink> and get to know with functionality + for work with it.</para> + </section> +</chapter> Added: trunk/as/docs/reference/en-US/webtools.xml =================================================================== --- trunk/as/docs/reference/en-US/webtools.xml (rev 0) +++ trunk/as/docs/reference/en-US/webtools.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,163 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="webtools"> + <title>Projects</title> + <para>The most popular of the projects we deal with are the J2EE ones, such as Dynamic Web + Project, EJB Project, or EAR project. Web projects of <property>JBoss Tools</property> are + Struts, JSF and Seam projects. All of them are called faceted projects. Thus, in this + chapter we are going to tell you about facets the main benefit of which to provide proper + structuring and packaging for any type of project.</para> + + <section> + <title>Faceted Projects Overview</title> + <para>The idea behind faceted projects is that each project can accept units of + functionality, or facets, which can be added or removed by the user. Most often, these + facets either add to the project's classpath, enable a builder, or watch the project in + some other fashion. Generally, every project concerned has at least one facet when + it's created. As an example, a Web project has a WebDoclet facet, or an EJB + Project has an EJB Module facet as prerequisites.</para> + + <para> WTP projects have undergone some criticism as being + <emphasis>over-engineered</emphasis> or too restrictive in their design. WTP projects + are set up in a tree-relationship to each other, where one project can be a child of + another. For example, an EAR project may have a Web Project child, an EJB project child, + or other types.</para> + + <para> However, the benefit of this is that the structure of your projects is then known, + and packaging it up *should* be trivial. Apparently, if your project is non-standard, or + you feel too confined by such rigid structural requirements, you can still choose to + package your project using the <link linkend="Project_archivesView">Archives + plugin</link>.</para> + </section> + + + <section> + <title>Adding Facets to a Project</title> + + <para>In this section we're going to consider the facets added by <property>JBoss + Tools</property> and show how you can configure them in a project: add new ones or + modify already existing configuration of the facets.</para> + + <para>One way to configure the facets is doing it while organizing a new project. To + demonstrate this let's create a new <property>Dynamic Web Project</property> by + selecting <emphasis> + <property>File > New > Other...</property> + </emphasis> and then <emphasis> + <property>Web > Dynamic Web Project</property>. </emphasis></para> + <figure> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property>Next</property> + </emphasis> and you will see Dynamic Web Project page like on the figure below.</para> + + <para> The first page of most WTP projects allows you to target a specific runtime, + representing a server's library location. It will also provide you the ability to add + this project to an EAR project, and select a preselected default set of facets, called + a configuration, rather than manually select each facet you might want.</para> + <para> Selecting the runtime, again, allows the project to install the proper classpaths to + the project so it knows what code to compile against.</para> + + <figure id="dyn_web_project"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on the <emphasis> + <property>Modify</property> + </emphasis> button next to <property>Configuration</property> section in order to open + the wizard which allows you to modify a chosen configuration. The wizard looks as + follows.</para> + + <figure id="project_facets"> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here part of the listed facets are those which are provided by WTP. Some of them are + added by <property>JBoss Tools</property>. They are:</para> + <itemizedlist> + <listitem> + <para>BIRT Charting Runtime Component</para> + </listitem> + <listitem> + <para>BIRT Reporting Runtime Component</para> + </listitem> + <listitem> + <para>JBoss ESB</para> + </listitem> + <listitem> + <para>JBoss Portlets</para> + </listitem> + <listitem> + <para>JBoss Web Services</para> + </listitem> + <listitem> + <para>Seam</para> + </listitem> + </itemizedlist> + + <para>On this wizard page you can enable or disable any facet as well as change it version. + What you should note here is that some facets or facets versions may conflict with each + other. In case of incompatibility you'll be prompted about this in the combo + box underneath.</para> + <figure> + <title>Facet Constraints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When switching on the <emphasis> + <property>Runtimes</property> + </emphasis> tab on the right you'll see the current server Runtime.</para> + <figure> + <title>Runtimes on the Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/webtools/webtools_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On this tab you can also create a new Server Runtime and make it primary by pressing <emphasis> + <property>Make Primary</property> + </emphasis> button after enabling it.</para> + + <para>Clicking on <emphasis> + <property>OK</property> + </emphasis> will save the chosen configuration of the facets and return you to the <link + linkend="dyn_web_project">Dynamic Web Project wizard</link>. Further pages in the + wizard are specific to either the project type or the facets selected.</para> + + + <para>If you need to configure the facets for the existing project, you should bring up the + context menu for selected project and click <emphasis> + <property>Properties</property> + </emphasis> and then <emphasis> + <property>Project Facets</property>. </emphasis> This will bring up the familiar + <link linkend="project_facets">Project Facets wizard</link>, where you can create + your own custom facets configuration.</para> + + <para/> + + </section> + <section id="rel_resources_links"> + <title>Relevant Resources Links</title> + + <para>More on the WTP facets you can read in the <ulink + url="http://help.eclipse.org/ganymede/index.jsp?topic=/org.eclipse.jst.j2ee.do..." + >eclipse help</ulink>.</para> + </section> +</chapter> Modified: trunk/as/docs/reference/pom.xml =================================================================== --- trunk/as/docs/reference/pom.xml 2010-03-04 03:44:51 UTC (rev 20634) +++ trunk/as/docs/reference/pom.xml 2010-03-04 04:21:20 UTC (rev 20635) @@ -98,9 +98,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: trunk/as/docs/reference/publican.cfg =================================================================== --- trunk/as/docs/reference/publican.cfg (rev 0) +++ trunk/as/docs/reference/publican.cfg 2010-03-04 04:21:20 UTC (rev 20635) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20634 - in trunk/portlet/docs/reference: en-US and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-03 22:44:51 -0500 (Wed, 03 Mar 2010) New Revision: 20634 Added: trunk/portlet/docs/reference/en-US/ trunk/portlet/docs/reference/en-US/Author_Group.xml trunk/portlet/docs/reference/en-US/Book_Info.xml trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml trunk/portlet/docs/reference/en-US/Preface.xml trunk/portlet/docs/reference/en-US/Revision_History.xml trunk/portlet/docs/reference/en-US/images/ trunk/portlet/docs/reference/en-US/images/favicon.ico trunk/portlet/docs/reference/en-US/images/jbosstools_logo.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/ trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png trunk/portlet/docs/reference/en-US/images/reference/ trunk/portlet/docs/reference/en-US/images/reference/javaPortlet2.png trunk/portlet/docs/reference/en-US/images/reference/javaPortlet3.png trunk/portlet/docs/reference/en-US/images/reference/javaPortlet4.png trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png trunk/portlet/docs/reference/en-US/images/reference/portlet_preferences.png trunk/portlet/docs/reference/en-US/images/seam_portlet/ trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png trunk/portlet/docs/reference/en-US/images/starting_project/ trunk/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png trunk/portlet/docs/reference/en-US/images/starting_project/runOnServer.png trunk/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png trunk/portlet/docs/reference/en-US/intro.xml trunk/portlet/docs/reference/en-US/jsf_portlet.xml trunk/portlet/docs/reference/en-US/master.xml trunk/portlet/docs/reference/en-US/master_output.xml trunk/portlet/docs/reference/en-US/portlet_tools_tasks.xml trunk/portlet/docs/reference/en-US/reference.xml trunk/portlet/docs/reference/en-US/seam_portlet.xml trunk/portlet/docs/reference/en-US/starting_project.xml trunk/portlet/docs/reference/en-US/summary.xml trunk/portlet/docs/reference/publican.cfg Removed: trunk/portlet/docs/reference/en/ Modified: trunk/portlet/docs/reference/pom.xml Log: modified book to be built by publican and maven Added: trunk/portlet/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/portlet/docs/reference/en-US/Author_Group.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/Author_Group.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,26 @@ +<?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>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author></authorgroup> Added: trunk/portlet/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/portlet/docs/reference/en-US/Book_Info.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/Book_Info.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -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>JBoss Portlet Tools User Guide</title><subtitle>Provides information relating to the JBoss Portlet Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JBoss Portlet Tools User Guide explains how to begin with and manage JBoss Portlet Tools.</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><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent =================================================================== --- trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent (rev 0) +++ trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JBoss_Portlet_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml =================================================================== --- trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,12 @@ +<?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="intro.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="portlet_tools_tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="reference.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="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: trunk/portlet/docs/reference/en-US/Preface.xml =================================================================== --- trunk/portlet/docs/reference/en-US/Preface.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/Preface.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -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><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:include></xi:fallback></xi:include></preface> Added: trunk/portlet/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/portlet/docs/reference/en-US/Revision_History.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/Revision_History.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -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(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/portlet/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet4.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/javaPortlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/reference/portlet_preferences.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/reference/portlet_preferences.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/runOnServer.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/runOnServer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en-US/intro.xml =================================================================== --- trunk/portlet/docs/reference/en-US/intro.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/intro.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,123 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="intro" xreflabel="intro"> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property>JBoss Portal</property> and JSR-186/JSR-286 portlets. + Thus, this guide is intended to explain you how to get started and manage <property>JBoss Portlet Tools</property>.</para> +<section> + <title>What is JBoss Portal and Portlet Tools?</title> + <para><property>JBoss Portal</property> provides an open source platform for hosting and + serving a portal's Web interface, publishing and managing its content, and customizing + its experience. It supports a wide range of features, including standard portlets, + single sign-on, clustering, and internationalization. More about <property>JBoss Portal</property> you can find visiting + its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org/jbossportal/</ulink>.</para> + + <para>With <property>JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property>JBoss Portal</property>.</para> + </section> + + <section id="key_features"> + <title>Key Features of JBoss Portlet Tools</title> + <para><property>JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and + <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with + <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets + in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project + (see <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link>). The project could be a non-WTP project, but you should know that + if it does not have the proper portlet API jar's the generated classes will have compile errors.</para> + + <para>The next table lists key features supplied by <property>JBoss Portlet Tools</property>.</para> + + <table> + <title>Key Features of JBoss Portlet Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>JBoss Portlet facets</para> + </entry> + <entry> + <para><property>JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> + </entry> + <entry> + <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link> + </entry> + </row> + + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> + + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant + portlets</para> + </entry> + <entry> + <link linkend="java_portlet_wizard">Java Portlet Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet Wizard</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="requirements_installation"> + <title>Requirements and Installation</title> + <para><property>JBoss + Portlet Tools</property> needs the following minimal requirements:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.2/Ganymede</para> + </listitem> + <listitem> + <para>JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">compatible version of Eclipse</ulink>)</para> + </listitem> + <listitem><para>JDK 5 or higher</para></listitem> + <listitem> + <para>JBoss Portal + JBoss AS bundle from: <ulink + url="http://www.jboss.org/jbossportal/download/index.html">http://www.jboss.org/jbossportal/download/index.html</ulink></para> + <note> + <title>Note:</title> + <para>JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA + versions of <property>JBoss Portal</property>. Remember, if you want to use Portlet + version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para> + </note> + </listitem> + <listitem> + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http://www.jboss.org/portletbridge/downloads.html</ulink></para> + </listitem> + </itemizedlist> + + <para><property>JBoss Portlet Tools</property> is included as part of <property>JBoss Tools</property> project. + Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">http://www.jboss.org/tools/download/installation.html</ulink> + for installation methods of <property>JBoss Tools</property>.</para> +</section> +</chapter> Added: trunk/portlet/docs/reference/en-US/jsf_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en-US/jsf_portlet.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/jsf_portlet.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,257 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="jsf_portlet"> + <title>Creating and Deploying a JSF Portlet</title> + + <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities + and then deploy it to <property>JBoss Portal</property>.</para> + + <section id="jsf_portlet1"> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> + + <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> + + <orderedlist> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property>JavaServer Faces</property></emphasis> + and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets enabled ( + <link linkend="create_dyn_web_proj_jsf">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable + JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( + <link linkend="create_jsf_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <para>Refer to the further sections for the procedures on how to do this.</para> + + <section id="create_dyn_web_proj_jsf"> + <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> + + <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> + + <orderedlist> + <listitem> + <para>Start the <emphasis><property>Dynamic Web Project</property></emphasis> wizard navigating to + <emphasis><property>File > New > Other > Web > Dynamic Web Project</property>.</emphasis></para> + + <tip> + <title>Tip:</title> + <para>You can also select the <property>Java EE</property> perspective and then go to + <emphasis><property>File > New > Dynamic Web Project</property>.</emphasis></para> + </tip> + + <figure> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Specify the project name and set the target runtime to <property>JBoss Portal</property> by following the points 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property>Configuration</property></emphasis> + area, click <emphasis><property>Modify</property></emphasis> and enable <emphasis><property>JavaServer Faces</property>,</emphasis> + <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets. + Hit <emphasis><property>OK</property>.</emphasis></para> + + <figure> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>You may leave the next two wizard pages with defaults, just press <emphasis><property>Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property>JBoss Portlet Capabilities</property> page, select <emphasis> + <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>JBoss Portlet Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>All types of the portlet implementation library are described more closely in the wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </tip> + </listitem> + + <listitem> + <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it + is here.</para> + + <figure> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select + <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will + copy Portlet Bridge libraries from the server runtime to the project classpath.</para> + + <figure> + <title>JBoss JSF PortletCapabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking + <emphasis><property>Add/Change Richfaces Libraries</property>.</emphasis></para> + </tip> + + <note> + <title>Note:</title> + <para>You can select the <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> type. Then it + is necessary to set the home of the Portlet Bridge distribution.</para> + <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: + <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">http://community.jboss.org/wiki/PortletFacetLibraries</ulink>.</para> + </note> + </listitem> + + <listitem> + <para>Click <emphasis><property>Finish</property>.</emphasis> The project will be created in the workbench.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_jsf_proj"> + <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> + + <para>How to organize a JSF project you can find out in the JSF Tools User Guide. Just + remember to point the target runtime to <property>JBoss Portal</property> directory location (see + how it is done for a dynamic Web project: steps 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure).</para> + + <figure> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> + + <orderedlist> + <listitem> + <para>Right-click the project and click <emphasis> + <property>Properties</property> + </emphasis> to open the project <property>Properties</property> sheet. Select <property>Project Facets</property> + on the left and enable the <emphasis><property>JavaServer Faces</property>,</emphasis> + <emphasis><property>JBoss Core Portlet</property></emphasis> and <emphasis><property>JBoss JSF Portlet</property></emphasis> facets.</para> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Notice, <emphasis> + <property>"Further configuration available..."</property> + </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. + Click the link. The <property>Modify Faceted Project</property> wizard appears.</para> + </listitem> + + <listitem> + <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the + <link linkend="jboss_core_portlet">"Creating a Dynamic Web Project with the JBoss Portlet Capabilities"</link> procedure. + Hit <emphasis><property>OK</property>.</emphasis></para> + </listitem> + + <listitem> + <para>To apply the changes click <emphasis><property>Apply</property></emphasis> and then + <emphasis><property>OK</property></emphasis> to close the project <property>Properties</property> sheet.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="jsf_portlet_to_JSF_project"> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use + the following procedure to add a JSF portlet to the created project and deploy it to <property>JBoss Portal</property>.</para> + + <orderedlist> + <listitem> + <para>Call the + <property>Create Portlet</property> wizard by navigating to <emphasis> + <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference).</para> + + <figure> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF + configuration for the project, so the default values in this wizard will be set as for a JSF + portlet.</para> + </tip> + </listitem> + + <listitem> + <para>Leave all the wizard pages with default values by clicking the <emphasis><property>Next</property></emphasis> button, + on the last one click <emphasis><property>Finish</property></emphasis> to complete the JSF portlet creation.</para> + </listitem> + + <listitem> + <para>Complete the steps described in the <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure to + deploy a JSF portlet to <property>JBoss Portal</property>. Just use the other URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> + + <figure> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + + </section> +</section> Added: trunk/portlet/docs/reference/en-US/master.xml =================================================================== --- trunk/portlet/docs/reference/en-US/master.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/master.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,72 @@ +<?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 intro SYSTEM "intro.xml"> +<!ENTITY installation SYSTEM "installation.xml"> +<!ENTITY portlet_tools_tasks SYSTEM "portlet_tools_tasks.xml"> +<!ENTITY starting_project SYSTEM "starting_project.xml"> +<!ENTITY jsf_portlet SYSTEM "jsf_portlet.xml"> +<!ENTITY seam_portlet SYSTEM "seam_portlet.xml"> +<!ENTITY reference SYSTEM "reference.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>JBoss Portlet Tools User Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author> + + <copyright> + <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/jboss_portal_tools_r...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + <toc/> + + + &intro; + &portlet_tools_tasks; + &reference; + &summary; +</book> Added: trunk/portlet/docs/reference/en-US/master_output.xml =================================================================== --- trunk/portlet/docs/reference/en-US/master_output.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/master_output.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,1698 @@ +<?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 intro SYSTEM "modules/intro.xml"> +<!ENTITY installation SYSTEM "modules/installation.xml"> +<!ENTITY portlet_tools_tasks SYSTEM "modules/portlet_tools_tasks.xml"> +<!ENTITY starting_project SYSTEM "modules/starting_project.xml"> +<!ENTITY jsf_portlet SYSTEM "modules/jsf_portlet.xml"> +<!ENTITY seam_portlet SYSTEM "modules/seam_portlet.xml"> +<!ENTITY reference SYSTEM "modules/reference.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>JBoss Portlet Tools User 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> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + <author><firstname>Snjezana</firstname><surname>Peco</surname><email>snjezana.peco(a)redhat.com</email></author> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Thomas</firstname><surname>Heute</surname><email>theute(a)jboss.org</email></author> + + <copyright> + <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/jboss_portal_tools_r...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + <toc></toc> + + + +<chapter id="intro" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/intro.xml" xreflabel="intro"> + <?dbhtml filename="intro.html"?> + <title>Introduction</title> + + <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins includes tools for supporting <property moreinfo="none">JBoss Portal</property> and JSR-186/JSR-286 portlets. + Thus, this guide is intended to explain you how to get started and manage <property moreinfo="none">JBoss Portlet Tools</property>.</para> + + <section id="preface"> + <title>What is JBoss Portal and Portlet Tools?</title> + <para><property moreinfo="none">JBoss Portal</property> provides an open source platform for hosting and + serving a portal's Web interface, publishing and managing its content, and customizing + its experience. It supports a wide range of features, including standard portlets, + single sign-on, clustering, and internationalization. More about <property moreinfo="none">JBoss Portal</property> you can find visiting + its home page at: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org/jbossportal/</ulink>.</para> + + <para>With <property moreinfo="none">JBoss Portlet Tools</property> you can easily create a Java, JSF and Seam portlet and deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + </section> + + <section id="key_features"> + <title>Key Features of JBoss Portlet Tools</title> + <para><property moreinfo="none">JBoss Portlet Tools</property> supports the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification (Portlet 1.0)</ulink> and + <ulink url="http://www.jcp.org/en/jsr/detail?id=286">JSR-286 Portlet Specification (Portlet 2.0)</ulink> and works with + <ulink url="http://www.jboss.org/portletbridge/">JBoss Portlet Bridge</ulink> for supporting Portlets + in JSF/Seam applications. To enable these features, you need to add the JBoss Portlet facet to a new or an existing web project + (see <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link>). The project could be a non-WTP project, but you should know that + if it does not have the proper portlet API jar's the generated classes will have compile errors.</para> + + <para>The next table lists key features supplied by <property moreinfo="none">JBoss Portlet Tools</property>.</para> + + <table> + <title>Key Features of JBoss Portlet Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>JBoss Portlet facets</para> + </entry> + <entry> + <para><property moreinfo="none">JBoss Portlet Tools</property> provides the Java, JSF and Seam Portlet facets that could be enabled for a Web project.</para> + </entry> + <entry> + <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link> + </entry> + </row> + + <row> + <entry> + <para>Java Portlet wizard</para> + </entry> + + <entry> + <para>The wizard helps create a JSR-186/JSR-286 compliant + portlets</para> + </entry> + <entry> + <link linkend="java_portlet_wizard">Java Portlet Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>JSF/Seam Portlet wizard</para> + </entry> + <entry> + <para>This wizard helps create JSF/Seam portlets</para> + </entry> + <entry> + <link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet Wizard</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section id="requirements_installation"> + <title>Requirements and Installation</title> + <para><property moreinfo="none">JBoss + Portlet Tools</property> needs the following minimal requirements:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.2/Ganymede</para> + </listitem> + <listitem> + <para>JBoss Tools 3.0.0.Alpha1 (for higher versions of JBoss Tools make sure you use the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">compatible version of Eclipse</ulink>)</para> + </listitem> + <listitem><para>JDK 5 or higher</para></listitem> + <listitem> + <para>JBoss Portal + JBoss AS bundle from: <ulink url="http://www.jboss.org/jbossportal/download/index.html">http://www.jboss.org/jbossportal/download/index.html</ulink></para> + <note> + <title>Note:</title> + <para>JBoss Portlet Tools has been tested using 2.6.5 and 2.7.0.ALPHA + versions of <property moreinfo="none">JBoss Portal</property>. Remember, if you want to use Portlet + version 2.0 (JSR-268), you have to choose JBoss Portal 2.7.</para> + </note> + </listitem> + <listitem> + <para>JBoss Portlet Bridge (optionally) from: <ulink url="http://www.jboss.org/portletbridge/downloads.html">http://www.jboss.org/portletbridge/downloads.html</ulink></para> + </listitem> + </itemizedlist> + + <para><property moreinfo="none">JBoss Portlet Tools</property> is included as part of <property moreinfo="none">JBoss Tools</property> project. + Refer to <ulink url="http://www.jboss.org/tools/download/installation.html">http://www.jboss.org/tools/download/installation.html</ulink> + for installation methods of <property moreinfo="none">JBoss Tools</property>.</para> + </section> +</chapter> + + +<chapter id="portlet_tools_tasks" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/portlet_tools_tasks.xml" xreflabel="portlet_tools_tasks"> + <?dbhtml filename="portlet_tools_tasks.html"?> + <title>JBoss Portlet Tools Tasks</title> + + +<section id="starting_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/starting_project.xml"> + <title>Creating and Deploying a Java Portlet</title> + + <para>This chapter shows how to create a Dynamic Web Project, add a Java + Portlet to it and deploy it to the <property moreinfo="none">JBoss Portal</property>.</para> + + <section id="jboss_core_portlet"> + <title>Creating a Web Project with JBoss Portlet Capabilities</title> + <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">File > New > Dynamic Web Project</property> + </emphasis> if you are in the <property moreinfo="none">Web</property> perspective or <emphasis><property moreinfo="none">File > + New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective. + The <property moreinfo="none">New Dynamic Web Project</property> wizard appears.</para> + + <figure float="0"> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Specify the name of the project.</para></listitem> + + <listitem> + <para>Click <emphasis> + <property moreinfo="none">New</property> + </emphasis> in the <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> + <property moreinfo="none">JBoss Community > JBoss 4.2 Runtime</property> + </emphasis> and select the <emphasis> + <property moreinfo="none">Create a new local server</property> + </emphasis> check box below. Click <emphasis> + <property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>New Server Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">New Server Runtime Environment</property> wizard appears. In the <emphasis> + <property moreinfo="none">Name</property></emphasis> field, type <emphasis> + <property moreinfo="none">JBoss Portal 2.7 Runtime</property>, + </emphasis> and then use the <emphasis> + <property moreinfo="none">Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> + <property moreinfo="none">Next</property></emphasis> to proceed.</para> + + <figure float="0"> + <title>New Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/server_runtime_environment.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>At this point a new JBoss Server instance will be created. On the next page you can verify the + runtime information defined. If something is incorrect, press <emphasis> + <property moreinfo="none">Back</property> + </emphasis> to return to the previous wizard page. Click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Modify</property> + </emphasis> in the <emphasis><property moreinfo="none">Configuration</property></emphasis> area to enable + a portlet facet for the project.</para> + + <figure float="0"> + <title>Setting the Project Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>In the <property moreinfo="none">Project Facets</property> dialog, check <emphasis> + <property moreinfo="none">JBoss Core Portlet</property> + </emphasis> and press <emphasis> + <property moreinfo="none">OK</property> + </emphasis>.</para> + + <figure float="0"> + <title>Enabling the JBoss Core Portlet Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4_a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If the portlet libraries aren't available in the runtime you targeted, + <emphasis> + <property moreinfo="none">JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> + <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in + <link linkend="preferences">JBoss Portlet Preferences</link>.</para> + </note> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Java</property> and <property moreinfo="none">Web Module</property> pages are for configuring Java and Web modules in the project. + Here all values are set, so leave everything as it is.</para> + </listitem> + + <listitem> + <para>The last wizard page will ask you to add JBoss Portlet capabilities to the + project. Select <emphasis> + <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis> + <property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> + + <figure float="0"> + <title>Including the Portlet Libraries Provided by Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/portlet_capabilities6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>All types available under <emphasis> + <property moreinfo="none">Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </note> + </listitem> + </orderedlist> + + <para>As the result, <property moreinfo="none">JBoss Portlet Tools</property> adds <emphasis> + <property moreinfo="none">JBoss Core Portlet</property></emphasis> facet to the project, + creates an empty <literal moreinfo="none">portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> + + <figure float="0"> + <title>Portlet Project Structure Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="adding_java_portlet"> + <title>Adding a Java Portlet to a Web Project</title> + + <para>At the previous section you have created a web project with JBoss Portlet capabilities. + The next steps will show you how to add a new Java portlet to the project.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and follow to <emphasis> + <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java + Portlet</property>.</emphasis></para> + + <figure float="0"> + <title>New Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for information about the wizard options, see + <link linkend="java_portlet_wizard">"Java Portlet Wizard"</link> in the guide reference). + The wizard fills in the <emphasis><property moreinfo="none">Project</property></emphasis> and <emphasis> + <property moreinfo="none">Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name + (for instance, <emphasis> + <property moreinfo="none">org.example</property></emphasis> and <emphasis> + <property moreinfo="none">TestPortlet</property></emphasis>). Then click <emphasis> + <property moreinfo="none">Next</property> + </emphasis>.</para> + + <figure float="0"> + <title>Specifying Class File Destination</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + </listitem> + </orderedlist> + + <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal moreinfo="none">TestPortlet.java</literal>), + <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none">portlet-instances.xml</literal> files and the <literal moreinfo="none">portlet.xml</literal> descriptor is updated as well.</para> + + <figure float="0"> + <title>Structure of the Project with a Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, now the project is ready to be built and deployed.</para> + </section> + + <section id="deploying_to_portal"> + <title>Deploying a Portlet to JBoss Portal</title> + + <para>You can deploy a portlet project in the way you deploy any other web application.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and do <emphasis> + <property moreinfo="none">Run As > Run On Server</property>. + </emphasis> The <property moreinfo="none">Run On Server</property> wizard starts.</para> + + <figure float="0"> + <title>Running the Java Portlet on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/runOnServer.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Select <emphasis><property moreinfo="none">JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <emphasis> + <property moreinfo="none">Add and Remove</property> + </emphasis> page move the created project to the right and click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Deploying the Portlet Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It will deploy the portlet application and start <property moreinfo="none">JBoss + AS</property>.</para> + </listitem> + + <listitem> + <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your + portlet in the browser.</para> + + <figure float="0"> + <title>Java Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> + +</section> + + +<section id="jsf_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/jsf_portlet.xml"> + <title>Creating and Deploying a JSF Portlet</title> + + <para>This chapter will explain how you can configure a JSF portlet within a JSF project with JBoss Portlet capabilities + and then deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + + <section id="jsf_portlet1"> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> + + <para>You can create a JSF project with JBoss Portlet capabilities in two ways:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">JavaServer Faces</property></emphasis> + and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets enabled ( + <link linkend="create_dyn_web_proj_jsf">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a JSF project using the wizard JBoss JSF Tools provides, then enable + JSF and JBoss Portlet facets and add JBoss Portlet capabilities ( + <link linkend="create_jsf_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <para>Refer to the further sections for the procedures on how to do this.</para> + + <section id="create_dyn_web_proj_jsf"> + <title>Creating a Dynamic Web Project with the JBoss Portlet Capabilities</title> + + <para>The basic steps to create a dynamic Web project with the JBoss Portlet capabilities are as follows:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Start the <emphasis><property moreinfo="none">Dynamic Web Project</property></emphasis> wizard navigating to + <emphasis><property moreinfo="none">File > New > Other > Web > Dynamic Web Project</property>.</emphasis></para> + + <tip> + <title>Tip:</title> + <para>You can also select the <property moreinfo="none">Java EE</property> perspective and then go to + <emphasis><property moreinfo="none">File > New > Dynamic Web Project</property>.</emphasis></para> + </tip> + + <figure float="0"> + <title>Setting the JSF Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Specify the project name and set the target runtime to <property moreinfo="none">JBoss Portal</property> by following the points 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> + area, click <emphasis><property moreinfo="none">Modify</property></emphasis> and enable <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> + <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets. + Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + + <figure float="0"> + <title>Enabling the Portlet Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>You may leave the next two wizard pages with defaults, just press <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss Portlet Capabilities</property> page, select <emphasis> + <property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> and click <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>JBoss Portlet Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet2a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>All types of the portlet implementation library are described more closely in the wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </tip> + </listitem> + + <listitem> + <para>Next wizard page is for configuring JSF capabilities. You can leave everything as it + is here.</para> + + <figure float="0"> + <title>JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select + <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> as the JSF portlet implementation library. It will + copy Portlet Bridge libraries from the server runtime to the project classpath.</para> + + <figure float="0"> + <title>JBoss JSF PortletCapabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>On this page, it is also possible to add the RichFaces libraries from the RichFaces distribution by checking + <emphasis><property moreinfo="none">Add/Change Richfaces Libraries</property>.</emphasis></para> + </tip> + + <note> + <title>Note:</title> + <para>You can select the <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> type. Then it + is necessary to set the home of the Portlet Bridge distribution.</para> + <para>For information about all the JSF Portlet facet library providers, refer to the wiki article at: + <ulink url="http://community.jboss.org/wiki/PortletFacetLibraries">http://community.jboss.org/wiki/PortletFacetLibraries</ulink>.</para> + </note> + </listitem> + + <listitem> + <para>Click <emphasis><property moreinfo="none">Finish</property>.</emphasis> The project will be created in the workbench.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_jsf_proj"> + <title>Creating a JSF Project and adding the JBoss Portlet Capabilities</title> + + <para>How to organize a JSF project you can find out in the <ulink url="../../jsf_tools_ref_guide/html_single/index.html#new_jsf_project">JSF Tools User Guide</ulink>. Just + remember to point the target runtime to <property moreinfo="none">JBoss Portal</property> directory location (see + how it is done for a dynamic Web project: steps 3, 4 and 5 in the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure).</para> + + <figure float="0"> + <title>Creating New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To add the JBoss Portlet capabilities to the created JSF project you should complete the next steps:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Right-click the project and click <emphasis> + <property moreinfo="none">Properties</property> + </emphasis> to open the project <property moreinfo="none">Properties</property> sheet. Select <property moreinfo="none">Project Facets</property> + on the left and enable the <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> + <emphasis><property moreinfo="none">JBoss Core Portlet</property></emphasis> and <emphasis><property moreinfo="none">JBoss JSF Portlet</property></emphasis> facets.</para> + + <figure float="0"> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Notice, <emphasis> + <property moreinfo="none">"Further configuration available..."</property> + </emphasis> warning appears at the bottom of the screen. It means that next you should configure the JSF Portlet capabilities in the project. + Click the link. The <property moreinfo="none">Modify Faceted Project</property> wizard appears.</para> + </listitem> + + <listitem> + <para>Complete all wizard pages the same way as described in the steps 5, 6, 7 of the + <link linkend="jboss_core_portlet">"Creating a Dynamic Web Project with the JBoss Portlet Capabilities"</link> procedure. + Hit <emphasis><property moreinfo="none">OK</property>.</emphasis></para> + </listitem> + + <listitem> + <para>To apply the changes click <emphasis><property moreinfo="none">Apply</property></emphasis> and then + <emphasis><property moreinfo="none">OK</property></emphasis> to close the project <property moreinfo="none">Properties</property> sheet.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="jsf_portlet_to_JSF_project"> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown how to create a JSF project with JBoss Portlet and JSF Portlet capabilities enabled. Use + the following procedure to add a JSF portlet to the created project and deploy it to <property moreinfo="none">JBoss Portal</property>.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Call the + <property moreinfo="none">Create Portlet</property> wizard by navigating to <emphasis> + <property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property></emphasis> on the context menu of the project (for information about the wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference).</para> + + <figure float="0"> + <title>Calling New Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>As you see, the JSF and Seam Portlet wizards are merged into one. We have set the JSF + configuration for the project, so the default values in this wizard will be set as for a JSF + portlet.</para> + </tip> + </listitem> + + <listitem> + <para>Leave all the wizard pages with default values by clicking the <emphasis><property moreinfo="none">Next</property></emphasis> button, + on the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the JSF portlet creation.</para> + </listitem> + + <listitem> + <para>Complete the steps described in the <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure to + deploy a JSF portlet to <property moreinfo="none">JBoss Portal</property>. Just use the other URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/JSFPortlet</emphasis>.</para> + + <figure float="0"> + <title>JSF Portlet in the Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + + </section> +</section> + + +<section id="seam_portlet" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/seam_portlet.xml"> + <title>Creating and Deploying a Seam Portlet</title> + + <para>This chapter covers the steps on how to configure a Seam portlet within a Seam + project with the help of the <property moreinfo="none">JBoss Portlet Tools</property> features.</para> + + <section id="seam_portlet1"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property moreinfo="none">Seam</property></emphasis> + and <emphasis><property moreinfo="none">JBoss Portlets</property></emphasis> facets enabled (<link linkend="create_dyn_web_proj_seam">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides + and follow all the wizard steps to enable JBoss Portlet capabilities (<link linkend="create_seam_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <section id="create_dyn_web_proj_seam"> + <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> + + <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to + <emphasis><property moreinfo="none">New > Other > Web > Dynamic Web Project</property>.</emphasis> The <property moreinfo="none">New Dynamic Web Project</property> + wizard starts.</para> + + <figure float="0"> + <title>Creating a New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Give the project a name and follow the steps 3, 4, 5 of the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure to set the target runtime.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property moreinfo="none">Configuration</property></emphasis> area of the first wizard page, + select <emphasis> + <property moreinfo="none">JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> + + <tip> + <title>Tip:</title> + <para>If you now click the <emphasis><property moreinfo="none">Modify</property></emphasis> button, you should see the + <emphasis><property moreinfo="none">JavaServer Faces</property>,</emphasis> <emphasis><property moreinfo="none">Jboss Portlets</property></emphasis> + and <emphasis><property moreinfo="none">Seam</property></emphasis> facets enabled.</para> + </tip> + + <figure float="0"> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The next two pages are for adjusting the project Java and Web modules. + They include the default values, so you can skip them by pressing <emphasis> + <property moreinfo="none">Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">Jboss Portlet Capabilities</property> page, select + <emphasis><property moreinfo="none">Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + + <tip> + <title>Tip:</title> + <para>All types of the portlet implementation library are described more closely in the wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </tip> + </listitem> + + <listitem> + <para>The next page is for configuring JSF capabilities. As it contains the default values, just click + <emphasis><property moreinfo="none">Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">Seam Facet</property> page, set a Seam runtime and + a connection profile.</para> + + <tip> + <title>Tip:</title> + <para>For details about how to set a Seam runtime and a connection profile, see + <ulink url="../../seam/html_single/index.html#seamFacet">"Configure Seam Facet Settings"</ulink> in the Chapter 2, + <ulink url="../../seam/html_single/index.html">"Seam Dev Tools Reference Guide"</ulink>.</para> + </tip> + + <figure float="0"> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property moreinfo="none">JBoss JSF Portlet Capabilities</property> page, select the + <emphasis><property moreinfo="none">JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> + + <tip> + <title>Tip:</title> + <para>If you have <property moreinfo="none">JBoss Portlet Bridge</property> downloaded, + alternatively you can select <emphasis><property moreinfo="none">JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to + the <property moreinfo="none">JBoss Portlet Bridge</property> distribution.</para> + </tip> + + <figure float="0"> + <title>Setting Portlet Bridge Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It will add <property moreinfo="none">JBoss Portlet Bridge</property> libraries to the project classpath.</para> + </listitem> + + <listitem> + <para>Hit <emphasis><property moreinfo="none">Finish</property></emphasis> to complete the project creation.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_seam_proj"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> menu, go to <emphasis> + <property moreinfo="none">New > Other > Seam > Seam Web Project</property>.</emphasis> The <property moreinfo="none">New Seam Project</property> + wizard appears.</para> + </listitem> + + <listitem> + <para>Next steps are the same as in the <link linkend="create_dyn_web_proj_seam">"Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities"</link> + procedure starting from the step 2.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="seam_portlet_to_seam_project"> + <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet + and deploy it to <property moreinfo="none">JBoss Portal</property> by following the next procedure:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>In the <emphasis><property moreinfo="none">File</property></emphasis> or context menu of the project go to + <emphasis><property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property>.</emphasis></para> + + <figure float="0"> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property moreinfo="none">Create Portlet</property> wizard starts (for more information about wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference). + As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + + <figure float="0"> + <title>Creating Seam Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Next two pages are filled out with default values, just press <emphasis><property moreinfo="none">Next</property></emphasis> to + proceed. On the last one click <emphasis><property moreinfo="none">Finish</property></emphasis> to complete.</para> + </listitem> + + <listitem> + <para>To deploy and run the portlet on <property moreinfo="none">JBoss Portal</property> complete the steps described in the + <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure. Just use the following URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> + + <figure float="0"> + <title>Seam Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> +</section> + +</chapter> + +<chapter id="reference" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/reference.xml" xreflabel="reference"> + <?dbhtml filename="reference.html"?> + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property moreinfo="none">JBoss Portlet Tools</property>.</para> + <section id="project_overview"> + <title>JBoss Portlet Descriptors</title> + + <para>In order to a web project with portlets could be deployed to <property moreinfo="none">JBoss Portal</property>, it should include certain descriptors. + The next table lists and describes these configuration files.</para> + + <table> + <title>JBoss Portlet Descriptors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>portlet.xml</entry> + <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. + It is used during deployment.</entry> + </row> + + <row> + <entry>portlet-instances.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry> + </row> + + <row> + <entry>*-object.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry> + </row> + + <row> + <entry>jboss-portlet.xml</entry> + <entry>The optional <property moreinfo="none">JBoss Portal</property> specific descriptor. It allows to use JBoss + specific functionality within a portlet application.</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>For more detail information about each descriptor, see + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/#descrip...">"Portlet Descriptors"</ulink> in Chapter 6, + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/">"JBoss Portal Reference Guide"</ulink>.</para> + </section> + + <section id="wizards"> + <title>Wizards</title> + <para>This section describes the <property moreinfo="none">JBoss Portlet Tools</property> wizards:</para> + <itemizedlist> + <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem> + <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem> + </itemizedlist> + + <section id="java_portlet_wizard"> + <title>Java Portlet Wizard</title> + + <para>The <property moreinfo="none">Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard, + but adapted to JBoss Portlet. You can call it from the <emphasis><property moreinfo="none">File</property></emphasis> or context menu of your project by following to + <emphasis><property moreinfo="none">New > Other > JBoss Tools Web > Portlet > Java Portlet</property>.</emphasis></para> + + <para>The wizard consists of the four pages:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>The first one includes the next options to adjust:</para> + + <table> + <title>Java Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new Java portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property moreinfo="none">Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Java package</entry> + <entry>Enter a package to contain a new portlet. Either type a valid package name or click + <emphasis><property moreinfo="none">Browse</property></emphasis> to select a package via the dialog box.</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type a name for a new Java portlet class</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property moreinfo="none">Browse</property></emphasis> to select a superclass for a Java portlet class</entry> + <entry>javax.portlet.GenericPortlet</entry> + </row> + + <row> + <entry>Use an existing Portlet class</entry> + <entry>Select this check box if you want to use an existing Java portlet class. In the appeared + <emphasis><property moreinfo="none">Class name</property></emphasis> field type or + click <emphasis><property moreinfo="none">Browse</property></emphasis> to select an existing portlet class.</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para> + + <figure float="0"> + <title>Second Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The descriptions of the options listed on this page are in the following table.</para> + + <table> + <title>Java Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Modifiers</entry> + <entry>Select one or more access modifiers for a new Java portlet class: + <itemizedlist> + <listitem><para>Public</para></listitem> + <listitem><para>Abstract</para></listitem> + <listitem><para>Final</para></listitem> + </itemizedlist> + </entry> + <entry>Public</entry> + </row> + + <row> + <entry>Interfaces</entry> + <entry>Click <emphasis><property moreinfo="none">Add</property></emphasis> to choose interfaces that a new class implements</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Which method stubs would you like to create?</entry> + <entry>Choose which methods from superclass to override in the Java portlet class: + <itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + <listitem><para>init</para></listitem> + <listitem><para>doView</para></listitem> + <listitem><para>doDispatch</para></listitem> + <listitem><para>destroy</para></listitem> + <listitem><para>doEdit</para></listitem> + <listitem><para>processAction</para></listitem> + <listitem><para>getPortletConfig</para></listitem> + <listitem><para>doHelp</para></listitem> + <listitem><para>render</para></listitem> + </itemizedlist> + </entry> + <entry>Inherited abstract methods, doView</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The third page is for adjusting the portlet deployment descriptor settings.</para> + + <figure float="0"> + <title>Third Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem> + </itemizedlist> + </entry> + <entry>View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property moreinfo="none">Add</property></emphasis> and fill in the + <emphasis><property moreinfo="none">Name</property>,</emphasis> <emphasis><property moreinfo="none">Value</property></emphasis> and + <emphasis><property moreinfo="none">Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry><blank></entry> + </row> + </tbody> + </tgroup> + </table> + + </listitem> + + <listitem> + <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para> + + <figure float="0"> + <title>Last Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Last Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property moreinfo="none">Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none"> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>[Portlet class name]Instance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>[Portlet class name]Window</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object. The syntax for this element is <literal moreinfo="none">[portal-instance].[portal-page]</literal>.</para> + <para>For example, <literal moreinfo="none">default.default</literal> means that the window appears on the default page, in the default portal.</para> + </entry> + <entry>default.default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + + <section id="jsf_seam_portlet_wizard"> + <title>JSF/Seam Portlet Wizard</title> + + <para>The <property moreinfo="none">JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a + JSF/Seam portlet that uses the <property moreinfo="none">JBoss Portlet Bridge</property> libraries. The default values in this wizard + depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be + as for a JSF portlet.</para> + + <para>The <property moreinfo="none">JSF/Seam Portlet</property> wizard could be started from the <emphasis><property moreinfo="none">File</property></emphasis> or + context menu of your project by following to + <emphasis><property moreinfo="none">New > Other > JBoss Tools Web > Portlet > JSF/Seam Portlet</property>.</emphasis></para> + + <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para> + + <figure float="0"> + <title>First Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new JSF/Seam portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type or click <emphasis><property moreinfo="none">Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry> + <entry>javax.portlet.faces.GenericFacesPortlet</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second page allows to configure a portlet deployment descriptors.</para> + + <figure float="0"> + <title>Second Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>riPortlet / seamPortlet</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem> + </itemizedlist> + </entry> + <entry>View, Edit, Help / View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property moreinfo="none">Add</property></emphasis> and fill in the + <emphasis><property moreinfo="none">Name</property>,</emphasis> <emphasis><property moreinfo="none">Value</property></emphasis> and + <emphasis><property moreinfo="none">Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The last wizard page helps you configure the JBoss Portlet specific information.</para> + + <figure float="0"> + <title>Third Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property moreinfo="none">Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal moreinfo="none">default-object.xml</literal> and <literal moreinfo="none"> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>JSFPortletInstance / SeamPortletInstance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>JSFPortlet / SeamPortlet</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>JSFPortletWindow / SeamPortletWindow</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object.</para> + <para>For example, <literal moreinfo="none">default</literal> means that the page appears in the default portal.</para> + </entry> + <entry>default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + + <row> + <entry>Create JBoss Application</entry> + <entry> + <para>Select to add the <literal moreinfo="none">jboss-app.xml</literal> descriptor.</para> + <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by + typing a new one in the <emphasis><property moreinfo="none">JBoss Application Name</property></emphasis> field.</para> + </entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Add the jboss-portlet.xml file</entry> + <entry>Select to create the <literal moreinfo="none">jboss-portlet.xml</literal> file</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Copy JSF Templates</entry> + <entry>Select to add the folder with JSF templates (<literal moreinfo="none">edit.jsp</literal>, <literal moreinfo="none">help.jsp</literal>, + <literal moreinfo="none">view.jsp</literal>) to the project</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + </section> + + <section id="preferences"> + <title>JBoss Portlet Preferences</title> + + <para>To open <property moreinfo="none">JBoss Portlet Preferences</property> property sheet, go to <emphasis> + <property moreinfo="none">Window > Preferences</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss Tools > JBoss Portlet</property>. + </emphasis></para> + + <figure float="0"> + <title>JBoss Runtime Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/portlet_preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">Check runtimes for Portlet Components</property> + </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para> + </section> +</chapter> + +<chapter id="summary" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/portlet/docs/reference/en/modules/summary.xml" xreflabel="summary"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + + <para>In conclusion, with this document you could easily get started with <property moreinfo="none">JBoss + Portlet Tools</property>. + The above chapters walked you through the steps on how to organize a web project with + JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to <property moreinfo="none">JBoss + Portal</property>. The document also includes the reference of <property moreinfo="none">JBoss Portlet Tools</property> features.</para> + + <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome + to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users forum</ulink>.</para> + + <para>Please, use <ulink url="https://jira.jboss.org/jira/browse/JBDS">Jira</ulink> to report bugs and requests on documentation.</para> + + <section id="rel_resources"> + <title>Other Relevant Resources on the Topic</title> + + <itemizedlist> + <listitem> + <para> + JBoss Portal home page: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org/jbossportal/</ulink> + </para> + </listitem> + + <listitem> + <para> + JBoss Portal Wiki at: <ulink url="http://wiki.jboss.org/wiki/JBossPortal">http://wiki.jboss.org/wiki/JBossPortal</ulink> + </para> + </listitem> + + <listitem> + <para>JBoss Portal documentation set at: <ulink url="http://docs.jboss.org/jbportal/">http://docs.jboss.org/jbportal/</ulink></para> + </listitem> + + <listitem> + <para> + JBoss Tools home page at: <ulink url="http://www.jboss.org/tools/">http://www.jboss.org/tools/</ulink> + </para> + </listitem> + + <listitem> + <para> + The latest JBossTools/JBDS documentation builds at: <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs/</ulink> + </para> + </listitem> + + <listitem> + <para>JBoss Developer Studio/JBoss Tools release documentation you can + find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> +</book> Added: trunk/portlet/docs/reference/en-US/portlet_tools_tasks.xml =================================================================== --- trunk/portlet/docs/reference/en-US/portlet_tools_tasks.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/portlet_tools_tasks.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="portlet_tools_tasks" xreflabel="portlet_tools_tasks"> + <?dbhtml filename="portlet_tools_tasks.html"?> + <title>JBoss Portlet Tools Tasks</title> + + <xi:include href="starting_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="jsf_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="seam_portlet.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +</chapter> Added: trunk/portlet/docs/reference/en-US/reference.xml =================================================================== --- trunk/portlet/docs/reference/en-US/reference.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/reference.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,670 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference" xreflabel="reference"> + <?dbhtml filename="reference.html"?> + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property>JBoss Portlet Tools</property>.</para> + <section id="project_overview"> + <title>JBoss Portlet Descriptors</title> + + <para>In order to a web project with portlets could be deployed to <property>JBoss Portal</property>, it should include certain descriptors. + The next table lists and describes these configuration files.</para> + + <table> + <title>JBoss Portlet Descriptors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>portlet.xml</entry> + <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. + It is used during deployment.</entry> + </row> + + <row> + <entry>portlet-instances.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry> + </row> + + <row> + <entry>*-object.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry> + </row> + + <row> + <entry>jboss-portlet.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to use JBoss + specific functionality within a portlet application.</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>For more detail information about each descriptor, see + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/#descrip...">"Portlet Descriptors"</ulink> in Chapter 6, + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/">"JBoss Portal Reference Guide"</ulink>.</para> + </section> + + <section id="wizards"> + <title>Wizards</title> + <para>This section describes the <property>JBoss Portlet Tools</property> wizards:</para> + <itemizedlist> + <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem> + <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem> + </itemizedlist> + + <section id="java_portlet_wizard"> + <title>Java Portlet Wizard</title> + + <para>The <property>Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard, + but adapted to JBoss Portlet. You can call it from the <emphasis><property>File</property></emphasis> or context menu of your project by following to + <emphasis><property>New > Other > JBoss Tools Web > Portlet > Java Portlet</property>.</emphasis></para> + + <para>The wizard consists of the four pages:</para> + + <orderedlist> + <listitem> + <para>The first one includes the next options to adjust:</para> + + <table> + <title>Java Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new Java portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property>Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Java package</entry> + <entry>Enter a package to contain a new portlet. Either type a valid package name or click + <emphasis><property>Browse</property></emphasis> to select a package via the dialog box.</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type a name for a new Java portlet class</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a superclass for a Java portlet class</entry> + <entry>javax.portlet.GenericPortlet</entry> + </row> + + <row> + <entry>Use an existing Portlet class</entry> + <entry>Select this check box if you want to use an existing Java portlet class. In the appeared + <emphasis><property>Class name</property></emphasis> field type or + click <emphasis><property>Browse</property></emphasis> to select an existing portlet class.</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para> + + <figure> + <title>Second Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The descriptions of the options listed on this page are in the following table.</para> + + <table> + <title>Java Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Modifiers</entry> + <entry>Select one or more access modifiers for a new Java portlet class: + <itemizedlist> + <listitem><para>Public</para></listitem> + <listitem><para>Abstract</para></listitem> + <listitem><para>Final</para></listitem> + </itemizedlist> + </entry> + <entry>Public</entry> + </row> + + <row> + <entry>Interfaces</entry> + <entry>Click <emphasis><property>Add</property></emphasis> to choose interfaces that a new class implements</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Which method stubs would you like to create?</entry> + <entry>Choose which methods from superclass to override in the Java portlet class: + <itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + <listitem><para>init</para></listitem> + <listitem><para>doView</para></listitem> + <listitem><para>doDispatch</para></listitem> + <listitem><para>destroy</para></listitem> + <listitem><para>doEdit</para></listitem> + <listitem><para>processAction</para></listitem> + <listitem><para>getPortletConfig</para></listitem> + <listitem><para>doHelp</para></listitem> + <listitem><para>render</para></listitem> + </itemizedlist> + </entry> + <entry>Inherited abstract methods, doView</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The third page is for adjusting the portlet deployment descriptor settings.</para> + + <figure> + <title>Third Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem> + </itemizedlist> + </entry> + <entry>View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry><blank></entry> + </row> + </tbody> + </tgroup> + </table> + + </listitem> + + <listitem> + <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para> + + <figure> + <title>Last Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Last Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>[Portlet class name]Instance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>[Portlet class name]Window</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object. The syntax for this element is <literal>[portal-instance].[portal-page]</literal>.</para> + <para>For example, <literal>default.default</literal> means that the window appears on the default page, in the default portal.</para> + </entry> + <entry>default.default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + + <section id="jsf_seam_portlet_wizard"> + <title>JSF/Seam Portlet Wizard</title> + + <para>The <property>JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a + JSF/Seam portlet that uses the <property>JBoss Portlet Bridge</property> libraries. The default values in this wizard + depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be + as for a JSF portlet.</para> + + <para>The <property>JSF/Seam Portlet</property> wizard could be started from the <emphasis><property>File</property></emphasis> or + context menu of your project by following to + <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam Portlet</property>.</emphasis></para> + + <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para> + + <orderedlist> + <listitem> + <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para> + + <figure> + <title>First Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new JSF/Seam portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry> + <entry>javax.portlet.faces.GenericFacesPortlet</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second page allows to configure a portlet deployment descriptors.</para> + + <figure> + <title>Second Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>riPortlet / seamPortlet</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem> + </itemizedlist> + </entry> + <entry>View, Edit, Help / View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The last wizard page helps you configure the JBoss Portlet specific information.</para> + + <figure> + <title>Third Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>JSFPortletInstance / SeamPortletInstance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>JSFPortlet / SeamPortlet</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>JSFPortletWindow / SeamPortletWindow</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object.</para> + <para>For example, <literal>default</literal> means that the page appears in the default portal.</para> + </entry> + <entry>default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + + <row> + <entry>Create JBoss Application</entry> + <entry> + <para>Select to add the <literal>jboss-app.xml</literal> descriptor.</para> + <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by + typing a new one in the <emphasis><property>JBoss Application Name</property></emphasis> field.</para> + </entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Add the jboss-portlet.xml file</entry> + <entry>Select to create the <literal>jboss-portlet.xml</literal> file</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Copy JSF Templates</entry> + <entry>Select to add the folder with JSF templates (<literal>edit.jsp</literal>, <literal>help.jsp</literal>, + <literal>view.jsp</literal>) to the project</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + </section> + + <section id="preferences"> + <title>JBoss Portlet Preferences</title> + + <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis> + <property>Window > Preferences</property> + </emphasis> and then <emphasis> + <property>JBoss Tools > JBoss Portlet</property>. + </emphasis></para> + + <figure> + <title>JBoss Runtime Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/portlet_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>Check runtimes for Portlet Components</property> + </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para> + </section> +</chapter> \ No newline at end of file Added: trunk/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en-US/seam_portlet.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/seam_portlet.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,220 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="seam_portlet"> + <title>Creating and Deploying a Seam Portlet</title> + + <para>This chapter covers the steps on how to configure a Seam portlet within a Seam + project with the help of the <property>JBoss Portlet Tools</property> features.</para> + + <section id="seam_portlet1"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>Follow one of two ways of creating a Seam project with JBoss Portlet capabilities enabled:</para> + <orderedlist> + <listitem> + <para>Create a dynamic Web project with the <emphasis><property>Seam</property></emphasis> + and <emphasis><property>JBoss Portlets</property></emphasis> facets enabled (<link linkend="create_dyn_web_proj_seam">the steps to proceed</link>)</para> + </listitem> + <listitem><para>Or create a Seam project with the JBoss Seam portlet configuration using the wizard JBoss Seam Tools provides + and follow all the wizard steps to enable JBoss Portlet capabilities (<link linkend="create_seam_proj">the steps to proceed</link>)</para></listitem> + </orderedlist> + + <section id="create_dyn_web_proj_seam"> + <title>Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities</title> + + <para>To create a dynamic Web project with Seam and JBoss Portlet capabilities you should take the following steps:</para> + + <orderedlist> + <listitem> + <para>In the <emphasis><property>File</property></emphasis> menu, go to + <emphasis><property>New > Other > Web > Dynamic Web Project</property>.</emphasis> The <property>New Dynamic Web Project</property> + wizard starts.</para> + + <figure> + <title>Creating a New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Give the project a name and follow the steps 3, 4, 5 of the + <link linkend="jboss_core_portlet">"Creating a Web Project with JBoss Portlet Capabilities"</link> procedure to set the target runtime.</para> + </listitem> + + <listitem> + <para>In the <emphasis><property>Configuration</property></emphasis> area of the first wizard page, + select <emphasis> + <property>JBoss Seam Portlet Project v2.0</property>.</emphasis> It will add needed facets to the project.</para> + + <tip> + <title>Tip:</title> + <para>If you now click the <emphasis><property>Modify</property></emphasis> button, you should see the + <emphasis><property>JavaServer Faces</property>,</emphasis> <emphasis><property>Jboss Portlets</property></emphasis> + and <emphasis><property>Seam</property></emphasis> facets enabled.</para> + </tip> + + <figure> + <title>Project Facets</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The next two pages are for adjusting the project Java and Web modules. + They include the default values, so you can skip them by pressing <emphasis> + <property>Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <property>Jboss Portlet Capabilities</property> page, select + <emphasis><property>Portlet Target Runtime Provider</property></emphasis> as the portlet implementation library.</para> + + <tip> + <title>Tip:</title> + <para>All types of the portlet implementation library are described more closely in the wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </tip> + </listitem> + + <listitem> + <para>The next page is for configuring JSF capabilities. As it contains the default values, just click + <emphasis><property>Next</property></emphasis> to proceed.</para> + </listitem> + + <listitem> + <para>On the <property>Seam Facet</property> page, set a Seam runtime and + a connection profile.</para> + + <tip> + <title>Tip:</title> + <para>For details about how to set a Seam runtime and a connection profile, see + Configure Seam Facet Settings in the Chapter 2 of the + Seam Dev Tools Reference Guide.</para> + </tip> + + <figure> + <title>Seam Facet Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>On the <property>JBoss JSF Portlet Capabilities</property> page, select the + <emphasis><property>JSF Portlet Target Runtime Provider</property></emphasis> type of the implementation library.</para> + + <tip> + <title>Tip:</title> + <para>If you have <property>JBoss Portlet Bridge</property> downloaded, + alternatively you can select <emphasis><property>JSF Portletbridge Runtime Provider</property></emphasis> and then provide a path to + the <property>JBoss Portlet Bridge</property> distribution.</para> + </tip> + + <figure> + <title>Setting Portlet Bridge Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will add <property>JBoss Portlet Bridge</property> libraries to the project classpath.</para> + </listitem> + + <listitem> + <para>Hit <emphasis><property>Finish</property></emphasis> to complete the project creation.</para> + </listitem> + </orderedlist> + </section> + + <section id="create_seam_proj"> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> + + <para>The steps to create a Seam project with JBoss Portlet capabilities are as follows:</para> + + <orderedlist> + <listitem> + <para>In the <emphasis><property>File</property></emphasis> menu, go to <emphasis> + <property>New > Other > Seam > Seam Web Project</property>.</emphasis> The <property>New Seam Project</property> + wizard appears.</para> + </listitem> + + <listitem> + <para>Next steps are the same as in the <link + linkend="create_dyn_web_proj_seam">"Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities"</link> + procedure starting from the step 2.</para> + </listitem> + </orderedlist> + </section> + </section> + + <section id="seam_portlet_to_seam_project"> + <title>Adding a Seam Portlet to the Project and Deploying It to JBoss Portal</title> + + <para>The previous section has shown you how to create a Web project with Seam and JBoss Portlet capabilities. Now you can create a Seam portlet + and deploy it to <property>JBoss Portal</property> by following the next procedure:</para> + + <orderedlist> + <listitem> + <para>In the <emphasis><property>File</property></emphasis> or context menu of the project go to + <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam + Portlet</property>.</emphasis></para> + + <figure> + <title>Calling the Create Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property>Create Portlet</property> wizard starts (for more information about wizard options, see + <link linkend="jsf_seam_portlet_wizard">"JSF/Seam Portlet Wizard"</link> in the guide reference). + As the Seam configuration is set for the project, the wizard puts the values as for Seam portlet.</para> + + <figure> + <title>Creating Seam Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet6.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Next two pages are filled out with default values, just press <emphasis><property>Next</property></emphasis> to + proceed. On the last one click <emphasis><property>Finish</property></emphasis> to complete.</para> + </listitem> + + <listitem> + <para>To deploy and run the portlet on <property>JBoss Portal</property> complete the steps described in the + <link linkend="deploying_to_portal">"Deploying a Portlet to JBoss Portal"</link> procedure. Just use the following URL to see it in the browser: + <emphasis>http://localhost:8080/portal/portal/default/SeamPortlet</emphasis>.</para> + + <figure> + <title>Seam Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> +</section> Added: trunk/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- trunk/portlet/docs/reference/en-US/starting_project.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/starting_project.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,297 @@ +<?xml version="1.0" encoding="UTF-8"?> +<section id="starting_project"> + <title>Creating and Deploying a Java Portlet</title> + + <para>This chapter shows how to create a Dynamic Web Project, add a Java + Portlet to it and deploy it to the <property>JBoss Portal</property>.</para> + + <section id="jboss_core_portlet"> + <title>Creating a Web Project with JBoss Portlet Capabilities</title> + <para>Fallow the next procedure to create a Web project with JBoss Portlet capabilities pointed to the JBoss Portal runtime.</para> + + <orderedlist> + <listitem> + <para>Go to <emphasis> + <property>File > New > Dynamic Web Project</property> + </emphasis> if you are in the <property>Web</property> perspective or <emphasis><property>File > + New > Other > Web > Dynamic Web Project</property></emphasis> in any other perspective. + The <property>New Dynamic Web Project</property> wizard appears.</para> + + <figure> + <title>New Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>Specify the name of the project.</para></listitem> + + <listitem> + <para>Click <emphasis> + <property>New</property> + </emphasis> in the <emphasis> + <property>Target Runtime</property> + </emphasis> area to create a JBoss Portal runtime. Choose <emphasis> + <property>JBoss Community > JBoss 4.2 Runtime</property> + </emphasis> and select the <emphasis> + <property>Create a new local server</property> + </emphasis> check box below. Click <emphasis> + <property>Next</property>.</emphasis></para> + + <figure> + <title>New Server Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property>New Server Runtime Environment</property> wizard appears. In the <emphasis> + <property>Name</property></emphasis> field, type <emphasis> + <property>JBoss Portal 2.7 Runtime</property>, + </emphasis> and then use the <emphasis> + <property>Browse</property></emphasis> button to point to the location of JBoss Portal + JBoss AS extracted. Click <emphasis> + <property>Next</property></emphasis> to proceed.</para> + + <figure> + <title>New Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/server_runtime_environment.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>At this point a new JBoss Server instance will be created. On the next page you can verify the + runtime information defined. If something is incorrect, press <emphasis> + <property>Back</property> + </emphasis> to return to the previous wizard page. Click <emphasis> + <property>Finish</property>.</emphasis></para> + + <figure> + <title>Target Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_3.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Click <emphasis> + <property>Modify</property> + </emphasis> in the <emphasis><property>Configuration</property></emphasis> area to enable + a portlet facet for the project.</para> + + <figure> + <title>Setting the Project Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>In the <property>Project Facets</property> dialog, check <emphasis> + <property>JBoss Core Portlet</property> + </emphasis> and press <emphasis> + <property>OK</property> + </emphasis>.</para> + + <figure> + <title>Enabling the JBoss Core Portlet Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_4_a.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If the portlet libraries aren't available in the runtime you targeted, + <emphasis> + <property>JBoss Portlets</property></emphasis> facets will be hidden on this page.</para> + <para>To make them always visible no matter what the runtime is set, you should enable the appropriate option in + <link linkend="preferences">JBoss Portlet Preferences</link>.</para> + </note> + </listitem> + + <listitem> + <para>The <property>Java</property> and <property>Web Module</property> pages are for configuring Java and Web modules in the project. + Here all values are set, so leave everything as it is.</para> + </listitem> + + <listitem> + <para>The last wizard page will ask you to add JBoss Portlet capabilities to the + project. Select <emphasis> + <property>Portlet Target Runtime Provider</property></emphasis> and click <emphasis> + <property>Finish</property></emphasis> to complete the project creation.</para> + + <figure> + <title>Including the Portlet Libraries Provided by Target Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/portlet_capabilities6.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>All types available under <emphasis> + <property>Portlet Implementation Library</property></emphasis> are fully described in the Wiki article at: + <ulink url="http://www.jboss.org/community/wiki/PortletFacetLibraries">http://www.jboss.org/community/wiki/PortletFacetLibraries</ulink>.</para> + </note> + </listitem> + </orderedlist> + + <para>As the result, <property>JBoss Portlet Tools</property> adds <emphasis> + <property>JBoss Core Portlet</property></emphasis> facet to the project, + creates an empty <literal>portlet.xml</literal> file and adds the JBoss Portlet library to the project classpath.</para> + + <figure> + <title>Portlet Project Structure Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_6.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="adding_java_portlet"> + <title>Adding a Java Portlet to a Web Project</title> + + <para>At the previous section you have created a web project with JBoss Portlet capabilities. + The next steps will show you how to add a new Java portlet to the project.</para> + + <orderedlist> + <listitem> + <para>Right-click the project and follow to <emphasis> + <property>New > Other > JBoss Tools Web > Portlet > Java + Portlet</property>.</emphasis></para> + + <figure> + <title>New Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_7.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>The <property>Create Portlet</property> wizard starts (for information about the wizard options, see + <link linkend="java_portlet_wizard">"Java Portlet Wizard"</link> in the guide reference). + The wizard fills in the <emphasis><property>Project</property></emphasis> and <emphasis> + <property>Source Folder</property></emphasis> fields for you. You should specify a Java package and a class name + (for instance, <emphasis> + <property>org.example</property></emphasis> and <emphasis> + <property>TestPortlet</property></emphasis>). Then click <emphasis> + <property>Next</property> + </emphasis>.</para> + + <figure> + <title>Specifying Class File Destination</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_8.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem><para>You may leave the next three pages with default values, on the last one hit <emphasis> + <property>Finish</property>.</emphasis></para> + </listitem> + </orderedlist> + + <para>Once a Java portlet is created, new resources are added to the project structure: a Java portlet class (<literal>TestPortlet.java</literal>), + <literal>default-object.xml</literal> and <literal>portlet-instances.xml</literal> files and the <literal>portlet.xml</literal> descriptor is updated as well.</para> + + <figure> + <title>Structure of the Project with a Java Portlet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, now the project is ready to be built and deployed.</para> + </section> + + <section id="deploying_to_portal"> + <title>Deploying a Portlet to JBoss Portal</title> + + <para>You can deploy a portlet project in the way you deploy any other web application.</para> + + <orderedlist> + <listitem> + <para>Right-click the project and do <emphasis> + <property>Run As > Run On Server</property>. + </emphasis> The <property>Run On Server</property> wizard starts.</para> + + <figure> + <title>Running the Java Portlet on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/runOnServer.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>Select <emphasis><property>JBoss Portal 2.7 Server</property></emphasis> created before and click <emphasis><property>Next</property>.</emphasis></para> + </listitem> + + <listitem> + <para>On the <emphasis> + <property>Add and Remove</property> + </emphasis> page move the created project to the right and click <emphasis> + <property>Finish</property>.</emphasis></para> + + <figure> + <title>Deploying the Portlet Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It will deploy the portlet application and start <property>JBoss + AS</property>.</para> + </listitem> + + <listitem> + <para>Use the <emphasis>http://localhost:8080/portal/portal/default/default</emphasis> URL to see your + portlet in the browser.</para> + + <figure> + <title>Java Portlet in the Browser Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/starting_project/starting_project_14.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + </orderedlist> + </section> + +</section> Added: trunk/portlet/docs/reference/en-US/summary.xml =================================================================== --- trunk/portlet/docs/reference/en-US/summary.xml (rev 0) +++ trunk/portlet/docs/reference/en-US/summary.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="summary" xreflabel="summary"> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + + <para>In conclusion, with this document you could easily get started with <property>JBoss + Portlet Tools</property>. + The above chapters walked you through the steps on how to organize a web project with + JBoss Portlet capabilities enabled, create a Java portlet, JSF or Seam portlet and deploy them to <property>JBoss + Portal</property>. The document also includes the reference of <property>JBoss Portlet Tools</property> features.</para> + + <para>If you have questions or suggestions concerned both the documentation and tools behavior, you are welcome + to <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users forum</ulink>.</para> + + <para>Please, use <ulink url="https://jira.jboss.org/jira/browse/JBDS">Jira</ulink> to report bugs and requests on documentation.</para> + + <section id="rel_resources"> + <title>Other Relevant Resources on the Topic</title> + + <itemizedlist> + <listitem> + <para> + JBoss Portal home page: <ulink url="http://www.jboss.org/jbossportal/">http://www.jboss.org/jbossportal/</ulink> + </para> + </listitem> + + <listitem> + <para> + JBoss Portal Wiki at: <ulink url="http://wiki.jboss.org/wiki/JBossPortal">http://wiki.jboss.org/wiki/JBossPortal</ulink> + </para> + </listitem> + + <listitem> + <para>JBoss Portal documentation set at: <ulink url="http://docs.jboss.org/jbportal/">http://docs.jboss.org/jbportal/</ulink></para> + </listitem> + + <listitem> + <para> + JBoss Tools home page at: <ulink url="http://www.jboss.org/tools/">http://www.jboss.org/tools/</ulink> + </para> + </listitem> + + <listitem> + <para> + The latest JBossTools/JBDS documentation builds at: <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs/</ulink> + </para> + </listitem> + + <listitem> + <para>JBoss Developer Studio/JBoss Tools release documentation you can + find at <ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> \ No newline at end of file Modified: trunk/portlet/docs/reference/pom.xml =================================================================== --- trunk/portlet/docs/reference/pom.xml 2010-03-04 01:52:03 UTC (rev 20633) +++ trunk/portlet/docs/reference/pom.xml 2010-03-04 03:44:51 UTC (rev 20634) @@ -99,9 +99,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: trunk/portlet/docs/reference/publican.cfg =================================================================== --- trunk/portlet/docs/reference/publican.cfg (rev 0) +++ trunk/portlet/docs/reference/publican.cfg 2010-03-04 03:44:51 UTC (rev 20634) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20632 - in trunk/esb/docs/esb_ref_guide: en-US and 4 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-03 19:31:28 -0500 (Wed, 03 Mar 2010) New Revision: 20632 Added: trunk/esb/docs/esb_ref_guide/en-US/ trunk/esb/docs/esb_ref_guide/en-US/Author_Group.xml trunk/esb/docs/esb_ref_guide/en-US/Book_Info.xml trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml trunk/esb/docs/esb_ref_guide/en-US/Preface.xml trunk/esb/docs/esb_ref_guide/en-US/Revision_History.xml trunk/esb/docs/esb_ref_guide/en-US/esb_editor.xml trunk/esb/docs/esb_ref_guide/en-US/esb_support.xml trunk/esb/docs/esb_ref_guide/en-US/images/ trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/ trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/ trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/ trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png trunk/esb/docs/esb_ref_guide/en-US/images/favicon.ico trunk/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png trunk/esb/docs/esb_ref_guide/en-US/introduction.xml trunk/esb/docs/esb_ref_guide/en-US/master.xml trunk/esb/docs/esb_ref_guide/en-US/master_output.xml trunk/esb/docs/esb_ref_guide/publican.cfg Removed: trunk/esb/docs/esb_ref_guide/en/ Modified: trunk/esb/docs/esb_ref_guide/pom.xml Log: updated book to build with publican and maven Added: trunk/esb/docs/esb_ref_guide/en-US/Author_Group.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/Author_Group.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/Author_Group.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,5 @@ +<?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>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author></authorgroup> Added: trunk/esb/docs/esb_ref_guide/en-US/Book_Info.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/Book_Info.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/Book_Info.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -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>ESB Tools Reference Guide</title><subtitle>Provides information relating to the ESB Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The ESB Tools Reference Guide explains how to use the ESB Tools to create ESB files quickly and with precision.</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><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "ESB_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,11 @@ +<?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="esb_support.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="esb_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: trunk/esb/docs/esb_ref_guide/en-US/Preface.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/Preface.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/Preface.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -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><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:include></xi:fallback></xi:include></preface> Added: trunk/esb/docs/esb_ref_guide/en-US/Revision_History.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/Revision_History.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/Revision_History.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -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(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/esb/docs/esb_ref_guide/en-US/esb_editor.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/esb_editor.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/esb_editor.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,362 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="esb_editor" xreflabel="esb_editor" role="updated"> + <?dbhtml filename="esbEditor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss ESB</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Editor</title> + + <para> ESB editor has lots of useful features, they are described in details in this chapter. In + addition you'll get to know with how <property>ESB Editor</property> uses combined + visual and source editing of esb files.</para> + + <section id="esb_file" role="updated"> + + <title>ESB File Editor</title> + <para><property>ESB File Editor</property> is a powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> + <figure> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>Some properties are represented as links to the associated editors.</para> + + <figure id="TreeViewLink"> + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01a_esb_tree_view_and_links.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now when editing ESB actions which refer to other files (Drools, Groovy, Smooks, etc.), + the label for the field turns into a link to launch the editor associated with that type of file.</para> + <figure > + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01b_esb_tree_view_and_links.png"/> + </imageobject> + </mediaobject> + </figure> + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property>Source view</property>.</para> + + <figure id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property>Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property>Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property>Outline view</property> and it will jump to the same place in + the Source editor, so you can navigate through the source code with Outline view.</para> + <figure> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property>Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para/> + <figure> + <title>Adding New Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property>Add</property>, <property>Edit</property> and + <property>Remove</property> buttons to the right.</para> + + <para>You can easily add a new Service too:</para> + <figure> + <title>Adding New Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure> + <title>Adding New Listener for Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property>Tree view</property> tab + (Form editor) using <property>Add</property>, <property>Edit</property> and + <property>Remove</property> buttons.</para> + + <para>Filter can be also edited this way</para> + + <figure> + <title>Editing Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06a_esb_filter.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>In order to add a new custom Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property>New > Custom Action</property>. </emphasis></para> + + <figure> + <title>Adding New Action in the Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Or instead make use of <emphasis> + <property>Add...</property> + </emphasis> button in the <property>Form editor</property> on the left.</para> + <figure> + <title>Adding New Action in the Form Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>Some new components are available to support ESB 4.7,such as: + new actions (XsltAction, PersistAction, BpmProcessor, ScriptingAction), + new processors (EJBProcessor), new routers (HttpRouter, JMSRouter, EmailRouter). + </para> + </note> + + <para>As you can see on the bath figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with <property>JBoss + ESB</property>. After choosing one an appeared <property>New Action wizard</property> + will ask you to fill out a name field and other fields specific for each Action + property. For example, for <emphasis> + <property>Content Based Router</property> + </emphasis> Action the wizard looks as follows:</para> + + <figure> + <title>New Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After confirming creating the Action you can see it in the Tree under the <emphasis> + <property>Actions</property> + </emphasis> node and preview as well as edit its settings in the <property>Form + editor</property> on the left.</para> + + <figure> + <title>Form Editor for Content Based Router</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para><property>ESB editor</property> can recognize some specific objects. On the figure you + can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis> + <property>Class</property> + </emphasis> section.</para> + + </section> + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <para>This last chapter covers capabilities on how you can use ESB editor.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in <property>JBoss ESB editor</property> you are constantly provided + with feedback and contextual error checking as you type. In the Source viewer, if at + any point a tag is incorrect or incomplete, an error will be indicated next to the + line and also in the <property>Problems view</property> below.</para> + + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + <para>The schema checks the child elements of any kind of provider element; the ESB generates errors on startup if you attempt to define an incorrect combination (e.g.: a jms-bus inside an ftp-provider).</para> + <note><title>Note:</title> + <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note> + + </section> + +  + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML file</title> + + <para>When you work with any ESB XML file <property>Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property>Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure> + <title>Content Assist for attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="openOn_for_esb"> + <title>OpenOn for ESB XML file</title> + <para>ESB file comes with the OpenOn feature that allows to make use of multiple file references in the file just with a click and the <emphasis> + <property>Ctrl</property></emphasis> key hold down.</para> + + <para>The OpenOn is implemented for different types of files/pages inside the <literal><action></literal> tag: .xsd, .xml, etc.</para> + + <figure> + <title>OpenOn for smooks configuration file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It is also available for classes:</para> + + <figure> + <title>OpenOn for classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property>Tree</property>) and source (<property>Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> + + <figure> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBoss ESB.</para> + + <para>We hope, this guide helped you to get started with the JBoss ESB Tools. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + + </section> + </section> +</chapter> Added: trunk/esb/docs/esb_ref_guide/en-US/esb_support.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/esb_support.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/esb_support.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,509 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="esb_support" role="updated"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Support</title> + + <para>In this section we will focus on all concepts that <property>JBoss Tools</property> + integrate for working with JBoss ESB.</para> + + <section> + <title>ESB Tools Installation</title> + + <para>This chapter will provide you with the information on how to install + JBoss ESB plugin into Eclipse.</para> + + <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a + dependence on other JBoss Tools modules we recommend you to install a bundle + of all <ulink url="http://labs.jboss.com/tools/download.html">JBoss + Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools" + >InstallingJBossTools</ulink> section.</para> + </section> + + <section> + <title>Creating a ESB Project</title> + <para>In this chapter we suggest a step-by-step walk-through of creating a new + ESB project. Let's try to create a new JBoss ESB project.</para> + + <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para> + + <para>Select <emphasis> + <property>File >New > Project...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property>ESB > ESB Project</property> + </emphasis> in the dialog opened:</para> + + <figure> + <title>Select a Wizard dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/01_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis> + <property>helloworld</property> + </emphasis> as a Project name and accept the default ESB version.</para> + <figure> + <title>JBoss ESB Project wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By clicking <emphasis>Modify</emphasis> button you can open <emphasis>Project Facets Wizard</emphasis> page,where you can select + facets that should be enabled for this project. + On the <emphasis>Project Facets Wizard</emphasis> page you can also configure runtime for the application</para> + <figure> + <title>Project Facets Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02a_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Next step provides you an opportunity to configure your project for building a java application</para> + + <para> Clicking <emphasis> + <property>Next</property> on this form + </emphasis> brings you to the ESB facet installation page where you can + specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options: + </para> + <para>1. Use <emphasis> + <property>Server Supplied ESB Runtime</property> + </emphasis> + + </para> + <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences. If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed. + </para> + <para>3. Choose ESB Config Vertion. From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd.</para> + <note><title>Note:</title> + <para>If you use ESB 4.7 you should select jbossesb-1.2.0.xsd.</para></note> + <figure> + <title>Install ESB facet step</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/03_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property>Finish</property> + </emphasis> and a ESB project with the default <emphasis><property>jboss-esb.xml</property></emphasis> + will be created. </para> + + <figure> + <title>The generated ESB project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/04_create_esb_project.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ESB_project_wizard" xreflabel="here"> + <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title> + <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start + creating a ESB project using this wizard.</para> + + <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property> + JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para> + + <para>Select <emphasis> + <property>File >New > Others </property> + </emphasis> , in the main menu bar or context menu for selected project and + then <emphasis> + <property>JBoss Tools > Project Examples</property> + </emphasis> in the New dialog:</para> + + <figure> + <title>Select a wizard - Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the wizard page where you can select a ESB project example from the example list. + Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para> + <para>Here is a list of ready examples available:</para> + + <itemizedlist> + + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -> XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> POJO Example</emphasis> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem> + + </itemizedlist> + + + + <para>We will take as our example <emphasis><property>JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para> + + + <figure> + <title>JBoss Tools ESB Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/06_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>Choose them using the Ctrl button and then click + <emphasis><property>Finish</property></emphasis>. As a result you will get two projects created:</para> + <figure> + <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/07_esb_project_example.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para> + </section> + + <section> + <title>Deploying a ESB Project</title> + <para>In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</para> + + <para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property>Window > Show View > Other > + Server > JBoss Server View</property></emphasis>, + create a JBoss Server in the Server view and start it, and then right click the created JBoss server, + select <emphasis><property> </property> Add and Remove Projects</emphasis>, + and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para> + + <figure> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/08_esb_project_deploy.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis><property>Finish</property> </emphasis> to add the project to the server. + You also can drag the ESB project from the Project View to the server.</para> + + <figure> + <title>JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/09_esb_runtime_new.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property>Publish</property></emphasis> to publish the project on the server. + You can check the deploying result in the Console view.</para> + <para>The <emphasis><property>Run</property></emphasis> and <emphasis><property>Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para> + <para>You can also use the "Finger touch" for a quick restart of the project without restarting the server:</para> + <figure> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/23_finger_touch.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</para> + <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property>Export</property></emphasis>:</para> + + <figure> + <title>Export of ESB project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/24_export_button.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property>ESB</property></emphasis> > <emphasis><property>ESB File</property></emphasis> and click <emphasis><property>Next</property></emphasis>:</para> + + <figure><title>Choosing ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/25_esb_file.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property>Finish</property></emphasis>.</para> + + <figure><title>ESB Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/26_esb_export.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Your project is deployed as an .esb archive.</para> + <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para> + + + </section> + + <section> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own + simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis> + <property>File >New > Other...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property>ESB > ESB File</property> + </emphasis> in the New dialog:</para> + + <figure> + <title>Select a wizard - ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis> + <property>jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and the default + version.</para> + + <note><title>Note:</title> + <para>From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd. + If you use ESB 4.7 you should select jbossesb-1.2.0.xsd. + </para> + </note> + <figure> + <title>Folder, Name and Version for ESB file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected projects folder by default. If + you want to change the folder for your future file click <emphasis> + <property>Browse...</property> + </emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis> + <property>Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml + file.</para> + + </section> + + <section role="updated"> + <title>Configuring ESB Runtime in Preferences</title> + <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para> + + <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it.</para> + + <para>Select <emphasis> + <property>Window >Preferences > JBoss Tools > JBoss ESB Runtime</property> + </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para> + + <figure> + <title>JBoss ESB Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/10_esb_runtime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> Select <emphasis><property>Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number. It's also possible to define configuration if you point the home location to a Jboss AS or SOA-p, in case you select a standalone ESB runtime location, the configuration combo will be empty and should be ignored. + You can also customize the libraries of the runtime by checking the <emphasis><property>Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para> + + <figure> + <title>Configure new JBoss ESB Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/11_esb_runtime_new.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property>OK</property> </emphasis> to finish and save the preferences. + You can use the configuration when creating a JBoss ESB project. </para> + <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property>Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para> + + <figure> + <title>Classpath Container Page to change ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/20_classpath_container.png"/> + </imageobject> + </mediaobject> + </figure> + + + + <para>Choose one of them to set to the ESB project and click <emphasis><property>Ok</property></emphasis>.</para> + <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property>Properties</property></emphasis>. Choose <emphasis><property>Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/21_source.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> + <para>To change Javadoc Location choose <emphasis><property>Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property>package-list</property></emphasis>:</para> + + <figure> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/22_Javadoc.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property>Apply</property></emphasis> and then on <emphasis><property>Ok</property></emphasis>.</para> + + </section> + + + <section id="using_SOA"> + <title>Using and Configuring SOA Platform</title> + + <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para> + + <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para> + <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para> + + <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para> + <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para> + + <para>To configure the JBoss Enterprise SOA platform select <emphasis> + <property>Window > Preferences > Server > Runtime Environments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para> + + <figure> + <title>Configure new Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select <emphasis><property>Add</property></emphasis>, choose <emphasis><property>JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property>Create a new local server</property></emphasis> checkbox and click <emphasis><property>Next</property></emphasis>:</para> + <figure> + <title>Type of Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/14typeOfRuntime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the next step you can specify a name of the server runtime environment and browse to its location. Click <emphasis><property>Finish</property></emphasis> to add the server runtime environment.</para> + + + <figure> + <title>New Server Runtime Environment Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/15AddNew.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"/>. As a result you will have two projects created:</para> + + <figure> + <title>Helloworld Projects Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/16HelloworldProjects.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property>Build Path > Add Libraries</property></emphasis>:</para> + + <figure> + <title>Add Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/17_Add_new_libraries.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property>JBoss ESB Libraries</property></emphasis> and click <emphasis><property>Next</property></emphasis>:</para> + + <figure> + <title>ESB Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/18_select_libraries.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select the necessary runtime to add to the project classpath:</para> + + + <figure> + <title>Select a ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/19_select_runtime.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis><property>Finish</property></emphasis>.</para> + <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para> + + + +</section> + + + + + + + + + + +</chapter> Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/esb/docs/esb_ref_guide/en-US/introduction.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/introduction.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/introduction.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,118 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB?</title> + + <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an + enterprise messaging system that provides the features Service Oriented + Architectures may be implemented with.</para> + <para>If you want to develop applications using ESB technology JBoss ESB also meets your + needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB + file.</para> + <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to + develop an ESB file much faster and with far fewer errors so sparing your time.</para> + + </section> + +<section> + <title>Key Features of ESB Tools</title> + <para>For a start, we propose you to look through the table of main features of ESB plugin:</para> + + <table> + + <title>Key Functionality of ESB 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>JBoss Tools Project Examples Wizard</para></entry> + <entry><para>Some kinds of projects with predefined structure are available for usage.</para></entry> + <entry> + <link linkend="ESB_project_wizard">Creating ESB Project using JBoss Tools Project Examples Wizard</link> + </entry> + </row> + + <row> + <entry><para>JBoss Enterprise SOA Platform</para></entry> + <entry><para>The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para></entry> + <entry> + <link linkend="using_SOA">using and configuring SOA Platform</link> + </entry> + </row> + + <row> + <entry><para>ESB Editor</para></entry> + <entry><para>JBoss ESB tooling has powerful editor features including syntax validation, support for XML Schema and other.</para></entry> + <entry> + <link linkend="esb_editor">ESB editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + +</section> + + + <section> + <title>Other relevant resources on the topic</title> + + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB + Documentation Library</ulink> + </para> + </listitem> + </itemizedlist> + + <para>The latest <property>JBoss Tools/JBoss Developer Studio</property> documentation + builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/" + > JBoss Tools nightly documentation page</ulink>.</para> + + </section> +</chapter> Added: trunk/esb/docs/esb_ref_guide/en-US/master.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/master.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/master.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,65 @@ +<?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 esb_support SYSTEM "esb_support.xml"> +<!ENTITY esb_editor SYSTEM "esb_editor.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>ESB 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> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.3.0.GA + </releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink> + </para> +</abstract> + +</bookinfo> + <toc/> + + &introduction; + &esb_support; + &esb_editor; + +</book> Added: trunk/esb/docs/esb_ref_guide/en-US/master_output.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/en-US/master_output.xml (rev 0) +++ trunk/esb/docs/esb_ref_guide/en-US/master_output.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,1052 @@ +<?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 esb_support SYSTEM "modules/esb_support.xml"> +<!ENTITY esb_editor SYSTEM "modules/esb_editor.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>ESB 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> + <author><firstname>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author> + <author><firstname>Tatyana</firstname><surname>Romanovich</surname></author> + + <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.3.0.GA + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/esb_ref_guide/pdf/ES...">PDF version</ulink> + </para> +</abstract> + +</bookinfo> + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en/modules/introduction.xml"> + <?dbhtml filename="introduction.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + <keyword>JBoss Tools</keyword> + <keyword>JBDS</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <section> + + <title>What is ESB?</title> + + <para>ESB (Enterprise Service Bus) - an abstraction layer on top of implementation of an + enterprise messaging system that provides the features Service Oriented + Architectures may be implemented with.</para> + <para>If you want to develop applications using ESB technology JBoss ESB also meets your + needs. The JBoss Tools provide an ESB editor and all necessary wizards for creating an ESB + file.</para> + <para>In this guide we provide you with the information on JBoss ESB support (installation, configuration and deployment) and usage of ESB Editor which allows you to + develop an ESB file much faster and with far fewer errors so sparing your time.</para> + + </section> + +<section> + <title>Key Features of ESB Tools</title> + <para>For a start, we propose you to look through the table of main features of ESB plugin:</para> + + <table> + + <title>Key Functionality of ESB 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>JBoss Tools Project Examples Wizard</para></entry> + <entry><para>Some kinds of projects with predefined structure are available for usage.</para></entry> + <entry> + <link linkend="ESB_project_wizard">Creating ESB Project using JBoss Tools Project Examples Wizard</link> + </entry> + </row> + + <row> + <entry><para>JBoss Enterprise SOA Platform</para></entry> + <entry><para>The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para></entry> + <entry> + <link linkend="using_SOA">using and configuring SOA Platform</link> + </entry> + </row> + + <row> + <entry><para>ESB Editor</para></entry> + <entry><para>JBoss ESB tooling has powerful editor features including syntax validation, support for XML Schema and other.</para></entry> + <entry> + <link linkend="esb_editor">ESB editor</link> + </entry> + </row> + + </tbody> + + </tgroup> + </table> + + +</section> + + + <section> + <title>Other relevant resources on the topic</title> + + <para>You can find a set of benefits and other extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb">JBoss ESB</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://wiki.jboss.org/wiki/JBossESB">JBoss Wiki</ulink> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://www.jboss.org/jbossesb/docs/index.html">JBoss ESB + Documentation Library</ulink> + </para> + </listitem> + </itemizedlist> + + <para>The latest <property moreinfo="none">JBoss Tools/JBoss Developer Studio</property> documentation + builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/"> JBoss Tools nightly documentation page</ulink>.</para> + + </section> +</chapter> + + +<chapter id="esb_support" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en/modules/esb_support.xml"> + <?dbhtml filename="esb_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>ESB</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Support</title> + + <para>In this section we will focus on all concepts that <property moreinfo="none">JBoss Tools</property> + integrate for working with JBoss ESB.</para> + + <section> + <title>ESB Tools Installation</title> + + <para>This chapter will provide you with the information on how to install + JBoss ESB plugin into Eclipse.</para> + + <para>ESB Tools come as one module of JBoss Tools project. Since ESB Tools have a + dependence on other JBoss Tools modules we recommend you to install a bundle + of all <ulink url="http://labs.jboss.com/tools/download.html">JBoss + Tools plug-ins</ulink>. You can find all necessary installation instructions on JBoss Wiki in the <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink> section.</para> + </section> + + <section> + <title>Creating a ESB Project</title> + <para>In this chapter we suggest a step-by-step walk-through of creating a new + ESB project. Let's try to create a new JBoss ESB project.</para> + + <para>We will show you how to use the ESB Project Creation wizard for creating a new ESB project and setting basic ESB classpath.</para> + + <para>Select <emphasis> + <property moreinfo="none">File >New > Project...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB > ESB Project</property> + </emphasis> in the dialog opened:</para> + + <figure float="0"> + <title>Select a Wizard dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/01_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the JBoss ESB Project wizard page where a project name, ESB version and target JBoss Runtime are to be specified. Specify, for example, <emphasis> + <property moreinfo="none">helloworld</property> + </emphasis> as a Project name and accept the default ESB version.</para> + <figure float="0"> + <title>JBoss ESB Project wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/02_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">By clicking </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Modify</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> button you can open </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Project Facets Wizard</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> page,where you can select + facets that should be enabled for this project. + On the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Project Facets Wizard</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> page you can also configure runtime for the application</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Project Facets Wizard</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_project/02a_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Next step provides you an opportunity to configure your project for building a java application</para> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> on this form + </emphasis> brings you to the ESB facet installation page where you can + specify Java Source Directory and ESB Content Directory. ESB Content Directory is a folder that contains the most of + artifacts that an ESB archive needs. You also can configure ESB libraries to the project by selecting a ESB runtime using one of the options: + </para> + <para>1. Use <emphasis> + <property moreinfo="none">Server Supplied ESB Runtime</property> + </emphasis> + + </para> + <para> 2. Select a ESB runtime from the JBoss ESB runtime list predefined in the preferences. If you choose the first option, make sure that the project has the Target JBoss Runtime set and this runtime has a ESB runtime installed. + </para> + <para><diffmk:wrapper diffmk:change="added">3. Choose ESB Config Vertion. From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd.</diffmk:wrapper></para> + <note diffmk:change="added"><title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Note:</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you use ESB 4.7 you should select jbossesb-1.2.0.xsd.</diffmk:wrapper></para></note> + <figure float="0"> + <title>Install ESB facet step</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/03_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> and a ESB project with the default <emphasis><property moreinfo="none">jboss-esb.xml</property></emphasis> + will be created. </para> + + <figure float="0"> + <title>The generated ESB project structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/04_create_esb_project.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ESB_project_wizard" xreflabel="here"> + <title>Creating ESB Project using JBoss Tools Project Examples Wizard</title> + <para>JBoss Tools provides a Project Example wizard that is an easy way for users to create some kinds of projects to be used as examples with some predefined structure. Let's start + creating a ESB project using this wizard.</para> + + <para>Before creating a ESB project example create JBoss Runtime with name <emphasis><property moreinfo="none"> + JBoss 4.2 Runtime</property></emphasis>, it will be used by your ESB project example. </para> + + <para>Select <emphasis> + <property moreinfo="none">File >New > Others </property> + </emphasis> , in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">JBoss Tools > Project Examples</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/05_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the wizard page where you can select a ESB project example from the example list. + Every ESB example has two projects, one is a ESB project and another is a Java project used to test the ESB project.</para> + <para>Here is a list of ready examples available:</para> + + <itemizedlist> + + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Example</emphasis> - demonstrates the minimal files necessary to make a basic ESB component execute as well as to prove that the ESB os properly configured.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld Action Example</emphasis> - demonstrates the use of multiple action invocations from a single configuration. You can use a single Action class and make multiple method calls or use multiple Action classes. </para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB HelloWorld File Action Example</emphasis> - demonstrates using the File gateway feature of the JBoss ESB. Files that are found in a particular directory with a particular extension are sent to a JMS queue with actions for processing.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service consumer1 Example</emphasis> - demonstrates how to consume a 181 Web Service in an ESB action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Web Service producer Example</emphasis> - demonstrates how to deploy a JSR181 Webservice endpoint on JBossESB using the SOAPProcessor action.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks CSV -> XML Example</emphasis> - demonstrates how to transform a comma separated value (CSV) file to an XML.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> POJO Example</emphasis> - demonstrates the use of Smooks performing a simple transformation by converting an XML file into Java POJOs.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML date-manipulation Example</emphasis> - demonstrates how to manually define and apply a Message Transformation within JBoss ESB.</para></listitem> + <listitem><para><emphasis role="bold">JBoss ESB Smooks XML -> XML Example</emphasis> - a very basic example of how to manually define and apply a Message Transformation within JBoss ESB. It applies a very simple XSLT to a SampleOrder.xml message and prints the before and after XML to the console. </para></listitem> + + </itemizedlist> + + + + <para>We will take as our example <emphasis><property moreinfo="none">JBoss ESB HelloWorld Example</property> </emphasis> ESB and Client project:</para> + + + <figure float="0"> + <title>JBoss Tools ESB Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/06_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Choose them using the Ctrl button and then click + <emphasis><property moreinfo="none">Finish</property></emphasis>. As a result you will get two projects created:</para> + <figure float="0"> + <title>JBoss ESB Project Examples: helloworld and helloworld_testclient</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/07_esb_project_example.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Deploy the HelloWorld ESB project and run a test class in the client Java project to see the test result in the Console view.</para> + </section> + + <section> + <title>Deploying a ESB Project</title> + <para>In this chapter you will see how to deploy a ESB project using the WTP deployment framework.</para> + + <para>Before deploying the project, open the JBoss Server View by selecting <emphasis><property moreinfo="none">Window > Show View > Other > + Server > JBoss Server View</property></emphasis>, + create a JBoss Server in the Server view and start it, and then right click the created JBoss server, + select <emphasis><property moreinfo="none"> </property> Add and Remove Projects</emphasis>, + and add the ESB projects you want to deploy from the left side to the right side in the opened dialog. </para> + + <figure float="0"> + <title>Add and Remove Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/08_esb_project_deploy.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click <emphasis><property moreinfo="none">Finish</property> </emphasis> to add the project to the server. + You also can drag the ESB project from the Project View to the server.</para> + + <figure float="0"> + <title>JBoss Server View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/09_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, you have just added the ESB project to the JBoss server module list. Right click the JBoss Server and select <emphasis><property moreinfo="none">Publish</property></emphasis> to publish the project on the server. + You can check the deploying result in the Console view.</para> + <para>The <emphasis><property moreinfo="none">Run</property></emphasis> and <emphasis><property moreinfo="none">Debug</property></emphasis> options work on ESB projects causing a (re)deploy for a user designated server.</para> + <para>You can also use the "Finger touch" for a quick restart of the project without restarting the server:</para> + <figure float="0"> + <title>Finger Touch button</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/23_finger_touch.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The "Finger" touches descriptors dependent on project (i.e. web.xml for WAR, application.xml for EAR) and now it is also available for jboss-esb.xml in ESB projects.</para> + <para>You can also deploy your ESB project as an .esb archive. Right-click on the project, choose <emphasis><property moreinfo="none">Export</property></emphasis>:</para> + + <figure float="0"> + <title>Export of ESB project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/24_export_button.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">ESB</property></emphasis> > <emphasis><property moreinfo="none">ESB File</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"><title>Choosing ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/25_esb_file.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And finally export the ESB project to the file system: choose the destination, choose the target runtime if need a specific one and make the appropriate settings for the archive. Then click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + + <figure float="0"><title>ESB Export</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/26_esb_export.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Your project is deployed as an .esb archive.</para> + <para>An ESB archive can be created for ESB projects only. It is also possible to deploy an .esb archive to a JBoss AS based server with JBoss ESB installed.</para> + + + </section> + + <section> + <title>Creating a ESB File</title> + <para>In this chapter we suggest a step-by-step walk-through of creating your own + simple file. Let's try to organize a new ESB file.</para> + + <para>We will show you how to use the Creation wizard for creating a new ESB file.</para> + + <para>At first you should open any project. Select <emphasis> + <property moreinfo="none">File >New > Other...</property> + </emphasis> in the main menu bar or context menu for selected project and + then <emphasis> + <property moreinfo="none">ESB > ESB File</property> + </emphasis> in the New dialog:</para> + + <figure float="0"> + <title>Select a wizard - ESB File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/01_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings you to the wizard page where a folder, a name and a version for the file should be specified. Choose, for example, <emphasis> + <property moreinfo="none">jboss-esb.xml</property> + </emphasis> as the name and accept the selected projects folder and the default + version.</para> + + <note><title>Note:</title> + <para><diffmk:wrapper diffmk:change="changed">From the version 3.1.0 JBoss ESB Tools supports three different jboss-esb.xsd versions: jbossesb-1.0.1.xsd, jbossesb-1.1.0.xsd and jbossesb-1.2.0.xsd. + If you use ESB 4.7 you should select jbossesb-1.2.0.xsd. + </diffmk:wrapper></para> + </note> + <figure float="0"> + <title>Folder, Name and Version for ESB file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_support/02_create_esb.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, your file will be created in the selected projects folder by default. If + you want to change the folder for your future file click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed folder or simply type it.</para> + + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> results in the file being generated. The wizard creates one xml + file.</para> + + </section> + + <section role="updated"> + <title>Configuring ESB Runtime in Preferences</title> + <para>In this chapter you will know how to predefine a JBoss ESB runtime on the Preferences page.</para> + + <para>You may already know, there are two ways to set JBoss ESB runtime when creating a ESB project, + one is to use the project target JBoss runtime, and another is to select a JBoss ESB runtime predefined in JBoss Tools preferences. + Let's configure it.</para> + + <para>Select <emphasis> + <property moreinfo="none">Window >Preferences > JBoss Tools > JBoss ESB Runtime</property> + </emphasis>, to open the JBoss ESB Runtime Preferences page where you can add, remove and Edit a JBoss ESB runtime.</para> + + <figure float="0"> + <title>JBoss ESB Runtimes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/10_esb_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Select <emphasis><property moreinfo="none">Add</property></emphasis> to open a dialog where you can specify the JBoss ESB runtime location, name and version number. It's also possible to define configuration if you point the home location to a Jboss AS or SOA-p, in case you select a standalone ESB runtime location, the configuration combo will be empty and should be ignored. + You can also customize the libraries of the runtime by checking the <emphasis><property moreinfo="none">Customize JBoss ESB Runtime jars</property> </emphasis> checkbox. </para> + + <figure float="0"> + <title>Configure new JBoss ESB Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/11_esb_runtime_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The new JBoss ESB Runtime will be configured. Click <emphasis> <property moreinfo="none">OK</property> </emphasis> to finish and save the preferences. + You can use the configuration when creating a JBoss ESB project. </para> + <para>When a ESB runtime is configured for your ESB project you are able to change it to any other using the classpath container page for ESB runtime. To do that, turn to the Package Explorer view and right-click the "JBoss ESB Runtime" library. Select <emphasis><property moreinfo="none">Properties</property></emphasis> and a table listing all available JBoss ESB runtimes will appear:</para> + + <figure float="0"> + <title>Classpath Container Page to change ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/20_classpath_container.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + <para>Choose one of them to set to the ESB project and click <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>ESB container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure float="0"> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/21_source.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>To change Javadoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para> + + <figure float="0"> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/22_Javadoc.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + + </section> + + + <section id="using_SOA"> + <title>Using and Configuring SOA Platform</title> + + <para>In this chapter you will know what is JBoss Enterprise SOA Platform and how you can configure it to use for your ESB projects. </para> + + <para>JBoss Enterprise SOA Platform delivers a flexible, standards-based platform to integrate applications, SOA services, business events and automate business processes. The SOA Platform integrates specific versions of JBoss ESB, jBPM, Drools and the JBoss Enterprise Application Platform that are certified to work together in a single supported enterprise distribution.</para> + <para>Having configured JBoss Enterprise SOA Platform for your ESB project you don't need to install and configure ESB server and runtime as they are already included.</para> + + <para>Check here to find more details on the platform: <ulink url="http://www.jboss.com/products/platforms/soa">JBoss Enterprise SOA Platform</ulink> and <ulink url="http://www.jboss.com/products/platforms/soa/components">JBoss Enterprise SOA Platform Component Details</ulink>.</para> + <para>You can find out what is SOA here: <ulink url="http://www.jboss.org/jbossesb/resources/SOABasics.html">Basics of SOA</ulink> and <ulink url="http://www.jboss.org/jbossesb/resources/SOAEOA.html">SOA and EOA</ulink>.</para> + + <para>To configure the JBoss Enterprise SOA platform select <emphasis> + <property moreinfo="none">Window > Preferences > Server > Runtime Environments</property></emphasis>, that will open the Server Runtime Environments Preferences page where you can add, remove and edit a Server Runtime Environment.</para> + + <figure float="0"> + <title>Configure new Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/13NewServerRuntimeEnv.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <emphasis><property moreinfo="none">Add</property></emphasis>, choose <emphasis><property moreinfo="none">JBoss 4.2 Runtime</property></emphasis> as a type of runtime environment, check the <emphasis><property moreinfo="none">Create a new local server</property></emphasis> checkbox and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + <figure float="0"> + <title>Type of Server Runtime Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/14typeOfRuntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next step you can specify a name of the server runtime environment and browse to its location. Click <emphasis><property moreinfo="none">Finish</property></emphasis> to add the server runtime environment.</para> + + + <figure float="0"> + <title>New Server Runtime Environment Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/15AddNew.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you have your SOA platform configured. To check the configuration create a ESB Project using instructions described <xref linkend="ESB_project_wizard"></xref>. As a result you will have two projects created:</para> + + <figure float="0"> + <title>Helloworld Projects Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/16HelloworldProjects.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you will need to add JBoss ESB libraries to your projects to configure the SOA server runtime exactly for your projects. Right-click on your project, select <emphasis><property moreinfo="none">Build Path > Add Libraries</property></emphasis>:</para> + + <figure float="0"> + <title>Add Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/17_Add_new_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Choose <emphasis><property moreinfo="none">JBoss ESB Libraries</property></emphasis> and click <emphasis><property moreinfo="none">Next</property></emphasis>:</para> + + <figure float="0"> + <title>ESB Libraries</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/18_select_libraries.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select the necessary runtime to add to the project classpath:</para> + + + <figure float="0"> + <title>Select a ESB runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_project/19_select_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>.</para> + <para>Now you can deploy your Helloworld project to the server and run a test class in the client Java project to see the test result in the Console view.</para> + + + +</section> + + + + + + + + + + +</chapter> + + +<chapter id="esb_editor" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/esb/docs/esb_ref_guide/en/modules/esb_editor.xml" xreflabel="esb_editor"> + <?dbhtml filename="esbEditor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss ESB</keyword> + <keyword>Editor</keyword> + <keyword>ESB</keyword> + </keywordset> + </chapterinfo> + + <title>ESB Editor</title> + + <para> ESB editor has lots of useful features, they are described in details in this chapter. In + addition you'll get to know with how <property moreinfo="none">ESB Editor</property> uses combined + visual and source editing of esb files.</para> + + <section id="esb_file" role="updated"> + + <title>ESB File Editor</title> + <para><property moreinfo="none">ESB File Editor</property> is a powerful and customizable tool. ESB File + Editor allows developing an application using ESB technology.</para> + + <para>ESB file editor has two tabs: Tree and Source.</para> + + <para>You can switch to Tree. The Tree view for the editor displays all ESB artifacts in a + tree format. By selecting any node you can see and edit its properties which will appear + in the right-hand area. For example, a Provider:</para> + <figure float="0"> + <title>Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01_esb_tree_view.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Some properties are represented as links to the associated editors.</para> + + <figure float="0" id="TreeViewLink"> + <title>Property Link to the Associated Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/01a_esb_tree_view_and_links.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Now when editing ESB actions which refer to other files (Drools, Groovy, Smooks, etc.), + the label for the field turns into a link to launch the editor associated with that type of file.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Property Link to the Associated Editor</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/esb_editor/01b_esb_tree_view_and_links.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can easily switch from Tree to Source by selecting the Source tab at the bottom of + the editor and work in <property moreinfo="none">Source view</property>.</para> + + <figure float="0" id="sourceView"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/02_esb_source_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The Source view for the editor displays a text content of the ESB file. It is always + synchronized with <property moreinfo="none">Tree view</property>, so any changes made in one of the + views will immediately appear in the other.</para> + + <para>No matter what view you select, you get full integration with <property moreinfo="none">Outline + view</property>. For example, you can work in the Source view with the help of the + Outline view. The Outline view shows a tree structure of the ESB file. Simply select any + element in the <property moreinfo="none">Outline view</property> and it will jump to the same place in + the Source editor, so you can navigate through the source code with Outline view.</para> + <figure float="0"> + <title>Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/03_esb_outline_view.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Adding, editing or deleting of some artifacts operations are available right in the + <property moreinfo="none">Tree view</property> . Right-click any node and select one of the + available actions in the context menu. For example, you can easily add a new Provider:</para> + <para></para> + <figure float="0"> + <title>Adding New Provider</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/04_esb_add_provider.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then you can add Channels and Properties for the Providers the same way or using the forms with <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons to the right.</para> + + <para>You can easily add a new Service too:</para> + <figure float="0"> + <title>Adding New Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/05_esb_add_service.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The same way you can create a listener for service and other elements of ESB:</para> + <figure float="0"> + <title>Adding New Listener for Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06_esb_add_listener.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The same actions can be done in the right part of <property moreinfo="none">Tree view</property> tab + (Form editor) using <property moreinfo="none">Add</property>, <property moreinfo="none">Edit</property> and + <property moreinfo="none">Remove</property> buttons.</para> + + <para>Filter can be also edited this way</para> + + <figure float="0"> + <title>Editing Filter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/06a_esb_filter.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>In order to add a new custom Action to your ESB XML file you should select the + Actions node under the Services, then right-click and choose <emphasis> + <property moreinfo="none">New > Custom Action</property>. </emphasis></para> + + <figure float="0"> + <title>Adding New Action in the Tree View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/11_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Or instead make use of <emphasis> + <property moreinfo="none">Add...</property> + </emphasis> button in the <property moreinfo="none">Form editor</property> on the left.</para> + <figure float="0"> + <title>Adding New Action in the Form Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/12_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para><diffmk:wrapper diffmk:change="added">Some new components are available to support ESB 4.7,such as: + new actions (XsltAction, PersistAction, BpmProcessor, ScriptingAction), + new processors (EJBProcessor), new routers (HttpRouter, JMSRouter, EmailRouter). + </diffmk:wrapper></para> + </note> + + <para>As you can see on the bath figures above, the context menu will also prompt you to + insert one of the Actions that are supplied out-of-the-box with <property moreinfo="none">JBoss + ESB</property>. After choosing one an appeared <property moreinfo="none">New Action wizard</property> + will ask you to fill out a name field and other fields specific for each Action + property. For example, for <emphasis> + <property moreinfo="none">Content Based Router</property> + </emphasis> Action the wizard looks as follows:</para> + + <figure float="0"> + <title>New Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/13_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After confirming creating the Action you can see it in the Tree under the <emphasis> + <property moreinfo="none">Actions</property> + </emphasis> node and preview as well as edit its settings in the <property moreinfo="none">Form + editor</property> on the left.</para> + + <figure float="0"> + <title>Form Editor for Content Based Router</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/14_esb_editor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para><property moreinfo="none">ESB editor</property> can recognize some specific objects. On the figure you + can see <emphasis>org.jboss.soa.esb.actions.ContentBasedRouter</emphasis> in the <emphasis> + <property moreinfo="none">Class</property> + </emphasis> section.</para> + + </section> + + <section id="esb_editors_features"> + + <title>ESB Editors Features</title> + <para>JBoss ESB tooling has powerful editor features that help you easily make use of + content and code assist.</para> + <para>This last chapter covers capabilities on how you can use ESB editor.</para> + + <section id="ESBsyntaxvalidation84"> + + <title>ESB syntax validation</title> + <para>When working in <property moreinfo="none">JBoss ESB editor</property> you are constantly provided + with feedback and contextual error checking as you type. In the Source viewer, if at + any point a tag is incorrect or incomplete, an error will be indicated next to the + line and also in the <property moreinfo="none">Problems view</property> below.</para> + + </section> + + <section id="ESBSupportXMLSchema"> + <title>Support for XML Schema</title> + + <para>JBoss ESB Framework fully <link linkend="sourceView">supports XML files based on + schemas as well as DTDs</link>.</para> + <para>The schema checks the child elements of any kind of provider element; the ESB generates errors on startup if you attempt to define an incorrect combination (e.g.: a jms-bus inside an ftp-provider).</para> + <note><title>Note:</title> + <para>The schema used behind ESB editor now uses the latest version available (from SOA-P 4.3). This removes the errors/warnings some users have reported seeing when using SOA-P specific esb.xml files.</para> </note> + + </section> + +  + + <section id="ESBContentAssist"> + + <title>Content Assist for ESB XML file</title> + + <para>When you work with any ESB XML file <property moreinfo="none">Content Assist</property> is + available to help you. It provides pop-up tip to help you complete your code + statements. It allows you to write your code faster and with more accuracy. Content + assist is always available in the Source mode. Simply type <emphasis> + <property moreinfo="none">Ctrl-Space</property> + </emphasis> to see what is available.</para> + + <para>Content Assist for ESB XML file:</para> + <figure float="0"> + <title>Content Assist for ESB XML file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/08_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist for attributes:</para> + <figure float="0"> + <title>Content Assist for attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/09_esb_features.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="openOn_for_esb"> + <title>OpenOn for ESB XML file</title> + <para>ESB file comes with the OpenOn feature that allows to make use of multiple file references in the file just with a click and the <emphasis> + <property moreinfo="none">Ctrl</property></emphasis> key hold down.</para> + + <para>The OpenOn is implemented for different types of files/pages inside the <literal moreinfo="none"><action></literal> tag: .xsd, .xml, etc.</para> + + <figure float="0"> + <title>OpenOn for smooks configuration file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It is also available for classes:</para> + + <figure float="0"> + <title>OpenOn for classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/openOn1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="FullControlOverSourceFiles-SynchronizedSourcAndVisualEditing"> + + <title>Synchronized Source and Visual Editing</title> + + <para>ESB file can be edited in either source or extra visual modes at the same time.</para> + + <para>JBoss Tools provide you two different editors to speed your development: a + graphical view (<property moreinfo="none">Tree</property>) and source (<property moreinfo="none">Source</property>). + At the same time, you always have full control over esb source file. Any changes you + make in the source view will immediately appear in the tree view. Both views are + synchronized, you can edit the file in any view.</para> + + <figure float="0"> + <title>Two Views are Synchronized</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/esb_editor/10_esb_features.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this reference supplies you with all necessary information on the + functionality that JBoss ESB Editor provides for work with JBoss ESB.</para> + + <para>We hope, this guide helped you to get started with the JBoss ESB Tools. + Besides, for additional information you are welcome on + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + + </section> + </section> +</chapter> + + +</book> Modified: trunk/esb/docs/esb_ref_guide/pom.xml =================================================================== --- trunk/esb/docs/esb_ref_guide/pom.xml 2010-03-04 00:00:50 UTC (rev 20631) +++ trunk/esb/docs/esb_ref_guide/pom.xml 2010-03-04 00:31:28 UTC (rev 20632) @@ -86,9 +86,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: trunk/esb/docs/esb_ref_guide/publican.cfg =================================================================== --- trunk/esb/docs/esb_ref_guide/publican.cfg (rev 0) +++ trunk/esb/docs/esb_ref_guide/publican.cfg 2010-03-04 00:31:28 UTC (rev 20632) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20631 - in trunk/drools/docs/reference: en-US and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-03 19:00:50 -0500 (Wed, 03 Mar 2010) New Revision: 20631 Added: trunk/drools/docs/reference/en-US/ trunk/drools/docs/reference/en-US/Author_Group.xml trunk/drools/docs/reference/en-US/Book_Info.xml trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml trunk/drools/docs/reference/en-US/Preface.xml trunk/drools/docs/reference/en-US/Revision_History.xml trunk/drools/docs/reference/en-US/create_new.xml trunk/drools/docs/reference/en-US/create_new_project.xml trunk/drools/docs/reference/en-US/debugging_rules.xml trunk/drools/docs/reference/en-US/editors.xml trunk/drools/docs/reference/en-US/images/ trunk/drools/docs/reference/en-US/images/create_new_project/ trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png trunk/drools/docs/reference/en-US/images/debugging_rules/ trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png trunk/drools/docs/reference/en-US/images/editors/ trunk/drools/docs/reference/en-US/images/editors/editors1.png trunk/drools/docs/reference/en-US/images/editors/editors1a.png trunk/drools/docs/reference/en-US/images/editors/editors1b.png trunk/drools/docs/reference/en-US/images/editors/editors1c.png trunk/drools/docs/reference/en-US/images/editors/editors1d.png trunk/drools/docs/reference/en-US/images/editors/editors1e.png trunk/drools/docs/reference/en-US/images/editors/editors1f.png trunk/drools/docs/reference/en-US/images/editors/editors1g.png trunk/drools/docs/reference/en-US/images/editors/editors2.png trunk/drools/docs/reference/en-US/images/editors/editors3.png trunk/drools/docs/reference/en-US/images/editors/editors4.png trunk/drools/docs/reference/en-US/images/editors/editors5.png trunk/drools/docs/reference/en-US/images/editors/editors6.png trunk/drools/docs/reference/en-US/images/editors/editors7.png trunk/drools/docs/reference/en-US/images/editors/editors8.png trunk/drools/docs/reference/en-US/images/editors/editors9.png trunk/drools/docs/reference/en-US/images/editors/icon1.png trunk/drools/docs/reference/en-US/images/editors/icon2.png trunk/drools/docs/reference/en-US/images/editors/icon3.png trunk/drools/docs/reference/en-US/images/editors/icon4.png trunk/drools/docs/reference/en-US/images/editors/icon5.png trunk/drools/docs/reference/en-US/images/editors/icon6.png trunk/drools/docs/reference/en-US/images/editors/icon7.png trunk/drools/docs/reference/en-US/images/editors/icon8.png trunk/drools/docs/reference/en-US/images/editors/icon9.png trunk/drools/docs/reference/en-US/images/jbosstools_logo.png trunk/drools/docs/reference/en-US/images/views/ trunk/drools/docs/reference/en-US/images/views/views1.png trunk/drools/docs/reference/en-US/introduction.xml trunk/drools/docs/reference/en-US/master.xml trunk/drools/docs/reference/en-US/master_output.xml trunk/drools/docs/reference/en-US/views.xml trunk/drools/docs/reference/publican.cfg Removed: trunk/drools/docs/reference/en/ Modified: trunk/drools/docs/reference/pom.xml Log: changed format for building with publican and maven Added: trunk/drools/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/drools/docs/reference/en-US/Author_Group.xml (rev 0) +++ trunk/drools/docs/reference/en-US/Author_Group.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -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>Olga</firstname><surname>Chikvina</surname></author></authorgroup> Added: trunk/drools/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/drools/docs/reference/en-US/Book_Info.xml (rev 0) +++ trunk/drools/docs/reference/en-US/Book_Info.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -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>Drools Tools Reference Guide</title><subtitle>Provides information relating to the Drools Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Drools Tools Reference Guide explains how to use the Drools Tools for creating, executing and debugging Drools processes and rules.</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><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent =================================================================== --- trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent (rev 0) +++ trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Drools_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml =================================================================== --- trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml (rev 0) +++ trunk/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,14 @@ +<?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="create_new_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="debugging_rules.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="editors.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: trunk/drools/docs/reference/en-US/Preface.xml =================================================================== --- trunk/drools/docs/reference/en-US/Preface.xml (rev 0) +++ trunk/drools/docs/reference/en-US/Preface.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -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><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:include></xi:fallback></xi:include></preface> Added: trunk/drools/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/drools/docs/reference/en-US/Revision_History.xml (rev 0) +++ trunk/drools/docs/reference/en-US/Revision_History.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -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(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/drools/docs/reference/en-US/create_new.xml =================================================================== --- trunk/drools/docs/reference/en-US/create_new.xml (rev 0) +++ trunk/drools/docs/reference/en-US/create_new.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,70 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new" xreflabel="create_new"> + + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Drools Perspective</title> + + <section id="creating_dsl"> + <title>Creating a New DSL</title> + + <para>Domain Specific Languages (DSL) allows to read your rules like natural + language.</para> + + <para>There is a wizard for creating a sample DSL file which is called from <emphasis> + <property>File > New > Domain Specific Language</property> + </emphasis> or using the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Calling New DSL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page select the parent folder and give a proper name to your <emphasis> + <property>.dsl</property> + </emphasis> file. Then hit <emphasis> + <property>Finish</property> + </emphasis> to create a file and open it in the <link linkend="dsl_editor">DSL + editor</link>.</para> + + <figure> + <title>New DSL Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="creating_decision_table"> + <title>Creating a New Decision Table</title> + <para/> + </section> + + <section id="creating_business_rule"> + <title>Creating a New Business Rule</title> + + <para>To create a rule this way, use the wizard menu. It will create an instance of a <emphasis> + <property>.brl</property> + </emphasis> file and open it in the <link linkend="guided_editor">Guided editor</link>. + The <property>Guided editor</property> works based on a <emphasis> + <property>.package</property> + </emphasis> file in the same directory as the <emphasis> + <property>.brl</property> + </emphasis> file. In this <emphasis> + <property>.package</property> + </emphasis> file you have the package name and import statements, just like you would in + the top of a normal DRL file. So the first time you create a brl rule, you will need to + populate the package file with the fact classes you are interested in.</para> + </section> +</chapter> \ No newline at end of file Added: trunk/drools/docs/reference/en-US/create_new_project.xml =================================================================== --- trunk/drools/docs/reference/en-US/create_new_project.xml (rev 0) +++ trunk/drools/docs/reference/en-US/create_new_project.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,216 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="create_new_project" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property>Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property>File > New > Drools Project</property>. </emphasis> This will open + <property>New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property>Next</property>.</emphasis></para> + + <figure> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let's select first two check + boxes and press <emphasis> + <property>Next</property>. </emphasis></para> + + <figure> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you + should do this now by clicking the <emphasis> + <property>Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You should see the <property>Preferences window</property> where you can configure the + workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> + <property>Add</property> + </emphasis> button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Let's simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property>Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property>OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property>OK</property>.</emphasis></para> + + <figure> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property>Finish</property> + </emphasis> to complete the project creation.</para> + + <figure> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let's look at the structure of the organized project. In the + <property>Package Explorer</property> you should see the following:</para> + + <figure> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property>Sample.drl</property> + </emphasis> in the <emphasis> + <property>src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property>DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property>src/main/java</property> + </emphasis>, in the <emphasis> + <property>com.sample</property> + </emphasis> package. All the others jar's that are necessary during execution + are also added to the classpath in a custom classpath container called <property>Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule resource to the project.</para> + + <para>You can either create an empty text <emphasis> + <property>.drl</property> + </emphasis> file or make use of the special <property>New Rule Resource + wizard</property> to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property>File > New > Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure> + <title>Opening the New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property>/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it's mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure> + <title>New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> Added: trunk/drools/docs/reference/en-US/debugging_rules.xml =================================================================== --- trunk/drools/docs/reference/en-US/debugging_rules.xml (rev 0) +++ trunk/drools/docs/reference/en-US/debugging_rules.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,137 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="debugging_rules" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we'll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possible then inspect the + variables known at that point and use any of the default debugging actions to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be used.</para> + + <para>You can add/remove rule breakpoints in <emphasis> + <property>.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property>Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property>Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Debug perspective</property> contains a <property>Breakpoints + view</property> which can be used to see all defined breakpoints, get their + properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> + <property>Window > Perspective > Others > Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property>Debug As > Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property>Debug As > Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property>Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property>New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This will + create a new configuration and already fill in some of the properties (like the + Project and Main class) based on main class you selected in the beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property>Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <para>After enabling the debugging, the application starts executing and will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the + corresponding <emphasis> + <property>.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the default Java + debug actions to decide what to do next (resume, terminate, step over, etc.). The debug + views can also be used to determine the contents of the working memory and agenda at + that time as well (you don't have to select a working memory now, the current executing + working memory is automatically shown).</para> + + + </section> +</chapter> Added: trunk/drools/docs/reference/en-US/editors.xml =================================================================== --- trunk/drools/docs/reference/en-US/editors.xml (rev 0) +++ trunk/drools/docs/reference/en-US/editors.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,537 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="editors" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>A domain-specific language is a set of custom rules, + that is created specifically to solve problems in a particular domain + and is not intended to be able to solve problems outside it. + A DSL's configuration is stored in plain text. + </para> + <para>In Drools this configuration is presented by <property>.dsl</property> + files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property>.dsl</property> files:</para> + <figure> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + By clicking on some row's header you can sort the lines in the table according to the clicked row. + By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings.To do this select from the drop down lins the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. + Once you have set up a Drools project,you can start adding ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> + <figure> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"/> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on the Select option in the palette and + then on the element in your ruleflow allows you to + view and set the properties of that element in the properies view.</para> + <figure> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easly navigate between parts of a schema. </para> + <figure> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"/> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="1*"/> + <colspec colnum="3" align="left" colwidth="3*"/> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property>Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property>Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"/> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property>End Events</property>. + The <property>End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property>RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property>Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property>Gateway[diverge]</property>node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property>Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"/> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property>Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property>Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property>Rule editor</property> works on files that have a <emphasis> + <property>.drl</property> + </emphasis> (or <emphasis> + <property>.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + +  + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property>Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property>Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property>Message</property> + </emphasis> suggests all available fields.</para> + + <figure> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property>Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + +  + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property>Rule editor</property> works in synchronization with the + <property>Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The view is updated on save. It provides a quick way of navigating around rules by + names in a file which may have hundreds of rules. The items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property>Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property>.drl</property> + </emphasis> file. Just click on the <emphasis> + <property>Rete Tree tab</property> + </emphasis> at the bottom of the <property>Rule editor</property>.</para> + + <figure> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The <property>Rete Tree view</property> works only in Drools Rule Projects, + where the Drools Builder is set in the project properties.</para> + </note> + <para>We hope, this guide helped you to get started with the JBoss BPMN Convert module. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> + + </section> + +</chapter> Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1a.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1b.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1c.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1d.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1e.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1e.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1f.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1f.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors1g.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors1g.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors4.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors5.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors6.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors7.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors8.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/editors9.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/editors9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon4.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon5.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon6.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon7.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon8.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/editors/icon9.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/editors/icon9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/images/views/views1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/reference/en-US/images/views/views1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/reference/en-US/introduction.xml =================================================================== --- trunk/drools/docs/reference/en-US/introduction.xml (rev 0) +++ trunk/drools/docs/reference/en-US/introduction.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,171 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction" xreflabel="introduction"> + <title>Introduction</title> + + <section id="whatisDrools"> + <title>What is Drools?</title> + + <para><property>Drools</property> is a business rule management system (BRMS) with a forward + chaining inference based rules engine, more correctly known as a production rule system, + using an enhanced implementation of the Rete algorithm.</para> + + <para> In this guide we are going to get you familiar with Drools Eclipse plugin which + provides development tools for creating, executing and debugging Drools processes and + rules from within Eclipse.</para> + + <note> + <title>Note:</title> + <para>It is assumed that you has some familiarity with rule engines and Drools in + particular. If no, we suggest that you look carefully through the <ulink + url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_single/index.html" + >Drools Documentation</ulink>.</para> + </note> + + <para><property>Drools Tools</property> come bundled with <property>JBoss Tools</property> + set of Eclipse plugins. How to install <property>JBoss Tools</property> you can find in + the Getting Started Guide.</para> + </section> + + <section id="drools_key_features"> + <title>Drools Tools Key Features</title> + + <para>The following table lists all valuable features of the <property>Drools + Tools</property>.</para> + <table> + <title>Key Functionality of Drools Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Wizard for creating a new Drools Project</para> + </entry> + <entry> + <para>The wizard allows to create a sample project to easy get started + with Drools</para> + </entry> + <entry> + <link linkend="sample_drools_project">Creating a Sample Drools + Project</link> + </entry> + </row> + + <row> + <entry> + <para>Wizards for creation new Drools resources</para> + </entry> + <entry> + <para>A set of wizards are provided with the Drools Eclipse tools to + quickly create a new Rule resource, a new Domain Specific language, + Decision Table and Business rule</para> + </entry> + <entry> + <link linkend="creating_rule">Creating a New Rule</link> +  + </entry> + </row> + + <row> + <entry> + <para>The Rule editor</para> + </entry> + <entry> + <para>An editor that is aware of DRL syntax and provides content + assistance and synchronizing with the Outline view</para> + </entry> + <entry> + <link linkend="textual_rule_editor">The Rule Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Domain Specific Language editor</para> + </entry> + <entry> + <para>The editor allows to create and manage mappings from users + language to the rule language</para> + </entry> + <entry> + <link linkend="dsl_editor">The Domain Specific Language Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Guided editor</para> + </entry> + <entry> + <para>This guided editor for rules allows you to build rules in a GUI + driven fashion based on your object model</para> + </entry> + <entry> +  + </entry> + </row> + + <row> + <entry> + <para>The Rule Flow graphical editor</para> + </entry> + <entry> + <para>The editor is meant for editing visual graphs which represent a + process (a rule flow)</para> + </entry> + <entry> + <link linkend="ruleflow_editor">The Rule Flow Graphical Editor</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para>All <property>JBoss Tools/JBDS</property> documentation you can find on the + <ulink url="http://docs.jboss.org/tools/">documentation release + page</ulink>.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> Added: trunk/drools/docs/reference/en-US/master.xml =================================================================== --- trunk/drools/docs/reference/en-US/master.xml (rev 0) +++ trunk/drools/docs/reference/en-US/master.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,69 @@ +<?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 create_new_project SYSTEM "create_new_project.xml"> +<!ENTITY create_new SYSTEM "create_new.xml"> +<!ENTITY debugging_rules SYSTEM "debugging_rules.xml"> +<!ENTITY views SYSTEM "views.xml"> +<!ENTITY editors SYSTEM "editors.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>Drools 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> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc/> + &introduction; + &create_new_project; + &debugging_rules; + &editors; + + +</book> Added: trunk/drools/docs/reference/en-US/master_output.xml =================================================================== --- trunk/drools/docs/reference/en-US/master_output.xml (rev 0) +++ trunk/drools/docs/reference/en-US/master_output.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,1127 @@ +<?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 create_new_project SYSTEM "modules/create_new_project.xml"> +<!ENTITY create_new SYSTEM "modules/create_new.xml"> +<!ENTITY debugging_rules SYSTEM "modules/debugging_rules.xml"> +<!ENTITY views SYSTEM "modules/views.xml"> +<!ENTITY editors SYSTEM "modules/editors.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>Drools 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> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/as/pdf/AS_Reference_...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + + <toc></toc> + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/introduction.xml" xreflabel="introduction"> + <title>Introduction</title> + + <section id="whatisDrools"> + <title>What is Drools?</title> + + <para><property moreinfo="none">Drools</property> is a business rule management system (BRMS) with a forward + chaining inference based rules engine, more correctly known as a production rule system, + using an enhanced implementation of the Rete algorithm.</para> + + <para> In this guide we are going to get you familiar with Drools Eclipse plugin which + provides development tools for creating, executing and debugging Drools processes and + rules from within Eclipse.</para> + + <note> + <title>Note:</title> + <para>It is assumed that you has some familiarity with rule engines and Drools in + particular. If no, we suggest that you look carefully through the <ulink url="http://downloads.jboss.com/drools/docs/4.0.7.19894.GA/html_single/index.html">Drools Documentation</ulink>.</para> + </note> + + <para><property moreinfo="none">Drools Tools</property> come bundled with <property moreinfo="none">JBoss Tools</property> + set of Eclipse plugins. How to install <property moreinfo="none">JBoss Tools</property> you can find in + the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">Getting Started Guide</ulink>.</para> + </section> + + <section id="drools_key_features"> + <title>Drools Tools Key Features</title> + + <para>The following table lists all valuable features of the <property moreinfo="none">Drools + Tools</property>.</para> + <table> + <title>Key Functionality of Drools Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Wizard for creating a new Drools Project</para> + </entry> + <entry> + <para>The wizard allows to create a sample project to easy get started + with Drools</para> + </entry> + <entry> + <link linkend="sample_drools_project">Creating a Sample Drools + Project</link> + </entry> + </row> + + <row> + <entry> + <para>Wizards for creation new Drools resources</para> + </entry> + <entry> + <para>A set of wizards are provided with the Drools Eclipse tools to + quickly create a new Rule resource, a new Domain Specific language, + Decision Table and Business rule</para> + </entry> + <entry> + <link linkend="creating_rule">Creating a New Rule</link> +  + </entry> + </row> + + <row> + <entry> + <para>The Rule editor</para> + </entry> + <entry> + <para>An editor that is aware of DRL syntax and provides content + assistance and synchronizing with the Outline view</para> + </entry> + <entry> + <link linkend="textual_rule_editor">The Rule Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Domain Specific Language editor</para> + </entry> + <entry> + <para>The editor allows to create and manage mappings from users + language to the rule language</para> + </entry> + <entry> + <link linkend="dsl_editor">The Domain Specific Language Editor</link> + </entry> + </row> + + <row> + <entry> + <para>The Guided editor</para> + </entry> + <entry> + <para>This guided editor for rules allows you to build rules in a GUI + driven fashion based on your object model</para> + </entry> + <entry> +  + </entry> + </row> + + <row> + <entry> + <para>The Rule Flow graphical editor</para> + </entry> + <entry> + <para>The editor is meant for editing visual graphs which represent a + process (a rule flow)</para> + </entry> + <entry> + <link linkend="ruleflow_editor">The Rule Flow Graphical Editor</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para>All <property moreinfo="none">JBoss Tools/JBDS</property> documentation you can find on the + <ulink url="http://docs.jboss.org/tools/">documentation release + page</ulink>.</para> + </listitem> + </itemizedlist> + + </section> +</chapter> + + +<chapter id="create_new_project" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/create_new_project.xml" xreflabel="create_new_project"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a New Drools Project</title> + + <para>In this chapter we are going to show you how to setup an executable sample Drools project + to start using rules immediately.</para> + + + + <section id="sample_drools_project"> + <title>Creating a Sample Drools Project</title> + + <para>First, we suggest that you use <property moreinfo="none">Drools perspective</property> which is aimed + at work with Drools specific resources.</para> + + <para>To create a new Drools project follow to <emphasis> + <property moreinfo="none">File > New > Drools Project</property>. </emphasis> This will open + <property moreinfo="none">New Drools Project wizard</property> like on the figure below.</para> + + <para>On the first page type the project name and click + <emphasis><property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>Creating a New Drools Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next you have a choice to add some default artifacts to it like sample rules, decision + tables or ruleflows and Java classes for them. Let's select first two check + boxes and press <emphasis> + <property moreinfo="none">Next</property>. </emphasis></para> + + <figure float="0"> + <title>Selecting Drools Project Elements</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next page asks you to specify a Drools runtime. If you have not yet set it up, you + should do this now by clicking the <emphasis> + <property moreinfo="none">Configure Workspace Settings</property> + </emphasis> link.</para> + + <figure float="0"> + <title>Configuring Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You should see the <property moreinfo="none">Preferences window</property> where you can configure the + workspace settings for Drools runtimes. To create a new runtime, press the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button. The appeared dialog prompts you to enter a + name for a new runtime and a path to the Drools runtime on your file system.</para> + + <note> + <title>Note:</title> + <para>A Drools runtime is a collection of jars on your file system that represent one + specific release of the Drools project jars. While creating a new runtime, you must + either point to the release of your choice, or you can simply create a new runtime + on your file system from the jars included in the Drools Eclipse plugin.</para> + </note> + + <figure float="0"> + <title>Adding a New Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Let's simply create a new Drools 5 runtime from the jars embedded in the + Drools Eclipse plugin. Thus, you should press <emphasis> + <property moreinfo="none">Create a new Drools 5 runtime</property> + </emphasis> button and select the folder where you want this runtime to be created and + hit <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + + <para>You will see the newly created runtime show up in your list of Drools runtimes. Check + it and press <emphasis> + <property moreinfo="none">OK</property>.</emphasis></para> + + <figure float="0"> + <title>Selecting a Drools Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to complete the project creation.</para> + + <figure float="0"> + <title>Completing the Drools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This will setup a basic structure, classpath and sample rules and test case to get you + started.</para> + </section> + + + <section id="structure_overview"> + <title>Drools Project Structure Overview</title> + + <para>Now let's look at the structure of the organized project. In the + <property moreinfo="none">Package Explorer</property> you should see the following:</para> + + <figure float="0"> + <title>Drools Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The newly created project contains an example rule file <emphasis> + <property moreinfo="none">Sample.drl</property> + </emphasis> in the <emphasis> + <property moreinfo="none">src/main/rules</property> + </emphasis> directory and an example java file <emphasis> + <property moreinfo="none">DroolsTest.java</property> + </emphasis> that can be used to execute the rules in a Drools engine in the folder <emphasis> + <property moreinfo="none">src/main/java</property> + </emphasis>, in the <emphasis> + <property moreinfo="none">com.sample</property> + </emphasis> package. All the others jar's that are necessary during execution + are also added to the classpath in a custom classpath container called <property moreinfo="none">Drools + Library</property>.</para> + + <tip> + <title>Tip:</title> + <para>Rules do not have to be kept in Java projects at all, this is just a convenience + for people who are already using eclipse as their Java IDE.</para> + </tip> + + </section> + + <section id="creating_rule"> + <title>Creating a New Rule</title> + + <para>Now we are going to add a new Rule resource to the project.</para> + + <para>You can either create an empty text <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> file or make use of the special <property moreinfo="none">New Rule Resource + wizard</property> to do it.</para> + + <para>To open the wizard follow to <emphasis> + <property moreinfo="none">File > New > Rule Resource</property> + </emphasis> or use the menu with the JBoss Drools icon on the toolbar.</para> + + <figure float="0"> + <title>Opening the New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the wizard page first select <emphasis> + <property moreinfo="none">/rules</property> + </emphasis> as a top level directory to store your rules and type the rule name. Next + it's mandatory to specify the rule package name. It defines a namespace that + groups rules together.</para> + + <figure float="0"> + <title>New Rule Resource Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As a result the wizard generates a rule skeleton to get you started.</para> + + <figure float="0"> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/create_new_project/create_new_project10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + +</chapter> + + +<chapter id="debugging_rules" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/debugging_rules.xml" xreflabel="debugging_rules"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Debugging rules</title> + + <para>This chapter describes how to debug rules during the execution of your Drools application.</para> + + <section id="creating_breakpoints"> + <title>Creating Breakpoints</title> + + <para>At first, we'll focus on how to add + breakpoints in the consequences of your rules.</para> + + <para>Whenever such a breakpoint is uncounted + during the execution of the rules, the execution is halted. It's possible then inspect the + variables known at that point and use any of the default debugging actions to decide what + should happen next (step over, continue, etc). To inspect + the content of the working memory and agenda the Debug views can be used.</para> + + <para>You can add/remove rule breakpoints in <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> files in two ways, similar to adding breakpoints to Java files:</para> + + <itemizedlist> + <listitem> + <para>Double-click the ruler in the <property moreinfo="none">Rule editor</property> at the line + where you want to add a breakpoint.</para> + <tip> + <title>Tip:</title> + <para>Note that rule breakpoints can only be created in the consequence of a + rule. Double-clicking on a line where no breakpoint is allowed will do + nothing.</para> + </tip> + <para>A breakpoint can be removed by double-clicking the ruler once more. </para> + </listitem> + + <listitem> + <para>Right-click the ruler. Select <emphasis> + <property moreinfo="none">Toggle Breakpoint</property> + </emphasis> action in the appeared popup menu. Clicking the action will add a + breakpoint at the selected line or remove it if there is one already.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding Breakpoints</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Debug perspective</property> contains a <property moreinfo="none">Breakpoints + view</property> which can be used to see all defined breakpoints, get their + properties, enable/disable or remove them, etc. You can switch to it by navigating to <emphasis> + <property moreinfo="none">Window > Perspective > Others > Debug</property>.</emphasis></para> + </section> + + <section id="debugging"> + <title>Debugging</title> + + <para>Drools breakpoints are only enabled if you debug your application as a Drools + Application. To do this you should perform one of the actions:</para> + + <itemizedlist> + <listitem> + <para>Select the main class of your application. Right click it and select <emphasis> + <property moreinfo="none">Debug As > Drools Application</property>.</emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Debugging Drools Application</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Alternatively, you can also go to <emphasis> + <property moreinfo="none">Debug As > Debug Configuration</property> + </emphasis> to open a new dialog for creating, managing and running debug + configurations.</para> + + <para>Select the <emphasis> + <property moreinfo="none">Drools Application</property> + </emphasis> item in the left tree and click the <emphasis> + <property moreinfo="none">New launch configuration</property> + </emphasis> button (leftmost icon in the toolbar above the tree). This will + create a new configuration and already fill in some of the properties (like the + Project and Main class) based on main class you selected in the beginning. All + properties shown here are the same as any standard Java program.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>New Debug Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/debugging_rules/debugging_rules3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>Remember to change the name of your debug configuration to something meaningful.</para> + </tip> + + <para>Next + click the <emphasis> + <property moreinfo="none">Debug</property> + </emphasis> button on the bottom to start debugging your application. </para> + + <para>After enabling the debugging, the application starts executing and will halt if + any breakpoint is encountered. This can be a Drools rule breakpoint, or any other + standard Java breakpoint. Whenever a Drools rule breakpoint is encountered, the + corresponding <emphasis> + <property moreinfo="none">.drl</property></emphasis> file is opened and the active line is highlighted. The Variables view + also contains all rule parameters and their value. You can then use the default Java + debug actions to decide what to do next (resume, terminate, step over, etc.). The debug + views can also be used to determine the contents of the working memory and agenda at + that time as well (you don't have to select a working memory now, the current executing + working memory is automatically shown).</para> + + + </section> +</chapter> + + +<chapter id="editors" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/reference/en/modules/editors.xml" xreflabel="editors"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Editors</title> + <section id="dsl_editor"> + <title>DSL Editor</title> + <para>A domain-specific language is a set of custom rules, + that is created specifically to solve problems in a particular domain + and is not intended to be able to solve problems outside it. + A DSL's configuration is stored in plain text. + </para> + <para>In Drools this configuration is presented by <property moreinfo="none">.dsl</property> + files that can be created by <emphasis>right click on the project->New->Other->Drools->Domain Specific Language</emphasis>.</para> + <para>DSL Editor is a default editor for <property moreinfo="none">.dsl</property> files:</para> + <figure float="0"> + <title>DSL Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In the table below all the components of the DSL Editor page are described:</para> + <table> + <title>DSL Editor Components.</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Components</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>Description</entry> + <entry>User's comments on a certain language message mapping</entry> + </row> + <row> + <entry>Table of language message mappings</entry> + <entry>The table is divided into 4 rows: + <itemizedlist id="rows"> + <listitem><para><emphasis>Language Expression</emphasis> :expression you want to use as a rule</para></listitem> + <listitem><para><emphasis>Rule Language Mapping</emphasis> :the implementation of the rules.This means that to this language expression the rule will be compiled + by the rule engine compiler.</para></listitem> + <listitem><para><emphasis>Object</emphasis> :name of the object</para></listitem> + <listitem><para><emphasis>Scope</emphasis> :indicates where the expression is + targeted: is it for the "condition" part of the rule ,"consequence" part, etc.</para></listitem> + </itemizedlist> + By clicking on some row's header you can sort the lines in the table according to the clicked row. + By double clicking on the line <link linkend="edit_wizard">Edit language mapping Wizard</link> will be open. + </entry> + </row> + <row> + <entry>Expression</entry> + <entry>Shows the language expression of the selected table line(language message mapping).</entry> + </row> + + <row> + <entry>Mapping</entry> + <entry>Shows the rule of language mapping for the selected table line(language message mapping).</entry> + </row> + <row> + <entry>Object</entry> + <entry>Shows the object for the selected table line(language message mapping)</entry> + </row> + + <row> + <entry id="sort">Sort By</entry> + <entry>Using this option you can change the type of lines sorting + in the table of language message mappings.To do this select from the drop down lins the method + of sorting you want and click <emphasis>Sort</emphasis> button.</entry> + </row> + <row> + <entry>Buttons</entry> + <entry><itemizedlist> + <listitem><para><emphasis>Edit</emphasis> :by clicking the button users can edit + selected in the table of language message mappings lines.For more information look + <link linkend="edit_wizard">Edit language mapping Wizard</link>section.</para></listitem> + <listitem><para><emphasis>Remove</emphasis> :if you click the button the selected mapping line will be deleted. </para></listitem> + <listitem><para><emphasis>Add</emphasis> :with this button you can add new mapping lines to the table.For more information look + <link linkend="add_wizard">Add language mapping Wizard</link>section. </para></listitem> + <listitem><para><emphasis>Sort</emphasis> : please, for more information go <link linkend="sort">here</link></para></listitem> + <listitem><para><emphasis>Copy</emphasis> :with this button you can add new mapping lines to the table + in which all the information will be copied from the selected mapping line.</para></listitem> + </itemizedlist> + </entry> + </row> + </tbody> + </tgroup> + </table> + <section id="edit_wizard"> + <title>Edit language mapping Wizard</title> + <para>This wizard can be opened by double clicking some line + in the table of language message mappings or by clicking the <emphasis>Edit</emphasis>button.</para> + <para>On the picture below you can see all the options,Edit language mapping Wizard allow to change.</para> + <para>Their names as well as the meaning of the options are correspond to the <link linkend="rows">rows</link> of the table.</para> + <figure float="0"> + <title>Edit language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To change the mapping a user should edit the otions he want and finally click <emphasis>Ok</emphasis>.</para> + </section> + <section id="add_wizard"> + <title>Add language mapping Wizard</title> + <para>This wizard is equal to <link linkend="edit_wizard">Edit language mapping Wizard</link>. + It can be opened by clicking the <emphasis>Add</emphasis> button. + </para> + <para>The only difference is that instead of editing the information you should enter new one.</para> + <figure float="0"> + <title>Add language mapping Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="ruleflow_editor"> + <title>Flow Editor</title> + <para>Drools tools also provide some functionality to define the order in + which rules should be executed.Ruleflow file allows you to specify + the order in which rule sets should be evaluated using a flow chart. + So you can define which rule sets should be evaluated in sequence or in parallel as well as + specify conditions under which rule sets should be evaluated.</para> + <para>Ruleflows can be set only by using the graphical flow editor which is part of the Drools plugin for Eclipse. + Once you have set up a Drools project,you can start adding ruleflows. + Add a ruleflow file(.rf) by clicking on the project and selecting "<emphasis>New -> Other...->Flow File</emphasis>":</para> + <figure float="0"> + <title>RuleFlow file creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1f.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>By default these ruleflow files (.rf) are opened in the graphical Flow editor. + You can see it on the picture below.</para> + <figure float="0"> + <title>Flow Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1g.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The Flow editor consists of a <emphasis>palette</emphasis>, a <emphasis>canvas</emphasis> + and an <emphasis>outline</emphasis> view. To add new elements to the canvas, select the + element you would like to create in the palette and then add it to the canvas by clicking on the preferred location. + </para> + <figure float="0"> + <title>Adding an element to the canvas</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1e.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on the Select option in the palette and + then on the element in your ruleflow allows you to + view and set the properties of that element in the properies view.</para> + <figure float="0"> + <title>Properties view</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Outline View is useful for big complex schemata where not all nodes are seen at one time. + So using your Outline view you can easly navigate between parts of a schema. </para> + <figure float="0"> + <title>Outline view usage</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <section> + <title>Different types of control elements in Flow Palette</title> + <para>Flow editor supports three types of control elements. + They are:</para> + <table> <title>Flow Palette Components.Part 1</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="1*"></colspec> + <colspec align="left" colnum="3" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon7.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Select</entry> + <entry>Select a node on the canvas</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon8.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Marquee</entry> + <entry>Is used for selecting a group of elements</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon9.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Sequence Flow</entry> + <entry>Use this element to join two elements on the canvas</entry> + </row> + </tbody> + + </tgroup> + </table> + </section> + + <section> + <title>Different types of nodes in Flow Palette</title> + + <para>Currently, ruleflow supports seven types of nodes. + In the table below you can find information about them:</para> + <table> <title>Flow Palette Components.Part 2.</title> + <tgroup cols="3"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec align="left" colnum="2" colwidth="1*"></colspec> + <colspec align="left" colnum="3" colwidth="3*"></colspec> + + <thead> + <row> + <entry>Component Picture</entry> + <entry>Component Name</entry> + <entry>Description</entry> + </row> + + </thead> + <tbody> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon1.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Start Event</entry> + <entry>The start of the ruleflow. A ruleflow should have exactly + one start node. The <property moreinfo="none">Start Event</property> can not have incoming + connections and should have one outgoing connection. Whenever the ruleflow process is started, + the executing is started here and is automatically proceeded to the first node + linked to this <property moreinfo="none">Start Event</property></entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon2.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>End Event</entry> + <entry>A ruleflow file can have one or more <property moreinfo="none">End Events</property>. + The <property moreinfo="none">End Event</property> node should have one incoming connection + and can not have outgoing connections. When an end node is reached in the ruleflow, + the ruleflow is terminated (including other remaining active nodes when parallelism + is used).</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon3.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Rule Task</entry> + <entry>represents a set of rules. A <emphasis>Rule Task</emphasis> node should have one + incoming connection and one outgoing connection. + The <property moreinfo="none">RuleFlowGroup</property> property which is used to specify the name of the + ruleflow-group that represents the set of rules of this <emphasis>Rule Task</emphasis> node. + When a <emphasis>Rule Task</emphasis> node is reached in the ruleflow, the engine will start + executing rules that are a part of the corresponding ruleflow-group. + Execution automatically continues to the next node when there are no + more active rules in this ruleflow-group. + </entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[diverge]</entry> + <entry>allows you to create branches in your ruleflow. + A <property moreinfo="none">Gateway[diverge]</property> node should have one incoming connection and two or more + outgoing connections.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon4.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Gateway[converge]</entry> + <entry>allows you to synchronize multiple branches. + A <property moreinfo="none">Gateway[diverge]</property>node should have two or more incoming connections and one + outgoing connection.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon5.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Reusable Sup-Process</entry> + <entry>represents the invocation of another ruleflow from this ruleflow. + A subflow node should have one incoming connection and one outgoing connection. + It contains the property "processId" which specifies the id of the process that should be executed. + When a <property moreinfo="none">Reusable Sup-Process</property> node is reached in the ruleflow, the engine will start the process with the given id. + The subflow node will only continue if that subflow process has terminated its execution. + Note that the subflow process is started as an independent process, + which means that the subflow process will not be terminated if this process reaches an end node.</entry> + </row> + <row> + <entry><inlinemediaobject> + <imageobject> + <imagedata fileref="images/editors/icon6.png"></imagedata> + </imageobject></inlinemediaobject></entry> + <entry>Script Task</entry> + <entry>represents an action that should be executed in this ruleflow. + An <property moreinfo="none">Script Task</property> node should have one incoming connection and one outgoing + connection. It contains the property "action" which specifies the action that should be executed. + When a <property moreinfo="none">Script Task</property> node is reached in the ruleflow, it will execute the action and + continue with the next node. An action should be specified as a piece of (valid) + MVEL code. </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + </section> + + <section id="textual_rule_editor"> + <title>The Rule Editor</title> + + <para>The <property moreinfo="none">Rule editor</property> works on files that have a <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> (or <emphasis> + <property moreinfo="none">.rule</property> + </emphasis> in the case of spreading rules across multiple rule files) extension.</para> + + <figure float="0"> + <title>New Rule</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The editor follows the pattern of a normal text editor in eclipse, with all the normal + features of a text editor:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="rules_editor_content_assist">Content Assist</link> + </para> + </listitem> + + <listitem> + <para> + <link linkend="rules_editor_code_folding">Code Folding</link> + </para> + </listitem> + +  + + <listitem> + <para> + <link linkend="rules_editor_sync_with_outline">Synchronization with Outline + View</link> + </para> + </listitem> + </itemizedlist> + + <section id="rules_editor_content_assist"> + <title>Content Assist</title> + + <para>While working in the <property moreinfo="none">Rule editor</property> you can get a content + assistance the usual way by pressing <emphasis> + <property moreinfo="none">Ctrl + Space</property>.</emphasis></para> + + <para>Content Assist shows all possible keywords for the current cursor position.</para> + + <figure float="0"> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Content Assist inside of the <emphasis> + <property moreinfo="none">Message</property> + </emphasis> suggests all available fields.</para> + + <figure float="0"> + <title>Content Assist Demonstration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="rules_editor_code_folding"> + <title>Code Folding</title> + + <para>Code folding is also available in the <property moreinfo="none">Rule editor</property>. To + hide/show sections of the file use the icons with minus/plus on the left vertical + line of the editor.</para> + + <figure float="0"> + <title>Code Folding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + +  + + <section id="rules_editor_sync_with_outline"> + <title>Synchronization with Outline View</title> + + <para>The <property moreinfo="none">Rule editor</property> works in synchronization with the + <property moreinfo="none">Outline view</property> which shows the structure of the rules, + imports in the file and also globals and functions if the file has them.</para> + + <figure float="0"> + <title>Synchronization with Outline View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The view is updated on save. It provides a quick way of navigating around rules by + names in a file which may have hundreds of rules. The items are sorted + alphabetically by default.</para> + </section> + + <section id="rete_view"> + <title>The Rete Tree View</title> + + <para>The <property moreinfo="none">Rete Tree view</property> shows you the current Rete Network for + your <emphasis> + <property moreinfo="none">.drl</property> + </emphasis> file. Just click on the <emphasis> + <property moreinfo="none">Rete Tree tab</property> + </emphasis> at the bottom of the <property moreinfo="none">Rule editor</property>.</para> + + <figure float="0"> + <title>Rete Tree</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Afterwards you can generate the current Rete Network visualization. You can push + and pull the nodes to arrange your optimal network overview.</para> + <para>If you got hundreds of nodes, select some of them with a frame. Then you can pull + groups of them.</para> + + <figure float="0"> + <title>Selecting the nodes in the Rete Tree with Frame</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can zoom in and out the Rete tree in case not all nodes are shown in the + current view. For this use the combo box or "+" and "-" icons on the toolbar.</para> + + <figure float="0"> + <title>Rete Tree Zooming</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/editors/editors8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>The <property moreinfo="none">Rete Tree view</property> works only in Drools Rule Projects, + where the Drools Builder is set in the project properties.</para> + </note> + <para>We hope, this guide helped you to get started with the JBoss BPMN + Convert module. Besides, for additional information you are welcome on + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> + + </section> + +</chapter> + + + +</book> Added: trunk/drools/docs/reference/en-US/views.xml =================================================================== --- trunk/drools/docs/reference/en-US/views.xml (rev 0) +++ trunk/drools/docs/reference/en-US/views.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,35 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="views" xreflabel="views"> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Drools Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Views</title> + + <section id="working_memory_view"> + <title>The Working Memory View</title> + </section> + + <section id="agenta_view"> + <title>The Agenda View</title> + </section> + + <section id="global_data_view"> + <title>The Global Data View</title> + </section> + + <section id="audit_view"> + <title>The Audit View</title> + </section> + + <section id="rules_view"> + <title>The Rules View</title> + </section> + + <section id="process_instance_view"> + <title>The Process Instance View</title> + </section> +</chapter> Modified: trunk/drools/docs/reference/pom.xml =================================================================== --- trunk/drools/docs/reference/pom.xml 2010-03-03 22:57:28 UTC (rev 20630) +++ trunk/drools/docs/reference/pom.xml 2010-03-04 00:00:50 UTC (rev 20631) @@ -95,9 +95,9 @@ <configuration> <sourceDocumentName>master.xml</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: trunk/drools/docs/reference/publican.cfg =================================================================== --- trunk/drools/docs/reference/publican.cfg (rev 0) +++ trunk/drools/docs/reference/publican.cfg 2010-03-04 00:00:50 UTC (rev 20631) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20630 - in trunk/documentation/guides: JBDS_Release_Notes and 1 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-03 17:57:28 -0500 (Wed, 03 Mar 2010) New Revision: 20630 Added: trunk/documentation/guides/JBDS_Release_Notes/ trunk/documentation/guides/JBDS_Release_Notes/en-US/ trunk/documentation/guides/JBDS_Release_Notes/en-US/Article_Info.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Author_Group.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Component_Versions.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Fixed_Issues.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Known_Issues.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/New_Features.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Overview.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.ent trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/Revision_History.xml trunk/documentation/guides/JBDS_Release_Notes/en-US/images/ trunk/documentation/guides/JBDS_Release_Notes/en-US/master.xml trunk/documentation/guides/JBDS_Release_Notes/pom.xml trunk/documentation/guides/JBDS_Release_Notes/publican.cfg Removed: trunk/documentation/guides/JBDS_3.0_Release_Notes/ Log: renamed release notes folder to exclude version number. Once the release has gone ahead these release notes will be moved into the JBDS 3.0 tag or branch and then this folder with house the release notes for the next JBDS release Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Article_Info.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Article_Info.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Article_Info.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,3 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<articleinfo><title>Release Notes</title><subtitle>Information about the changes made for this release of the JBoss Developer Studio.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>0</edition><pubsnumber>0</pubsnumber><abstract><para>These release notes contain important information related to the JBoss Developer Studio. New features, resources, and other current issues are addressed here.</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><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></articleinfo> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Author_Group.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Author_Group.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Author_Group.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author></authorgroup> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Component_Versions.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Component_Versions.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Component_Versions.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,29 @@ +<?xml version='1.0' encoding='utf-8' ?> +<section id="Component_Versions"> + <title>Component Versions</title> + <para> + This section details the versions of the components which create the JBoss Developer Studio that can be found in this release. + </para> + <itemizedlist> + <listitem> + <para> + Eclipse 3.5 (Galileo) + </para> + </listitem> + <listitem> + <para> + JBoss Tools 3.1.0 + </para> + </listitem> + <listitem> + <para> + JBoss Enterprise Application Platform 5.0 + </para> + </listitem> + </itemizedlist> + <note> + <para> + The Enterprise Application Platform Server has been redefined for the enterprise market to a level where direct association to a community release can no longer be drawn. + </para> + </note> +</section> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Fixed_Issues.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Fixed_Issues.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Fixed_Issues.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,975 @@ +<?xml version='1.0' encoding='utf-8' ?> +<section id="Issues-fixed-in-this-release"> + <title> + Issues fixed in this release + </title> + + <para> + Following is a list of issues fixed in this release: + </para> + <formalpara> + <title>Contexts and Dependency Injection (CDI)</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5770">JBIDE-5770</ulink>: The EL code completion icon has been updated to use the <application>JBoss Weld</application> icon. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5355">JBIDE-5355</ulink>: A Contexts and Dependency Injection Project Facet has been added to <application>JBoss Developer Studio</application>. This makes it possible to enable CDI support for a faceted project via the <guilabel>New Dynamic Web Project</guilabel> wizard or the <guilabel>Project Facets</guilabel> setting page available at <menuchoice><guimenuitem>Project</guimenuitem><guimenuitem>Properties</guimenuitem><guimenuitem>Project Facets</guimenuitem></menuchoice>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5276">JBIDE-5276</ulink>: The <guimenuitem>Add CDI Support</guimenuitem> and <guimenuitem>Remove CDI Support</guimenuitem> items have been added to the Project menu. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>ESB</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5653">JBIDE-5653</ulink>: The <guilabel>ESB Content Based Router </guilabel> dialog box has been modified so that the <guilabel>CBR Alias</guilabel> field is now mandatory, allowing the value of it to determine what other fields are available. The <guilabel>Rule Set</guilabel> field is now not required when a <guilabel>CBR Alias</guilabel> of Regex or XPath is provided, since with these alias the rules can be specified in-line and the <guilabel>Rule Language</guilabel> field is now set to apply only when the <guilabel>CBR Alias</guilabel> is Drools. The <guilabel>Rules Reload</guilabel> field will only apply when a <guilabel>Rule Set</guilabel> has been specified. + </para> + <para> + The table <guilabel>Route List</guilabel> found in the <guilabel>JBoss ESB Editor</guilabel> now lists the <emphasis>expression</emphasis> since this is a common undertaking by users. + </para> + <para> + In the <guilabel> Add Route To</guilabel> dialog box, the <guilabel>Service Category</guilabel> field has been made mandatory. Other changes to this dialog box include the <guilabel>Destination name</guilabel> only being required if the previous CBR action contained a <guilabel>Rule Set</guilabel> and if the CBR action did not contain a <guilabel>Rule Set</guilabel>, an <guilabel>Expression</guilabel> field is included. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5627">JBIDE-5627</ulink>: For this release of the <application>JBoss Developer Studio</application> variations of the <guilabel>Content Based Router</guilabel> menu have been added to the ESB editor for Drools, Drools XPath, Generic, XPath and Regex. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5548">JBIDE-5548</ulink>: In the ESB Configuration Editor, when selecting a JBR Listener, JBR Bus or JBR Provider, new functionality has been added to allow a user to configure the properties: <property>synchronous</property>, <property>serviceInvokerTimeout</property> and <property>asyncResponse</property> through the new child object <property>Config</property>. These new configurable properties allow a user increased control over the execution of the JBR components. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5547">JBIDE-5547</ulink>: In the ESB Configuration Editor, when selecting a FTP Listener in read-only mode new functionality has been added to allow a user to configure the properties: <property>maxNodes</property>, <property>timeToLiveSeconds</property> and <property>maxAgeSeconds</property> through the new child object <property>Cache</property>. In addition the following properties have been added to allow a user to select their own values for the: <property>Class</property>, <property>Config File</property> and <property>Cache Listener</property> available through the new child object <property>Remote Filesystem Strategy</property>. These new configurable properties allow a user increased control over the execution of the FTP Listener. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5489">JBIDE-5489</ulink>: For the <guilabel>BPMProcessor</guilabel> within the ESB Editor, the <property>Command</property> property has been modified to include possible values of <emphasis>NewProcessInstanceCommand</emphasis>, <emphasis>StartProcessCommand</emphasis> and <emphasis>CancelProcessInstanceCommand</emphasis> in a drop-down box. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5486">JBIDE-5486</ulink>: When a user would try to open an editor for a property that didn't exist nothing would occur. With this update, a <guilabel>New File</guilabel> wizard opens to guide the user through the creation of the property they were attempting to open. Once this is completed, the ESB Editor fields are then populated with the new file name and path for the property. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5427">JBIDE-5427</ulink>: In the ESB Editor, the items that displayed when right clicking and going to <menuchoice><guimenuitem>Provider</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> were presented in a different order to those of the <menuchoice><guimenuitem>Listener</guimenuitem><guimenuitem>New</guimenuitem></menuchoice> list. To ensure consistency the <guimenuitem>Provider</guimenuitem> list of items has been reordered to match the <guimenuitem>Listener</guimenuitem> menu. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5229">JBIDE-5229</ulink>: ESB 4.7 that is contained within <application>JBoss SOA Platform 5.0</application> is now officially supported in this version of the <application>JBoss Developer Studio</application>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5191">JBIDE-5191</ulink>: The Smooks, Drools, jPDL, XSLT and Groovy editors have been linked to the ESB Editor, providing an improved user experience. <guibutton>Browse</guibutton> buttons that allow for file association and use have been added to the <property>Smooks Transformer</property>, <property>GroovyActionProcessor</property>, <property>Rule Set</property> and <property>Rule Language</property> properties. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5108">JBIDE-5108</ulink>: The JBoss Runtime Manager was setup to search for ESB Runtime files from a specified location regardless of how it was installed. This caused issue when the ESB Runtime was installed as a user defined runtime. The issue has been rectified by adding a <guilabel>Configuration</guilabel> field to the <guilabel>Preference</guilabel> page. If the user sets the <guilabel>Configuration</guilabel> field to the home location of the <application>JBoss Enterprise Application Platform</application> or <application>JBoss SOA Platform</application>, there configuration combination will list all available configurations. If the user selects a standalone ESB Runtime location, the configuration combination will be empty and the user should ignore the field. The ESB runtime classpath container now gathers configuration information from the selected server runtime and then selects JARs accordingly or the st! andalone ESB Runtime. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4730">JBIDE-4730</ulink>: The ESB project creation wizard receives a new logo following this update. Instead of using the generic <application>JBoss Developer Studio</application> logo within the ESB project wizard, a new ESB wizard logo is displayed. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4320">JBIDE-4320</ulink>: ESB projects are now Web Tools Platform (WTP) modules. This ensures that it is possible to use an ESB module inside a WAR or EAR archive within WTP. ESB project deployment has not been limited though and they can still be deployed as an individual module. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4168">JBIDE-4168</ulink>: The ability to select a directory using a browser window has been added for the FS Message Filter and the FTP Message filter attributes of <property>directory</property>, <property>post-directory</property> and <property>error-directory</property>. This added feature ensures that a user does not need to manually type the entire path to a directory but instead they just select the path from a browser. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2024">JBIDE-2024</ulink>: The <guilabel>Process</guilabel> field f the <guilabel>Action</guilabel> tab in the ESB now includes a <guibutton>Browse</guibutton> button that allows a user to select which method of the <classname>Action</classname> class should be used for the process. The list in the dialog will show all public methods that has a <property>Message</property> parameter. Multiple methods can be selected if necessary. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2023">JBIDE-2023</ulink>: The <guilabel>Class</guilabel> field of the <guilabel>Action</guilabel> tab now includes a <guibutton>Browse</guibutton> button that displays the possible classes that extend from the <classname>AbstractActionLifecycle</classname> class. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>Hibernate</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5824">JBIDE-5824</ulink>: The <filename>reveng.xml</filename> editor provided an option to <guilabel>Exclude column from reverse engineering</guilabel>. Selecting this option did not change any functioning of the column and the specified option should not have been part of the interface. This update removes the unnecessary option as to not confuse users. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5643">JBIDE-5643</ulink>: Within the <guilabel>Hibernate</guilabel> tab of the <filename>persistence.xml</filename> editor, the button beside the <guilabel>Configuration file</guilabel> line was labeled <guibutton>Browse</guibutton>. This was misleading as upon clicking the button the user would be asked setup a configuration file. To provide an improved user experience, the button has now been altered to be called <guibutton>Setup</guibutton> and correctly guides the user through configuration file creation. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5641">JBIDE-5641</ulink>: When specifying the persistence property: <property><property name="hibernate.ejb.cfgfile" value="hibernate.cfg.xml"/></property>, an error could display saying that the <filename>hibernate.cfg.xml</filename> file could not be found. This occurred because the validator only considered full paths and not relative path naming. This has since been corrected through the modification of the <classname>HibernatePersistenceUnit</classname> class. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5499">JBIDE-5499</ulink>: Refactoring support has been added to <guilabel>Hibernate Code Generation Configurations</guilabel>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5411">JBIDE-5411</ulink>: The <guilabel>New Hibernate XML Mapping file</guilabel> wizard used to show all available packages. This update ensures that only packages containing java classes are shown. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5408">JBIDE-5408</ulink>: Three issues are fixed: + <itemizedlist> + <listitem> + <para> + The new Hibernate XML Mapping file (<filename>hbm.xml</filename>) would rewrite all <filename>hbm.xml</filename> files without warning. To correct this the entire result is written into the systems' temporary directory and then the merge of results is conducted. + </para> + </listitem> + <listitem> + <para> + After the merge of results is conducted, clicking the <guibutton>Finish without Preview</guibutton> button should change the page, however this did not work. The <guibutton>Finish without Preview</guibutton> now works as expected. + </para> + </listitem> + <listitem> + <para> + After the merge, following the button clicks <guibutton>GoTo</guibutton>, <guibutton>Next</guibutton>, <guibutton>Back</guibutton> and then <guibutton>Finish</guibutton> would not work correctly. This method of steps now functions as users would expect. + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5222">JBIDE-5222</ulink>: A new feature as been added that allows for support of <guilabel>filter configurations in closed projects</guilabel> for console configuration. This option is available through <menuchoice><guimenuitem>Preferences</guimenuitem><guimenuitem>Run/Debug</guimenuitem><guimenuitem>Launching</guimenuitem><guimenuitem>Launch Configurations</guimenuitem></menuchoice>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5124">JBIDE-5124</ulink>: In the Hibernate Diagram Viewer new functionality has been added that allows a user to choose between two different connection routers: Manhattan connection router for small diagrams and Fan connection router for larger diagrams. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5031">JBIDE-5031</ulink>: To close a database connection a user would have to close the <application>JBoss Developer Studio</application> and then restart the application to continue work without the connection. The database connection can now be closed from within the <application>JBoss Developer Studio</application> by choosing the <guimenuitem>Close Configuration</guimenuitem> menu item from the right-click menu in <guilabel>Hibernate Configurations</guilabel> tab. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4956">JBIDE-4956</ulink>: A feature has been added to the <guilabel>Mapping Diagram</guilabel> viewer so that it now displays relationships between database tables. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4916">JBIDE-4916</ulink>: An editor for the <filename>hibernate.properties</filename> file has been added to the <application>JBoss Developer Studio</application>. The editor supports content assist authoring. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4899">JBIDE-4899</ulink>: The <guilabel>Hibernate Configurations</guilabel> view was not updated after a hibernate console enabled project with console configuration was deleted from the workspace. This meant that the console configuration was not removed along with the project. This bug is rectified with this update. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4780">JBIDE-4780</ulink>: The <guilabel>Options</guilabel> tab now allows you to browse and set the <property>NamingStrategy</property> and <property>EntityResolver</property>. The console configuration option has also been updated to react when one of the packages of a referenced class changes. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4733">JBIDE-4733</ulink>: A new feature has been added that allows a user to select wheather JPA-Generate DDL should be executed in the database. Before this update this feature was automatic, always executing JPA-Generate in the database. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4715">JBIDE-4715</ulink>: A toggle button has been added to the Hibernate Mapping diagram to allow the outline view to be ordered either alphabetically or by the structure outlined in the file. The toggle button interface ensures the experience remains consistent across all tools included within the <application>JBoss Developer Studio</application>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4666">JBIDE-4662</ulink>: Annotations support has been added to Hibernate Tools. The addition of annotations support allows for interaction with the Eclipse Dali Java Persistence Tools Project plug-in. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4451">JBIDE-4451</ulink>: The option is now given to the user to enable the <guilabel>HQL Editor</guilabel> and <guilabel>Hibernate Criteria Editor</guilabel> to be dynamically updated when opening a new query instead of opening an instance of each editor for each query. This can be achieved by clicking the button of a tack to the right of the <guilabel>Max results:</guilabel> drop-won box in the editor. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4450">JBIDE-4450</ulink>: The <guilabel>Properties</guilabel> view has been updated with a new property called <property>Tab name</property>. The addition of this property allows for a user to individually name each query tab, allowing for improved tab management. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4227">JBIDE-4227</ulink>: The <guimenuitem>Open Mapping File</guimenuitem> option now supports all possible configuration files. In the past only files called <filename>orm.xml</filename> have been supported and this update now provides increased user functionality. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>JavaServer Faces (JSF)</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5670">JBIDE-5670</ulink>: The <filename>faceleted-taglib</filename> tag library was not supported in <filename>*taglib.xml</filename> with XML Schema Definition (XSD). Support for this library has been added to this release of the <application>JBoss Developers Studio</application>, allowing for support of <application>JavaServer Faces 2</application>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5660">JBIDE-5660</ulink>: When setting the location of an <property><error-page></property> within <filename>web.xml</filename>, the location would not be recognized if it included a query string. For example the location <filename>views/error/error.xhtml</filename> would be valid, whereas the location <filename>/views/error/error.xhtml?statusCode=403</filename> would not be valid. This has been corrected by adding a test for a query string into the <filename>CheckResource.java</filename> file, allowing for locations to be specified that include a query string. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5471">JBIDE-5471</ulink>: <filename>web-facesconfig_2_0.xsd</filename> support has been added to the <guilabel>JavaServer Faces Configuration</guilabel> editor. This file provides the XML Schema for the JavaServer Faces Application Configuration File Version 2.0. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5381">JBIDE-5381</ulink>: Content Assist has been added for use with the elements defined using the default namespace. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5277">JBIDE-5277</ulink>: The options to Add and Remove JSF support have been added to the project menu. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5670">JBIDE-5237</ulink>: CSS Class Hyperlink for the <property>class</property> attribute of HTML tags would not search through CSS loaded using JSF tags (for example: <a:loadStyle />). This has now been fixed so that the searching of CSS classes returns the correct user expected results. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5099">JBIDE-5099</ulink>: OpenOn support has been added for custom JSF 2.0 components. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5097">JBIDE-5097</ulink>: Content Assist did not support multiple namespaces with the same Uniform Resource Identifier (URI).This issue has been fixed by modifying <classname>XmlContextImpl</classname> class within the <filename>XmlContextImpl.java</filename> file from: <code>nameSpaces.get(region).put(nameSpace.getURI(), nameSpace);</code> to <code>nameSpaces.get(region).put(nameSpace.getPrefix(), nameSpace);</code>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5089">JBIDE-5089</ulink>: JSF Expression Language (EL) validation has been added for message bundles. This improves the performance of the <classname>PageContextFactory</classname>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5015">JBIDE-5015</ulink>: Support for JSF 2.0 composition components has been added in this update. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4978">JBIDE-4978</ulink>: JSF has been upgraded with the addition of Seam Expression Language (EL) support. This now allows for JSF EL validation to use all available EL resolvers, providing increased validation over past releases. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4978">JBIDE-4970</ulink>: <application>KBbuilder</application> now loads composite components from the JSF resource folders and adds them to the KB module. This allows for the components to be available for code assistance. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4771">JBIDE-4771</ulink>: The <property>Find Usages</property> function has been improved to provide information about methods when inside an EL expression. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2806">JBIDE-2806</ulink>: The Eclipse OpenOn feature that allows a user to click any reference to a template as if it was a hyperlink did not work if the template path was set using an EL variable. This limitation has now been corrected so that OpenOn works with all paths, including those set using the EL variable. This is a great advantage to users as the Expression Language variable is a frequently used feature. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-816">JBIDE-816</ulink>: A bug existed within the JSF component of the <application>JBoss Developer Studio</application> where if a resource bundle is defined in a template page code completion for the bundle would not be available within the file that includes the template with the loadbundles. The workaround for this was to also define the resource bundle in this template client file, however that meant the same component was defined twice in the component tree. + </para> + <para> + The bug has since been fixed by adding a schema for included page contexts. This schema enables the creation of contexts for all the pages included in the source and for the gathering of information on bundles declared in the included pages. The information collected is as follows: + </para> + <itemizedlist> + <listitem> + <para> + Namespaces that are declared + </para> + </listitem> + <listitem> + <para> + Tag libraries that are used + </para> + </listitem> + <listitem> + <para> + Resource bundles that are declared + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-512">JBIDE-512</ulink>: The drop-down box for context variable code completion has been upgraded for enhanced usability. The source of the variable is now outlined during code completion and the code is highlighted in a different colour for improved reading and overall understanding of each file. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>RichFaces</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5743">JBIDE-5743</ulink>: Content assistance in coding did not show anything for the tag <property><rich:menuItem ... icon="|" /></property>. The content assistance has been corrected by adding the <property>icon</property> attribute to the <filename>RichFaces.xml</filename> tag library. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5025">JBIDE-5025</ulink>: The RichFaces libraries have been updated to version 3.3.2.SR1. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>Seam</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5275">JBIDE-5275</ulink>: The <guimenuitem>Add Seam Support</guimenuitem> and <guimenuitem>Remove Seam Support</guimenuitem> items have been added to the Project menu. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5221">JBIDE-5221</ulink>: The <guilabel>JBoss Server View</guilabel> has now been replaced with the <guilabel>Server View</guilabel> in the Seam perspective. This has occurred out of the <guilabel>JBoss Server View</guilabel> being deprecated. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5192">JBIDE-5192</ulink>: The name of the editor when using the <guilabel>Diagram Viewer</guilabel> was a concatenation of the names of the diagram entities, leading to a long name in some cases. This issue has been corrected by modifying the <filename>OrmDiagram.java</filename> and <filename>DiagramViewer.java</filename> files to display a name from the following three options (based on the number of entities): + <itemizedlist> + <listitem> + <para> + Console name: Entity name + </para> + </listitem> + <listitem> + <para> + Console name: First Entity name and Second Entity name + </para> + </listitem> + <listitem> + <para> + Console name: First Entity name and <number of other entities> others + </para> + </listitem> + </itemizedlist> + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5170">JBIDE-5170</ulink>: When changing, adding or removing a Seam runtime from within <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Preferences</guimenuitem><guimenuitem>JBoss Tools</guimenuitem><guimenuitem>Web</guimenuitem><guimenuitem>Seam</guimenuitem></menuchoice>, Seam projects would not be built or validated. The behavior has been changed to build and validate Seam projects upon changes in the <guimenuitem>Preferences</guimenuitem> section to ensure correct functioning of the project. The <filename>SeamRuntimeManager.java</filename> file was updated to correct this. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5012">JBIDE-5012</ulink>: The Booking and DVDStore Seam examples have been updated for Seam 2.2 within the <application>JBoss Enterprise Application Platform</application>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4987">JBIDE-4987</ulink>: Seam and JPA Connection Profiles have been synchronized for this release. The <filename>jpa-connection</filename> profile is used in the launch configuration instead of <filename>hibernate.properties</filename> if the JPA facet is installed. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4985">JBIDE-4985</ulink>: Seam projects now create a Hibernate configuration that uses the selected connection profile directly (without copying its settings into the <filename>hibernate.properties</filename> file). + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4944">JBIDE-4944</ulink>: The Seam wizards <guilabel>Action</guilabel>, <guilabel>Entity</guilabel> and <guilabel>Conversation</guilabel> had the ability to overwrite resources when they generated code. The wizards would warn the user that some resources already existed and yet overwrite them. This has been corrected through the modification of the <filename>SeamBaseOperation.java</filename> file. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4856">JBIDE-4856</ulink>: Seam component methods and properties used in the Expression Language (EL) have been refactored. This has caused the internal structure of the components to be modified so that the <classname>Query Participant</classname> works with the JDT Java Search to find usages and append them to search results. The <classname>Rename Participant</classname> has also been modified to work with the JDT Java Refactor to rename usages and apply changes to the Java Refactor, allowing for a user to rename a <emphasis>setter</emphasis> or <emphasis>getter</emphasis> method and have the <classname>Rename Participant</classname> warn the user of the consequences of renaming a paired method. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4136">JBIDE-4136</ulink>: Classloading issues were being faced by users of Seam Tools because the <application>JBoss Developer Studio</application> used the <filename>MANIFEST.MF</filename> file for creating an artifact classpath instead of using the EAR <filename>lib/</filename> directory that is recommended by Seam. Until now the <application>JBoss Developer Studio</application> has not been able to use the EAR <filename>lib/</filename> directory because this functionality has not been supported by Eclipse. With the introduction of Eclipse 3.5 in this release the use of the EAR <filename>lib/</filename> directory is now supported and the process of creating an artifact classpath has been updated. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2807">JBIDE-2807</ulink>: An option is now provided when creating a <guilabel>New Seam Project</guilabel>, to not create a test project. This has become an option since the Seam model does not require the test project to exist and so allows the user to decide if it is of importance. Selecting to create or not create a test project is achieved through the ticking of a <guilabel>Create Test Project</guilabel> check box within the <guilabel>New Seam Project</guilabel> wizard. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-1452">JBIDE-1452</ulink>: Support has been added for the Seam PDF Facelet tag library. This Facelet library allows for PDF creation from within Seam. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-1451">JBIDE-1451</ulink>: Support has been added for the Seam Mail Facelet tag library. This Facelet library allows for email forms to be created from within Seam. All components of the Facelet have been included except <property>mail:message</property> and <property>mail:body</property> as these components are rendered as divisions (using the <div> tag). + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-1176">JBIDE-1176</ulink>: The Seam Web Project now supports the JPA facet. Addition of the Java Persistence API allows for the management of relational data within applications. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>Smooks</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5275">JBIDE-5259</ulink>: The Smooks configuration has received a test facility through the modification of the <guibutton>Run</guibutton> button to output a java result to the <guilabel>Console</guilabel>. This allows a user to test Smooks projects in a simplified way. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5088">JBIDE-5088</ulink>: When opening an existing Smooks configuration file it wouldn't contain any process information. To correct this an input task is automatically created and the Smooks configuration file is analyzed to add any missing task types if necessary. During the course of this update a <exceptionname>NullPointerException</exceptionname> was also fixed. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5086">JBIDE-5086</ulink>: A default layout is added in the Java-Mapping viewer. This allows for the layout of the information in the Smooks editor to be rearranged into a predefined default layout. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4878">JBIDE-4878</ulink>: The Smooks <guilabel>Reader</guilabel> page has been replaced with a new <guilabel>Input</guilabel> page. While the <guilabel>Input</guilabel> page inherits many functions from the <guilabel>Reader</guilabel> page there are some differences as follows: + </para> + <itemizedlist> + <listitem> + <para> + The <guilabel>Reader</guilabel> page allowed for multiple Readers to be created. <guilabel>Input</guilabel> page only allows for one Reader. + </para> + </listitem> + <listitem> + <para> + The <guilabel>Reader</guilabel> page supported the addition of multiple input data , where each was usable. The <guilabel>Input</guilabel> page only allows for one piece of input data to be used, while still allowing for multiple pieces of input data. + </para> + </listitem> + <listitem> + <para> + The <guilabel>Reader</guilabel> page could view the transformation results of the Reader. The new <guilabel>Input</guilabel> page utilizes an input model view to check the transform result. + </para> + </listitem> + </itemizedlist> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>Struts</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5278">JBIDE-5278</ulink>: The options to Add and Remove Struts support have been added to the project menu. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>Visual Page Editor</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5184">JBIDE-5184</ulink>: A memory leak existed in the Visual Page Editor. To fix this leak, the following plug-ins have been modified: + </para> + <itemizedlist> + <listitem> + <para> + <filename>org.jboss.tools.vpe</filename> + </para> + </listitem> + <listitem> + <para> + <filename>org.jboss.tools.vpe.xulrunner</filename> + </para> + </listitem> + <listitem> + <para> + <filename>org.jboss.tools.jst.jsp</filename> + </para> + </listitem> + </itemizedlist> + <para> + The issues that caused the memory leak were: + </para> + <itemizedlist> + <listitem> + <para> + <emphasis>JSPMultiPageEditorSite</emphasis>: The constructor created the <classname>serviceLocator</classname> that wasn't disposed of after use. + </para> + </listitem> + <listitem> + <para> + The <methodname>XulRunnerBrowser.dispose()</methodname> method would remove the <classname>progressListener</classname>, however this would only be done after all SWT objects and controls were already disposed. This meant the method had no effect. The dispose method is now called before the SWT objects and controls are disposed. + </para> + </listitem> + <listitem> + <para> + The <methodname>MozillaEditor.getEditor()</methodname> madethe Mozilla window editable using <methodname>nsIEditingSession.setupEditorOnWindow()</methodname>. To counteract this the objects created are now removed by using <methodname>nsIEditingSession.tearDownEditorOnWindow()</methodname>. + </para> + </listitem> + <listitem> + <para> + The <methodname>createPartControl()</methodname> method in the <classname>MozillaEditor</classname> and <classname>MozillaPreview</classname> classes create <classname>XullRunnerEditor</classname> as an inner class. The issue was that the <classname>XullRunnerEditor</classname> class retained a reference to <classname>MozillaEditor(MozillaPreview)</classname> that caused it not to be released and instead retain references to WST and EMF classes. This has now been corrected so that <classname>MozillaEditor(MozillaPreview)</classname> is now released after use and references are not retained. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5100">JBIDE-5100</ulink>: Support for JSF 2.0 attributes have been added to the Visual Page Editor. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5091">JBIDE-5091</ulink>: Support for JSF 2.0 Composition components that come packaged into the Web Application Root has been added to the Visual Page Editor. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5065">JBIDE-5065</ulink>: The icons in the Visual Page Editor have been redesigned for improved aesthetic appearance. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4945">JBIDE-4945</ulink>: A new feature has been added to the Visual Page Editor that allows a user to select both the element before and the element after a central element. This has been achieved through the modification of the <filename>SelectionBar.java</filename> file. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4934">JBIDE-4934</ulink>: Facelets tag library support has been added to the <guilabel>Palette</guilabel> for the Visual Page Editor. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4914">JBIDE-4914</ulink>: The Visual Page Editor has been redesigned so that all drop-down menu items are placed in the toolbar as buttons. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4323">JBIDE-4323</ulink>: Zoom actions have been added to the visual context menu so that a user can now resize the content of the Visual Page Editor to make it easier to read and manage. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2820">JBIDE-2820</ulink>: Support for new JSF 2.0 elements has been added to the Visual Page Editor. The tags that are newly supported are: + </para> + <itemizedlist> + <listitem> + <para> + h:head + </para> + </listitem> + <listitem> + <para> + h:body + </para> + </listitem> + <listitem> + <para> + h:outputscript + </para> + </listitem> + <listitem> + <para> + h:outputstyle + </para> + </listitem> + <listitem> + <para> + h:button + </para> + </listitem> + <listitem> + <para> + h:link + </para> + </listitem> + <listitem> + <para> + f:ajax + </para> + </listitem> + <listitem> + <para> + f:event + </para> + </listitem> + <listitem> + <para> + f:validateBean + </para> + </listitem> + <listitem> + <para> + f:validateRequired + </para> + </listitem> + <listitem> + <para> + f:viewParam + </para> + </listitem> + <listitem> + <para> + f:metadata + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2571">JBIDE-2571</ulink>: Selection of the <property><h:selectOneMenu></property> did not function correctly. Instead of being selected with one mouse click, two clicks were necessary. A bug was also present that made the nested components <property><f:selectItem></property> and <property><f:selectItems></property> unable to be selected from within the Visual Page Editor. Correction of the two clicks necessary to select the <property><h:selectOneMenu></property> component has been completed by removing the check within <filename>VpeController.java</filename> that ensures the node is of type text. The issue that did not allow for the selection of the <property><f:selectItem></property> and <property><f:selectItems></property> components was found to be a bug in XULRunner. To correct this the XULRunner component has been updated to version 1.9, which corrects this error and provides! numerous other small bug fixes (<ulink url="http://jira.jboss.com/jira/browse/JBIDE-2248">JBIDE-2248</ulink>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2248">JBIDE-2248</ulink>: The XULRunner component has been upgraded to version 1.9. This new version of XULRunner adds support for the newest HTML and CSS features to the Visual Page Editor. Included in this is support for CSS3. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-1592">JBIDE-1592</ulink>: A new feature has been added that allows for Facelets tag libraries from <filename>file.jar/META-INF/*.tablib.xml</filename> or those that are registered within <filename>web.xml</filename> by the <filename>facelets.LIBRARIES</filename> context parameter to now be used within content assist for source editing in the Visual Page Editor. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-527">JBIDE-527</ulink>: A bug existed within the Visual Page Editor that inhibited the <guibutton>Previous</guibutton> and <guibutton>Next</guibutton> buttons for detected occurrences of searched annotations to not function correctly. The action of these buttons has now been corrected so that a user can navigate their way through all found occurrences of a searched annotation. This functionality works in the Visual Page Editor as it would work in a text editor. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>XHTML Editor</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4946">JBIDE-4946</ulink>: Tool tips for tags and attributes in the XHTML Editor have been added. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>XML Structured Editor</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5521">JBIDE-5521</ulink>: The Web Servlet Mapping dialog box now contains a drop-down list for the <guilabel>Servlet-Name</guilabel> field so that servlets that have been entered into the <filename>web.xml</filename> file can be selected easily. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5426">JBIDE-5426</ulink>: The Servlet Mapping Editor <guilabel>Servlet-Name</guilabel> field has been improved with a drop-down menu to fill it in. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + <formalpara> + <title>General Issues</title> + <para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5743">JBIDE-5743</ulink>: The Web Servlet Mapping dialog box now contains a drop-down list for the <guilabel>Servlet-Name</guilabel> field so that servlets that have been entered into the <filename>web.xml</filename> file can be selected easily. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5734">JBIDE-5734</ulink>: The shortcut keys for full publishing a project to the server and building a full archive have been combined under then shortcut key menu accessed with <keycombo><keycap>Alt</keycap><keycap>Shift</keycap><keycap>Y</keycap></keycombo>. From this menu press <keycap>F</keycap> to full publish the project or <keycap>B</keycap> to build the full archive. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5690">JBIDE-5690</ulink>: The <guibutton>Full-Publish</guibutton> hotkey would only accept the first module and re-deploy it to the first server the module is deployed on. For the user this meant that if the module was already deployed on several servers, using <guibutton>Full-Publish</guibutton> would only re-deploy it to the first server returned in the list. To solve this issue a user interface has been added for the <guibutton>Full-Publish</guibutton> hotkey that allows for the selection of the server to re-deploy to. During the implementation of this fix, the package has been renamed to XPL. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2541">JBIDE-5383</ulink>: Expression Language Code Assistance has been added for the <property>@Name</property> beans. This allows for users to begin typing code and for suggestions of automatic completion to be suggested, improving user efficiency. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5743">JBIDE-5267</ulink>: The <application>JBoss Enterprise Application Platform</application> server would start correctly, however the <application>JBoss Developer Studio</application> would not acknowledge that it had started. To counteract this the <filename>JMXPoller.java</filename> timeout behavior has been modified to always return that the server succeeded in starting instead of ignoring the timeout. This fix ensures that a user is not informed that the server did not start correctly when it did. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5153">JBIDE-5153</ulink>: A <guilabel>JavaMain</guilabel> tab has been added to the tab group to allow for customization of the main class of the server. The changes to the main class are verified to persist by server startup checks. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5122">JBIDE-5122</ulink>: <guilabel>JBoss Servers View</guilabel> has been removed with this release. All the functionality provided by this view can be found in the <guilabel>Servers View</guilabel>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5048">JBIDE-5048</ulink>: SSH deployment has been added to the <application>JBoss Developer Studio</application> with this update. Specifically the following improvements have been made: + </para> + <itemizedlist> + <listitem> + <para> + A server type has been created that accepts SSH deployment for Eclipse Web Tools Platform (WTP) archives + </para> + </listitem> + <listitem> + <para> + WTP, single-file and project archives can now be published + </para> + </listitem> + <listitem> + <para> + Java Secure Channel (JSch) errors are now verified + </para> + </listitem> + <listitem> + <para> + All situations return IStatus objects and their associated user interface (an IStatus object represents the outcome of an operation) + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5041">JBIDE-5041</ulink>: The <keycap>menu</keycap> key on the keyboard would not work in the <guilabel>Web Projects</guilabel> view, <guilabel>Seam Components</guilabel> view or JBoss Tools XML Editor. The functioning of this key has now been corrected so it behaves as a user would expect. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-5005">JBIDE-5005</ulink>: A new export wizard has been added to the <application>JBoss Developer Studio</application>. The new wizard allows the export operation to utilize IModule objects. This added feature reduces redundancy and inconsistency for the export operation. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4976">JBIDE-4976</ulink>: The <guilabel>JBoss Tools Palette</guilabel> has been intergrated into the standard Eclipse GEF <guilabel>Palette</guilabel> view. The standard <guilabel>Palette</guilabel> view, accessible at <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Others</guimenuitem><guimenuitem>General</guimenuitem><guimenuitem>Palette</guimenuitem></menuchoice> is now shown in the right top part of the <guilabel>Web Development</guilabel> and <guilabel>Seam</guilabel> perspectives. The <guilabel>JBoss Tools Palette</guilabel> remains at <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Show View</guimenuitem><guimenuitem>Others</guimenuitem><guimenuitem>JBoss Tools Web</guimenuitem><guimenuitem>JBoss Tools Palette</guimenuitem></menuchoice>. + </para> + <para> + The differences in behavior between the palettes are: + </para> + <itemizedlist> + <listitem> + <para> + The new <guilabel>Palette</guilabel> is filled only when the <guilabel>Visual Page Editor</guilabel> is open and activated. The old palette remains static. + </para> + </listitem> + <listitem> + <para> + The expanded and collapsed state of tabs in the new palette is associated with the opened instance of the <guilabel>Visual Page Editor</guilabel> and not globally set as they were in the old palette. This allows for the state of tabs to be different for individual files. Each new file opened in the <guilabel>Visual Page Editor</guilabel> will have the default <guilabel>Palette</guilabel> state with all tabs collapsed. + </para> + </listitem> + </itemizedlist> + <para> + Though the behavior of the new palette is standard for Eclipse, for customers used to the globally set state of tabs and perfer to customize the palette before opening the <guilabel>Visual Page Editor</guilabel>, the old palette will remain accessible. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4955">JBIDE-4955</ulink>: BPEL and ESB projects can now be excluded from deployment through the addition of new fileset capability. When the fileset is referenced the includes, excludes and root folder layout is implemented just as it is for archives. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4922">JBIDE-4922</ulink>: Seam and RichFaces portletbridge archetypes have been added to the <application>JBoss Developer Studio</application> foruse with the Maven plug-in <application>m2eclipse</application>. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4888">JBIDE-4888</ulink>: The portlet facets configuration utility has been added for m2eclipse. This configuration utility allows for the following: + </para> + <itemizedlist> + <listitem> + <para> + If the <filename>pom.xml</filename> file contains a <property>portlet-api</property> dependency, the JBoss Core Portlet facet is added. + </para> + </listitem> + <listitem> + <para> + If the <filename>pom.xml</filename> file contains portletbridge dependencies, the JBoss JSF Portlet facet is added. + </para> + </listitem> + <listitem> + <para> + If the project contains Seam, JBoss Core Portlet and JBoss JSF Portlet facet, the JBoss Seam Portlet facet is added. + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4877">JBIDE-4877</ulink>: Tag completion has been upgraded so that partial matches are displayed and selectable following direct tag matches. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4850">JBIDE-4850</ulink>: A new feature has been added to the CSS Views with this release that allows a user to edit styles inside HTML and xhtm. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4690">JBIDE-4690</ulink>: The Maven Portlet library provider has been added to the <application>JBoss Developer Studio</application> with this release. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-4689">JBIDE-4689</ulink>: The portlet libraries engine has been updated to use the WTP 3.1 Library Framework. This framework is implemented in the Portlet Core and JSF Portlet installation page. The following library providers are now available to the user: + </para> + <itemizedlist> + <listitem> + <para> + Library provider: + </para> + <itemizedlist> + <listitem> + + <para> + User Library + </para> </listitem> + <listitem> + + <para> + Library provided by Target Runtime + </para> </listitem> + <listitem> + + <para> + Disable Library Configuration + </para> </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + Portlet Core Facet library providers: + </para> + <itemizedlist> + <listitem> + + <para> + Portlet Target Runtime Provider + </para> </listitem> + <listitem> + + <para> + Maven Portlet 1.0 and 2.0 Libraries + </para> </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + JSF Portlet Facet library providers: + <itemizedlist> + <listitem> + + <para> + JSF Portletbridge Runtime provider + </para> </listitem> + <listitem> + + <para> + JSF Portlet Target Runtime Provider + </para> </listitem> + <listitem> + + <para> + Maven Portletbridge 2.0.0 ALPHA Libraries + </para> </listitem> + <listitem> + + <para> + Maven Portletbridge 2.0.0 ALPHA Libraries with dependencies + </para> </listitem> + </itemizedlist> + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-3563">JBIDE-3563</ulink>: Code assist has been added for classes that are defined in linked CSS. The schema for included page contexts has been added. This has occurred as it is needed to create the contexts for all the pages included in the source. It allows for the gathering of information on bundles declared in included pages. + </para> + <para> + The included page contexts are created and the following information is collected within the included contexts: + </para> + <itemizedlist> + <listitem> + <para> + Namespaces are declared within the included pages + </para> + </listitem> + <listitem> + <para> + Tag libraries are used in the included pages + </para> + </listitem> + <listitem> + <para> + Resource bundles are declared within the included pages + </para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-3125">JBIDE-3125</ulink>: Exadel OpenOn support has been added to the code editors. This new functionality allows for a user to open a file that is being referenced within the code, in a new editor window. Related CDI Beans will also appear from a search of references to an object within the code, allowing for a user to quickly see where else an object is referenced. + </para> + </listitem> + <listitem> + <para> + <ulink url="http://jira.jboss.com/jira/browse/JBIDE-2541">JBIDE-2541</ulink>: A new feature has been added to this release that allows for the JavaDoc documentation to be available for the EL proposals as it is for Java methods. The JavaDoc comments are also available if they originated from a projects source folders. + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> + </section> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Known_Issues.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Known_Issues.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Known_Issues.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,20 @@ +<?xml version='1.0' encoding='utf-8' ?> +<section id="Known_Issues_with_this_release"> + <title> + Known Issues with this release + </title> + <para> + Following is a list of known issues at the time of release. + </para> + <formalpara> + <title>General Known Issues</title> + <para> + <itemizedlist> + <listitem> + <para> + </para> + </listitem> + </itemizedlist> + </para> + </formalpara> +</section> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/New_Features.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/New_Features.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/New_Features.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,7 @@ +<?xml version='1.0' encoding='utf-8' ?> +<section id="New_Features"> + <title>New Features in JBoss Developer Studio 3.0</title> + <para> + New product information to go here + </para> +</section> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Overview.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Overview.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Overview.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,50 @@ +<?xml version='1.0' encoding='utf-8' ?> +<section id="Overview"> + <title>Overview</title> + <para> + JBoss Developer Studio provides an integrated development environment for developers to build rich Web and enterprise applications, and SOA services. The technologies used include: + </para> + <itemizedlist> + <listitem> + <para> + Hibernate + </para> + </listitem> + <listitem> + <para> + JBoss Seam + </para> + </listitem> + <listitem> + <para> + RichFaces + </para> + </listitem> + <listitem> + <para> + JBoss jBPM + </para> + </listitem> + <listitem> + <para> + JBoss ESB + </para> + </listitem> + <listitem> + <para> + JBoss Portal + </para> + </listitem> + <listitem> + <para> + JBoss Drools + </para> + </listitem> + </itemizedlist> + <para> + JBoss Developer Studio includes both certified visual tooling and a runtime platform that Red Hat supports for 5 years, ensuring developers of a stable, upgradable, deployable and supportable platform. + </para> + <para> + JBoss Developer Studio is available for Windows, Linux and MacOS. + </para> + </section> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.ent =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.ent (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.ent 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss Developer Studio"> +<!ENTITY BOOKID "Release_Notes"> +<!ENTITY YEAR "2009"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Release_Notes.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,11 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<article> + <xi:include href="Article_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="Overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + + <xi:include href="Component_Versions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + <xi:include href="Fixed_Issues.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> +</article> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/Revision_History.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/Revision_History.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/Revision_History.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,3 @@ +<?xml version='1.0' encoding='utf-8' ?> + +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Mon Dec 21 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/documentation/guides/JBDS_Release_Notes/en-US/master.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/en-US/master.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/en-US/master.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3CR3//EN" +"http://www.oasis-open.org/docbook/xml/4.3CR3/docbookx.dtd" + +[<!ENTITY Overview SYSTEM "Overview.xml"> +<!ENTITY NewFeatures SYSTEM "New_Features.xml"> +<!ENTITY ComponentVersions SYSTEM "Component_Versions.xml"> +<!ENTITY FixedIssues SYSTEM "Fixed_Issues.xml"> +<!ENTITY KnownIssues SYSTEM "Known_Issues.xml"> +]> + +<article> + + <articleinfo> + <title>Release Notes</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author> + <firstname>Isaac</firstname> + <surname>Rooskov</surname> + <email>irooskov(a)redhat.com</email> + </author> + <copyright> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.0 + </releaseinfo> + + + + </articleinfo> + + <toc/> + &Overview; +  + &ComponentVersions; + &FixedIssues; + + +</article> Added: trunk/documentation/guides/JBDS_Release_Notes/pom.xml =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/pom.xml (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/pom.xml 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,157 @@ +<project xmlns="http://maven.apache.org/POM/4.0.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> + + <modelVersion>4.0.0</modelVersion> + + <groupId>org.jboss.tools</groupId> + <artifactId>converter-ref-guide${translation}</artifactId> + <version>1.0-SNAPSHOT</version> + <packaging>jdocbook</packaging> + <name>Release_Notes</name> + <profiles> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>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>diffmk</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-diff.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-diff.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf-diff.xsl</xsl-pdf> + </properties> + </profile> + </profiles> + <build> + <plugins> + <plugin> + <groupId>org.jboss.maven.plugins</groupId> + <artifactId>maven-jdocbook-plugin</artifactId> + <version>2.1.0-200803311251UTC-MPJDOCBOOK-8</version> + <extensions>true</extensions> + <dependencies> + <dependency> + <groupId>com.jboss</groupId> + <artifactId>jbossent-docbook-xslt</artifactId> + <version>1.0.0</version> + </dependency> + <dependency> + <groupId>com.jboss</groupId> + <artifactId>jbossent-jdocbook-style</artifactId> + <version>1.0.0</version> + <type>jdocbook-style</type> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-docbook-xslt</artifactId> + <version>1.1.0</version> + </dependency> + <dependency> + <groupId>org.jboss</groupId> + <artifactId>jbossorg-jdocbook-style</artifactId> + <version>1.1.0</version> + <type>jdocbook-style</type> + </dependency> + <dependency> + <groupId>org.jboss.tools</groupId> + <artifactId>jbosstools-docbook-xslt</artifactId> + <version>1.0.0-SNAPSHOT</version> + </dependency> + <dependency> + <groupId>org.apache.xmlgraphics</groupId> + <artifactId>fop</artifactId> + <version>0.95</version> + </dependency> + </dependencies> + + <configuration> + <sourceDocumentName>master.xml</sourceDocumentName> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> + <imageResource> + <directory>${pom.basedir}/en-US</directory> + <includes> + <include>images/**/*</include> + </includes> + </imageResource> + <cssResource> + <directory>${pom.basedir}/${cssdir}</directory> + </cssResource> + + <formats> + <format> + <formatName>pdf</formatName> + <stylesheetResource>${xsl-pdf}</stylesheetResource> + <finalName>${pom.name}.pdf</finalName> + </format> + <format> + <formatName>html</formatName> + <stylesheetResource>${xsl-chunked}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>html_single</formatName> + <stylesheetResource>${xsl-single}</stylesheetResource> + <finalName>index.html</finalName> + </format> + <format> + <formatName>eclipse</formatName> + <stylesheetResource>file:${pom.basedir}/${stylesdir}/xslt/org/jboss/tools/eclipse.xsl</stylesheetResource> + <finalName>index.html</finalName> + </format> + </formats> + + <options> + <xincludeSupported>true</xincludeSupported> + <xmlTransformerType>saxon</xmlTransformerType> +  +  + <docbookVersion>1.72.0</docbookVersion> + </options> + </configuration> + </plugin> + </plugins> + </build> + + <distributionManagement> + <repository> +  +  +  + <id>repository.jboss.org</id> + <url>file://${maven.repository.root}</url> + </repository> + <snapshotRepository> + <id>snapshots.jboss.org</id> + <name>JBoss Snapshot Repository</name> + <url>dav:https://snapshots.jboss.org/maven2</url> + </snapshotRepository> + </distributionManagement> + + <properties> + <stylesdir>../../../documentation/jbosstools-docbook-xslt/src/main/resources/</stylesdir> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/org/css/</cssdir> + <translation>en-US</translation> + </properties> + + +</project> Added: trunk/documentation/guides/JBDS_Release_Notes/publican.cfg =================================================================== --- trunk/documentation/guides/JBDS_Release_Notes/publican.cfg (rev 0) +++ trunk/documentation/guides/JBDS_Release_Notes/publican.cfg 2010-03-03 22:57:28 UTC (rev 20630) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Mon Dec 21 12:14:29 2009 + +xml_lang: en-US +type: Article +brand: JBoss +

14 years, 10 months

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits March 2010