March 2010 - jbosstools-commits - Jboss List Archives

JBoss Tools SVN: r20782 - in branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide: en-US and 3 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:38:36 -0500 (Thu, 11 Mar 2010) New Revision: 20782 Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Author_Group.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Book_Info.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Preface.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Revision_History.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/creation_and_registration.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/favicon.ico branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/Thumbs.db branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_10.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_11.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_12.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_14.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_15.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_16.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_17.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_18.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_19.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_2.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_1.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_2.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_21.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_22.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_23.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24a.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24b.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24c.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24d.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26a.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26b.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26c.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26d.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_27.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_28.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_29.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_3.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_30.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_31.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_32.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_33.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_34.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_35.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_36.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_37.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_38.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_39.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_4.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_40.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_42.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_43.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_44.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_45.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_46.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_47.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_48.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_49.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_5.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_50.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_51.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_52.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_53.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_54.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_55.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_56.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_57.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_58.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_59.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_6.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_7.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_8.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_9.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/Thumbs.db branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_1.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_2.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_3.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_4.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_5.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_6.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_7.png branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_project_verification.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/managed_beans.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/publican.cfg Removed: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en/ Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml Log: builds with publican Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Author_Group.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,6 @@ +<?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>Svetlana</firstname><surname>Mukhina</surname><email>smukhina(a)exadel.com</email></author></authorgroup> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Book_Info.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -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>JSF Tools Reference Guide</title><subtitle>Provides information relating to the JSF Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JSF Tools Reference Guide explains how to use the JSF Tools module to develop JSF applications.</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: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.ent 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JSF_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/JSF_Tools_Reference_Guide.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,16 @@ +<?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="jsf_support.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="projects.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="webxml_editor.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="jsf_config_file.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="managed_beans.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="creation_and_registration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="jsf_project_verification.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Preface.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -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: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/Revision_History.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -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: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/creation_and_registration.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/creation_and_registration.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/creation_and_registration.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,364 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="creation_and_registration"> + <?dbhtml filename="creation_and_registration.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Creation and Registration</title> + + <section id="CreateAndRegisterACustomConverter94230"> + + <title>Create and Register a Custom Converter</title> + + <para>It's also possible to create a + custom Converter in order to specify your own converting rules. Let's look at how you can do this.</para> + + <para>To create and register a custom converter it's necessary to + go through the following steps:</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open <emphasis> + <property>faces-config.xml</property> + </emphasis> and select <emphasis> + <property>Tree</property> + </emphasis> tab.</para> + </listitem> + </itemizedlist> + <figure> + <title>Converters</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_44.png" scale="80" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Converters</property> + </emphasis> and click on<emphasis> + <property> Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the form type the name of your converter in the <emphasis> + <property>Converter-id</property> + </emphasis> field and name of the class for + converters. After clicking <emphasis> + <property>Finish</property> + </emphasis> button your custom converter is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure> + <title>Add Converter Form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_45.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Now you can create <emphasis role="italic"> + <property>"converter"</property> + </emphasis> class. In the Converter section you + should see your <emphasis> + <property>Converter-id</property> + </emphasis> and + <emphasis><property>Converter-class</property>.</emphasis> + Click on <emphasis> + <property>Converter-class</property> + </emphasis> to generate the source code.</para> + </listitem> + </itemizedlist> + <figure> + <title>Generation of Source Code for Converter Class</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_46.png" scale="80" + /> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>A usual wizard for creating a Java class will appear. + All needed fields here will be adjusted + automatically. Just leave everything without changes + and click <emphasis> + <property>Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_47.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open a converter class click again on <emphasis> + <property>Converter-class</property> + </emphasis> link in the Converter section.</para> + </listitem> + </itemizedlist> + <figure> + <title>Converter Class</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_48.png" + /> + </imageobject> + </mediaobject> + </figure> + <para>Now you + are able to add a business logic of converter in the + Java editor.</para> + </section> + + <section id="CreateAndRegisterACustomValidator5632"> + + <title>Create and Register a Custom Validator</title> + + <para>It's also quite easy to develop your + own custom Validators. You should perform the actions similar to the + previous one. Go through the following steps:</para> + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property> faces-config.xml</property> + </emphasis> and select <emphasis> + <property>Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure> + <title>Validator in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_49.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Validators</property> + </emphasis> and click on <emphasis> + <property>Add </property> + </emphasis>button.</para> + </listitem> + <listitem> + <para>Type the name of your validator in the <emphasis> + <property>Validator-id</property> + </emphasis> field and name of the class for + validators. After clicking <emphasis> + <property>Finish</property> + </emphasis> button your custom validator is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure> + <title>Adding Validator</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_50.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para>Now you can create the "validator" class. </para> + <itemizedlist> + <listitem> + <para>In the Validator section you can see your <emphasis> + <property>Validator-id</property> + </emphasis> and <emphasis> + <property>Validator-class</property></emphasis>. To generate the source code click on <emphasis> + <property>Validator-class</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Creating Validator Class</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_51.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property>Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_52.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open validator class click again on <emphasis> + <property>Validator-Class</property> + </emphasis> link in the Validator section. Now you + are able to write a business logic of validator in + the Java editor.</para> + </listitem> + </itemizedlist> + <figure> + <title>Converter Class Editing</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_53.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="referenced_beans"> + <title>Create and Register Referenced Beans</title> + + <para>Creation of Referenced Beans is similar to creation of Custom + Validator as well. To perform this, let's walk through the necessary steps.</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property> faces-config.xml</property> + </emphasis> and select <emphasis> + <property>Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure> + <title>Referenced Beans in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_54.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Referenced Beans</property> + </emphasis> and click on <emphasis> + <property>Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Type in the name of your Referenced Bean and type in + or select <emphasis> + <property>Referenced-Bean-Class</property> + </emphasis> by using <emphasis> + <property>Browse</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure> + <title>Add Referenced Bean</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_55.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the Referenced Bean section you should see your <emphasis> + <property>Referenced-Bean-Name</property> + </emphasis> and + <emphasis><property>Referenced-Bean-Class</property>.</emphasis> + Click on the link to open the Java creation + wizard.</para> + </listitem> + </itemizedlist> + <figure> + <title>Create Referenced Bean Class</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_56.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property>Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_57.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open Referenced Bean class click again on <emphasis> + <property>Referenced-Bean-Class</property> + </emphasis> in the Referenced Bean section. Now you + are able to write business logic of Referenced Bean + in the Java editor.</para> + </listitem> + </itemizedlist> + <figure> + <title>Referenced Bean Class Editing</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_58.png" + /> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> \ No newline at end of file Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/Thumbs.db =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/Thumbs.db ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_18.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_19.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_20_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_21.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_22.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_23.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_24d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_26d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_27.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_27.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_28.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_28.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_29.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_29.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_30.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_30.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_31.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_31.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_32.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_32.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_33.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_33.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_34.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_34.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_35.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_35.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_36.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_36.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_37.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_37.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_38.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_38.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_39.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_39.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_40.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_40.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_42.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_42.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_43.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_43.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_44.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_44.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_45.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_45.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_46.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_46.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_47.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_47.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_48.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_48.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_49.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_49.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_50.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_50.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_51.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_51.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_52.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_52.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_53.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_53.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_54.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_54.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_55.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_55.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_56.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_56.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_57.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_57.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_58.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_58.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_59.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_59.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/jsf_support/jsf_support_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/Thumbs.db =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/Thumbs.db ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/images/verif_valid/verif_valid_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/introduction.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,112 @@ +<?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>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF + Tools provide extensible and exemplary tools for building JSF-based applications as well as + adding JSF capabilities to existing web projects, importing JSF projects and choosing any + JSF implementation while developing JSF application.</para> + + <para>In this guide we provide you with the information on JSF tooling which allows you to + develop JSF applications much faster and with far fewer errors so sparing your time.</para> + + <section id="jsf_key_features"> + <title>Key Features of JSF Tools</title> + + <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para> + + <table> + <title>Key Functionality for JSF Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + + <row> + <entry>JSF and Facelets support</entry> + <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> + <entry><link linkend="jsf_support">jsf support</link></entry> + </row> + + <row> + <entry>Flexible and customizable project template management</entry> + <entry>Jump-start development with out-of-the-box templates or easily + customized templates for re-use.</entry> + <entry> + <link linkend="projects">projects</link> + </entry> + </row> + + <row> + <entry>Support for JSF Configuration File</entry> + <entry>Working on file using three modes: diagram, tree and source. + Synchronization between the modes and full control over the code. Easy + moving around the diagram using the Diagram Navigator.</entry> + <entry> + <link linkend="jsf_config_file" + >graphical editor for jsf</link> + </entry> + </row> + + <row> + <entry>Support for Managed Beans</entry> + <entry>Adding new managed beans, generating code for attributes, properties + and getter/setter methods.</entry> + <entry> + <link linkend="managed_beans">managed beans</link> + </entry> + </row> + + <row> + <entry>Support for Custom Converters and Validators</entry> + <entry>Fast creating of custom converters and validators with tree view of + faces-config.xml file.</entry> + <entry> + <link linkend="creation_and_registration">converters and validators</link> + </entry> + </row> + + <row> + <entry>Verification and Validation</entry> + <entry>All occuring errors will be immediately reported by verification + feature, no matter in what view you are working. Constant validation and + errors checking allows to catch many of the errors during development + process that significantly reduces development time.</entry> + <entry> + <link linkend="jsf_project_verification">verification and + validation</link> + </entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + <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> + </section> +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_config_file.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,436 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_config_file" role="updated"> + <?dbhtml filename="jsf_config_file.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Configuration File Editor</title> + + <para>First, we should mention that JSF configuration file (<emphasis> + <property>faces-config.xml</property> + </emphasis>) is intended for registering JSF application resources such as Converters, + Validators, Managed Beans and page-to-page navigation rules.</para> + <para>Now, let's look at how you can easily configure this file by means of a special + graphical editor for JSF configuration file. The editor has three main views:</para> + + <itemizedlist> + <listitem> + <para>Diagram</para> + </listitem> + <listitem> + <para>Tree</para> + </listitem> + <listitem> + <para>Source</para> + </listitem> + </itemizedlist> + + <para>They can be selected via the tabs at the bottom of the editor.</para> + + <section id="Diagram9553"> + + <title>Diagram view</title> + + <para>Here, we will show you how to work with JSF configuration file through the Diagram + view of the editor.</para> + <para>As you can see on the figure below, the Diagram view displays the navigation rules in + the faces-config.xml:</para> + <figure> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> + <property>Diagram Navigator</property> + </emphasis> mode by selecting the middle icon at the top of the view window. It allows + you to easily move around the diagram. Just move the blue area in any direction, and the + diagram on the left will also move:</para> + <figure> + <title>Outline View for Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> + + <para>To create a new page here, you should click the page icon (View Template) on the + toolbar from the left and then click anywhere on the diagram. A New Page Wizard will + appear.</para> + + <para>To create a transition for connecting pages:</para> + + <itemizedlist> + <listitem> + <para>Select the transition icon from the toolbar (New Connection).</para> + </listitem> + <listitem> + <para>Click the source page.</para> + </listitem> + <listitem> + <para>Click the target page.</para> + </listitem> + </itemizedlist> + + <para>A transition will appear between the two pages:</para> + <figure> + <title>Transition between JSP Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_22.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It is also possible to create a new page with context menu by right-clicking anywhere + on the diagram and selecting <emphasis> + <property>New View</property>. </emphasis></para> + <figure> + <title>Creating a New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_23.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To edit an existing transition, first select the transition line. Then, place the + mouse cursor over the last black dot (on the target page). The mouse cursor will change + to a big +. At this point, drag the line to a new target page:</para> + <figure> + <title>Editing Transition between Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="TreeView11123" role="updated"> + + <title>Tree View</title> + + <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of + the <property>VPE</property>.</para> + + <para>The view displays all JSF application artifacts referenced in the configuration file + in a tree format. By selecting any node on the left, you can see and edit its properties + which will appear in the right-hand area. Let's look at the structure of this + tree more closely.</para> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Application</property> + </emphasis> node you can adjust JSF application specific settings such as + internationalization, possibility to set extensions, add property and variable + resolvers, etc.</para> + </listitem> + </itemizedlist> + + <figure> + <title>JSF Application Specific Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24a.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Components</property> + </emphasis> node is for registering custom JSF components. Right-click and + choose <emphasis> + <property>New > Component</property> + </emphasis> or just press the <emphasis> + <property>Add</property> + </emphasis> button in the right-hand area to add a new component to the JSF + Configuration file.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Registering a New JSF Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property>Add Component wizard</property> you should set a component + type and point to a component class by using the <emphasis> + <property>Browse</property> + </emphasis> button or create a new class for this component by using the <emphasis> + <property>Component-Class</property> + </emphasis> link.</para> + + <figure> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24c.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property>Render Kit</property> + </emphasis> node to create and register a set of related renderers for custom + JSF components.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24d.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Converters</property> + </emphasis> node you can create a converter class for your JSF application + either with id or for a proper class. How to do that see the <link + linkend="CreateAndRegisterACustomConverter94230">Create and Register a + Custom Converter</link> section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Creating a New Custom Converter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_59.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Managed Bean</property> + </emphasis> node is meant for creating and registering Bean classes in your JSF + application. Read more on the topic in the <link linkend="managed_beans">Managed + Beans</link> chapter.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property>Navigation Rules</property> + </emphasis> node to configure a navigation between the pages in your + application: create a new navigation rule and adjust necessary properties for it + in the right-hand area.</para> + </listitem> + </itemizedlist> + <tip> + <title>Tip:</title> + <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the + JSF Configuration file editor.</para> + </tip> + + <figure> + <title>Configuring Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26a.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property>Referenced Beans</property> + </emphasis> node you can add a new Referenced Bean and configure various + properties for it. To learn more on this refer to the <link + linkend="referenced_beans">Create and Register Referenced Beans</link> + section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Referenced Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26b.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Validators</property> + </emphasis> node is needed to create validator classes for organizing the + validation of your application data. You can read more on the topic in the <link + linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom + Validator</link> section.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26c.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property>Extensions</property> + </emphasis> node is for setting extensions for your <emphasis> + <property>faces-config.xml</property>.</emphasis></para> + </listitem> + </itemizedlist> + + <figure> + <title>Adding Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26d.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property>Tree view</property> you can also edit the properties of the selected + element with the help of the <property>Properties view</property> as shown below:</para> + + <figure> + <title>Properties View </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="SourceView4643"> + + <title>Source View</title> + + <para>Here, we'll discuss how you can configure your faces-config.xml with the help + of Source View.</para> + <para>The Source view for the editor displays a text content of the JSF configuration file. + It is always synchronized with other two views, so any changes made in one of the views + will immediately appear in the other:</para> + <figure> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + + <para>You can also work in the Source view with the help of the <emphasis> + <property>Outline view</property>.</emphasis> The Outline view shows a tree + structure of the JSF configuration file. Simply select any element in the Outline view, + 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/jsf_support/jsf_support_31.png" scale="50"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jsf_editor_features"> + <title>Editor Features</title> + <para>Here we'll discuss a very important features that JSF configuration file + editor provides for work with JSF resources.</para> + + <section id="jsf_openOn"> + <title>Open On</title> + <para>The JSF configuration file editor comes with a very useful OpenOn navigating + feature. More fully you can read about it in our Visual Web Tools + Guide.</para> + </section> + + <section id="ContentAssist976"> + + <title>Code Assist</title> + <para>Code Assist provides pop-up tip to help you complete your code statements. It + allows you to write your code faster and with more accuracy.</para> + <para>Code assist is always available in the Source mode:</para> + <figure> + <title>Code Assist in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ErrorReporting3324"> + + <title>Error Reporting</title> + <para>When you are developing your project, error checking is constantly provided. This + greatly reduces your development time as it allows you to catch many of the errors + during development.</para> + <para>Errors will be reported by <link linkend="jsf_project_verification"> + verification</link> facility:</para> + <figure> + <title>Error Reporting in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>Other errors are also reported.</para> + <figure> + <title>Other Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_project_verification.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_project_verification.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_project_verification.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,107 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_project_verification"> + <?dbhtml filename="struts_project_verification.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Project Verification</title> + + <para>In this chapter we'll discuss a possible verification that you can take advantage + of.</para> +  + <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> + <property>Window > Preferences</property> + </emphasis> from the menu bar, selecting <emphasis> + <property>JBoss Tools > Web > Verification</property> + </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para> + <figure> + <title>JSF Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para> + <figure> + <title>Faces-config.xml File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>While typing a class name, you might make a minor typo (like <emphasis role="italic"> + <property>"jsfHello.PersonBean9"</property> + </emphasis> instead of <emphasis role="italic"> + <property>"jsfHello.PersonBean"</property> + </emphasis>). After saving the file, verification checks to make sure everything is correct + and finds the error below:</para> + <figure> + <title>Error in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>Notice that the Package Explorer View shows a marked folder and a marked file where the + error is.</para> + <para>You can place the cursor over the line with an error message and get a detailed error + message:</para> + <figure> + <title>Error Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Verification also checks navigation rules:</para> + <figure> + <title>Checking Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If you provide a page name that does not exist, verification will let you know about that:</para> + <figure> + <title>Page Name Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>You can always call up verification explicitly by right-clicking any element in the tree + and selecting Verify from the context menu. This works from both the Tree and Diagram + viewers for the JSF configuration file editor. You can also invoke verification from the Web + Projects view. Below we are checking all of the elements in the configuration file.</para> + <figure> + <title>Verify Command</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this document highlights all the JSF-specific features of <property>JBoss Tools</property> + meant for enhancing the development of rich Web applications based on JSF technology. The + reference introduces you to wizards for creating and importing JSF projects, JSF + Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> + + <para>If you have questions or good suggestions, please refer to <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/jsf_support.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,317 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_support"> + <?dbhtml filename="jsf_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JavaServer Faces Support</title> + + <para>We don't lock you into any one <property>JavaServer + Faces</property> implementation. You can always select the one which is + necessary for you while <link linkend="new_jsf_project">creating a new JSF + project</link>, <link linkend="add_jsf_capability">adding JSF capability</link> to + any existing Eclipse project or <link linkend="ImportingExsJSFProjWithAnyStr74447" + >importing existing JSF projects</link> as well.</para> + <para>At this point the special wizard will prompt you to specify a proper JSF environment. + It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and + changes. The wizard also lets you select JSF implementation with a component + orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para> + + <figure> + <title>Choosing JSF Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After specifying a proper JSF environment all the required libraries for the selected + version will be added to your project.</para> + + <section id="FaceletsSupport865"> + + <title>Facelets Support</title> + <para>In this section we will focus more on all concepts that are integrated for + working with Facelets.</para> + + <para>The Facelets extends JavaServer Faces by providing a lightweight framework + that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we + will consider further in this section.</para> + + <section> + <title>Facelets templates</title> + <para>If you want to build an application using Facelets, just create a + project with Facelets based on version 1.2 of the JSF Reference + Implementation, i. e. select the <emphasis> + <property>JSF 1.2 with Facelets</property> + </emphasis> in the JSF Environment section of the New JSF Project + wizard.</para> + + <figure> + <title>Choosing Facelets Environment</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_2.png" + /> + </imageobject> + </mediaobject> + </figure> + + <para>Once you've selected the environment, it's possible + to specify the one of three available templates:</para> + <figure> + <title>Choosing Facelets Template</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_3.png" + /> + </imageobject> + </mediaobject> + </figure> + <para>The following table lists possible templates with Facelets for any JSF + project and gives a proper description for each one.</para> + <table> + <title>Facelets Templates</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="3*"/> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property>FaceletsBlankWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already provide + jsf libs and you take risk + of getting conflicting + libraries while deploying + your project. To avoid such + conflicts, use a template + without libs if you have a + server with its own jsf + libraries</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property>FaceletsKickStartWithRILibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application with + Facelets that is ready to + run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property>FaceletsKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application without + libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + <section> + <title>Facelets components</title> + + <para>The JBoss Tools + Palette comes with the Facelets components ready to + use. A useful tip appears when you hover the mouse cursor over the + tag, the tip includes a detailed description of the tag component, + the syntax and available attributes.</para> + +  + <figure> + <title>Facelets Components</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_4.png" + scale="65"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Code assist for Facelets</title> + + <para>One more feature which comes with Facelets support is code assist + (Ctrl + Space). It is available for <property>Facelets + tags</property> while editing <emphasis> + <property>.xhtml</property> + </emphasis> files.</para> + + <figure> + <title>XHTML File Code Assist</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_5.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + + <para>What's more, code assist is also available for <emphasis + role="italic"> + <property>"jsfc"</property> + </emphasis> attribute in any HTML tag.</para> + + <figure> + <title>Code Assist for JSFC Attribute</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_6.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>After selecting <emphasis role="italic"> + <property>"jsfc"</property> + </emphasis> you get the code assist for JSF components available on + a page.</para> + + <figure> + <title>Code Assist for JSF Components</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>When a component is chosen you will see all available attributes for + it.</para> + + <figure> + <title>Available Attributes for the Component</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_8.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Open On feature</title> + <para>Finally, Eclipse's <emphasis> + <property>OpenOn</property> + </emphasis> feature for editing Facelets files is supported. Using this feature, + you can easily navigate between the <property>Facelets + templates</property> and other parts of your projects. Just by + holding down the Control key while hovering the mouse cursor over a + reference to a template, the reference becomes a hyperlink to open + that template.</para> + + + <figure> + <title>Template Hyperlink</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsf_support/jsf_support_9.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + +  +  + </section> + +  + </section> + + + + + + + + + + +  +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/managed_beans.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/managed_beans.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/managed_beans.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,208 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="managed_beans"> + <?dbhtml filename="managed_beans.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Managed Beans</title> + + <para>There is lots of power to work with <property>managed beans</property>.</para> + <itemizedlist> + <listitem> + <para>Add and generate code for new managed beans</para> + <itemizedlist> + <listitem> + <para>Generate code for attributes and getter/setter methods</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Add existing managed beans to JSF configuration file</para> + </listitem> + </itemizedlist> + + <para>Thus, in this section we will guides you through all this possibilities.</para> + + <section id="CodeGenerationForManagedBeans421"> + + <title>Code Generation for Managed Beans</title> + + <para>To start, create a new managed bean in JSF configuration file editor, in the Tree + view.</para> + <figure> + <title>Creation of New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_34.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When you define a new managed bean, make sure that <emphasis> + <property>Generate Source Code</property> + </emphasis> is checked as shown in the figure below.</para> + </note> + <figure> + <title>New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>After the <emphasis role="italic"> + <property>"Java"</property> + </emphasis> class has been generated you can open it for additional editing. There are + two ways to open the <emphasis role="italic"> + <property>"Java"</property> + </emphasis> class:</para> + + <itemizedlist> + <listitem> + <para>click on <emphasis> + <property>Managed-Bean-Class</property> + </emphasis> link in the editor</para> + </listitem> + </itemizedlist> + <para>or</para> + <itemizedlist> + <listitem> + <para>right click the <emphasis> + <property>managed bean</property> + </emphasis> and select <emphasis> + <property>Open Source</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure> + <title>Opening of Created Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_36.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The generated Java source should look as follows:</para> + + <figure> + <title>Java Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_37.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can also generate source code for properties, also includes <emphasis + role="italic"> + <property>"getter"</property> + </emphasis> and <emphasis role="italic"> + <property>"setter"</property> + </emphasis> methods. Right click on the bean and select <emphasis> + <property>New > Property</property> + </emphasis>. You will see <property>Add Property</property> dialog.</para> + <figure> + <title>Generation of Source Code for Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_38.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When the form is open make sure that all the check boxes are selected:</para> + <itemizedlist> + <listitem> + <para>Add Java property</para> + </listitem> + <listitem> + <para>Generate Getter</para> + </listitem> + <listitem> + <para>Generate Setter</para> + </listitem> + </itemizedlist> + <para/> + <figure> + <title>"Add Property" Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_39.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once the generation is complete, you can open the file and see the added property with + <emphasis role="italic"> + <property>"get"</property> + </emphasis> and <emphasis role="italic"> + <property>"set"</property> + </emphasis> methods:</para> + <figure> + <title>Generated Java Source Code for Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, we've discussed everything which comes to creating a new Managed Bean. + The next section will show you how to add an existing Bean into a JSF configuration + file.</para> + </section> + <section id="AddExistingJavaBeansToAJSFConfigurationFile74332"> + + <title>Add Existing Java Beans to a JSF Configuration File</title> + <para>If you already have a Java bean you can easily add it to a <property>JSF configuration + file</property>.</para> + <para>You should start the same way you create a new managed bean. Use the <emphasis> + <property>Browse...</property> + </emphasis> button to add your existing Java class.</para> + <figure> + <title>New Managed Bean Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_42.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once the class is set, its <emphasis> + <property>Name</property> + </emphasis> will be set as well. But you can easily substitute it for the other one. + Notice that <emphasis> + <property>Generate Source Code</property> + </emphasis> option is not available as the <emphasis role="italic"> + <property>"Java"</property> + </emphasis> class already exists. </para> + <para>After adding your class <emphasis> + <property>Next</property> + </emphasis> button will be activated. Pressing it you'll get <emphasis> + <property>Managed Properties</property> + </emphasis> dialog where all corresponding properties are displayed. Check the necessary + ones to add them into your <property>JSF Configuration File</property>.</para> + + <figure> + <title>Selection of Bean's Properties.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_43.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you don't want to add any, just click <emphasis> + <property>Finish</property>. </emphasis></para> + <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF + configuration file, i.e. <emphasis> + <property>faces-config.xml</property>. </emphasis> In the next chapter + you'll know how to organize and register another kind of artifacts.</para> + </section> +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,77 @@ +<?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 jsf_support SYSTEM "jsf_support.xml"> +<!ENTITY projects SYSTEM "projects.xml"> +<!ENTITY webxml_editor SYSTEM "webxml_editor.xml"> +<!ENTITY jsf_config_file SYSTEM "jsf_config_file.xml"> +<!ENTITY managed_beans SYSTEM "managed_beans.xml"> +<!ENTITY creation_and_registration SYSTEM "creation_and_registration.xml"> +<!ENTITY jsf_project_verification SYSTEM "jsf_project_verification.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"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> + + +]> +<book> + <bookinfo> + <title>JSF 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>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></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: 3.1.0.GA + </releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc/> + + &introduction; + &jsf_support; + &projects; + &webxml_editor; + &jsf_config_file; + &managed_beans; + &creation_and_registration; + &jsf_project_verification; +</book> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/master_output.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,1987 @@ +<?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 jsf_support SYSTEM "modules/jsf_support.xml"> +<!ENTITY projects SYSTEM "modules/projects.xml"> +<!ENTITY webxml_editor SYSTEM "modules/webxml_editor.xml"> +<!ENTITY jsf_config_file SYSTEM "modules/jsf_config_file.xml"> +<!ENTITY managed_beans SYSTEM "modules/managed_beans.xml"> +<!ENTITY creation_and_registration SYSTEM "modules/creation_and_registration.xml"> +<!ENTITY jsf_project_verification SYSTEM "modules/jsf_project_verification.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"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>JSF 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>Anatoly</firstname><surname>Fedosik</surname></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></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: 3.1.0.GA + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jsf_tools_ref_guide/...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_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>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction</title> + + <para>JSF Tools are especially designed for supporting JSF and JSF-related technologies. JSF + Tools provide extensible and exemplary tools for building JSF-based applications as well as + adding JSF capabilities to existing web projects, importing JSF projects and choosing any + JSF implementation while developing JSF application.</para> + + <para>In this guide we provide you with the information on JSF tooling which allows you to + develop JSF applications much faster and with far fewer errors so sparing your time.</para> + + <section id="jsf_key_features"> + <title>Key Features of JSF Tools</title> + + <para>Here, we provide you with a key functionality which is integrated in JSF tooling.</para> + + <table> + <title>Key Functionality for JSF Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + + <row> + <entry>JSF and Facelets support</entry> + <entry>Step-by-step wizards for creating new JSF and Facelets projects with a number of predefined templates, importing existing ones and adding JSF capabilities to non-jsf web projects.</entry> + <entry><link linkend="jsf_support">jsf support</link></entry> + </row> + + <row> + <entry>Flexible and customizable project template management</entry> + <entry>Jump-start development with out-of-the-box templates or easily + customized templates for re-use.</entry> + <entry> + <link linkend="projects">projects</link> + </entry> + </row> + + <row> + <entry>Support for JSF Configuration File</entry> + <entry>Working on file using three modes: diagram, tree and source. + Synchronization between the modes and full control over the code. Easy + moving around the diagram using the Diagram Navigator.</entry> + <entry> + <link linkend="jsf_config_file">graphical editor for jsf</link> + </entry> + </row> + + <row> + <entry>Support for Managed Beans</entry> + <entry>Adding new managed beans, generating code for attributes, properties + and getter/setter methods.</entry> + <entry> + <link linkend="managed_beans">managed beans</link> + </entry> + </row> + + <row> + <entry>Support for Custom Converters and Validators</entry> + <entry>Fast creating of custom converters and validators with tree view of + faces-config.xml file.</entry> + <entry> + <link linkend="creation_and_registration">converters and validators</link> + </entry> + </row> + + <row> + <entry>Verification and Validation</entry> + <entry>All occuring errors will be immediately reported by verification + feature, no matter in what view you are working. Constant validation and + errors checking allows to catch many of the errors during development + process that significantly reduces development time.</entry> + <entry> + <link linkend="jsf_project_verification">verification and + validation</link> + </entry> + + </row> + </tbody> + </tgroup> + </table> + </section> + <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> + </section> +</chapter> + + +<chapter id="jsf_support" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_support.xml"> + <?dbhtml filename="jsf_support.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JavaServer Faces Support</title> + + <para>We don't lock you into any one <property moreinfo="none">JavaServer + Faces</property> implementation. You can always select the one which is + necessary for you while <link linkend="new_jsf_project">creating a new JSF + project</link>, <link linkend="add_jsf_capability">adding JSF capability</link> to + any existing Eclipse project or <link linkend="ImportingExsJSFProjWithAnyStr74447">importing existing JSF projects</link> as well.</para> + <para>At this point the special wizard will prompt you to specify a proper JSF environment. + It may be JSF 1.1.02 RI or JSF 1.2 which integrates a number of new features and + changes. The wizard also lets you select JSF implementation with a component + orientation such as JSF 1.2 with Facelets or MyFaces 1.1.4.</para> + + <figure float="0"> + <title>Choosing JSF Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After specifying a proper JSF environment all the required libraries for the selected + version will be added to your project.</para> + + <section id="FaceletsSupport865"> + + <title>Facelets Support</title> + <para>In this section we will focus more on all concepts that are integrated for + working with Facelets.</para> + + <para>The Facelets extends JavaServer Faces by providing a lightweight framework + that radically simplifies the design of presentation pages for JSF. Facelets can be used in a variety of ways that we + will consider further in this section.</para> + + <section> + <title>Facelets templates</title> + <para>If you want to build an application using Facelets, just create a + project with Facelets based on version 1.2 of the JSF Reference + Implementation, i. e. select the <emphasis> + <property moreinfo="none">JSF 1.2 with Facelets</property> + </emphasis> in the JSF Environment section of the New JSF Project + wizard.</para> + + <figure float="0"> + <title>Choosing Facelets Environment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once you've selected the environment, it's possible + to specify the one of three available templates:</para> + <figure float="0"> + <title>Choosing Facelets Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The following table lists possible templates with Facelets for any JSF + project and gives a proper description for each one.</para> + <table> + <title>Facelets Templates</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsBlankWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already provide + jsf libs and you take risk + of getting conflicting + libraries while deploying + your project. To avoid such + conflicts, use a template + without libs if you have a + server with its own jsf + libraries</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsKickStartWithRILibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application with + Facelets that is ready to + run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">FaceletsKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>A sample application without + libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + <section> + <title>Facelets components</title> + + <para>The <ulink url="../../jsf/html_single/index.html#palette">JBoss Tools + Palette</ulink> comes with the Facelets components ready to + use. A useful tip appears when you hover the mouse cursor over the + tag, the tip includes a detailed description of the tag component, + the syntax and available attributes.</para> + +  + <figure float="0"> + <title>Facelets Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_4.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Code assist for Facelets</title> + + <para>One more feature which comes with Facelets support is code assist + (Ctrl + Space). It is available for <property moreinfo="none">Facelets + tags</property> while editing <emphasis> + <property moreinfo="none">.xhtml</property> + </emphasis> files.</para> + + <figure float="0"> + <title>XHTML File Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_5.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>What's more, code assist is also available for <emphasis role="italic"> + <property moreinfo="none">"jsfc"</property> + </emphasis> attribute in any HTML tag.</para> + + <figure float="0"> + <title>Code Assist for JSFC Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_6.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After selecting <emphasis role="italic"> + <property moreinfo="none">"jsfc"</property> + </emphasis> you get the code assist for JSF components available on + a page.</para> + + <figure float="0"> + <title>Code Assist for JSF Components</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When a component is chosen you will see all available attributes for + it.</para> + + <figure float="0"> + <title>Available Attributes for the Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_8.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section> + <title>Open On feature</title> + <para>Finally, Eclipse's <emphasis> + <property moreinfo="none">OpenOn</property> + </emphasis> feature for editing Facelets files is supported. Using this feature, + you can easily navigate between the <property moreinfo="none">Facelets + templates</property> and other parts of your projects. Just by + holding down the Control key while hovering the mouse cursor over a + reference to a template, the reference becomes a hyperlink to open + that template.</para> + + + <figure float="0"> + <title>Template Hyperlink</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_9.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + +  +  + </section> + +  + </section> + + + + + + + + + + +  +</chapter> + + +<chapter id="projects" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/projects.xml"> + <?dbhtml filename="projects.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Projects</title> + <para>To take an advantage of JSF firstly you should perform one of the next steps:</para> + + <itemizedlist> + <listitem> + <para>Create new JSF projects</para> + </listitem> + <listitem> + <para>Import (open) existing JSF projects</para> + </listitem> + <listitem> + <para>Add JSF capability to any existing Eclipse project</para> + </listitem> + <listitem> + <para>Import and add JSF capability to any existing project created outside + Eclipse.</para> + </listitem> + </itemizedlist> + <para>In this section we're going to stop on each of them in detail.</para> + + <section id="new_jsf_project"> + + <title>Creating a New JSF Project</title> + + <para>If you want your project to already contain all JSF libraries, tag libraries + and JSF configuration file, just organize a new brand JSF project. It is + possible to do this easily with the help of the special wizard. To get it, select<emphasis> + <property moreinfo="none"> File > New > Project > JBoos Tools + Web > JSF > JSF Project</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Next</property>.</emphasis></para> + + <figure float="0"> + <title>Choosing a JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form you'll be prompted to enter <property moreinfo="none">Project + Name</property> and select a location for the project or just leave + a default path.</para> + <para>Here, JSF Version also allows you to select which JSF implementation to + use.</para> + <figure float="0"> + <title>Creating a New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>There is a number of predefined project templates that are flexible and easily + customizable. Thus you can pick a different template on which the projects + Importing Existing should be based on. Almost all templates come in two + variations: with jsf libraries and without ones.</para> + <figure float="0"> + <title>Choosing JSF Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_12.png "></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The table below provides description for each possible JSF template.</para> + <table> + <title>JSF Project Templates</title> + <tgroup cols="2"> + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="3*"></colspec> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFBlankWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will create a standard Web + project structure with all JSF capabilities</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFKickStartWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will create a standard Web + project structure but will also include a sample + application that is ready to run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property moreinfo="none">JSFKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already provide jsf libs and + you take risk of getting conflicting libraries + while deploying your project. To avoid such + conflicts, use a template without libs if you have + a server with its own jsf libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + +  + + <para>On the next screen select what <emphasis> + <property moreinfo="none">Servlet version</property> + </emphasis> to use and whether to register this application with JBoss AS + (or other server) for running and testing your application.</para> + + <para>The <emphasis> + <property moreinfo="none">Context Path</property> + </emphasis> is the name under which the application will be deployed.</para> + + <para>The <emphasis> + <property moreinfo="none">Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries in order to + build (compile) the project. It is not possible to finish project creation + without selecting Runtime. If you don't have any values, select <emphasis> + <property moreinfo="none">New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> allows you specifying whether to deploy the application. The + Target Server corresponds to the Runtime value selected above. If you + don't want to deploy the application, uncheck this value.</para> + <figure float="0"> + <title>Registering the Project on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When you are all done, you should have the project that has been appeared in + the Package Explorer view:</para> + <figure float="0"> + <title>A New Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>At this point you can open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> and start working on your application. There are a lot of + features to develop JSF applications. We will describe the features + further.</para> + </section> + + <section id="ImportingExsJSFProjWithAnyStr74447"> + + <title>Importing Existing JSF Projects with Any Structure</title> + + <para>For detailed information on migration of JSF projects into a workspace see + <ulink url="../../Exadel-migration/html_single/index.html#jsf_struts">Migration + Guide</ulink>.</para> + + </section> + <section id="add_jsf_capability"> + + <title>Adding JSF Capability to Any Existing Eclipse Project</title> + + <para>It's also possible to add <property moreinfo="none">JSF capability</property> (JSF + libraries, tag libraries) to any existing Eclipse project in your workspace. + After that you'll be able to make use of such editors as JSF + configuration editor, JBoss Tools JSP editor and any others.</para> + <para>Right click the project and select <emphasis> + <property moreinfo="none">JBoss Tools > Add JSF Capabilities</property>. </emphasis> + This will start the process of adding all necessary libraries, files to make + this a Web JSF project.</para> + <figure float="0"> + <title>Adding JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The wizard will first ask you to show the <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file location and the project name.</para> + <figure float="0"> + <title>Project Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On the last form you can set the different folders for your project as well as + register this application with a servlet container.</para> + + <para>Make sure to select <emphasis> + <property moreinfo="none">Add Libraries</property> + </emphasis> to add all required JSF related libraries to this + project.</para> + + <para>The <emphasis> + <property moreinfo="none">Context Path</property> + </emphasis> is the name under which the application will be deployed.</para> + + <para>The <emphasis> + <property moreinfo="none">Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries in order to + build (compile) the project. It is not possible to finish project import + without selecting Runtime. If you don't have any values, select <emphasis> + <property moreinfo="none">New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property moreinfo="none">Target Server</property> + </emphasis> allows you to specify whether to deploy the application. The + Target Server corresponds to the Runtime value selected above. If you + don't want to deploy the application, uncheck this value.</para> + <figure float="0"> + <title>Project Folders</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_18.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once your project is imported you can see that JSF related libraries have been + added to your project: <emphasis> + <property moreinfo="none">jsf-api.jar</property> + </emphasis> and <emphasis> + <property moreinfo="none">jsf-impl.jar</property> + </emphasis>.</para> + <note> + <title>Note:</title> + <para>Some application servers provide their own jsf implementation + libraries. Thus, to avoid conflicts you should not add jsf libraries + while adding jsf capabilities.</para> + </note> + <para>You are now ready to work with JSF by creating a new JSF configuration + file:</para> + + + <figure float="0"> + <title>Creating a New JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once the file has been created, it should be opened in a special <link linkend="jsf_config_file">Faces Config Editor</link>.</para> + </section> + <section id="AddingYourOwnProjectTemplates853"> + + <title>Adding Your Own Project Templates</title> + <para>Template is a set of files that is served as a basis to facilitate the + creation of a new project. Project templates provide content and structure + for a project.</para> + <para>There is a powerful templating capability for creating new and importing + existing Struts and JSF projects. This templating facility has a variety of + aspects to consider. But, let's start with the most straightforward + case and consider the process of creating a template from your existing JSF + project.</para> + + <para>Let's say you have a project that you want to use as the basis for a + new <property moreinfo="none">template</property>. Follow these steps to make a template out + of it:</para> + <itemizedlist> + <listitem> + <para>In the Web Projects view, right-click the project and select <emphasis> + <property moreinfo="none">JBoss Tools JSF > Save As + Template</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Saving Your Project as Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the first dialog box, you can choose a name for the + template (defaults to the project name) and confirm what + run-time implementation of the project technology will be + used</para> + </listitem> + + </itemizedlist> + <figure float="0"> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Next</property> + </emphasis> and you will be sent to a dialog box with your + project structure displayed with check boxes. Here you can + check only those parts and files in your project directory + that should be part of the template</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>At this point, unless you want to designate some extra files + as having Velocity template coding inside them, you should + click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <para>That's it. Now, you can use this template with any new or imported + project that uses the same run-time implementation as the project you turned + into a template.</para> + <para>At this point, you have a fully configured project and now you can bring some + new logic to it starting from JSF configuration file.</para> + </section> + <section> + <title>Relevant Resources Links</title> + + <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can + be used in various scenarios while developing JSF applications in our <ulink url="../../jsf/html_single/index.html">Visual Web Tools guide</ulink>.</para> + </section> +</chapter> + + +<chapter id="webxml_editor" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/webxml_editor.xml" xreflabel="webxml_editor"> + <?dbhtml filename="webxml_editor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Web.xml Editor</title> + + <para>The <emphasis> + <property moreinfo="none">web.xml</property></emphasis> file inside the <emphasis> + <property moreinfo="none">WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It + describes the servlets and other components and deployment properties that make up your application.</para> + + <para><property moreinfo="none">JBoss Tools</property> add the <emphasis> + <property moreinfo="none">web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. + See the Visual Web Tools guide that gives a descriptive information on the <ulink url="../../jsf/html_single/index.html#GraphicalWebApplicationFileEditor">web.xml editor</ulink>.</para> +</chapter> + +<chapter id="jsf_config_file" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_config_file.xml"> + <?dbhtml filename="jsf_config_file.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Configuration File Editor</title> + + <para>First, we should mention that JSF configuration file (<emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis>) is intended for registering JSF application resources such as Converters, + Validators, Managed Beans and page-to-page navigation rules.</para> + <para>Now, let's look at how you can easily configure this file by means of a special + graphical editor for JSF configuration file. The editor has three main views:</para> + + <itemizedlist> + <listitem> + <para>Diagram</para> + </listitem> + <listitem> + <para>Tree</para> + </listitem> + <listitem> + <para>Source</para> + </listitem> + </itemizedlist> + + <para>They can be selected via the tabs at the bottom of the editor.</para> + + <section id="Diagram9553"> + + <title>Diagram view</title> + + <para>Here, we will show you how to work with JSF configuration file through the Diagram + view of the editor.</para> + <para>As you can see on the figure below, the Diagram view displays the navigation rules in + the faces-config.xml:</para> + <figure float="0"> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If your diagram is large, make use of the Outline view. Within it you can switch to a <emphasis> + <property moreinfo="none">Diagram Navigator</property> + </emphasis> mode by selecting the middle icon at the top of the view window. It allows + you to easily move around the diagram. Just move the blue area in any direction, and the + diagram on the left will also move:</para> + <figure float="0"> + <title>Outline View for Diagram</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_32.png" scale="50"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To create a new page here, you should click the page icon (View Template) on the + toolbar from the left and then click anywhere on the diagram. A New Page Wizard will + appear.</para> + + <para>To create a transition for connecting pages:</para> + + <itemizedlist> + <listitem> + <para>Select the transition icon from the toolbar (New Connection).</para> + </listitem> + <listitem> + <para>Click the source page.</para> + </listitem> + <listitem> + <para>Click the target page.</para> + </listitem> + </itemizedlist> + + <para>A transition will appear between the two pages:</para> + <figure float="0"> + <title>Transition between JSP Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It is also possible to create a new page with context menu by right-clicking anywhere + on the diagram and selecting <emphasis> + <property moreinfo="none">New View</property>. </emphasis></para> + <figure float="0"> + <title>Creating a New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_23.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To edit an existing transition, first select the transition line. Then, place the + mouse cursor over the last black dot (on the target page). The mouse cursor will change + to a big +. At this point, drag the line to a new target page:</para> + <figure float="0"> + <title>Editing Transition between Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="TreeView11123" role="updated"> + + <title>Tree View</title> + + <para>You can find it more convenient to edit your JSF Configuration file in the Tree view of + the <property moreinfo="none">VPE</property>.</para> + + <para>The view displays all JSF application artifacts referenced in the configuration file + in a tree format. By selecting any node on the left, you can see and edit its properties + which will appear in the right-hand area. Let's look at the structure of this + tree more closely.</para> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Application</property> + </emphasis> node you can adjust JSF application specific settings such as + internationalization, possibility to set extensions, add property and variable + resolvers, etc.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JSF Application Specific Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Components</property> + </emphasis> node is for registering custom JSF components. Right-click and + choose <emphasis> + <property moreinfo="none">New > Component</property> + </emphasis> or just press the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button in the right-hand area to add a new component to the JSF + Configuration file.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Registering a New JSF Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Add Component wizard</property> you should set a component + type and point to a component class by using the <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button or create a new class for this component by using the <emphasis> + <property moreinfo="none">Component-Class</property> + </emphasis> link.</para> + + <figure float="0"> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property moreinfo="none">Render Kit</property> + </emphasis> node to create and register a set of related renderers for custom + JSF components.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding a New JSF Component to the JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_24d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Converters</property> + </emphasis> node you can create a converter class for your JSF application + either with id or for a proper class. How to do that see the <link linkend="CreateAndRegisterACustomConverter94230">Create and Register a + Custom Converter</link> section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Creating a New Custom Converter</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_59.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Managed Bean</property> + </emphasis> node is meant for creating and registering Bean classes in your JSF + application. Read more on the topic in the <link linkend="managed_beans">Managed + Beans</link> chapter.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Managed Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Use the <emphasis> + <property moreinfo="none">Navigation Rules</property> + </emphasis> node to configure a navigation between the pages in your + application: create a new navigation rule and adjust necessary properties for it + in the right-hand area.</para> + </listitem> + </itemizedlist> + <tip> + <title>Tip:</title> + <para>The same you can do in the <link linkend="Diagram9553">Diagram view</link> of the + JSF Configuration file editor.</para> + </tip> + + <figure float="0"> + <title>Configuring Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Under the <emphasis> + <property moreinfo="none">Referenced Beans</property> + </emphasis> node you can add a new Referenced Bean and configure various + properties for it. To learn more on this refer to the <link linkend="referenced_beans">Create and Register Referenced Beans</link> + section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Referenced Beans</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Validators</property> + </emphasis> node is needed to create validator classes for organizing the + validation of your application data. You can read more on the topic in the <link linkend="CreateAndRegisterACustomValidator5632">Create and Register a Custom + Validator</link> section.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Validators</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>The <emphasis> + <property moreinfo="none">Extensions</property> + </emphasis> node is for setting extensions for your <emphasis> + <property moreinfo="none">faces-config.xml</property>.</emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Adding Extensions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_26d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the <property moreinfo="none">Tree view</property> you can also edit the properties of the selected + element with the help of the <property moreinfo="none">Properties view</property> as shown below:</para> + + <figure float="0"> + <title>Properties View </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_33.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + <section id="SourceView4643"> + + <title>Source View</title> + + <para>Here, we'll discuss how you can configure your faces-config.xml with the help + of Source View.</para> + <para>The Source view for the editor displays a text content of the JSF configuration file. + It is always synchronized with other two views, so any changes made in one of the views + will immediately appear in the other:</para> + <figure float="0"> + <title>Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_27.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You can also work in the Source view with the help of the <emphasis> + <property moreinfo="none">Outline view</property>.</emphasis> The Outline view shows a tree + structure of the JSF configuration file. Simply select any element in the Outline view, + 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/jsf_support/jsf_support_31.png" scale="50"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jsf_editor_features"> + <title>Editor Features</title> + <para>Here we'll discuss a very important features that JSF configuration file + editor provides for work with JSF resources.</para> + + <section id="jsf_openOn"> + <title>Open On</title> + <para>The JSF configuration file editor comes with a very useful OpenOn navigating + feature. More fully you can read about it in our <ulink url="../../jsf/html_single/index.html#OpenOnSelection4Hyperlinknavigation">Visual Web Tools + Guide</ulink>.</para> + </section> + + <section id="ContentAssist976"> + + <title>Code Assist</title> + <para>Code Assist provides pop-up tip to help you complete your code statements. It + allows you to write your code faster and with more accuracy.</para> + <para>Code assist is always available in the Source mode:</para> + <figure float="0"> + <title>Code Assist in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_28.png" scale="65"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="ErrorReporting3324"> + + <title>Error Reporting</title> + <para>When you are developing your project, error checking is constantly provided. This + greatly reduces your development time as it allows you to catch many of the errors + during development.</para> + <para>Errors will be reported by <link linkend="jsf_project_verification"> + verification</link> facility:</para> + <figure float="0"> + <title>Error Reporting in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_29.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Other errors are also reported.</para> + <figure float="0"> + <title>Other Errors Reporting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_30.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + +</chapter> + + +<chapter id="managed_beans" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/managed_beans.xml"> + <?dbhtml filename="managed_beans.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Managed Beans</title> + + <para>There is lots of power to work with <property moreinfo="none">managed beans</property>.</para> + <itemizedlist> + <listitem> + <para>Add and generate code for new managed beans</para> + <itemizedlist> + <listitem> + <para>Generate code for attributes and getter/setter methods</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Add existing managed beans to JSF configuration file</para> + </listitem> + </itemizedlist> + + <para>Thus, in this section we will guides you through all this possibilities.</para> + + <section id="CodeGenerationForManagedBeans421"> + + <title>Code Generation for Managed Beans</title> + + <para>To start, create a new managed bean in JSF configuration file editor, in the Tree + view.</para> + <figure float="0"> + <title>Creation of New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_34.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When you define a new managed bean, make sure that <emphasis> + <property moreinfo="none">Generate Source Code</property> + </emphasis> is checked as shown in the figure below.</para> + </note> + <figure float="0"> + <title>New Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_35.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class has been generated you can open it for additional editing. There are + two ways to open the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class:</para> + + <itemizedlist> + <listitem> + <para>click on <emphasis> + <property moreinfo="none">Managed-Bean-Class</property> + </emphasis> link in the editor</para> + </listitem> + </itemizedlist> + <para>or</para> + <itemizedlist> + <listitem> + <para>right click the <emphasis> + <property moreinfo="none">managed bean</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Open Source</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Opening of Created Managed Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_36.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The generated Java source should look as follows:</para> + + <figure float="0"> + <title>Java Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_37.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can also generate source code for properties, also includes <emphasis role="italic"> + <property moreinfo="none">"getter"</property> + </emphasis> and <emphasis role="italic"> + <property moreinfo="none">"setter"</property> + </emphasis> methods. Right click on the bean and select <emphasis> + <property moreinfo="none">New > Property</property> + </emphasis>. You will see <property moreinfo="none">Add Property</property> dialog.</para> + <figure float="0"> + <title>Generation of Source Code for Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_38.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the form is open make sure that all the check boxes are selected:</para> + <itemizedlist> + <listitem> + <para>Add Java property</para> + </listitem> + <listitem> + <para>Generate Getter</para> + </listitem> + <listitem> + <para>Generate Setter</para> + </listitem> + </itemizedlist> + <para></para> + <figure float="0"> + <title>"Add Property" Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_39.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the generation is complete, you can open the file and see the added property with + <emphasis role="italic"> + <property moreinfo="none">"get"</property> + </emphasis> and <emphasis role="italic"> + <property moreinfo="none">"set"</property> + </emphasis> methods:</para> + <figure float="0"> + <title>Generated Java Source Code for Property</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_40.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus, we've discussed everything which comes to creating a new Managed Bean. + The next section will show you how to add an existing Bean into a JSF configuration + file.</para> + </section> + <section id="AddExistingJavaBeansToAJSFConfigurationFile74332"> + + <title>Add Existing Java Beans to a JSF Configuration File</title> + <para>If you already have a Java bean you can easily add it to a <property moreinfo="none">JSF configuration + file</property>.</para> + <para>You should start the same way you create a new managed bean. Use the <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to add your existing Java class.</para> + <figure float="0"> + <title>New Managed Bean Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_42.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Once the class is set, its <emphasis> + <property moreinfo="none">Name</property> + </emphasis> will be set as well. But you can easily substitute it for the other one. + Notice that <emphasis> + <property moreinfo="none">Generate Source Code</property> + </emphasis> option is not available as the <emphasis role="italic"> + <property moreinfo="none">"Java"</property> + </emphasis> class already exists. </para> + <para>After adding your class <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button will be activated. Pressing it you'll get <emphasis> + <property moreinfo="none">Managed Properties</property> + </emphasis> dialog where all corresponding properties are displayed. Check the necessary + ones to add them into your <property moreinfo="none">JSF Configuration File</property>.</para> + + <figure float="0"> + <title>Selection of Bean's Properties.</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_43.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you don't want to add any, just click <emphasis> + <property moreinfo="none">Finish</property>. </emphasis></para> + <para>Above-listed steps have demonstrated how you can specify an existing Bean in the JSF + configuration file, i.e. <emphasis> + <property moreinfo="none">faces-config.xml</property>. </emphasis> In the next chapter + you'll know how to organize and register another kind of artifacts.</para> + </section> +</chapter> + + +<chapter id="creation_and_registration" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/creation_and_registration.xml"> + <?dbhtml filename="creation_and_registration.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Creation and Registration</title> + + <section id="CreateAndRegisterACustomConverter94230"> + + <title>Create and Register a Custom Converter</title> + + <para>It's also possible to create a + custom Converter in order to specify your own converting rules. Let's look at how you can do this.</para> + + <para>To create and register a custom converter it's necessary to + go through the following steps:</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree</property> + </emphasis> tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_44.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Converters</property> + </emphasis> and click on<emphasis> + <property moreinfo="none"> Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the form type the name of your converter in the <emphasis> + <property moreinfo="none">Converter-id</property> + </emphasis> field and name of the class for + converters. After clicking <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button your custom converter is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add Converter Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_45.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Now you can create <emphasis role="italic"> + <property moreinfo="none">"converter"</property> + </emphasis> class. In the Converter section you + should see your <emphasis> + <property moreinfo="none">Converter-id</property> + </emphasis> and + <emphasis><property moreinfo="none">Converter-class</property>.</emphasis> + Click on <emphasis> + <property moreinfo="none">Converter-class</property> + </emphasis> to generate the source code.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Generation of Source Code for Converter Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_46.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>A usual wizard for creating a Java class will appear. + All needed fields here will be adjusted + automatically. Just leave everything without changes + and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_47.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open a converter class click again on <emphasis> + <property moreinfo="none">Converter-class</property> + </emphasis> link in the Converter section.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converter Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_48.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now you + are able to add a business logic of converter in the + Java editor.</para> + </section> + + <section id="CreateAndRegisterACustomValidator5632"> + + <title>Create and Register a Custom Validator</title> + + <para>It's also quite easy to develop your + own custom Validators. You should perform the actions similar to the + previous one. Go through the following steps:</para> + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property moreinfo="none"> faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Validator in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_49.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Validators</property> + </emphasis> and click on <emphasis> + <property moreinfo="none">Add </property> + </emphasis>button.</para> + </listitem> + <listitem> + <para>Type the name of your validator in the <emphasis> + <property moreinfo="none">Validator-id</property> + </emphasis> field and name of the class for + validators. After clicking <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button your custom validator is + registered under the entered name.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Adding Validator</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_50.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now you can create the "validator" class. </para> + <itemizedlist> + <listitem> + <para>In the Validator section you can see your <emphasis> + <property moreinfo="none">Validator-id</property> + </emphasis> and <emphasis> + <property moreinfo="none">Validator-class</property></emphasis>. To generate the source code click on <emphasis> + <property moreinfo="none">Validator-class</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Creating Validator Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_51.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_52.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open validator class click again on <emphasis> + <property moreinfo="none">Validator-Class</property> + </emphasis> link in the Validator section. Now you + are able to write a business logic of validator in + the Java editor.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Converter Class Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_53.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="referenced_beans"> + <title>Create and Register Referenced Beans</title> + + <para>Creation of Referenced Beans is similar to creation of Custom + Validator as well. To perform this, let's walk through the necessary steps.</para> + + <itemizedlist> + <listitem> + <para>In the Project Explorer view open<emphasis> + <property moreinfo="none"> faces-config.xml</property> + </emphasis> and select <emphasis> + <property moreinfo="none">Tree </property> + </emphasis>tab.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Referenced Beans in Faces Config Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_54.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Referenced Beans</property> + </emphasis> and click on <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Type in the name of your Referenced Bean and type in + or select <emphasis> + <property moreinfo="none">Referenced-Bean-Class</property> + </emphasis> by using <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add Referenced Bean</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_55.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the Referenced Bean section you should see your <emphasis> + <property moreinfo="none">Referenced-Bean-Name</property> + </emphasis> and + <emphasis><property moreinfo="none">Referenced-Bean-Class</property>.</emphasis> + Click on the link to open the Java creation + wizard.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create Referenced Bean Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_56.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Java class will be created automatically. Leave + everything without changes and click <emphasis> + <property moreinfo="none">Finish</property>. + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>New Java Class Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_57.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>To open Referenced Bean class click again on <emphasis> + <property moreinfo="none">Referenced-Bean-Class</property> + </emphasis> in the Referenced Bean section. Now you + are able to write business logic of Referenced Bean + in the Java editor.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Referenced Bean Class Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_58.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + +<chapter id="jsf_project_verification" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jsf/docs/jsf_tools_ref_guide/en/modules/jsf_project_verification.xml"> + <?dbhtml filename="struts_project_verification.html"?> + + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>JSF Project Verification</title> + + <para>In this chapter we'll discuss a possible verification that you can take advantage + of.</para> +  + <para>Many different rules are checked for a JSF project that can be configured by selecting <emphasis> + <property moreinfo="none">Window > Preferences</property> + </emphasis> from the menu bar, selecting <emphasis> + <property moreinfo="none">JBoss Tools > Web > Verification</property> + </emphasis> from the Preferences dialog box and then expanding the JSF Rules node.</para> + <figure float="0"> + <title>JSF Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Suppose you are working in the Source viewer for a JSF configuration file as shown below:</para> + <figure float="0"> + <title>Faces-config.xml File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>While typing a class name, you might make a minor typo (like <emphasis role="italic"> + <property moreinfo="none">"jsfHello.PersonBean9"</property> + </emphasis> instead of <emphasis role="italic"> + <property moreinfo="none">"jsfHello.PersonBean"</property> + </emphasis>). After saving the file, verification checks to make sure everything is correct + and finds the error below:</para> + <figure float="0"> + <title>Error in Source View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_3.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Notice that the Package Explorer View shows a marked folder and a marked file where the + error is.</para> + <para>You can place the cursor over the line with an error message and get a detailed error + message:</para> + <figure float="0"> + <title>Error Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Verification also checks navigation rules:</para> + <figure float="0"> + <title>Checking Navigation Rules</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>If you provide a page name that does not exist, verification will let you know about that:</para> + <figure float="0"> + <title>Page Name Verification</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>You can always call up verification explicitly by right-clicking any element in the tree + and selecting Verify from the context menu. This works from both the Tree and Diagram + viewers for the JSF configuration file editor. You can also invoke verification from the Web + Projects view. Below we are checking all of the elements in the configuration file.</para> + <figure float="0"> + <title>Verify Command</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/verif_valid/verif_valid_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In summary, this document highlights all the JSF-specific features of <property moreinfo="none">JBoss Tools</property> + meant for enhancing the development of rich Web applications based on JSF technology. The + reference introduces you to wizards for creating and importing JSF projects, JSF + Configuration File editor features, functionality for enabling JSF capabilities and etc.</para> + + <para>If you have questions or good suggestions, please refer to + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> +</chapter> + +</book> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/projects.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,403 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="projects"> + <?dbhtml filename="projects.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>JSF Tools</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Projects</title> + <para>To take an advantage of JSF firstly you should perform one of the next steps:</para> + + <itemizedlist> + <listitem> + <para>Create new JSF projects</para> + </listitem> + <listitem> + <para>Import (open) existing JSF projects</para> + </listitem> + <listitem> + <para>Add JSF capability to any existing Eclipse project</para> + </listitem> + <listitem> + <para>Import and add JSF capability to any existing project created outside + Eclipse.</para> + </listitem> + </itemizedlist> + <para>In this section we're going to stop on each of them in detail.</para> + + <section id="new_jsf_project"> + + <title>Creating a New JSF Project</title> + + <para>If you want your project to already contain all JSF libraries, tag libraries + and JSF configuration file, just organize a new brand JSF project. It is + possible to do this easily with the help of the special wizard. To get it, select<emphasis> + <property> File > New > Project > JBoos Tools + Web > JSF > JSF Project</property> + </emphasis> and click <emphasis> + <property>Next</property>.</emphasis></para> + + <figure> + <title>Choosing a JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form you'll be prompted to enter <property>Project + Name</property> and select a location for the project or just leave + a default path.</para> + <para>Here, JSF Version also allows you to select which JSF implementation to + use.</para> + <figure> + <title>Creating a New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_11.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>There is a number of predefined project templates that are flexible and easily + customizable. Thus you can pick a different template on which the projects + Importing Existing should be based on. Almost all templates come in two + variations: with jsf libraries and without ones.</para> + <figure> + <title>Choosing JSF Templates</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The table below provides description for each possible JSF template.</para> + <table> + <title>JSF Project Templates</title> + <tgroup cols="2"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + + + <thead> + <row> + <entry align="center"> + <para>Template</para> + </entry> + + <entry align="center"> + <para>Description</para> + </entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para> + <emphasis> + <property>JSFBlankWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will create a standard Web + project structure with all JSF capabilities</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property>JSFKickStartWithLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>This template will create a standard Web + project structure but will also include a sample + application that is ready to run</para> + </entry> + </row> + + <row> + <entry> + <para> + <emphasis> + <property>JSFKickStartWithoutLibs</property> + </emphasis> + </para> + </entry> + + <entry> + <para>Some servers already provide jsf libs and + you take risk of getting conflicting libraries + while deploying your project. To avoid such + conflicts, use a template without libs if you have + a server with its own jsf libraries</para> + </entry> + </row> + + </tbody> + </tgroup> + </table> + + +  + + <para>On the next screen select what <emphasis> + <property>Servlet version</property> + </emphasis> to use and whether to register this application with JBoss AS + (or other server) for running and testing your application.</para> + + <para>The <emphasis> + <property>Context Path</property> + </emphasis> is the name under which the application will be deployed.</para> + + <para>The <emphasis> + <property>Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries in order to + build (compile) the project. It is not possible to finish project creation + without selecting Runtime. If you don't have any values, select <emphasis> + <property>New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property>Target Server</property> + </emphasis> allows you specifying whether to deploy the application. The + Target Server corresponds to the Runtime value selected above. If you + don't want to deploy the application, uncheck this value.</para> + <figure> + <title>Registering the Project on Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_14.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>When you are all done, you should have the project that has been appeared in + the Package Explorer view:</para> + <figure> + <title>A New Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_15.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>At this point you can open <emphasis> + <property>faces-config.xml</property> + </emphasis> and start working on your application. There are a lot of + features to develop JSF applications. We will describe the features + further.</para> + </section> + + <section id="ImportingExsJSFProjWithAnyStr74447"> + + <title>Importing Existing JSF Projects with Any Structure</title> + + <para>For detailed information on migration of JSF projects into a workspace see the Migration + Guide.</para> + + </section> + <section id="add_jsf_capability"> + + <title>Adding JSF Capability to Any Existing Eclipse Project</title> + + <para>It's also possible to add <property>JSF capability</property> (JSF + libraries, tag libraries) to any existing Eclipse project in your workspace. + After that you'll be able to make use of such editors as JSF + configuration editor, JBoss Tools JSP editor and any others.</para> + <para>Right click the project and select <emphasis> + <property>JBoss Tools > Add JSF Capabilities</property>. </emphasis> + This will start the process of adding all necessary libraries, files to make + this a Web JSF project.</para> + <figure> + <title>Adding JSF Capabilities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_16.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The wizard will first ask you to show the <emphasis> + <property>web.xml</property> + </emphasis> file location and the project name.</para> + <figure> + <title>Project Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>On the last form you can set the different folders for your project as well as + register this application with a servlet container.</para> + + <para>Make sure to select <emphasis> + <property>Add Libraries</property> + </emphasis> to add all required JSF related libraries to this + project.</para> + + <para>The <emphasis> + <property>Context Path</property> + </emphasis> is the name under which the application will be deployed.</para> + + <para>The <emphasis> + <property>Runtime</property> + </emphasis> value tells Eclipse where to find Web libraries in order to + build (compile) the project. It is not possible to finish project import + without selecting Runtime. If you don't have any values, select <emphasis> + <property>New...</property> + </emphasis> to add new Runtime.</para> + + <para>The <emphasis> + <property>Target Server</property> + </emphasis> allows you to specify whether to deploy the application. The + Target Server corresponds to the Runtime value selected above. If you + don't want to deploy the application, uncheck this value.</para> + <figure> + <title>Project Folders</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_18.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Once your project is imported you can see that JSF related libraries have been + added to your project: <emphasis> + <property>jsf-api.jar</property> + </emphasis> and <emphasis> + <property>jsf-impl.jar</property> + </emphasis>.</para> + <note> + <title>Note:</title> + <para>Some application servers provide their own jsf implementation + libraries. Thus, to avoid conflicts you should not add jsf libraries + while adding jsf capabilities.</para> + </note> + <para>You are now ready to work with JSF by creating a new JSF configuration + file:</para> + + + <figure> + <title>Creating a New JSF Configuration File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the file has been created, it should be opened in a special <link + linkend="jsf_config_file">Faces Config Editor</link>.</para> + </section> + <section id="AddingYourOwnProjectTemplates853"> + + <title>Adding Your Own Project Templates</title> + <para>Template is a set of files that is served as a basis to facilitate the + creation of a new project. Project templates provide content and structure + for a project.</para> + <para>There is a powerful templating capability for creating new and importing + existing Struts and JSF projects. This templating facility has a variety of + aspects to consider. But, let's start with the most straightforward + case and consider the process of creating a template from your existing JSF + project.</para> + + <para>Let's say you have a project that you want to use as the basis for a + new <property>template</property>. Follow these steps to make a template out + of it:</para> + <itemizedlist> + <listitem> + <para>In the Web Projects view, right-click the project and select <emphasis> + <property>JBoss Tools JSF > Save As + Template</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Saving Your Project as Template</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the first dialog box, you can choose a name for the + template (defaults to the project name) and confirm what + run-time implementation of the project technology will be + used</para> + </listitem> + + </itemizedlist> + <figure> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_1.png" + /> + </imageobject> + </mediaobject> + </figure> + + + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Next</property> + </emphasis> and you will be sent to a dialog box with your + project structure displayed with check boxes. Here you can + check only those parts and files in your project directory + that should be part of the template</para> + </listitem> + </itemizedlist> + <figure> + <title>Define Template Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsf_support/jsf_support_20_2.png" + /> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>At this point, unless you want to designate some extra files + as having Velocity template coding inside them, you should + click <emphasis> + <property>Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <para>That's it. Now, you can use this template with any new or imported + project that uses the same run-time implementation as the project you turned + into a template.</para> + <para>At this point, you have a fully configured project and now you can bring some + new logic to it starting from JSF configuration file.</para> + </section> + <section> + <title>Relevant Resources Links</title> + + <para>You can find more in-depth explanation on how to work with special wizards, editors and views that can + be used in various scenarios while developing JSF applications in our Visual Web Tools Guide.</para> + </section> +</chapter> Added: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/en-US/webxml_editor.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,21 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="webxml_editor" xreflabel="webxml_editor"> + <?dbhtml filename="webxml_editor.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>JSF Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Web.xml Editor</title> + + <para>The <emphasis> + <property>web.xml</property></emphasis> file inside the <emphasis> + <property>WEB-INF</property></emphasis> folder is a deployment descriptor file for a Web Application. It + describes the servlets and other components and deployment properties that make up your application.</para> + + <para><property>JBoss Tools</property> add the <emphasis> + <property>web.xml</property></emphasis> file to created JSF project automatically and provides a special editor for its editing. + See the Visual Web Tools guide that gives a descriptive information on the <filename>web.xml</filename> editor.</para> +</chapter> \ No newline at end of file Modified: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2010-03-12 00:30:28 UTC (rev 20781) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/pom.xml 2010-03-12 00:38:36 UTC (rev 20782) @@ -23,7 +23,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -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: branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/jsf/docs/jsf_tools_ref_guide/publican.cfg 2010-03-12 00:38:36 UTC (rev 20782) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

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

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:30:28 -0500 (Thu, 11 Mar 2010) New Revision: 20781 Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/jmx/docs/reference/en/ Modified: branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml Log: modified to build with publican Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Author_Group.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>JBoss Tools Team</firstname></author></authorgroup> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Book_Info.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>JMX Tools Reference Guide</title><subtitle>Provides information relating to the JMX Tools module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JMX Tools Reference Guide explains how to use the JMX Tools module to setup multiple JMX connections and explore the JMX tree and execute operations.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.ent 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JMX_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/JMX_Tools_Reference_Guide.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,19 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="references.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="summary.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> + +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Preface.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><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: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/Revision_History.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/collaps_all.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/eclipse-jmx_0.2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/link-with-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-horizontal-layout_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor-layout-buttons_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-editor_0.2.0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/mbean-explorer-query.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/new_connection_icon.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/images/notifications.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/introduction.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,104 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="intruduction" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + + <title>Introduction</title> + <para><property>JBoss Tools</property>' 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>JMX Tools</property> allows to setup multiple JMX connections and provides view + for exploring the JMX tree and execute operations directly from Eclipse.</para> + + <para>This chapter covers the basics of working with <property>JMX plugin</property>, which is + used to manage Java applications through JMX and its RMI Connector.</para> + + <figure> + <title>JMX Tools</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/eclipse-jmx_0.2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section><title>Key Features of JMX Tools</title> + <para>For a start, we propose you to look through the table of main features of JMX Tools:</para> + <table> + + <title>Key Functionality for JMX Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + <colspec colnum="3" align="left" colwidth="2*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry><para>MBean Explorer</para></entry> + <entry><para>MBean Explorer is a useful view with a text filter that displays domains, mbeans, attributes, and operations inside a connection.</para></entry> + <entry> + <link linkend="mbean_explorer">MBean Explorer</link> + </entry> + </row> + + <row> + <entry><para>MBean Editor</para></entry> + <entry><para>MBean Editor is a multi-page editor to manage MBeans.</para></entry> + <entry> + <link linkend="mbean_editor">MBean Editor</link> + </entry> + </row> + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Requirements and Installation</title> + <section> + <title> Requirements</title> + <para>Requirements to use <property>JMX Tools</property> are the following:</para> + + <itemizedlist> + <listitem> + <para><property>JMX Tools</property> is developed on Eclipse 3.4.x milestones</para> + </listitem> + <listitem> + <para><property>JMX Tools</property> requires that Eclipse is run on a JDK 1.5.0 or above + (due to dependencies on JMX packages which were introduced in Java 1.5.0)</para> + </listitem> + </itemizedlist> + </section> + <section> + <title>Installation</title> + <para>Here, we are going to explain how to install the <property>JMX plugin</property> into + Eclipse.</para> + + <para><property>JMX Tools</property> is one module of the <property>JBoss Tools</property> + project. <property>JMX Tools</property> has no dependency on any other part of <property>JBoss + Tools</property>, and can be downloaded standalone. Even though the <property>JMX + Tools</property> have no dependencies, other plugins, such as <property>AS Tools</property>, + do depend on the JMX Tooling and even extend it. </para> + + <para>You can find the <property>JBoss Tools</property> plugins over at the <ulink + url="http://labs.jboss.com/tools/download.html">download pages</ulink>. The only + package you'll need to get is the JMX Tooling, however the <property>AS + Tools</property> would give you a more full experience when using JMX with JBoss Servers. + You can find further download and installation instructions on the JBoss Wiki in the <ulink + url="http://labs.jboss.com/wiki/InstallingJBossTools">InstallingJBossTools</ulink> + section.</para> + </section> + </section> +</chapter> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,74 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "mbean_editor.xml"> +<!ENTITY connection SYSTEM "connection.xml"> +<!ENTITY how_to SYSTEM "how_to.xml"> +<!ENTITY extensions SYSTEM "extensions.xml"> +<!ENTITY tasks SYSTEM "tasks.xml"> +<!ENTITY references SYSTEM "references.xml"> +<!ENTITY summary SYSTEM "summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]> + +<book> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 1.1.0.GA + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_guide/pdf/JM...">PDF version</ulink> + </para> +</abstract> + </bookinfo> + + <toc/> + &introduction; + &tasks; + &references; + &summary; +  + +</book> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/master_output.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,634 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY mbean_explorer SYSTEM "modules/mbean_explorer.xml"> +<!ENTITY mbean_editor SYSTEM "modules/mbean_editor.xml"> +<!ENTITY connection SYSTEM "modules/connection.xml"> +<!ENTITY how_to SYSTEM "modules/how_to.xml"> +<!ENTITY extensions SYSTEM "modules/extensions.xml"> +<!ENTITY tasks SYSTEM "modules/tasks.xml"> +<!ENTITY references SYSTEM "modules/references.xml"> +<!ENTITY summary SYSTEM "modules/summary.xml"> +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JMX Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.GA + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jmx_ref_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> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/references.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,170 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="references" xreflabel="references"> + <?dbhtml filename="references.html"?> + <title>References</title> + + <section id="mbean_explorer" xreflabel="mbean_explorer"> + <?dbhtml filename="mbean_explorer.html"?> + + <title>MBean Explorer</title> + <para>The <property>MBean Explorer</property> displays the MBean features (both attributes and operations) in its + hierarchy. Double-clicking on a feature will open a <property>MBean Editor</property>, display the page + corresponding to the feature type and select the feature.</para> + + <figure> + <title>MBean Explorer Features</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-explorer-features.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Since it'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> + + </section> + <section id="mbean_editor" xreflabel="mbean_editor"> + <?dbhtml filename="mbean_editor.html"?> + + <title>MBean Editor</title> + + <figure> + <title>MBean Editor Pages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>MBean Editor</property> is composed of several pages:</para> + + <itemizedlist> + <listitem> + <para>the <emphasis> + <property>Attributes</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Operations</property></emphasis> page</para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Notifications</property></emphasis> page </para> + </listitem> + <listitem> + <para>the <emphasis> + <property>Info</property></emphasis> page </para> + </listitem> + </itemizedlist> + + <para> The <emphasis> + <property>Attributes</property> + </emphasis> and <emphasis> + <property>Operations</property> + </emphasis> pages display a list for either the MBean attributes or operations as well as + details for the selection.</para> + + <para> It is possible to toggle the layout between the list and the details either vertically + (by default) or horizontally with the help of the special icons + + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-layout-buttons_0.2.0.png"/> + </imageobject> + </inlinemediaobject> + + in the right top corner of the editor.</para> + + <figure> + <title>MBean Editor Horizontal Layout</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png"/> + </imageobject> + </mediaobject> + </figure> + <figure id="figu-Beginners_Guide-Visual_Web_Tools-Visual_Page_Editor"> + <title>Visual Page Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/mbean-editor-horizontal-layout_0.2.0.png" format="PNG" width="444" /> + </imageobject> + <textobject> + <phrase> + The Visual Page Editor, showing both the source and a visual preview simultaneously. + </phrase> + </textobject> + </mediaobject> + </figure> + <section> + <title>Notifications Page</title> + <para>One more page in the <property>MBean Editor</property> is the <emphasis> + <property>Notifications</property></emphasis> page, which gives the possibility to + subscribe (resp. unsubscribe) to a MBean to receive its notifications by checking (resp. + unchecking) the <emphasis> + <property>Subscribe</property></emphasis> button in the right top corner. </para> + <para>The list of notifications is refreshed every time a new notification is + received:</para> + + <figure> + <title>MBean Editor Notifications Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/notifications.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note</title> + <para>It is only possible to subscribe to MBean, which emits notifications (they must be + NotificationBroadcaster).</para> + </note> + + </section> + + </section> + + </chapter> Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/summary.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,32 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter> + <?dbhtml filename="summary.html"?> + <title>Summary</title> + <para>In conclusion, with this document you could easily start with JXM Tools. + The chapters above walked you through the steps on how to do Tomcat,Eclipse Equinox or JBoss Instances managing and how to create new JMX connections. + The document also includes the reference of JMX Tools features. + + If you have questions or suggestions concerned both the documentation and tools behavior, + you are welcome to JBoss Tools Users forum. + Please, use Jira to report bugs and requests on documentation.</para> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at + <ulink url="http://docs.jboss.org/tools">http://docs.jboss.org/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> \ No newline at end of file Added: branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/en-US/tasks.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,259 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="tasks" xreflabel="tasks"> + <?dbhtml filename="tasks.html"?> + <title>JMX Tools Tasks</title> + <para>This chapter will give you answers on most popular questions asked by <property>JMX + plugin</property> users.</para> + <section> + <title>Quick Start</title> + + <para>To start using the <property>JMX Tools</property>, it's necessary to open + <property>MBean Explorer</property>. Go to <emphasis><property>Window > Show View > Other</property></emphasis> and then select + <property>MBean Explorer</property> and click <emphasis><property>OK</property>.</emphasis></para> + + <para>The <property>MBean Explorer</property> lists all of the domains, mbeans, attributes, and operations inside a + connection. When you double-click on a MBean in the <emphasis><property>MBean Explorer</property>,</emphasis> it opens a multi-page + editor to manage the MBean. The <property>MBean Editor</property> is composed of these pages:</para> + + <itemizedlist> + <listitem> + <para><emphasis><property>Attributes page</property>,</emphasis> to get/set the attributes of the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Operations page</property>,</emphasis> to invoke operations on the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Notifications page</property>,</emphasis> to receive notifications from the MBean</para> + </listitem> + <listitem> + <para><emphasis><property>Info page</property>,</emphasis> which displays general information about the MBean </para> + </listitem> + </itemizedlist> + + </section> + <section> + <title>Tomcat Managing</title> + + <para>It'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>Eclipse Equinox Managing</title> + + <para>You can manage Equinox through the Equinox monitoring framework.</para> + <para>Once you have installed the Equinox monitoring framework and restarted Eclipse:</para> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property>Window > 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> + <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>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> + </section> +</chapter> + Modified: branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-12 00:27:27 UTC (rev 20780) +++ branches/jbosstools-3.1.x/jmx/docs/reference/pom.xml 2010-03-12 00:30:28 UTC (rev 20781) @@ -20,11 +20,20 @@ <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> </properties> </profile> - + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../documentation/jbosstools-jdocbook-style/src/main/com/css/</cssdir> + </properties> + </profile> <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -88,9 +97,9 @@ <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/jmx/docs/reference/publican.cfg 2010-03-12 00:30:28 UTC (rev 20781) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20780 - in branches/jbosstools-3.1.x/as/docs/reference: en-US and 7 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:27:27 -0500 (Thu, 11 Mar 2010) New Revision: 20780 Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/ branches/jbosstools-3.1.x/as/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/images/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/favicon.ico branches/jbosstools-3.1.x/as/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_4.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_6.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_7.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2_a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets4.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_10.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_11.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_12.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_13.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_14.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_15.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_16.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_17.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_18.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_19.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_20.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_22.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23b.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23c.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_25.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_26.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_4.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_6.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_7.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_8.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_9.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/projectarchives_error.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/server_classpaths.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/hotkeys.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/publish_button.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4b.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_6.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_7.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_8.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/ branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_1.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_2.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_3.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_4.png branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_5.png branches/jbosstools-3.1.x/as/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/modules.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/perspective.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/quick_start.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/runtimes_servers.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/tptp_support.xml branches/jbosstools-3.1.x/as/docs/reference/en-US/webtools.xml branches/jbosstools-3.1.x/as/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/as/docs/reference/en/ Modified: branches/jbosstools-3.1.x/as/docs/reference/pom.xml Log: updated to build with publican Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/Author_Group.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/Book_Info.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.ent 2010-03-12 00:27:27 UTC (rev 20780) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JBoss_Server_Manager_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/JBoss_Server_Manager_Reference_Guide.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/Preface.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/Revision_History.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/modules/modules_8_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/dnd_toJBossServerView.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2_a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets2_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/filesets5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_18.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_19.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_20.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_21a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_22.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_23c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_24a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_25.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_25.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_26.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_26.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/perspective_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/projectarchives_error.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/projectarchives_error.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/server_classpaths.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/server_classpaths.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/perspective/userlibraryfileset2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/hotkeys.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/hotkeys.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/publish_button.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/publish_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_4b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/quick_start/quick_start_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_4c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/runtimes_servers/runtimes_servers_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/tptp_support/tptp_support_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/as/docs/reference/en-US/images/webtools/webtools_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/as/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/master.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/master_output.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -0,0 +1,2350 @@ +<?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> + + <pubdate>April 2008</pubdate> + <copyright> + <year>2007</year> + <year>2009</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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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><diffmk:wrapper diffmk:change="changed">Key Functionality for JBoss AS and Archive Tools</diffmk:wrapper></title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + <colspec align="left" colnum="3" colwidth="2*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + <tbody> + <row> + <entry><para>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><diffmk:wrapper diffmk:change="changed">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 </diffmk:wrapper><link linkend="runtimes_servers">Runtimes and Servers in the JBoss AS plugin</link><diffmk:wrapper diffmk:change="changed"> + chapter.</diffmk:wrapper></para> + + <para>To start working with JBoss AS, select a <property moreinfo="none">JBoss AS Perspective</property><diffmk:wrapper diffmk:change="changed"> via + </diffmk:wrapper><emphasis><property moreinfo="none"><diffmk:wrapper diffmk:change="changed">Window > Open Perspective > Other > JBoss + AS</diffmk:wrapper></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 diffmk:change="added" id="publishing"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Publishing to JBoss Server</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">The publishing of all the modules added to a Server is performed automatically when starting a Server.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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 </diffmk:wrapper><link diffmk:change="added" linkend="server_editor"><diffmk:wrapper diffmk:change="added">Server Editor</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> and use the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Publish to Server</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> (</diffmk:wrapper><inlinemediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/quick_start/publish_button.png"></imagedata> + </imageobject> + </inlinemediaobject><diffmk:wrapper diffmk:change="added">) button which initiates an incremental publish. + </diffmk:wrapper></para> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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.</diffmk:wrapper></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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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 diffmk:change="added"><diffmk:wrapper diffmk:change="added">Under the </diffmk:wrapper><emphasis diffmk:change="added"> + <property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Publishing</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> section it' possible to disable/inable the automatic publishing of the changes in the workspace.</diffmk:wrapper></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, 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>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>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 diffmk:change="added" id="CreatingaUserLibrariesFileSet"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Creating User Library FileSet</diffmk:wrapper></title> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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.</diffmk:wrapper></para> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To add a new user libraries file set, call the right-click menu on the necessary archive and choose " New User Libraries FileSet" item</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Adding New User Library Fileset</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/perspective/userlibraryfileset1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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</diffmk:wrapper></para> + + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Editing User Library Fileset</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" 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> + </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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/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: branches/jbosstools-3.1.x/as/docs/reference/en-US/modules.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/modules.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/modules.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/perspective.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/perspective.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/perspective.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -0,0 +1,1242 @@ +<?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> + </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: branches/jbosstools-3.1.x/as/docs/reference/en-US/quick_start.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/quick_start.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/quick_start.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/runtimes_servers.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/runtimes_servers.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/runtimes_servers.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/tptp_support.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/tptp_support.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/tptp_support.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/en-US/webtools.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/en-US/webtools.xml (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/en-US/webtools.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -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: branches/jbosstools-3.1.x/as/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/pom.xml 2010-03-12 00:27:21 UTC (rev 20779) +++ branches/jbosstools-3.1.x/as/docs/reference/pom.xml 2010-03-12 00:27:27 UTC (rev 20780) @@ -32,7 +32,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -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: branches/jbosstools-3.1.x/as/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/as/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/as/docs/reference/publican.cfg 2010-03-12 00:27:27 UTC (rev 20780) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20779 - branches/jbosstools-3.1.x/jbpm/docs/reference.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:27:21 -0500 (Thu, 11 Mar 2010) New Revision: 20779 Added: branches/jbosstools-3.1.x/jbpm/docs/reference/publican.cfg Log: added publican config file Added: branches/jbosstools-3.1.x/jbpm/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/jbpm/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/jbpm/docs/reference/publican.cfg 2010-03-12 00:27:21 UTC (rev 20779) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20778 - in branches/jbosstools-3.1.x/portlet/docs/reference: en-US and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:23:23 -0500 (Thu, 11 Mar 2010) New Revision: 20778 Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/portlet/docs/reference/en/ Modified: branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml Log: updated to build with publican Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Author_Group.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Book_Info.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.ent 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "JBoss_Portlet_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/JBoss_Portlet_Tools_User_Guide.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Preface.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/Revision_History.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet2a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/jsf_portlet/jsf_portlet9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/javaPortlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/jsf_seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/reference/portlet_preferences.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/seam_portlet/seam_portlet7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/portlet_capabilities6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/runOnServer.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/server_runtime_environment.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_4_a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/images/starting_project/starting_project_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/intro.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,124 @@ +<?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 id="preface"> + <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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/jsf_portlet.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/master_output.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/portlet_tools_tasks.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,10 @@ +<?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> \ No newline at end of file Added: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/reference.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/seam_portlet.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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, + 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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/starting_project.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/en-US/summary.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml 2010-03-12 00:20:34 UTC (rev 20777) +++ branches/jbosstools-3.1.x/portlet/docs/reference/pom.xml 2010-03-12 00:23:23 UTC (rev 20778) @@ -32,7 +32,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -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: branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/portlet/docs/reference/publican.cfg 2010-03-12 00:23:23 UTC (rev 20778) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20776 - in branches/jbosstools-3.1.x/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-11 19:12:45 -0500 (Thu, 11 Mar 2010) New Revision: 20776 Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Author_Group.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Book_Info.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Preface.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Revision_History.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_editor.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_support.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/favicon.ico branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/introduction.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master_output.xml branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/publican.cfg Removed: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en/ Modified: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/pom.xml Log: updated to use publican -This line, and those below, will be ignored-- D esb_ref_guide/en A esb_ref_guide/en-US A esb_ref_guide/en-US/introduction.xml A esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml A esb_ref_guide/en-US/esb_support.xml A esb_ref_guide/en-US/Preface.xml A esb_ref_guide/en-US/Book_Info.xml A esb_ref_guide/en-US/images A esb_ref_guide/en-US/images/esb_project AM esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png AM esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png AM esb_ref_guide/en-US/images/esb_project/02_create_esb.png AM esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png AM esb_ref_guide/en-US/images/esb_project/21_source.png AM esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png AM esb_ref_guide/en-US/images/esb_project/15AddNew.png AM esb_ref_guide/en-US/images/esb_project/22_Javadoc.png AM esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png AM esb_ref_guide/en-US/images/esb_project/25_esb_file.png AM esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png AM esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png AM esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png AM esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png AM esb_ref_guide/en-US/images/esb_project/23_finger_touch.png AM esb_ref_guide/en-US/images/esb_project/24_export_button.png AM esb_ref_guide/en-US/images/esb_project/26_esb_export.png AM esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png AM esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png AM esb_ref_guide/en-US/images/esb_project/18_select_libraries.png AM esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png AM esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png AM esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png AM esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png AM esb_ref_guide/en-US/images/esb_project/20_classpath_container.png AM esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png AM esb_ref_guide/en-US/images/esb_project/19_select_runtime.png A esb_ref_guide/en-US/images/esb_editor AM esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png AM esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png AM esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png AM esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png AM esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png AM esb_ref_guide/en-US/images/esb_editor/10_esb_features.png AM esb_ref_guide/en-US/images/esb_editor/08_esb_features.png AM esb_ref_guide/en-US/images/esb_editor/openOn1.png AM esb_ref_guide/en-US/images/esb_editor/09_esb_features.png AM esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png AM esb_ref_guide/en-US/images/esb_editor/openOn2.png AM esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png AM esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png AM esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png AM esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png AM esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png AM esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png AM esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png AM esb_ref_guide/en-US/images/jbosstools_logo.png A esb_ref_guide/en-US/images/esb_support AM esb_ref_guide/en-US/images/esb_support/01_create_esb.png AM esb_ref_guide/en-US/images/esb_support/02_create_esb.png AM esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png AM esb_ref_guide/en-US/images/favicon.ico A esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent A esb_ref_guide/en-US/master.xml A esb_ref_guide/en-US/master_output.xml A esb_ref_guide/en-US/Author_Group.xml A esb_ref_guide/en-US/Revision_History.xml A esb_ref_guide/en-US/esb_editor.xml M esb_ref_guide/pom.xml A esb_ref_guide/publican.cfg Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Author_Group.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Book_Info.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.ent 2010-03-12 00:12:45 UTC (rev 20776) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "ESB_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/ESB_Tools_Reference_Guide.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Preface.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/Revision_History.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_editor.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_editor.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_editor.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_support.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_support.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/esb_support.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01_esb_tree_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01a_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/01b_esb_tree_view_and_links.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/02_esb_source_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/03_esb_outline_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/04_esb_add_provider.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/05_esb_add_service.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06_esb_add_listener.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/06a_esb_filter.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/08_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/09_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/10_esb_features.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/11_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/12_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/13_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/14_esb_editor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_editor/openOn2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/01_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/02a_create_esb_project.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/03_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/04_create_esb_project.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/05_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/06_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/07_esb_project_example.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/08_esb_project_deploy.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/09_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/10_esb_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/11_esb_runtime_new.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/13NewServerRuntimeEnv.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/14typeOfRuntime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/15AddNew.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/16HelloworldProjects.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/17_Add_new_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/18_select_libraries.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/19_select_runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/20_classpath_container.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/21_source.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/22_Javadoc.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/23_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/24_export_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/25_esb_file.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_project/26_esb_export.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/01_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02_create_esb.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/esb_support/02a_create_esb_project.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/introduction.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/en-US/master_output.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/pom.xml =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/pom.xml 2010-03-12 00:08:45 UTC (rev 20775) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/pom.xml 2010-03-12 00:12:45 UTC (rev 20776) @@ -23,7 +23,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -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: branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/esb/docs/esb_ref_guide/publican.cfg 2010-03-12 00:12:45 UTC (rev 20776) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20775 - in branches/jbosstools-3.1.x/drools/docs/reference: en-US and 5 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:08:45 -0500 (Thu, 11 Mar 2010) New Revision: 20775 Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/ branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg Removed: branches/jbosstools-3.1.x/drools/docs/reference/en/ Modified: branches/jbosstools-3.1.x/drools/docs/reference/pom.xml Log: updated to use publican Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Author_Group.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Book_Info.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.ent 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Drools_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Drools_Tools_Reference_Guide.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Preface.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/Revision_History.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/create_new_project.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/debugging_rules.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/editors.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/create_new_project/create_new_project9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/debugging_rules/debugging_rules3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1e.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1f.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors1g.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/editors9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/editors/icon9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/drools/docs/reference/en-US/images/views/views1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/introduction.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/master.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/master_output.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/en-US/views.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -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: branches/jbosstools-3.1.x/drools/docs/reference/pom.xml =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-12 00:02:01 UTC (rev 20774) +++ branches/jbosstools-3.1.x/drools/docs/reference/pom.xml 2010-03-12 00:08:45 UTC (rev 20775) @@ -11,35 +11,45 @@ <name>Drools_Tools_Reference_Guide</name> <profiles> - <profile> - <id>release</id> - <properties> - <master>master_output.xml</master> - <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> - <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> - <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> - </properties> - </profile> - <profile> - <id>releaseJBDS</id> - <properties> - <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> - <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> + <profile> + <id>release</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseTest</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/org/jboss/tools/xhtml-single-release-nomarker.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/org/jboss/tools/xhtml-release-nomarker.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/org/jboss/tools/pdf.xsl</xsl-pdf> + </properties> + </profile> + <profile> + <id>releaseJBDS</id> + <properties> + <master>master_output.xml</master> + <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> + <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> + <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> + <cssdir>../../../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> @@ -85,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: branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/reference/publican.cfg 2010-03-12 00:08:45 UTC (rev 20775) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20774 - branches/jbosstools-3.1.x/drools/docs/guvnor_ref.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 19:02:01 -0500 (Thu, 11 Mar 2010) New Revision: 20774 Added: branches/jbosstools-3.1.x/drools/docs/guvnor_ref/publican.cfg Log: added needed publican file Added: branches/jbosstools-3.1.x/drools/docs/guvnor_ref/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/drools/docs/guvnor_ref/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/drools/docs/guvnor_ref/publican.cfg 2010-03-12 00:02:01 UTC (rev 20774) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20773 - in branches/jbosstools-3.1.x/documentation/guides/MigrationGuide: en-US and 1 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 18:58:46 -0500 (Thu, 11 Mar 2010) New Revision: 20773 Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Author_Group.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Book_Info.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.ent branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Preface.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Revision_History.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds2.png branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds4.png branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs2.png branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs4.png branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/migration-guide-step-1.png branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/introduction.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/issues.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/master.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/migration.xml branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/publican.cfg Removed: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en/ Modified: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/pom.xml Log: modified book to build with publican Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Author_Group.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>JBoss Tools Team</firstname></author></authorgroup> Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Book_Info.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -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>Migration Guide</title><subtitle>JBoss Developer Studio 2.1 to 3.0.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The JBoss Developer Studio Migration Guide explains how to migrate from the previous version of the JBoss Developer Studio to the latest version.</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: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.ent 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Migration_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Migration_Guide.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -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="migration.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="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> +</book> Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Preface.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -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: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/Revision_History.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -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: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds2.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jbds4.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs2.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/jdbs4.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/migration-guide-step-1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/images/migration-guide-step-1.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/introduction.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/introduction.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/introduction.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,27 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="introduction" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Introduction </title> + <para>This document is intended to help you to easily migrate from 2.1 to 3.0.0 + <property>JBoss Developer Studio</property>. + It also describes some popular issues that can appear while the process of migration, + as well as the methods of their solving. </para> + + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio release documentation you can find at <ulink url="http://www.redhat.com/docs/en-US/JBoss_Developer_Studio/">http://www.redhat.com/docs/en-US/JBoss_Developer_Studio</ulink> in the corresponding release directory.</para> + <para>For more information about JBoss Developer Studio please visit + <ulink url="http://www.jboss.com/products/devstudio/">http://www.jboss.com/products/devstudio/</ulink>.</para> + <para>If your problem is not described in the guide or you have questions or suggestions concerned both the documentation and studio behavior, you are welcome at <ulink url="http://community.jboss.org/en/jbossdevstudio?view=discussions">JBoss Users forum</ulink>. + </para> + </section> +</chapter> Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/introduction.xml ___________________________________________________________________ Name: svn:executable + * Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/issues.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/issues.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/issues.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,59 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="issues" xreflabel="issues"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + </keywordset> + </chapterinfo> + + <title>Possible issues</title> + <para>In this chapter you will find a list of most popular + issues that can appear while the process of migration. + </para> + + + <section> + <title>Visual Editor starts with "Missing Natures" message dialog</title> + <para>While opening existing projects or creating new ones + with some standard eclipse wizards this message can appear:</para> + <figure> + <title>"Missing Natures" message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jbds4.png" /> + </imageobject> + </mediaobject> + </figure> + <para>This message shows that some functionality of Visual Editor may not work if a project + doesn't have org.jboss.tools.jsf.jsfnature or org.jboss.tools.jst.web.kb.kbnature + in .project configuration. To fix this problem and turn off the message box execute the following steps:</para> + <itemizedlist> + <listitem><para>Right click the project in Package Explorer.</para></listitem> + <listitem><para>Select <property>Configure -> Add JSF Capabilities</property> from the context menu.</para></listitem> + <listitem><para>Configure your project using Add JSF Capabilities wizard and press <property>Finish</property></para></listitem> + </itemizedlist> + </section> + + + <section> + <title>Visual Editor doesn't start and "XPCOM error -2147467259" appears</title> + <para>This error shows that you have problems with your buildin XULRunner plugin.To resolve the issue,please: </para> + <itemizedlist> + <listitem><para>Open <property>Help -> About JBoss Developer Studio-> Installation Details... -> Configuration</property></para></listitem> + <listitem><para>find org.eclipse.swt.browser.XULRunnerPath and open this path in terminal</para></listitem> + <listitem><para>try xulrunner.exe -version or ./xulrunner -version command and you will see what is needed for XULRunner to work</para></listitem> + </itemizedlist> + </section> + <section> + <title>Problems with <emphasis>not "JBDS"</emphasis> plugins</title> + <para>Some additional plugins that are not supplied by JBDS and work on JBDS 2.X may not work on 3.0.0.GA.</para> + <itemizedlist> + <listitem><para>To solve the problem check whether the plugin is compatible with Eclipse 3.5.</para></listitem> + <listitem><para>But because such pugins are not supported by JBDS, we can not guarantee its proper work.</para></listitem> + </itemizedlist> + </section> + +</chapter> Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/issues.xml ___________________________________________________________________ Name: svn:executable + * Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/master.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,30 @@ +<?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 migration SYSTEM "migration.xml"> +<!ENTITY issues SYSTEM "issues.xml"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> + +]> + +<book> + <bookinfo> + <title>JBoss Developer Studio 2.1 to 3.0 Migration Guide</title> + + + <copyright> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> +Version: 3.0.0.GA +</releaseinfo> + </bookinfo> + + <toc/> +&introduction; +&migration; +&issues; +</book> Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/master.xml ___________________________________________________________________ Name: svn:executable + * Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/migration.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/migration.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/migration.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,56 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsf_struts" xreflabel="jsf_struts"> + <?dbhtml filename="jsf_struts.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JBDS</keyword> + <keyword>Exadel Studio Pro</keyword> + <keyword>Migration</keyword> + </keywordset> + </chapterinfo> + + <title>Migration Process</title> + <para>In this chapter you can find concise description of JBoss Developer Studio migration from + 2.1.0 to 3.0.0 version.</para> + <section id="migration"> + <title>How to migrate from 2.1 to 3.0.0 JBoss Developer Studio</title> + <para></para> + <para>To migrate from 2.1 to 3.0.0 you have to install a fresh JBDS 3.0.0 and go through all the steps of + installation process that is fully described in + <ulink url="gsglink">Getting Started with JBoss Developer Studio</ulink> guide.</para> + <figure> + <title>Process of JBDS 3.0.0 installation </title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/jbds2.png" /> + </imageobject> + </mediaobject> + </figure> + <para>Now you can not update your JBDS 2.X to 3.0.0 using update site (https://devstudio.jboss.com/updates/3.0/ ), as it was available in previous versions:</para> + <figure> + <title>Installation from the update site</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/migration-guide-step-1.png" /> + </imageobject> + </mediaobject> + </figure> + <para>The reason is that JBDS 3.0 uses Eclipse 3.5, whereas JBDS 2.x uses Eclipse 3.4. + Because of this platform change, a full installation is required to migrate. </para> + <para>When the installation process is complete you can point your JBDS 3.0.0 at your old workspace directory and continue working with your projects created using previous + JBDS/Tools versions, or create a new one and import old projects into the new workspace. + </para> + + <note> + <title>Note:</title> + <para>In JBDS 3.0.0 Linux users no longer need to install the library libstdc+.so.5 on their mashines. + Now this library is not required and can be removed from the system. + </para> + </note> + </section> + + +</chapter> Property changes on: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/en-US/migration.xml ___________________________________________________________________ Name: svn:executable + * Modified: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/pom.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/pom.xml 2010-03-11 23:57:54 UTC (rev 20772) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/pom.xml 2010-03-11 23:58:46 UTC (rev 20773) @@ -89,9 +89,9 @@ </dependencies> <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/MigrationGuide/publican.cfg 2010-03-11 23:58:46 UTC (rev 20773) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

JBoss Tools SVN: r20772 - in branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide: en-US and 7 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-03-11 18:57:54 -0500 (Thu, 11 Mar 2010) New Revision: 20772 Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Author_Group.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.ent branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Preface.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/database.zip branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/first_seam.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/further_reading.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/getting_started.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/favicon0.ico branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam10.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam11.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam12.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam13.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam14.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam15.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam16.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam17.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam18.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam19.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam20.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam21.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam22.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam23.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam24.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam25.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam26.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam27.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam28.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam29.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam30.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam31.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam32.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam33.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34a.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam35.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam36.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam37.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam38.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam39.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam40.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam41.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam42.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam43.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam44.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam45.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam46.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam47.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam48.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam49.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam5.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam6.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam7.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam9.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_3_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4a.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4b.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4c.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4d.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4e.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4f.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_5.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_6.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_7.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_8.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_9.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_10.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_11.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_12.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_13.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_14.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_15.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_16.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_17.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_18.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_19_finger_touch.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_5.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_6.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_8.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_9.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/eap5runtime.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_11.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_15.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_16.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_17.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_6.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_8.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_9.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_5.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_user_site.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/preferences.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_1.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_10.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_11.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_12.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_13.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_14.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_15.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_16.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_17.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_18.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_19.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_2.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_20.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_21.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_22.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_23.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_3.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_4.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_5.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_6.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_7.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8a.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8b.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_9.png branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/jsp_application.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/manage.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master_output.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/project_examples.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/publican.cfg Removed: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en/ Modified: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/pom.xml Log: modified to build with publican Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Author_Group.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Author_Group.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Author_Group.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>JBoss Tools Team</firstname></author></authorgroup> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Book_Info.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -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>Getting Started Guide</title><subtitle>Provides information relating to the BPMN Convert module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Getting Started Guide explains the JBoss Developer Studio.</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: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.ent =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.ent (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.ent 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Getting_Started_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Getting_Started_Guide.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,16 @@ +<?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="getting_started.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="manage.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="first_seam.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="jsp_application.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="rad_jsf_application.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="project_examples.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="gsg_faq.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="further_reading.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Preface.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Preface.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Preface.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -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: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/Revision_History.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -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: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/database.zip =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/database.zip ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/first_seam.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/first_seam.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/first_seam.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,1009 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="first_seam" xreflabel="first_seam"> + <?dbhtml filename="first_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Seam</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Write Your First Project with JBoss Developer Studio</title> + + <para>This chapter is a set of hands-on labs. You get step-by-step information about how the JBoss + Developer Studio can be used during the development process.</para> + + <section id="create_seam_application"> + <title>Create a Seam Application</title> + + <para>In this section you get to know how to create a Seam project in JBDS, how to start the + server and what a structure your project has after creating.</para> + + <section id="start_dev_db"> + <title>Start Development Database</title> + + <para>Before opening the JBoss Developer studio you need to <ulink + url="http://anonsvn.jboss.org/repos/jbosstools/trunk/documentation/guides/Gett..." + >download</ulink> and start a Workshop Database.</para> + <para>To start the database just run <property>./runDBServer.sh</property> or + <property>runDBServer.bat</property> from the database directory.</para> + <para>The end result should be a console window that looks like:</para> + + <figure> + <title>Starting DataBase</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam1.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="create_deploy_seam"> + <title>Create and deploy Seam Web Project</title> + + <para>Minimize the terminal window and run the <property>JBoss Developer Studio</property> + from Applications Menu or from the desktop icon.</para> + <para>First of all you get the Workspace Launcher. Change the default workspace location if + it's needed. Click on <property>Ok</property>. </para> + + <figure> + <title>Workspace Launcher Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After startup, you see the welcome page. You could read how to work with welcome pages + in <link linkend="Welcome">previous</link> chapter. Now select <property>Create + New...</property> icon and then press on <property>Create Seam Project</property> + link.</para> + + <para>The <property>New Seam Project wizard</property> is started. You need to enter a name + (e.g., "workshop") and a location directory for your new project. The + wizard has an option for selecting the actual Server (and not just WTP runtime) that will be + used for the project. This allows the wizard to correctly identify where the needed + datasource and driver libraries need to go.</para> + + <figure> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>All settings are already specified here, you can just modify the Configuration. Click on + the <emphasis> + <property>Modify...</property> + </emphasis> button to configure your custom facets pattern:</para> + + + <figure id="ProjectFacetsSpecifyingScreen"> + <title>Project Facets Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole the dialog allows to select the "features" you want to use in your project. + Doing this <property>JBoss Developer Studio</property> setups the appropriate tooling for + your project. Since JBoss Seam integrates all popular Java EE frameworks, you can select any + combination of technologies from the list. Here, for the default configuration, Dynamic Web + Module, Java, JavaServer Faces (JSF), and Seam Facet are already selected for a typical + database-driven web application. The default project facets should suffice.</para> + + <para>In the <property>Project Facets</property> form you can also bring up server runtimes + panel by clicking <property> Runtimes</property> tab on the right corner. This panel shows + available server runtimes.</para> + + <figure> + <title>Runtimes Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <emphasis> + <property>Ok</property> + </emphasis> and then <emphasis> + <property>Next</property> + </emphasis> to proceed further.</para> + + <para>A dynamic web application contains both web pages and Java code. The wizard will ask you + where you want to put those files. You can just leave the default values or choose another + folder.</para> + + <figure> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam6.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form, you will be able to select where those library JARs come from. The + easiest is just to select the JARs provided by the JBoss AS runtime associated with this + project. That is why it is important to chose the right JBoss AS 4.2 runtime in the project + setup window.</para> + <itemizedlist> + <listitem> + <para>Check <emphasis> + <property>Server Supplied JSF Implementation</property> + </emphasis>. We will use JSF + implementation that comes with JBoss server</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure> + <title>JSF Capabilities Adding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next wizard step needs more settings that previous. Let's start with + <property>General</property> section.</para> + <para>Leave the default Seam runtime and check a WAR deployment.</para> + + <figure> + <title>Seam Facet Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Next <property>Database</property> section is a little tricky. The <property>Connection + Profile</property> needs to be edited so that the new project works properly with the + external HSQLDB server. By default the project wizard tries to use the JBoss embedded + HSQLDB, but the tutorial uses an external database to replicate a more real world + development scenario. Click on <property>Edit</property> to modify the Connection + Profile.</para> + + <figure> + <title>DataBase Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property>JDBC Connection Properties</property>. Make sure the URL is set to <emphasis> + <property>jdbc:hsqldb:hsql://localhost:1701</property> + </emphasis></para> + + <figure> + <title>JDBC Connection Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam9.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Try click on <property>Test Connection</property> button. It probably won’t work. This + happens if the hsql jdbc driver is not exactly the same. This can be worked around by + modifying the HSQLDB database driver settings. To modify the settings, click the + <property>“...”</property> next to the drop-down box.</para> + + <para>The proper Driver JAR File should be listed under <property>Driver File(s)</property>. + Select the hsqldb.jar file found in the database/lib directory and click on + <property>Ok</property>.</para> + + <figure> + <title>Driver Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property>Hypersonic DB</property> and click on <property>Ok</property>. Again, + this only happens if the selected hsqldb.jar is different from the running database.</para> + + <figure> + <title>Hypersonic DB Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam11.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, the <property>Test Connection</property> should succeed. After testing the + connection, click on Ok.</para> + + <figure> + <title>Connection Testing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam12.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can leave the <property>Code Generation</property> section as is. It refers to Java + packages in which the generated code will be placed.</para> + + <figure> + <title>Code Generation Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam13.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <property>Finish</property> button. Now, there should be a new Seam project + called “workshop” listed in Package Explorer view.</para> + + <figure> + <title>"worskhop" Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam14.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="start_JBossAS"> + <title>Start JBoss Application Server</title> + + <para>The complete information on how to manage JBoss AS from JBoss Developer Studio you can + read in a <link linkend="manage">corresponding chapter</link>.</para> + <para>Now you just need to start the server by clicking on the Start the server icon ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam15.png"/> + </imageobject> + </inlinemediaobject> ) in the + JBoss Server View.</para> + + <para>Then run the project by selecting the project and use <emphasis><property>Run As... > + Run on Server</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the project does not show up, then you can use a normal browser and use <emphasis> + <property>http://localhost:8080/workshop/home.seam</property> + </emphasis> as the url.</para> + </note> + + <para>Your project looks like this:</para> + + <figure> + <title>"workshop" Project Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam16.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="workshop_code_overview"> + <title>Workshop Project Code Overview</title> + + <para>Now let's examine the project and its structure. Go back to the Package Explorer view in + JBoss Developer Studio.</para> + + <para>It seems like it's not much for project but this shell application contains a login + screen with default login logic, a menu template that can be further modified, and other + layout templates.</para> + + <para>It's important to note that the business logic will reside in the <emphasis> + <property>src/hot</property> + </emphasis> folder, by default. And, the package naming conventions that were used in <property>New Seam + project wizard</property> could have been changed to something different from <emphasis> + <property>org.domain.workshop.session</property>. + </emphasis> Also, notice that there is a default <property>Authenticator. java</property> + file. This is where custom security logic can be added. Seam has a nice declarative security + model that we will explore in a bit more detail later on. The <emphasis> + <property>src/main</property> + </emphasis> folder is a model directory. It stores the project's JPA entity beans.</para> + + <figure> + <title>Project Structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam17.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The view tier of the + application is also important. Seam uses facelets and there is a built-in facelets GUI + editor that has some nice WYSIWYG and component drag/drop functionality. Try this out by + opening <property>home.xhtml</property> from <property>WebContent</property> folder.</para> + + <figure> + <title>Facelets GUI Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam18.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that the templates reside in the <emphasis> + <property>WebContent/layout</property> + </emphasis> folder. There is a stylesheet in the <emphasis> + <property>WebContent/stylesheet</property> + </emphasis> folder. There is also a login and default error page. The Facelet editor will be + explored in more detail later in the lab.</para> + + <para>The project already has a datasource that was created per the Seam project wizard + database settings. And, obviously all of the Seam specific configuration files and JAR + dependencies are included and placed in the proper locations. On last noteworthy line item + is related to the build script. There isn’t a build script because the Eclipse WTP(Web Tools + Project) plugin is used to publish web application changes. As you can see, JBoss Developer + Studio is removing a great deal of complexity from the enterprise Java project + setup/deployment process. The end result is a developer that is writing code, not spending + days/weeks trying to figure out how to get a decent development environment and project + build process.</para> + + </section> + + </section> + + + <section id="seam_action_dev"> + <title>Seam Action Development</title> + + <para>Now, it’s time to write some code. The good news is that JBoss Developer Studio can also + help out in this respect. In this section, we will create a new Seam Action POJO and facelet + with some custom business logic and some GUI changes.</para> + + <section id="create_seam_action"> + <title>Create a New Seam Action</title> + + <para>Go to main menu bar and click on <emphasis> + <property>File > New > New Seam Action</property> + </emphasis> to start the New Seam Action wizard.</para> + + <para>Specify a <property>Seam component name</property> (e.g., "myAction"). + The other properties will be auto-completed for you so there is no need to change them. + Click on <property>Finish</property>.</para> + + <figure> + <title>New Seam Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam19.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, open the <property>MyAction.java</property> file and replace the + "myAction" method with this logic:</para> + + <programlisting><![CDATA[public void myAction() { +Calendar cal = Calendar.getInstance(); +log.info("myAction.myAction() action called"); +facesMessages.add("MyAction Executed on:" + cal.getTime()); +}]]></programlisting> + + <para>You also need to import the <property>java.util.Calendar</property> class by clicking + <emphasis><property>CTRL + Shift + O</property>.</emphasis></para> + + </section> + + <section id="test_seam_action"> + <title>Test Seam Action</title> + + <para>The new action can be tested by browsing the workshop-test project. JBoss Developer + Studio has already created a TestNG test case for you.</para> + + <figure> + <title>"workshop-test" Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam20.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + + <para>The test case simulates a Seam component/method execution for the + <property>MyAction.myAction()</property> logic.</para> + <para>To run the test case, right click on <property>MyActionTest.xml</property> and click <emphasis> + <property>Run As > TestNG Suite</property> + </emphasis> or use the <property>Run As...</property> toolbar shortcut as shown + below.</para> + + <figure> + <title>TestNG Running</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam21.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>With any luck, the test case will pass. Look at the TestNG view.</para> + + <figure> + <title>TestNG Results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam22.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, it’s safe to test the new Seam Action in a web browser. The fastest way to do that + is to right click on <property>myAction.xhtml</property> and use <emphasis> + <property>Run As... > Run On Server</property> + </emphasis> which will show the appropriate url in the browser. Alternatively you can + manually enter <emphasis> + <property>http://localhost:8080/workshop/myAction.seam</property> + </emphasis> into a browser.</para> + + <figure> + <title>Seam Action in a Web Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam23.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="modify_seam_action"> + <title>Modify Seam Action User Interface</title> + + <para>Browse to <emphasis> + <property>http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and click on <property>myAction</property>. This executes the “myAction” method. + This looks pretty good, but we could make this page look a little better.</para> + + <para>Open <emphasis> + <property>WebContent/myAction.xhtml</property> + </emphasis> in JBoss Developer Studio to use the nice facelets editor.</para> + + <figure> + <title>Open Seam Action with Editor </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam24.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the "myAction!" button in the visual part of editor and + select <property><h:commandButton> Attributes</property>.</para> + + <figure> + <title>Seam Action Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam25.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Change the <property>value</property> of the button to something different. If desired, + you can change any other text on the page. Then, type <emphasis> + <property>CTRL + S</property> + </emphasis> to save the facelet.</para> + + <figure> + <title>Attributes Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam26.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Refresh <emphasis> + <property>http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and now you should see your changes.</para> + + <para>Notice that you did not have to publish the application. JBoss Developer Studio + auto-published it for you.</para> + + <figure> + <title>Seam Action Is Modified</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam27.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + + </section> + + <section id="declarative_security"> + <title>Declarative Security</title> + + <para>In this section you will see how it’s easy to secure the facelets and facelet components + in Seam. Let’s go ahead and secure the action button, then we will secure the entire + page.</para> + + <section id="edit_login"> + <title>Edit Login Authentication Logic</title> + + <para>There is a class called <property>Authenticator.java</property>. The login page will + execute the <property>Authenticator.authenticate()</property> method by default, so we’ll + start by adding some custom login logic.</para> + <para>Open <property>Authenticator.java</property> in JBoss Developer Studio and replace the + <property>authenticate()</property> method with this code:</para> + + <programlisting><![CDATA[public boolean authenticate() { +if (identity.getUsername().equals("admin") +&& identity.getPassword().equals("password")) { +identity.addRole("admin"); +return true; +} +else +return true; +}]]></programlisting> + + </section> + <section id="secure_seam_page"> + <title>Secure Seam Page Component</title> + + <para>Open <property>myAction.xhtml</property> and add a new secured command button:</para> + <programlisting><![CDATA[<h:commandButton id="myActionSecured" +value="Secured Action Button" +action="#{myAction.myAction}" +rendered="#{s:hasRole('admin')}"/>]]></programlisting> + + <para>Refresh <emphasis> + <property>http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will only see one button. If you are logged in, + there will be two buttons.</para> + + + <figure> + <title>One Button on a Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam28.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The secured button is not visible because the user isn’t logged in as + <property>"admin"</property>.</para> + + <figure> + <title>Secured Button is Visible</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam29.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The user is logged in as <property>"admin"</property>. Securing + components is easy but securing pages is pretty simple as well. </para> + <para>Open <emphasis> + <property>WebContent/WEB-INF/pages.xml</property> + </emphasis>. Then add this markup directly underneath the <pages> + element:</para> + + <programlisting><![CDATA[<page view-id="/myAction.xhtml" login-required="true"/>]]></programlisting> + + <para>Refresh <emphasis> + <property>http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will get bounced back to the login page.</para> + + <figure> + <title>Login Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam30.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, if you enter login credentials for the + <property>"admin"</property> user, you will be re-directed to the + secured page and secured component. If you enter different login credentials, page access + will be granted, but the secured component will not be displayed.</para> + + <para>Congratulations! You have secured your new action both at the facelet component and page + level. You also added custom authentication logic to the login action.</para> + + </section> + + </section> + + <section id="browsing_workshop_db"> + <title>Browsing Workshop Database</title> + + <para>In this section you get to know how to use the workshop database that was started at the + beginning of the lab.</para> + + <section id="database_connectivity"> + <title>Database Connectivity Setup</title> + + <para>The workshop data can be browsed inside of JBoss Developer Studio.</para> + + <para>To open the Data Source Explorer, click on <emphasis><property>Window > Open Perspective + > Other > Database Development</property>.</emphasis></para> + <para>In the Data Source Explorer, expand a <property>Databases</property> node and select a + <property>Default</property> database. Right click on it, select + <property>Connect</property> from the context menu.</para> + + <figure> + <title>Data Source Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam31.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="browsing_workshop_db2"> + <title>Browse Workshop Database</title> + + <para>Then in the current view, drill down to the <property>CUSTOMERS</property> table.</para> + + <figure> + <title>"CUSTOMERS" Table</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam32.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on <property>CUSTOMERS</property>, select <emphasis> + <property>Data > Sample Contents</property> + </emphasis> to view the data in the table.</para> + + <para>There should be a SQL Results view on the workbench, but it could be hidden. Click on + the <property>"Result1"</property> tab in the right side and you should + see the data in the CUSTOMERS table.</para> + + + <figure> + <title>SQL Results View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam33.png" scale="92"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you can’t find the SQL Results view tab, click on <emphasis><property>Window > Show + View > Other > SQL Development > SQL Results</property>.</emphasis></para> + </note> + + <para>Congratulations! You just connected to the workshop database and queried the content + using Database Explorer tools.</para> + + </section> + + </section> + + <section id="db_programming"> + <title>Database Programming</title> + + <para>Now, it’s time to reverse engineer the workshop database into a fully functioning Seam + CRUD(Create Read Update Delete) application.</para> + + <section id="reverse_engineer_crud"> + <title>Reverse Engineer CRUD from a Running Database</title> + + <para>In <property>JBoss Developer Studio</property>, switch to <property>Seam + perspective</property>, and then right-click the project and select + <emphasis><property>New > Seam Generate Entities</property>.</emphasis></para> + + <para>"workshop" project in the <property>Seam Generate Entities + wizard</property> will be selected automatically. There is no need to change something + more, click <emphasis> + <property>Next</property> + </emphasis> to proceed further.</para> + + <figure> + <title>Generate Seam Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the next page use the <emphasis> + <property>Include</property> + </emphasis> button to include all the tables from the database and click <emphasis> + <property>Finish</property>.</emphasis></para> + + <figure> + <title>Selecting Tables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34a.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>After running the Generate Entities action, you will see new <emphasis> + <property>org.domain.workshop.entity</property> + </emphasis> classes. These classes represent insert/update/delete/query logic.</para> + + <figure> + <title>org.domain.workshop.entity Classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam35.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>There are also <emphasis> + <property>org.domain.workshop.entity</property> + </emphasis> package that contains the JPA classes. These are the entity beans that are + mapped to database tables.Note,that you can use Seam refactoring tools with Seam components. + Read more about it in <ulink + url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind..." + >Seam refactoring tools chapter</ulink> of Seam Dev Tools Reference Guide.</para> + + <para>Last, but not least, there are facelets for all of the CRUD screens. The best way to get + a feel for the generated code is to open a browser and play around with the application. Go + to <emphasis> + <property>http://localhost:8080/workshop</property> + </emphasis> and insert/update/delete/query a few records. There is quite a bit of AJAX in + this application, but which we will explore further later on in the lab. For now, take note + of the page tabs, required field logic and data table sorting in the list pages. </para> + + <figure> + <title>CustomersList.xhtml in the Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam36.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You now have a fully functioning CRUD application that is already AJAX + enabled.</para> + + </section> + + <section id="use_hibernate_tools"> + <title>Use Hibernate Tools to Query Data via JPA</title> + + <para>Now, it's time to write some JPA queries using the Hibernate perspective in + <property>JBoss Developer Studio</property>.</para> + <para>In the upper right corner of the workbench there is a small icon (see the figure below), + click on it and choose <property>Hibernate</property>.</para> + + <figure> + <title>Hibernate Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam37.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Look at the Hibernate Configurations view. In the "workshop" project, + drill down on the <property>Session Factory</property> and notice that the JPA + entities/attributes are listed in a nice tree view.</para> + + <figure> + <title>Hibernate Configurations View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam38.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the <property>Session Factory</property> and select <property>HQL + Editor</property>. This will open a JPA query scratch pad window.</para> + + <para>Write your query and click on the "Hibernate Dynamic SQL Preview" tab. + You should see the SQL that will be executed if this JPA query is run.</para> + + <figure> + <title>JPA Query Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam39.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Run the query by clicking on the green run icon.</para> + + <para>The results are listed in the "Hibernate Query Result" tab. There is a + "Properties" tab in the workbench that can be used to see a specific JPA + result. These results represent the JPA objects because our query did not specify column + names.</para> + + <figure> + <title>Hibernate Query Result View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam40.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The query can be refined, and take note that there is nice code completion in the JPA + query editor.</para> + + <figure> + <title>Code Completion</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam41.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>A refined query will return results that are more ResultSet oriented. Notice the join + logic that JPA supports.</para> + + <figure> + <title>The Hibernate Query Result</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam42.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>There was no need to specify an <property>Employees</property> table in the + <property>from</property> part of the JPA query because JPA supports reference traversal + via Java class attribute references. Not only are JPA and HQL queries fully supported, but + Criteria based queries can also be written in the Criteria Editor. You should spend some + time tinkering with different queries and possibly Criteria based queries, even though the + instructions are not provided in this lab.</para> + + <figure> + <title>Criteria Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam43.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="use_hibernate_to_vizualize"> + <title>Use Hibernate Tools to visualize the Data Model</title> + + <para>Now, it’s time to view the data model for the workshop database.</para> + + <para>In the Hibernate Configurations view, select "workshop" project and + expand the <property>Configuration</property> node. Select the + <property>Customers</property> entity, right click on it, choose <property>Open Mapping + Diagram</property>.</para> + + <figure> + <title>Mapping Diagram Opening</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam44.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para>You see a Diagram tab for the CUSTOMERS table and any tables that have FK references. + This is a handy way to view the data model and JPA mappings. Now, you’ve got access to + something that the Erwin Data Modeler can’t do.</para> + + + <figure> + <title>Diagram Tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam45.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + + <section id="rich_components"> + <title>Rich Components</title> + + <para>This lab will conclude with one last AJAX twist. In this section we add a RichFaces + <property>inputNumberSlider</property> to the Order Details edit screen.</para> + + <section id="add_richfaces"> + <title>Add a Richfaces component to the CRUD Application</title> + + <para>Switch to Seam perspective, open <emphasis> + <property>WebContent/OrderdetailsEdit.xhtml</property> + </emphasis> in JBoss Developer Studio.</para> + <para>Change the form field values using the visual editor. Seam has generated the form field + names that match the database column names. This is not ideal for business users.</para> + + <figure> + <title>Form Fields Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam46.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Also, replace the QTY Ordered input field with a <property>inputNumberSlider</property>. + You can use the JBoss Developer Studio palette or right click on the form and insert the + RichFaces component.</para> + + <figure> + <title>Insert RichFaces Component from Context Menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam47.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + + <para>One the last option is to use the source view and manually copy the inputNumberSlider + markup listed below:</para> + + <programlisting><![CDATA[<rich:inputNumberSlider id="quantityOrdered" required="true" + value="#{orderdetailsHome.instance.quantityordered}"/>]]></programlisting> + + <figure> + <title>Manually coping Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam48.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The end result is an edit page that has better form labels and a new RichFaces + control.</para> + + <figure> + <title>The Result Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam49.png" scale="85"/> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You have completed the JBoss Developer Studio lab.</para> + + </section> + + </section> +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/further_reading.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/further_reading.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/further_reading.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,167 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="further_reading" xreflabel="further_reading"> + <?dbhtml filename="further_reading.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Further Reading</title> +<itemizedlist> + + <listitem> + <para> + <emphasis role="bold">Seam Dev Tools Reference Guide</emphasis> + </para> + <para> This guide helps you to understand what Seam is and how to install Seam plug-in into + Eclipse. It tells you the necessary steps to start working with Seam Framework and assists in a + simple Seam Project creation. Also you will learn how to create and run the CRUD Database + Application with Seam as well as find out what Seam Editors Features and Seam Components are. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Visual Web Tools Reference Guide</emphasis> +</para> +<para> + This guide provides general orientation and an overview of JBDS visual web tools functionality. This guide discusses the following topics: editors, palette, web properties view, openOn, content assist, RichFaces support. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Server Manager Reference Guide</emphasis> + </para> + <para> This guide covers the basics of working with the JBoss server manager. You will read how to + install runtimes and servers and quickly learn how to configure, start, stop the server and know + how deployment and archiving process. You will find out how to manage installed JBoss Servers + via JBoss AS Perspective. You will also read how to deploy modules onto the server. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">jBPM Tools Reference Guide</emphasis> + </para> + <para>With jBPM Tools Reference Guide we'll help you to facilitate a cross-product + learning and know how you can speed your development using special editors and visual designers. + We'll also guide you through the steps on how to create a simple process and test it + within jBPM jPDL perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Hibernate Tools Reference Guide</emphasis> + </para> + <para>Throughout this guide you will learn how to install and use Hibernate Tools bath via Ant and + through Eclipse. We'll supply you with the information on how to create mapping files, + configuration file as well as a file for controlling reverse engineering by using specific + wizards that Hibernate tooling provides. Also you will know about Code Generation and + peculiarities of work within Hibernate Console Perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">ESB Editor Reference Guide</emphasis> + </para> + <para>This guide provides you with the information on ESB Editor and all necessary wizards for ESB + files development.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Portal Tools Reference Guide</emphasis> + </para> + <para>The guide gives a detail look at how you can easily build a Portlet Web Application with + JBoss Tools and deploy it onto JBoss Portal.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss WS User Guide</emphasis> + </para> + <para>This guide gives you practical help on JBossWS usage. You will learn how to create a web service using JBossWS runtime, find out how to create a web service client from a WSDL document using JBoss WS and also see how to set your development environment.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Smooks Tools Reference Guide</emphasis> + </para> + <para>This guide is packed with useful and easy-to-understand information about graphical, configuration and source editor pages.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Drools Tools Reference Guide</emphasis> + </para> + <para>The guide help you to discover how to create a new Drools project, use debugging rules and work with different editors.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JMX Tools Reference Guide</emphasis> + </para> + <para>With the help of this guide you'll explore the best practices to follow when working with MBean Explorer, MBean Editor, Connections and etc.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Eclipse Guvnor Tools Reference Guide</emphasis> + </para> + <para>The purpose of this guide is to describe briefly the functionality present in the Eclipse Guvnor Tools (EGT) for Drools 5.</para> + </listitem> + + + + <listitem> + <para> + <emphasis role="bold">JSF Tools Tutorial</emphasis> + </para> + <para> This tutorial will describe how to deal with classic/old style of JSF development and how + to create a simple JSF application using the JBoss Developer Studio. </para> + </listitem> + + <listitem> <para> + <emphasis role="bold">JSF Tools Reference Guide</emphasis> + + </para> + <para> From this guide you'll discover all peculiarities of work at a JSF project. You'll + learn all shades that cover the process of project creation and take a closer look at the JSF + configuration file. Also you'll get to know managed beans and how to work with them and + find out, how to create and register a custom converter, custom validator and referenced beans + in a JSF project. </para> + </listitem> + + <listitem> <para> + <emphasis role="bold">Struts Tools Reference Guide</emphasis> + </para> + <para> In Struts Tools Reference Guide you will learn how to create and work with a new struts + project. This guide also provides information about graphical editor for struts configuration + files, tiles files, and struts validation files. </para> + </listitem> + +<listitem> + <para> + <emphasis role="bold">Struts Tools Tutorial</emphasis> + </para> + <para> This tutorial will describe the classical style of Struts development, and will + step-by-step show you how to create a simple Struts application in JBoss Developer Studio.</para> +</listitem> + + + <listitem> + <para> + <emphasis role="bold">Exadel Studio Migration Guide</emphasis> + </para> + <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects + from Exadel Studio into JBoss Developer Studio. </para> + </listitem> + +</itemizedlist> +<para>If there's anything we didn't cover in this guide, please feel free to visit our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss Developer Studio Users Forum</ulink> or <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss Tools Users Forum</ulink> to ask questions. There we are also looking for your suggestions and comments.</para> + +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/getting_started.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/getting_started.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/getting_started.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,896 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="getting_started" xreflabel="getting_started"> + <?dbhtml filename="getting_started.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Getting Started with JBoss Developer Studio</title> + + <section id="intro1"> + <title>What is JBDS?</title> + <para><property>JBoss Developer Studio</property> is a set of eclipse-based development tools that + are pre-configured for JBoss Enterprise Middleware Platforms and Red Hat Enterprise Linux. + Developers are not required to use <property>JBoss Developer Studio</property> to develop on + JBoss Enterprise Middleware and/or Red Hat Linux. But, many find these pre-configured tools offer + significant time-savings and value, making them more productive and speeding time to deployment.</para> + <para>This guide covers the first steps to get started working with <property>JBoss Developer + Studio</property>. You will learn how to install and configure necessary software for your OS + (currently Linux, Microsoft Windows or Mac OSX).</para> + <para>Thus this guide will provide you with detailed info on how to start JDK, JBDS and JBoss + Tools.</para> + </section> + +<section> + <title>Key Features of JBoss Developer Studio and Requirements</title> + <para>For a start, we propose you to look through the table of main features of JBoss Developer Studio:</para> + + <table> + + <title>Key Functionality of JBoss Developer Studio</title> + <tgroup cols="2"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + + <tbody> + + <row> + <entry><para>JBoss Enterprise Application Platform</para></entry> + <entry><para>JBoss Developer Studio includes and integrates JBoss Enterprise Application Platform, the same version of the middleware platform that Red Hat supports in production for 5 years.</para></entry> + </row> + + <row> + <entry><para>New Seam Tools</para></entry> + <entry><para>JBoss Developer Studio includes brand new tools for Seam. They provide wizards for creating new Seam projects, validation tools, expression language code completion, testing tools, and wizards for generating entity objects.</para></entry> + </row> + + <row> + <entry><para>Visual Page Editor</para></entry> + <entry><para>JBoss Developer Studio includes a Visual Page Editor for combined visual and source editing of Web pages. The Visual Page Editor even renders AJAX-enabled RichFaces components.</para></entry> + </row> + + <row> + <entry><para>AJAX Capabilities</para></entry> + <entry><para>JBoss Developer Studio includes a Technology Preview of JBoss RichFaces. RichFaces provides nearly 70 skinnable components, including calendar, tree, dropdown menu, drag-and-drop components, and more. JBoss Developer Studio’s Visual Page Editor can render RichFaces components.</para></entry> + </row> + + <row> + <entry><para>JBoss Tools Palette</para></entry> + <entry><para>The JBoss Tools Palette contains a developer’s project tag libraries and enables inserting tags into a JSP with one click. The Tools Palette supports custom and 3rd party tags.</para></entry> + </row> + + <row> + <entry><para>JBoss jBPM Tools</para></entry> + <entry><para>JBoss Developer Studio includes jBPM tooling for defining Seam page flows.</para></entry> + </row> + + <row> + <entry><para>Spring Tools</para></entry> + <entry><para>JBoss Developer Studio includes Spring IDE for developing Spring applications.</para></entry> + </row> + + <row> + <entry><para>Struts Tools</para></entry> + <entry><para>JBoss Developer Studio includes Struts tools for Struts 1.x applications.</para></entry> + </row> + + <row> + <entry><para>Optimized JBoss Application Server adapter</para></entry> + <entry><para>JBoss Developer Studio’s advanced JBoss AS adapter includes features like incremental deployment for fast development and is pre-configured for the included JBoss Application server.</para></entry> + </row> + + <row> + <entry><para>Red Hat Enterprise Linux and RHN Access</para></entry> + <entry><para>JBoss Developer Studio includes access to Red Hat Enterprise Linux, Linux development tools, and Red Hat Network for development purposes.</para></entry> + </row> + + <row> + <entry><para> Project Examples</para></entry> + <entry><para> Tooling for easy installation of Examples.</para></entry> + </row> + + <row> + <entry><para>JBossWeb Service</para></entry> + <entry><para>JBoss WS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para></entry> + </row> + </tbody> + </tgroup> + </table> + + <para><property>JBDS</property> requires JDK 5+ (JDK 6 in case of EAP 5.0). Also it's important that + the JVM's architecture matches the particular <property>JBDS</property> build, i.e. if you're on a + 64-bit system and use the 64-bit JVM, you need the 64-bit JBDS.</para> + + <para>For the 32-bit version of JBDS use the 32-bit JVM or just use <literal>-vm</literal> flag to + tell JBDS to use 32-bit java if the 64-bit one is found as the default.</para> + + <note> + <title>Note:</title> + <para>On Linux system with 64-bit JVM the visual editor may fail to start. In this case you need the <literal>libstdc++.so.5</literal> library. + See also the <link linkend="question_1">FAQ</link>.</para> + </note> +</section> + + <section id="ConfigJavaEnvironment"> + <?dbhtml filename="ConfigJavaEnvironment.html"?> + <title>Configuring Your Java Environment</title> + <para>You must have a working installation of JDK before you install <property>JBoss Developer + Studio</property>. Thus in this + guide we will show you how to install a 32-bit Sun JDK 5.0 on a Linux Platform and Microsoft + Windows Platform.</para> + + <section id="InstallJDK50onLinux"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Linux</title> + <para>To install 32-bit Sun JDK 5.0 on Linux and configure it, you should follow the next steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + <x>" (where "x" is the latest update number) for + download and then select "Red Hat Package Manager in self-extracting" file + for Linux. Read the instructions on Sun's website for installing the JDK.</para> + </listitem> + <listitem> + <para>If you don't want to use SysV service scripts you can install the + "self-extracting file" for Linux instead of choosing the "RPM in + self-extracting" file. In that case you can skip the next step mentioned here. But it + is recommended to use the SysV service scripts for production servers.</para> + </listitem> + <listitem> + <para>Download and install the appropriate -compat RPM from JPackage <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-free/">here</ulink>. + Please ensure you choose a matching version of the -compat package to the JDK you've + installed.</para> + </listitem> + <listitem> + <para>Create an environment variable that points to the JDK installation directory and call it + JAVA_HOME. Add <emphasis> + <property>$JAVA_HOME/bin</property> + </emphasis> to the system path to be able to run java from the command line. You can do this + by adding the following lines to the .bashrc file in your home directory.</para> + <programlisting><![CDATA[#In this example /usr/java/jdk1.5.0_11 is the JDK installation directory. +export JAVA_HOME=/usr/java/jdk1.5.0_11 +export PATH=$PATH:$JAVA_HOME/bin]]></programlisting> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + + <para>If you have JDK already installed and added in your system path, you should add + <emphasis>$JAVA_HOME/bin</emphasis> before the old <emphasis>$PATH</emphasis> (not after it) + so that the new version of JDK can be found first, i. e. <emphasis> + <emphasis>export PATH=$JAVA_HOME/bin:$PATH</emphasis> + </emphasis> This way, the machine will pick up the new JVM first. You only need to run + "alternative" as a safe guard for the right JVM. </para> + </note> + + <para>Set this variable for your account doing the installation and also for the user account + that will run the server.</para> + <itemizedlist> + <listitem> + <para>If you have more than one version of JVM installed on your machine, make sure you are + using the JDK 1.5 installation as the default java and javac. You can do this using the + alternatives system. The alternatives system allows different versions of Java from different + sources to co-exist on your system.</para> + </listitem> + </itemizedlist> + <section id="SelectAlternativesforJava"> + <title>Select alternatives for java, javac and java_sdk_1.5.0</title> + <itemizedlist> + <listitem> + <para>As a root user, type the following command at the shell prompt and you should see + something like this:</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs that provide 'java'. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>Make sure the Sun version [jre-1.5.0-sun in this case] is selected (marked with a + '+' in the output), or select it by entering its number as prompted.</para> + <itemizedlist> + <listitem> + <para>Repeat the same for javac and java_sdk_1.5.0.</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config javac +There is 1 program that provides 'javac'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun/bin/javac +Enter to keep the current selection[+], or type selection number: + +[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.5.0 +There is 1 program that provide 'java_sdk_1.5.0'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer + and version.</para> + <note> + <title>Note:</title> + <para>You can always override this step by setting the JAVA_HOME environment variable as + explained in the previous step.</para> + </note> + <itemizedlist> + <listitem> + <para>Make sure that the java executable is in your path and that you are using an appropriate + version. To verify your Java environment, type "java -version" at the shell + prompt and you should see something like this:</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ java -version +java version "1.5.0_11" +Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) +Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing)]]></programlisting> + </section> + + </section> + <section id="InstallJDK50onWindows"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> + + <para>To install and configure 32-bit Sun JDK 5.0 on Microsoft Windows, follow these steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + <x>" (where "x" is the latest update number) for + download and then select your Windows Platform options to perform the installation.</para> + </listitem> + <listitem> + <para>Create an environment variable called JAVA_HOME that points to the JDK installation + directory, for example: + <emphasis>C:\Program Files\Java\jdk1.5.0_11\</emphasis> + </para> + </listitem> + </itemizedlist> + + <para>In order to run java from the command line, add the <emphasis>jre\bin</emphasis> directory + to your path, for example:</para> + <para> + <emphasis>C:\Program Files\Java\jdk1.5.0_11\jre\bin</emphasis> + </para> + <para>To do this, open the <emphasis> + <property>Control Panel</property> + </emphasis> from the <emphasis> + <property>Start</property> + </emphasis> menu, switch to Classic View if necessary, open the System Control Panel applet (<emphasis> + <property>System</property> + </emphasis>), select the <emphasis> + <property>Advanced</property> + </emphasis> Tab, and click on the <emphasis> + <property>Environment Variables</property> + </emphasis> button.</para> + <para>Now, when 32-bit Sun JDK 5.0 has been successfully installed, we can pass on to the next + step.</para> + </section> + + </section> + + <section id="InstallingJBDS"> + <?dbhtml filename="InstallingRHDS.html"?> + <title>JBoss Developer Studio Installation</title> + + <para>This chapter will provide you with detailed information on how to install <property>JBoss + Developer Studio</property>.</para> + + <para>JBDS comes with a simple installer, bundled with tested/pre-configured versions of Eclipse, + WTP, JBossEAP, Seam, and SpringIDE. Thus, to start perform the next steps:</para> + + <itemizedlist> + <listitem> + <para>First of all you need the appropriate installation file for your platform from + <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_studio.html">Red Hat + website</ulink>.</para> + </listitem> + <listitem> + <para>Then run in console:</para> + <programlisting role="JAVA"><![CDATA[java -jar jbdevstudio-eap-linux-gtk-2.1.0.GA.jar +]]></programlisting> + </listitem> + <listitem> + <para>Follow the instructions presented by the installation wizard:</para> + </listitem> + </itemizedlist> + + <figure> + <title>JBoss Developer Studio Installation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Provide the installation path</para> + </listitem> + <listitem> + <para>Select Java VM</para> + </listitem> + </itemizedlist> + + <figure> + <title>Select Java VM</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>By selecting <emphasis> + <property>Default Java VM</property> + </emphasis> you set default Java VM of your system (to verify your Java environment, type + "java -version" in console).</para> + </tip> + + <para>Selecting <emphasis> + <property>Specific Java VM</property> + </emphasis> you can provide the path to non-default Java VM.</para> + + <note> + <title>Note:</title> + <para>JBoss Developer Studio needs Java 5 and "gij" isn't available on + every platform.</para> + </note> + + <itemizedlist> + <listitem> + <para>Installation process includes <ulink url="http://www.jboss.com/products/platforms/application">JBoss Enterprise Application + Platform</ulink>. Select <emphasis> + <property>Yes</property></emphasis> to use it in JBoss Developer Studio.</para> + <note> + <title>Note:</title> + <para>JBDS 2.0.0.GA comes integrated with JBoss EAP 4.3, while the current 2.1.0.GA release of JBDS comes with JBoss EAP 5 that support EAP 5 adapter + and Seam 2.2.</para> + </note> + + <para>This step lets you configure locally available JBoss Application Servers: </para> + </listitem> + </itemizedlist> + + <figure> + <title>JBoss Enterprise Application Platform Installing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3.png"/> + </imageobject> + </mediaobject> + </figure> + +<itemizedlist> + <listitem><para>You can fill the list automatically using the <emphasis><property>Find</property></emphasis> button: click <emphasis><property>Find</property></emphasis>, select a folder where search of available JBoss Application Servers should be started and click on <emphasis><property>Ok</property></emphasis>: </para> </listitem> +</itemizedlist> + + <figure> + <title>Finding Servers in the Selected Directory</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_3_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + <itemizedlist> + <listitem><para> All available servers in the selected directory will be added to the list with the following information specified: Name, Type, Version and Location. + </para></listitem> + </itemizedlist> + + <itemizedlist> + <listitem> <para>You can also add servers one by one using the <emphasis><property>Add</property></emphasis> button:</para> + </listitem> + </itemizedlist> + + <figure> + <title>Add Server to be Configured</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + +<para>Click on <emphasis><property>Browse</property></emphasis> and select the server location. Fields Name, Type and Version will be filled in automatically:</para> + + <figure> + <title>Specify Server Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + + <para>Click on <emphasis><property>Ok</property></emphasis>. The server is added to the list with the details on its type, version and location.</para> + + + + <para>The <emphasis><property>Remove</property></emphasis> button will the remove the selected server from the list. If necessary, you can edit the server details clicking on the <emphasis><property>Edit</property></emphasis> button:</para> + + <figure> + <title>Edit Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + + +  + + <itemizedlist> + <listitem> + <para>Click <emphasis><property>Next</property></emphasis>. Check your installation paths and see the components to install. If you'd like to change + something, press the <emphasis> + <property>Previous</property> + </emphasis> button. Click <emphasis> + <property>Next</property> + </emphasis> to start installation. </para> + </listitem> + </itemizedlist> + + <para/> + + <figure> + <title>Summary Information</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jbds_jbosstools"> + + <title>JBoss Developer Studio and JBoss Tools</title> + + <para>This section uncovers the points on the differences between <property>JBoss Developer + Studio</property> and <property>JBoss Tools</property> and provides the steps on <property>JBoss + Tools</property> installation as well.</para> + + <section id="WhatDifferenceBetweenJBDSAndJBossTools"> + <title>What is the difference?</title> + + <para><property>JBoss Tools</property> is what went into our <property>JBoss Developer + Studio</property> which comes as an easy-to-install Eclipse based IDE fully configured and ready + to run with the bundled <property>JBoss Enterprise Application Platform</property>.</para> + + <para>In short <property>JBoss Tools</property> are just a set of Eclipse plugins and + <property>JBoss Developer Studio</property> adds:</para> + <itemizedlist> + <listitem> + <para>An installer</para> + </listitem> + <listitem> + <para>Eclipse and Web Tools preconfigured</para> + </listitem> + <listitem> + <para>JBoss EAP with JBoss AS and Seam preconfigured</para> + </listitem> + <listitem> + <para>3rd party plugins bundled and configured</para> + </listitem> + <listitem> + <para>Access to RHEL and Red Hat Network</para> + </listitem> + <listitem> + <para>Access to the JBoss/Red Hat supported software</para> + </listitem> + </itemizedlist> + <para> For additional information see <ulink url="http://www.jboss.com/products/devstudio" + >JBoss.com</ulink></para> + </section> + + <section id="JBossToolsInstall"> + <title>JBoss Tools Installation and Update</title> + <para>Here, let's consider the installation of the <property>JBoss Tools</property> + modules.</para> + <para><property>JBoss Tools</property> is an umbrella project for the JBoss developed plugins + that will make it into <property>JBoss Developer Studio</property>. The JBoss Tools modules are:</para> + <itemizedlist> + <listitem> + <para>JBoss AS Tools</para> + </listitem> + <listitem> + <para>Seam Tools</para> + </listitem> + <listitem> + <para>Hibernate Tools</para> + </listitem> + <listitem> + <para>Visual Page Editor</para> + </listitem> + <listitem> + <para>JST Tools</para> + </listitem> + <listitem> + <para>JBPM Tools</para> + </listitem> + </itemizedlist> + + <para>To install the JBoss Tools plugins for Eclipse, you need the following:</para> + + <itemizedlist> + <listitem> + <para>Get Eclipse and Web Tools (make sure you have the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">appropriate version of Eclipse</ulink>)</para> + </listitem> + </itemizedlist> + <para>The current version of JBoss Tools (3.1.M2) targets at Eclipse 3.5/Galileo which is available from <ulink url="http://www.eclipse.org/downloads/">eclipse.org</ulink></para> + + <tip> + <title>Tip:</title> + <para>We recommend you do not use Eclipse.org update site to go from old version of Eclipse to new one. + Instead we suggest that you download the full binary from <ulink url="http://www.eclipse.org/downloads/">here</ulink>.</para> + </tip> + + <para>If you can only use Eclipse 3.3 use <ulink url="http://www.jboss.org/tools/download.html">JBoss Tools 2.1.2</ulink>, but + JBoss Tools 2.x will not have any of the new features.</para> + + <note> + <title>Note:</title> + <para>Remember to choose the download that matches your OS and use Java 5 when you run + it.</para> + </note> + + <itemizedlist> + <listitem> + <para>Get the <ulink url="http://download.jboss.org/jbosstools/builds/nightly/latestBuild.html" + >latest JBoss Tools build</ulink></para> + </listitem> + </itemizedlist> + + <para>Some of our newer plugins, like TPTP and BIRT, need additional drivers. On the left side of + the download page you can find all of the required drivers for chosen build and their versions.</para> + <para>If you need to install any standalone plug-in from JBoss Tools visit a <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">JBoss Tools Wiki</ulink> page to read + about dependencies between standalone plug-ins.</para> + <section> + <title>Installation From Update Site</title> + + + <para>Instead of downloading installation/updating manually, it's also possible to + get the latest release of <property>JBoss Tools</property> from one of our update sites: + <itemizedlist id="sites"> + <listitem> + <para>Stable Updates: <ulink url="http://download.jboss.org/jbosstools/updates/stable" + >http://download.jboss.org/jbosstools/updates/stable</ulink></para> + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://download.jboss.org/jbosstools/updates/development" + >http://download.jboss.org/jbosstools/updates/development</ulink></para> + </listitem> + <listitem> + <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/trunk/" + >http://download.jboss.org/jbosstools/updates/nightly/trunk/</ulink></para> + </listitem> + </itemizedlist> + </para> +<itemizedlist> + <para>To install/update Jboss Tools from one of the update sites you should follow the steps:</para> + <listitem><para>First, download the correct version of Eclipse + for your platform which is compatible with the version of JBoss + Tools you plan to install.For example if you want to install + 3.1.0.GA Eclipse 3.5 is required.</para></listitem> + <listitem><para>If you do not already have Java 5 or 6 installed and in your path, + download and install it.</para></listitem> + <listitem><para>When Eclipse is started, go to <itemizedlist> + <listitem><para>Help->Software Updates... ->Available Software->Manage Sites...->Add...<emphasis>(Eclipse 3.4)</emphasis></para></listitem> + <listitem><para>Help->Install New Software->Add..<emphasis>(Eclipse 3.5)</emphasis></para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para>After clicking <emphasis>Add</emphasis> button <property>Add Site</property> View should appear. + In the <property>Location</property> field you should paste one of the update sites described + <link linkend="sites">above</link>.In <property>Name</property> you can write any name you like. + In the end press the <property>Ok</property> button.</para> + <figure> + <title>Add Update Site</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4a.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem id="from_point"><para>In the <property>Install</property> View select features to install, then click <emphasis>Next</emphasis>.</para> + <figure> + <title>Jboss Tools installation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4b.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> +  + <para>If Jboss Tools are already installed on your Eclipse and you are doing updating but not + installation the following messages will appear in your <emphasis>Details</emphasis> section. + Ignore them and press <emphasis>Next.</emphasis></para> + <figure> + <title>Possible messages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4c.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>When you click Finish the prosses of Installation/Updating starts up. </para></listitem> + <listitem><para>Install. Restart when prompted.</para> + <figure> + <title>Message dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4d.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>After fetching all the features and plugins for installation, + you may be prompted that your selection contains unsigned jars. + This is normal,simply accept the warning and continue. </para> + <figure> + <title>Warning Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4e.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> +</itemizedlist> + + <note> + <title>Note:</title> + <para>While installing JBoss Tools on GNU/Linux (64-bit) through the eclipse installation manager you may run into some problems which can interrupt your installation process. + Please, read the + <ulink url="http://www.jboss.org/community/wiki/ManualinstallationofJBossTools31xonEc...">Manual installation of JBoss Tools 3.1.x on Eclipse 3.5 on GNU/Linux (64-bit)</ulink> + wiki article which provides you with the necessary steps to do it correct.</para> + </note> + </section> + <section> + <title>Installation From Zip file</title> + <para>You can download Jboss tools in a zip file from one of the pages below:</para> + <itemizedlist id="zip_sites"> + <listitem> + <para>Stable Releases: <ulink url="http://www.jboss.org/tools/download/stable.html" + >http://www.jboss.org/tools/download/stable.html</ulink></para> + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://www.jboss.org/tools/download/dev.html" + >http://www.jboss.org/tools/download/dev.html</ulink></para> + </listitem> + <listitem> + <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/" + >http://download.jboss.org/jbosstools/updates/nightly/</ulink></para> + </listitem> + </itemizedlist> + <para>When you downloaded Jboss Tools Zip please <emphasis>DO NOT UNZIP IT</emphasis> and follow the steps described below:</para> + <itemizedlist> + <listitem><para>When Eclipse is started, go to <property>Help -> Install New Software... -> Add... -> Archive...</property></para></listitem> + <listitem><para>Browse for the update site zip.In the <emphasis>Name</emphasis> field you can write any name you like. + In the end press <property>Ok</property> button.</para> + <figure> + <title>Installation from a zip file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4f.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>All the other steps are the same as it was described in the <link linkend="from_point"> + Installation From Update Site section</link>. </para> + </listitem> + </itemizedlist> + + </section> + + </section> + </section> + + <section id="Welcome"> + <title>Welcome to JBoss Developer Studio</title> + <para>In this section we'll show you how to work with the welcome page of the <property>JBoss + Developer Studio</property>.</para> + <para>The welcome page is the first page you see when you first launch <property>JBoss Developer + Studio</property>. </para> + + <figure> + <title>Welcome to JBoss Developer Studio</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>With the help of its page you will be able:</para> + <itemizedlist> + <listitem> + <para>to get quick access to Getting Started Documentation (guides, tutorials and + viewlets)</para> + </listitem> + </itemizedlist> + + <figure> + <title>Getting Started Documentation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to create new Seam projects, jBPM Process, JSF or Struts projects using JBDS + wizards</para> + </listitem> + </itemizedlist> + + <figure> + <title>Create New...</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to get short description of perspectives that JBDS offers for more productive + development</para> + </listitem> + </itemizedlist> + + <figure> + <title>Perspectives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to visit JBoss Developer Studio web resources.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Web Resources</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_9.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>Start work with <property>JBoss Developer Studio</property> by clicking on <emphasis> + <property>Workbench</property> + </emphasis> button or simply close the Welcome page.</para> + + </section> + + <section id="Upgrading"> + <?dbhtml filename="Upgrading.html"?> + <title>Upgrading</title> + <para>To upgrade, of course you can uninstall your current version and install the new one.</para> + <para>Now it's possible to upgrade from JBDS 2.0 to 2.1 using the update site which is available at + <ulink url="is available at http://devstudio.jboss.com/updates/2.1">http://devstudio.jboss.com/updates/2.1</ulink>. + This is described more fully in the <ulink url="http://www.jboss.com/products/devstudio/update/">JBDS Update Guide</ulink>.</para> + <note> + <title>Note:</title> + <para>You <emphasis><property>CAN NOT</property></emphasis> upgrade from 2.1 to 3.0 using update site because of some platform change.Full installation is required.</para> + </note> + </section> + + <section id="Uninstalling"> + <?dbhtml filename="Uninstalling.html"?> + <title>Uninstalling</title> + <itemizedlist> + <listitem> + <para>Make sure <property>JBoss Developer Studio</property> is not running</para> + </listitem> + <listitem> + <para>Uninstall your current version of <property>JBoss Developer Studio</property> by running + Uninstaller</para> + </listitem> + </itemizedlist> + </section> + + <section id="Support"> + <?dbhtml filename="Support.html"?> + <title>Support</title> + <para>If you have comments or questions, you can discuss them at our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss + Developer Studio Forum</ulink>.</para> + <para>When writing to the forum for questions, please include the following information:</para> + <orderedlist> + <listitem> + <para>JBoss Developer Studio version</para> + </listitem> + <listitem> + <para>Exact error message</para> + </listitem> + <listitem> + <para>Steps to reproduce the issue</para> + </listitem> + </orderedlist> + + <para><property>JBDS</property> subscribers can get necessary support on our <ulink url="https://network.jboss.com/jbossnetwork/login.html">Support Portal</ulink>.</para> + </section> + + + <section id="OtherRelevantResourcesOnTheTopic33"> + <?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> + <title>Other relevant resources on the topic</title> + <para>JBDS on RedHat: <ulink url="http://www.redhat.com/developer_studio">JBoss Developer + Studio</ulink></para> + <para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss + Forum</ulink></para> + <para> + Wiki: <ulink url="http://www.jboss.org/community/wiki/JBossTools"> JBossToolsWiki </ulink> + </para> + <para>Subscription: <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_studio.html">JBDS + Subscription</ulink></para> + + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para> + + <para> + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">Matrix of supported platforms, runtimes and technologies in JBossTools/JBDS</ulink></para> + </section> + +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/gsg_faq.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,221 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<chapter id="gsg_faq" xreflabel="gsg_faq" role="updated"> + <?dbhtml filename="gsg_faq.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>FAQ</title> + + <para>For more information on <property>JBoss Developer Studio</property> features, refer to the + following FAQ to get the answers on the most "popular" questions.</para> + + <section id="question_1"> + <title>What should I do if Visual Page Editor does not start under Linux</title> + + <para>Linux users may need to do the following to get the <property>Visual Page + Editor</property> to work correctly on their machines.</para> + + <orderedlist> + <listitem> + <para>On Red Hat based Linux distributions install the xpLib.i386 package</para> + </listitem> + <listitem> + <para>Type</para> + <programlisting role="JAVA"><![CDATA[ln -s libstdc++.so.5.0.7 libstdc++.so.5 +]]></programlisting> + </listitem> + <listitem> + <para>and/or use</para> + <programlisting role="JAVA"><![CDATA[yum install libXp +]]></programlisting> + </listitem> + <listitem> + <para>Open the JBDS perspective. If you see the Help view open, close it and restart + JBDS</para> + </listitem> + <listitem><para> If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present + in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar.To add this file to eclipse you should: + </para> + <itemizedlist> + <listitem> + <para>Decompress eclipse/plugins/org.eclipse.swt.gtk.linux.x86_3.4.1.v3449c.jar form eclipse-SDK-3.4.1-linux-gtk-x86_64.tar.gz</para> + </listitem> + <listitem> + <para>Copy <property>libswt-xulrunner-gtk-3449.so</property> file to your Fedora Eclipse location.</para> + </listitem> + + <listitem> + <para>Open the file eclipse.ini,which can be found in your Fedora Eclipse location and add the following line: </para> + <programlisting role="JAVA"><![CDATA[-Dswt.library.path=/usr/lib/eclipse +]]></programlisting><para>,where <code>/usr/lib/eclipse</code> is the path to your eclipse folder.</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>If none of these work, do the following:</para> + <itemizedlist> + <listitem> + <para>Clear the Eclipse log file, + <emphasis><workspace>\.metadata\.log</emphasis></para> + </listitem> + <listitem> + <para>Start Eclipse with the -debug option:</para> + <programlisting role="JAVA"><![CDATA[eclipse -debug +]]></programlisting> + </listitem> + <listitem> + <para>Post the Eclipse log file + (<emphasis><workspace>\.metadata\.log</emphasis>) on + the forums.</para> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> + </section> + + <section id="question_2"> + <title>Do I need to have JBoss Server installed to run JBoss Developer Studio?</title> + + <para>No. <property>JBoss Developer Studio</property> already comes bundled with JBoss + Server. We bundle it together so that you don't need to download any additional + software and can test your application in a Web browser right away.</para> + <para>If you want to use a different JBoss server installation, after <property>JBoss + Developer Studio</property> is installed open Servers View (select + <emphasis><property>Window > Show View > Others > Server + > Servers</property>),</emphasis> then right click on this <emphasis> + <property>view > New > Server</property> + </emphasis> and follow the wizards steps to point to another Jboss Server + installation.</para> + <para><property>JBoss Developer Studio</property> works with any servlet container, not just + JBoss. For more information on deployment, please see the Deploying Your Application + section.</para> + </section> + + <section id="question_3"> + <title>I have an existing Seam 1.2.1 project. Can I migrate/import the project to a JBDS + Seam project?</title> + + <para>We highly recommend you to create Seam 1.2.1 project using the + <property>JBDS</property>. In other case try to do manually:</para> + + <itemizedlist> + <listitem> + <para>Create a Seam Web project to get the JBoss tools structure</para> + </listitem> + </itemizedlist> + <para>Then from your Seam 1.2.1 seam-gen project start doing the following:</para> + <itemizedlist> + <listitem> + <para>Copy <property>src</property> to <property>src</property></para> + </listitem> + <listitem> + <para>Copy <property>view</property> to <property>Web content</property></para> + </listitem> + <listitem> + <para>Copy resources individual files to where they are in the seam web project + etc.</para> + </listitem> + </itemizedlist> + + </section> + <section id="questio_4"> + <title>I have an existing Struts or JSF project. Can I open the project in JBDS?</title> + + <para>Yes. From main menu select <emphasis> + <property>File > Import > Other > JSF Project (or Struts + Project)</property> + </emphasis> and follow wizards steps.</para> + + </section> + + <section id="question_5"> + <title>Can I import a .war file?</title> + + <para>Yes. Select <emphasis><property>File > Import > Web > WAR + file</property>, </emphasis> then follow importing steps.</para> + </section> + + <section id="question_6"> + <title>Is it possible to increase the performance of Eclipse after installing your + product?</title> + + <para><property>JBoss Developer Studio</property> preconfigures eclipse via the eclipse.ini + file to allocate extra memory, but if you for some reason need more memory then by + default, you can manually make adjustments in this file. For example:</para> + <programlisting role="XML"> + <![CDATA[-vmargs -Xms128m -Xmx512m -XX:MaxPermSize=128m +]]></programlisting> + </section> + + <section id="question_7"> + <title>How can I add my own tag library to the JBoss Tools Palette?</title> + + <para>See the Adding Tag + Libraries section in Visual Web Tools Guide.</para> + </section> + + <section id="question_8"> + <title>How to get Code Assist for Seam specific resources in an externally generated + project?</title> + + <para>To get Code Assist for Seam specific resources in an externally generated project, you + should enable Seam features in Project Preferences. Right click an imported project and + navigate <emphasis> + <property>Properties > Seam Settings</property>.</emphasis> Check <emphasis> + <property>Seam support</property> + </emphasis> box to enable all available Seam + Settings.</para> + </section> + + <section id="question_9"> + <title>How to import an example Seam project from jboss-eap directory?</title> + + <para>To import an example Seam project from <emphasis> + <property>jboss-eap</property> + </emphasis> into your working directory, you should perform the following steps:</para> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property>New > Other > Java Project from Existing Buildfile</property> + </emphasis></para> + </listitem> + + <listitem> + <para>Point to the <emphasis> + <property>build.xml</property> + </emphasis> of any chosen project by pressing <emphasis> + <property>Browse</property> + </emphasis> button</para> + </listitem> + + <listitem> + <para>Hit <emphasis> + <property>Finish</property> + </emphasis> to open the project</para> + </listitem> + </itemizedlist> + + <para>As these seam examples are non WTP projects, next you should enable Seam support for + them. To do that, right click the project and go to <emphasis> + <property>Properties > Seam Settings</property>.</emphasis></para> + </section> + + <section id="question_10"> + <title>Is a cross-platform project import possible for JBDS?</title> + + <para>Yes. You can easily import created in Linux JSF, Struts or Seam project to Windows and + vice versa.</para> + + <para>To do the transferring JSF, Struts or Seam project, go to <emphasis> + <property>Menu > Import > General > Existing Projects into Workspace</property>,</emphasis> + select the folder where your project stored and press <emphasis> + <property>Finish</property>.</emphasis></para> + </section> +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/favicon0.ico =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/favicon0.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam18.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam19.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam20.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam21.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam22.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam23.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam24.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam24.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam25.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam25.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam26.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam26.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam27.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam27.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam28.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam28.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam29.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam29.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam30.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam30.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam31.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam31.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam32.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam32.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam33.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam33.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam34a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam35.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam35.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam36.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam36.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam37.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam37.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam38.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam38.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam39.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam39.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam40.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam40.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam41.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam41.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam42.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam42.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam43.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam43.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam44.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam44.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam45.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam45.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam46.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam46.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam47.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam47.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam48.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam48.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam49.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam49.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam8_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/first_seam/first_seam9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_3_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_3_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_3_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4c.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4c.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4d.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4d.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4e.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4e.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4f.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_4f.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/getting_started_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/getting_started/update_wizard_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_18.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_19_finger_touch.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_19_finger_touch.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/jsp_application/jsp_application_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/eap5runtime.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/eap5runtime.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/manage/manage_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_user_site.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/pr_example_user_site.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/preferences.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/project_examples/preferences.png ___________________________________________________________________ Name: svn:executable + * Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_1.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_10.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_11.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_11.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_12.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_12.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_13.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_13.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_14.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_14.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_15.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_15.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_16.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_16.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_17.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_17.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_18.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_18.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_19.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_19.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_2.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_20.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_20.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_21.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_21.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_22.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_22.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_23.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_23.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_3.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_4.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_5.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_6.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_7.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8a.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8a.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8b.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_8b.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_9.png =================================================================== (Binary files differ) Property changes on: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/images/rad_jsf_application/rad_jsf_application_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/jsp_application.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/jsp_application.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/jsp_application.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,441 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jsp_application" xreflabel="jsp_application"> + <?dbhtml filename="jsp_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSP</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Developing a simple JSP web application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property>Seam</property>. This chapter is for users + who for some reason cannot use Seam.</para> + </note> + + <para>In this chapter you'll find out how to create a simple <ulink + url="http://java.sun.com/products/jsp/">JSP</ulink> application using the + <property>JBoss Developer Studio</property>. The application will show a classic + "Hello World!" on the page.</para> + <para>We'll assume that you have already launched <property>JBoss Developer + Studio</property> and also that the <property>Web Development</property> perspective is the + current perspective. If not, make it active by selecting <emphasis> + <property>Window > Open Perspective > Web Development</property> + </emphasis> from the menu bar or by selecting <emphasis> + <property>Window > Open Perspective > Other...</property> + </emphasis> from the menu bar and then selecting Web Development from the Select Perspective + dialog box.</para> + + <section id="SettingUpTheProject"> + <?dbhtml filename="SettingUpTheProject.html"?> + <title>Setting Up the Project</title> + <para>We are going to start with the creating a Dynamic Web Project with a minimal + structure, i.e. with just required facets. Thus this section will perform you all + necessary steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis> + <property>File > New > Other...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>Web > Dynamic Web Project</property> + </emphasis> in the New Project dialog box</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Next</property> + </emphasis> + </para> + </listitem> + <listitem> + <para>Enter "jspHello" as a project name</para> + </listitem> + <listitem> + <para>Then select <emphasis> + <property>Minimal Configuration</property> + </emphasis> from the list of possible configurations and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Create New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>jspHello</property> + </emphasis> node should appear in the upper-left <property>Package Explorer</property> + view.</para> + <figure> + <title>New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingJSPPage"> + <?dbhtml filename="CreatingJSPPage.html"?> + <title>Creating JSP Page</title> + <para>This section covers all the points how to create, edit and then preview JSP page.</para> + <para>In our simple application we need to create only one JSP page which displays a + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis><property>WebContent > New > + JSP</property>. </emphasis></para> + </listitem> + <listitem> + <para>Type "hello.jsp" for a file name and click the <emphasis> + <property>Next</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <para>In the next window you can choose a template for your jsp page and see its preview.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>New JSP File (xhtml)</property> + </emphasis> template and click <emphasis> + <property>Finish</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure> + <title>Create JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Our <emphasis><property>hello.jsp</property></emphasis> page will now appear in + <property>Project Explorer</property>. + </para> + <section id="EditingJSPPage"> + <?dbhtml filename="EditingJSPPage.html"?> + <title>Editing a JSP Page</title> + <para>Let's now make a little change so that a jsp page displays + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> +  + <para> + + Insert this line inside the + <code><body> </body> + </code> + tag: + </para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<% System.out.println("Hello World!"); %>]]> + </programlisting> + + <para>Notice that content assist functionality is always available when you are typing:</para> + <figure> + <title>Content Assist in JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>After changes made your <emphasis> + <property>hello.jsp</property> + </emphasis> page should look like this:</para> + <figure> + <title>Hello.jsp Page Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This line will actually output <emphasis>"Hello + World!"</emphasis> message in the <property>Console</property>. To make the + message displayed in the Browser, just replace this line with the simple + <emphasis>Hello World!</emphasis>.</para> + </section> + + <section id="WebXML"> + <?dbhtml filename="WebXML.html"?> + <title>web.xml file</title> + <para>When you are creating web project the wizard creates the <emphasis> + <property>web.xml</property> + </emphasis> for you automatically. The <property>web.xml file editor</property> + provided by <property>JBoss Developer Studio</property> is available in two modes: + <property>Tree</property> and <property>Source</property>.</para> + <figure> + <title>Web.xml in Design and Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_6.png" scale="90" + /> + </imageobject> + </mediaobject> + </figure> + <para>Both modes are fully synchronized. Let's add mapping to our <emphasis> + <property>hello.jsp</property> + </emphasis> page in <emphasis> + <property>web.xml</property> + </emphasis> file.</para> + <itemizedlist> + <listitem> + <para>Switch to <property>Source</property> tab.</para> + </listitem> + <listitem> + <para>Add the next code into + <code><welcome-file-list></code> + :</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<welcome-file>hello.jsp</welcome-file> +]]></programlisting> + <para>If you come back to <property>Tree</property> mode you will see that the changes + made are automatically reflected in that mode.</para> + <para>Actually you don't really need to do any configurations right now.</para> + </section> + + <section id="DeployTheProject"> + <?dbhtml filename="DeployTheProject.html"?> + <title>Deploying the project</title> + <para>While creating any web project you could experience a pain writing ant scripts and + managing the packaging even when writing the most trivial web applications. With + <property>JBoss Developer Studio</property> you are saved from such a pain. All + you need is to start <property>JBoss Server</property> and launch your application + in your favorite browser.</para> + <para>You can also create a war archive with JBDS's Archive Tools + and export it to any web server.</para> + <section id="WarConfig"> + <?dbhtml filename="WarConfig.html"?> + <title>WAR Config</title> + <para>Project archives managing is available through Project Archives view.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>Window > Show view > Other > JBoss + Tools > Project archives</property> + </emphasis> from menu bar</para> + </listitem> + <listitem> + <para>Select a project in Package Explorer you want to be archived</para> + </listitem> + </itemizedlist> + <para>In <property>Project Archives</property> you will see available archive types + for the project:</para> + <figure> + <title>Project Archives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_8.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click, for example, <emphasis> + <property>WAR</property> + </emphasis> option to create war archive</para> + </listitem> + </itemizedlist> + <para>In the <property>New WAR</property> dialog you can see automatically selected + default values.</para> + <figure> + <title>New WAR Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_9.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>Next</property> + </emphasis> to see a stub archive configuration for your project: <figure> + <title>Stub Archive Configuration</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsp_application/jsp_application_10.png" + /> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property>. </emphasis> The + <emphasis>.war</emphasis> file will appear in <property>Package + Explorer</property> and also in <property>Project Archives</property> + view as structure tree: <figure> + <title>Archive is Created</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsp_application/jsp_application_11.png" + /> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Archive in Project Archives View</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/jsp_application/jsp_application_12.png" + /> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>Via <property>Project Archives</property> view you could now edit your + archive, add new folders, publish to server, and so on:</para> + <figure> + <title>Configure Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_13.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="AutoRedeploy"> + <?dbhtml filename="AutoRedeploy.html"?> + <title>Auto redeploy</title> + <para>When you are creating a web application and register it on <property>JBoss + Server</property> it is automatically deployed into + <emphasis>/deploy</emphasis> directory of the server. JBDS comes with the + feature of auto-redeploy. It means that you don't need to restart + <property>JBoss Server</property>. Any changes made in the application in + exploded format will trigger a redeployment on the server.</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/jsp_application/jsp_application_19_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> + + </section> + + </section> + + <section id="Previewtab"> + <?dbhtml filename="Previewtab.html"?> + <title>JSP Page Preview</title> + <para><property>JBDS</property> comes with JSP design-time preview features. When + designing JSP pages you can easily preview how they will look during runtime. You + can even attach your stylesheet to the + Preview.</para> + <itemizedlist> + <listitem> + <para>Make a little change to <emphasis> + <property>hello.jsp</property> + </emphasis> page, e.g. put this code snippet:</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<%= new java.util.Date() %> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Switch to Preview page by clicking <property>Preview</property> tab at the + bottom of the page. You will see how the page will look at runtime.</para> + </listitem> + </itemizedlist> +  + </section> + <section id="LaunchingTheProject"> + <?dbhtml filename="LaunchingTheProject.html"?> + <title>Launch JSP Project</title> + <para>Let's now launch our project on server. We'll use + <property>JBoss Server</property> that is shipped with <property>JBoss Developer + Studio</property>. You can do it by performing one of the following actions:</para> + <itemizedlist> + <listitem> + <para>Start JBoss Server from JBoss + Server view by clicking the Start the server icon ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_18.png"/> + </imageobject> + </inlinemediaobject> ) .</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Click the Run icon or right click your project folder and select <emphasis> + <property>Run As > Run on Server</property>. </emphasis> If you + haven't made any changes in <emphasis> + <property>web.xml</property> + </emphasis> file or cleared it out you can launch the application by right + clicking the <emphasis> + <property>hello.jsp</property> + </emphasis> page and selecting <emphasis> + <property>Run on the Server</property> </emphasis>( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_16.png"/> + </imageobject> + </inlinemediaobject> ).</para> + </listitem> + </itemizedlist> + + <para>You should see the next page in a Browser :</para> + <figure> + <title>Running Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus with the help of this chapter you've learnt how to organize a Dynamic + Web Project with a minimal configuration, add any staff to it (in our case it's + just one jsp page) and deploy and run it on the <property>JBoss Server</property> + shipped with <property>JBDS</property>. + </para> + </section> + + </section> +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/manage.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/manage.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/manage.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,308 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="manage" xreflabel="manage"> + <?dbhtml filename="manage.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Manage JBoss AS from JBoss Developer Studio</title> + + <para>In this chapter we'll focus more on how to operate the <property>JBoss + AS</property> from <property>JBoss Developer Studio</property>.</para> + <para><property>JBoss Developer Studio 2.1.0.GA</property> is shipped with <property>JBoss EAP 5 + </property>. When you followed the default installation of <property>JBoss + Developer Studio</property>, you should already have a JBoss EAP 5 Server installed and + defined. To run JBoss AS you need JDK 1.5, JDK 6 is not formally supported yet, although + you may be able to start the server with it.</para> + + <section id="JBossbundled"> + <?dbhtml filename="JBossbundled.html"?> + <title>How to Manage the JBoss AS Bundled in JBDS</title> + <para>This section covers the basics of working with the <property>JBoss Server</property> + supported directly by <property>JBDS</property> via bundled AS plug-in. The server points to + the JBoss Enterprise Application Platform 5.0 Runtime shipped with <property>JBDS</property>.</para> + + <figure> + <title>JBoss EAP 5.0 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/eap5runtime.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>To read more about AS plug-in, refer to the Server Manager guide.</para> + <section id="StartingServer"> + <?dbhtml filename="StartingServer.html"?> + <title>Starting JBoss Server</title> + <para>Starting <property>JBoss Server</property> is quite simple. <property>JBoss + Developer Studio</property> allows you to control its behaviour with the help of + a special toolbar, where you could start it in a regular or debug mode, stop it or + restart it.</para> + + <itemizedlist> + <listitem> + <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> + </listitem> + </itemizedlist> + <figure> + <title>Starting from Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>While launching, server output is written to the <property>Console + view</property>:</para> + + <figure> + <title>Console Output</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When the server is started you should see <emphasis> + <property>Started</property> + </emphasis> in the square brackets right next its name in <property>JBoss Server + View</property>.</para> + + <figure> + <title>Server is Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_4.png"/> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="StoppingJBoss"> + <?dbhtml filename="StoppingJBoss.html"?> + <title>Stopping JBoss Server</title> + <para>To stop the server, click the <emphasis> + <property>Stop</property> + </emphasis> icon in <property>JBoss Server View</property> or right click the server + name and press <emphasis> + <property>Stop</property>. </emphasis></para> + + <figure> + <title>Stopping Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>When the server is stopped you will see <emphasis> + <property>Stopped</property> + </emphasis> in the square brackets next to its name.</para> + </section> + <section id="ServerPreferences"> + <?dbhtml filename="ServerPreferences.html"?> + <title>Server Container Preferences</title> + <para>You can control how <property>JBoss Developer Studio</property> interacts with + server containers in the <property>Server editor</property>. Double-click the server + to open it in the editor.</para> + + <figure> + <title>Server Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here you can specify some common settings: host name, server name, runtime as well + as settings related to the publishing, timeouts and server ports.</para> + + </section> + </section> + + <section id="JBossInstances"> + <?dbhtml filename="JBossInstances.html"?> + <title>How to Use Your Own JBoss AS Instance with JBDS</title> + <para>Although <property>JBoss Developer Studio</property> works closely with + <property>JBoss EAP 5</property> we do not ultimately tie you to any particular + server for deployment. There are some servers that Studio supports directly (via the + bundled Eclipse WTP plug-ins). In this section we discuss how to manage self-installed + JBoss AS. Suppose you want to deploy the application to <property>JBoss 4.2.3 + server</property>. First of all you need to install it.</para> + <section id="JBossInstalling"> + <?dbhtml filename="JBossInstalling.html"?> + <title>JBoss AS Installation</title> + <itemizedlist> + <listitem> + <para>Download the binary package of JBoss AS, e.g. <property>JBoss 4.2.3</property> and save + it on your computer: <ulink url="http://labs.jboss.com/jbossas/downloads" + >http://labs.jboss.com/jbossas/downloads</ulink></para> + </listitem> + </itemizedlist> + <para>It does not matter where on your system you install JBoss server.</para> + + <note> + <title>Note:</title> + <para>The installation of JBoss server into a directory that has a name containing + spaces provokes problems in some situations with Sun-based VMs. Try to avoid + using installation folders that have spaces in their names.</para> + </note> + + <para>There is no requirement for root access to run JBoss Server on UNIX/Linux systems + because none of the default ports are within the 0-1023 privileged port + range.</para> + <itemizedlist> + <listitem> + <para>After you have the binary archive you want to install, use the JDK jar + tool (or any other ZIP extraction tool) to extract the jboss-4.2.3.GA.zip + archive contents into a location of your choice. The jboss-4.2.3.GA.tgz + archive is a gzipped tar file that requires a gnutar compatible tar which + can handle the long pathnames in the archive. The extraction process will + create a jboss-4.2.3.GA directory. </para> + </listitem> + </itemizedlist> + </section> + + <section id="AddingJBossServer"> + <?dbhtml filename="AddingJBossServer.html"?> + <title>Adding and Configuring JBoss Server</title> + <para>Now we should add just installed server into server manager in <property>JBoss + Developer Studio</property>.</para> + <itemizedlist> + <listitem> + <para>Open the <property>JBoss Server View</property> by selecting <emphasis> + <property>Window > Show View > Other > Server + > JBoss Server View</property> + </emphasis></para> + </listitem> + <listitem> + <para>Right click anywhere in this view and select <emphasis> + <property>New Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>JBoss Community > JBoss 4.2 Server</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Selecting Server Name and Server Type</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_9.png"/> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now in the <property>New Server wizard</property> there is a separation + between the .org servers (the <emphasis> + <property>JBoss Community</property> + </emphasis> category) and product server that comes bundled with JBoss EAP (the + <emphasis> + <property>JBoss Enterprise Middleware</property></emphasis> category).</para> + </note> + + <itemizedlist> + <listitem> + <para>To create a new runtime, which Jboss AS 4.2 matches to, click <emphasis> + <property>Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>In the next step make <property>JBoss Developer Studio</property> to know + where you have installed the Server and define JRE.</para> + </listitem> + </itemizedlist> + <figure> + <title>Defining JBoss Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_11.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When adding a new server you will need to specify what JRE to use. It is + important to set this value to a full JDK, not JRE. Again, you need a full JDK + to run Web applications, JRE will not be enough.</para> + </note> + + <itemizedlist> + <listitem> + <para>In the next dialog verify the specified information and if something is + unfair go back and correct it</para> + </listitem> + </itemizedlist> + <figure> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_15.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the last wizard's dialog modify the projects that are + configured on the server and click <emphasis> + <property>Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <figure> + <title>Configuring Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_16.png"/> + </imageobject> + </mediaobject> + </figure> + <para>A new <property>JBoss Server</property> should now appear in the <property>JBoss + Server view</property>.</para> + <figure> + <title>New JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_17.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now, we are ready to create the first web application.</para> + </section> + + </section> +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,71 @@ +<?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 getting_started SYSTEM "getting_started.xml"> +<!ENTITY manage SYSTEM "manage.xml"> +<!ENTITY first_seam SYSTEM "first_seam.xml"> +<!ENTITY jsp_application SYSTEM "jsp_application.xml"> +<!ENTITY rad_jsf_application SYSTEM "rad_jsf_application.xml"> +<!ENTITY gsg_faq SYSTEM "gsg_faq.xml"> +<!ENTITY further_reading SYSTEM "further_reading.xml"> +<!ENTITY project_examples SYSTEM "project_examples.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"> +<!ENTITY jbossportallink "../../jboss_portal_tools_ref_guide/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> +<!ENTITY wslink "../../ws_ref_guide/html_single/index.html"> +<!ENTITY smookslink "../../jboss_smooks_plugin_ref_guide/html_single/index.html"> +<!ENTITY droolslink "../../drools_tools_ref_guide/html_single/index.html"> +<!ENTITY jmxlink "../../jmx_ref_guide/html_single/index.html"> +<!ENTITY guvnorlink "../../guvnor_tools_ref_guide/html_single/index.html"> + + +]> + +<book> + <bookinfo> + <title>Getting Started Guide</title> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo>Version: 3.0.0.GA</releaseinfo> + <abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/GettingStartedGuide/...">PDF version</ulink> + </para> +</abstract> + + +</bookinfo> + <toc/> + + + +&getting_started; + &manage; + &first_seam; + &jsp_application; + &rad_jsf_application; + &project_examples; + &gsg_faq; + &further_reading; + +</book> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master_output.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master_output.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/master_output.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,4414 @@ +<?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 getting_started SYSTEM "modules/getting_started.xml"> +<!ENTITY manage SYSTEM "modules/manage.xml"> +<!ENTITY first_seam SYSTEM "modules/first_seam.xml"> +<!ENTITY jsp_application SYSTEM "modules/jsp_application.xml"> +<!ENTITY rad_jsf_application SYSTEM "modules/rad_jsf_application.xml"> +<!ENTITY gsg_faq SYSTEM "modules/gsg_faq.xml"> +<!ENTITY further_reading SYSTEM "modules/further_reading.xml"> +<!ENTITY project_examples SYSTEM "modules/project_examples.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"> +<!ENTITY jbossportallink "../../jboss_portal_tools_ref_guide/html_single/index.html"> +<!ENTITY migrationlink "../../Exadel-migration/html_single/index.html"> +<!ENTITY wslink "../../ws_ref_guide/html_single/index.html"> +<!ENTITY smookslink "../../jboss_smooks_plugin_ref_guide/html_single/index.html"> +<!ENTITY droolslink "../../drools_tools_ref_guide/html_single/index.html"> +<!ENTITY jmxlink "../../jmx_ref_guide/html_single/index.html"> +<!ENTITY guvnorlink "../../guvnor_tools_ref_guide/html_single/index.html"> + + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>Getting Started with JBoss Developer Studio</title> + + <copyright> + <year>2007</year> + <year>2008</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo>Version: 3.0.0.GA</releaseinfo> + <abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/GettingStartedGuide/...">PDF version</ulink> + </para> +</abstract> + + +</bookinfo> + <toc></toc> + + + + +<chapter id="getting_started" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/getting_started.xml" xreflabel="getting_started"> + <?dbhtml filename="getting_started.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Getting Started with JBoss Developer Studio</title> + + <section id="intro1"> + <title>What is JBDS?</title> + <para><property moreinfo="none">JBoss Developer Studio</property> is a set of eclipse-based development tools that + are pre-configured for JBoss Enterprise Middleware Platforms and Red Hat Enterprise Linux. + Developers are not required to use <property moreinfo="none">JBoss Developer Studio</property> to develop on + JBoss Enterprise Middleware and/or Red Hat Linux. But, many find these pre-configured tools offer + significant time-savings and value, making them more productive and speeding time to deployment.</para> + <para>This guide covers the first steps to get started working with <property moreinfo="none">JBoss Developer + Studio</property>. You will learn how to install and configure necessary software for your OS + (currently Linux, Microsoft Windows or Mac OSX).</para> + <para>Thus this guide will provide you with detailed info on how to start JDK, JBDS and JBoss + Tools.</para> + </section> + +<section> + <title>Key Features of JBoss Developer Studio and Requirements</title> + <para>For a start, we propose you to look through the table of main features of JBoss Developer Studio:</para> + + <table> + + <title>Key Functionality of JBoss Developer Studio</title> + <tgroup cols="2"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + + <tbody> + + <row> + <entry><para>JBoss Enterprise Application Platform</para></entry> + <entry><para>JBoss Developer Studio includes and integrates JBoss Enterprise Application Platform, the same version of the middleware platform that Red Hat supports in production for 5 years.</para></entry> + </row> + + <row> + <entry><para>New Seam Tools</para></entry> + <entry><para>JBoss Developer Studio includes brand new tools for Seam. They provide wizards for creating new Seam projects, validation tools, expression language code completion, testing tools, and wizards for generating entity objects.</para></entry> + </row> + + <row> + <entry><para>Visual Page Editor</para></entry> + <entry><para>JBoss Developer Studio includes a Visual Page Editor for combined visual and source editing of Web pages. The Visual Page Editor even renders AJAX-enabled RichFaces components.</para></entry> + </row> + + <row> + <entry><para>AJAX Capabilities</para></entry> + <entry><para>JBoss Developer Studio includes a Technology Preview of JBoss RichFaces. RichFaces provides nearly 70 skinnable components, including calendar, tree, dropdown menu, drag-and-drop components, and more. JBoss Developer Studio’s Visual Page Editor can render RichFaces components.</para></entry> + </row> + + <row> + <entry><para>JBoss Tools Palette</para></entry> + <entry><para>The JBoss Tools Palette contains a developer’s project tag libraries and enables inserting tags into a JSP with one click. The Tools Palette supports custom and 3rd party tags.</para></entry> + </row> + + <row> + <entry><para>JBoss jBPM Tools</para></entry> + <entry><para>JBoss Developer Studio includes jBPM tooling for defining Seam page flows.</para></entry> + </row> + + <row> + <entry><para>Spring Tools</para></entry> + <entry><para>JBoss Developer Studio includes Spring IDE for developing Spring applications.</para></entry> + </row> + + <row> + <entry><para>Struts Tools</para></entry> + <entry><para>JBoss Developer Studio includes Struts tools for Struts 1.x applications.</para></entry> + </row> + + <row> + <entry><para>Optimized JBoss Application Server adapter</para></entry> + <entry><para>JBoss Developer Studio’s advanced JBoss AS adapter includes features like incremental deployment for fast development and is pre-configured for the included JBoss Application server.</para></entry> + </row> + + <row> + <entry><para>Red Hat Enterprise Linux and RHN Access</para></entry> + <entry><para>JBoss Developer Studio includes access to Red Hat Enterprise Linux, Linux development tools, and Red Hat Network for development purposes.</para></entry> + </row> + + <row> + <entry><para> Project Examples</para></entry> + <entry><para> Tooling for easy installation of Examples.</para></entry> + </row> + + <row> + <entry><para>JBossWeb Service</para></entry> + <entry><para>JBoss WS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para></entry> + </row> + </tbody> + </tgroup> + </table> + + <para><property moreinfo="none">JBDS</property> requires JDK 5+ (JDK 6 in case of EAP 5.0). Also it's important that + the JVM's architecture matches the particular <property moreinfo="none">JBDS</property> build, i.e. if you're on a + 64-bit system and use the 64-bit JVM, you need the 64-bit JBDS.</para> + + <para>For the 32-bit version of JBDS use the 32-bit JVM or just use <literal moreinfo="none">-vm</literal> flag to + tell JBDS to use 32-bit java if the 64-bit one is found as the default.</para> + + <note> + <title>Note:</title> + <para>On Linux system with 64-bit JVM the visual editor may fail to start. In this case you need the <literal moreinfo="none">libstdc++.so.5</literal> library. + See also the <link linkend="question_1">FAQ</link>.</para> + </note> +</section> + + <section id="ConfigJavaEnvironment"> + <?dbhtml filename="ConfigJavaEnvironment.html"?> + <title>Configuring Your Java Environment</title> + <para>You must have a working installation of JDK before you install <property moreinfo="none">JBoss Developer + Studio</property>. Thus in this + guide we will show you how to install a 32-bit Sun JDK 5.0 on a Linux Platform and Microsoft + Windows Platform.</para> + + <section id="InstallJDK50onLinux"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Linux</title> + <para>To install 32-bit Sun JDK 5.0 on Linux and configure it, you should follow the next steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + <x>" (where "x" is the latest update number) for + download and then select "Red Hat Package Manager in self-extracting" file + for Linux. Read the instructions on Sun's website for installing the JDK.</para> + </listitem> + <listitem> + <para>If you don't want to use SysV service scripts you can install the + "self-extracting file" for Linux instead of choosing the "RPM in + self-extracting" file. In that case you can skip the next step mentioned here. But it + is recommended to use the SysV service scripts for production servers.</para> + </listitem> + <listitem> + <para>Download and install the appropriate -compat RPM from JPackage <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-free/">here</ulink>. + Please ensure you choose a matching version of the -compat package to the JDK you've + installed.</para> + </listitem> + <listitem> + <para>Create an environment variable that points to the JDK installation directory and call it + JAVA_HOME. Add <emphasis> + <property moreinfo="none">$JAVA_HOME/bin</property> + </emphasis> to the system path to be able to run java from the command line. You can do this + by adding the following lines to the .bashrc file in your home directory.</para> + <programlisting format="linespecific"><![CDATA[#In this example /usr/java/jdk1.5.0_11 is the JDK installation directory. +export JAVA_HOME=/usr/java/jdk1.5.0_11 +export PATH=$PATH:$JAVA_HOME/bin]]></programlisting> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + + <para>If you have JDK already installed and added in your system path, you should add + <emphasis>$JAVA_HOME/bin</emphasis> before the old <emphasis>$PATH</emphasis> (not after it) + so that the new version of JDK can be found first, i. e. <emphasis> + <emphasis>export PATH=$JAVA_HOME/bin:$PATH</emphasis> + </emphasis> This way, the machine will pick up the new JVM first. You only need to run + "alternative" as a safe guard for the right JVM. </para> + </note> + + <para>Set this variable for your account doing the installation and also for the user account + that will run the server.</para> + <itemizedlist> + <listitem> + <para>If you have more than one version of JVM installed on your machine, make sure you are + using the JDK 1.5 installation as the default java and javac. You can do this using the + alternatives system. The alternatives system allows different versions of Java from different + sources to co-exist on your system.</para> + </listitem> + </itemizedlist> + <section id="SelectAlternativesforJava"> + <title>Select alternatives for java, javac and java_sdk_1.5.0</title> + <itemizedlist> + <listitem> + <para>As a root user, type the following command at the shell prompt and you should see + something like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs that provide 'java'. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>Make sure the Sun version [jre-1.5.0-sun in this case] is selected (marked with a + '+' in the output), or select it by entering its number as prompted.</para> + <itemizedlist> + <listitem> + <para>Repeat the same for javac and java_sdk_1.5.0.</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config javac +There is 1 program that provides 'javac'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun/bin/javac +Enter to keep the current selection[+], or type selection number: + +[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.5.0 +There is 1 program that provide 'java_sdk_1.5.0'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer + and version.</para> + <note> + <title>Note:</title> + <para>You can always override this step by setting the JAVA_HOME environment variable as + explained in the previous step.</para> + </note> + <itemizedlist> + <listitem> + <para>Make sure that the java executable is in your path and that you are using an appropriate + version. To verify your Java environment, type "java -version" at the shell + prompt and you should see something like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific"><![CDATA[[root@vsr ~]$ java -version +java version "1.5.0_11" +Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) +Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing)]]></programlisting> + </section> + + </section> + <section id="InstallJDK50onWindows"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> + + <para>To install and configure 32-bit Sun JDK 5.0 on Microsoft Windows, follow these steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun's website. Choose "JDK 5.0 Update + <x>" (where "x" is the latest update number) for + download and then select your Windows Platform options to perform the installation.</para> + </listitem> + <listitem> + <para>Create an environment variable called JAVA_HOME that points to the JDK installation + directory, for example: + <emphasis>C:\Program Files\Java\jdk1.5.0_11\</emphasis> + </para> + </listitem> + </itemizedlist> + + <para>In order to run java from the command line, add the <emphasis>jre\bin</emphasis> directory + to your path, for example:</para> + <para> + <emphasis>C:\Program Files\Java\jdk1.5.0_11\jre\bin</emphasis> + </para> + <para>To do this, open the <emphasis> + <property moreinfo="none">Control Panel</property> + </emphasis> from the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> menu, switch to Classic View if necessary, open the System Control Panel applet (<emphasis> + <property moreinfo="none">System</property> + </emphasis>), select the <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis> Tab, and click on the <emphasis> + <property moreinfo="none">Environment Variables</property> + </emphasis> button.</para> + <para>Now, when 32-bit Sun JDK 5.0 has been successfully installed, we can pass on to the next + step.</para> + </section> + + </section> + + <section id="InstallingJBDS"> + <?dbhtml filename="InstallingRHDS.html"?> + <title>JBoss Developer Studio Installation</title> + + <para>This chapter will provide you with detailed information on how to install <property moreinfo="none">JBoss + Developer Studio</property>.</para> + + <para>JBDS comes with a simple installer, bundled with tested/pre-configured versions of Eclipse, + WTP, JBossEAP, Seam, and SpringIDE. Thus, to start perform the next steps:</para> + + <itemizedlist> + <listitem> + <para>First of all you need the appropriate installation file for your platform from + <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_studio.html">Red Hat + website</ulink>.</para> + </listitem> + <listitem> + <para>Then run in console:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[java -jar jbdevstudio-eap-linux-gtk-2.1.0.GA.jar +]]></programlisting> + </listitem> + <listitem> + <para>Follow the instructions presented by the installation wizard:</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JBoss Developer Studio Installation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Provide the installation path</para> + </listitem> + <listitem> + <para>Select Java VM</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Select Java VM</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>By selecting <emphasis> + <property moreinfo="none">Default Java VM</property> + </emphasis> you set default Java VM of your system (to verify your Java environment, type + "java -version" in console).</para> + </tip> + + <para>Selecting <emphasis> + <property moreinfo="none">Specific Java VM</property> + </emphasis> you can provide the path to non-default Java VM.</para> + + <note> + <title>Note:</title> + <para>JBoss Developer Studio needs Java 5 and "gij" isn't available on + every platform.</para> + </note> + + <itemizedlist> + <listitem> + <para>Installation process includes <ulink url="http://www.jboss.com/products/platforms/application">JBoss Enterprise Application + Platform</ulink>. Select <emphasis> + <property moreinfo="none">Yes</property></emphasis> to use it in JBoss Developer Studio.</para> + <note> + <title>Note:</title> + <para>JBDS 2.0.0.GA comes integrated with JBoss EAP 4.3, while the current 2.1.0.GA release of JBDS comes with JBoss EAP 5 that support EAP 5 adapter + and Seam 2.2.</para> + </note> + + <para>This step lets you configure locally available JBoss Application Servers: </para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JBoss Enterprise Application Platform Installing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + +<itemizedlist> + <listitem><para>You can fill the list automatically using the <emphasis><property moreinfo="none">Find</property></emphasis> button: click <emphasis><property moreinfo="none">Find</property></emphasis>, select a folder where search of available JBoss Application Servers should be started and click on <emphasis><property moreinfo="none">Ok</property></emphasis>: </para> </listitem> +</itemizedlist> + + <figure float="0"> + <title>Finding Servers in the Selected Directory</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_3_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + <itemizedlist> + <listitem><para> All available servers in the selected directory will be added to the list with the following information specified: Name, Type, Version and Location. + </para></listitem> + </itemizedlist> + + <itemizedlist> + <listitem> <para>You can also add servers one by one using the <emphasis><property moreinfo="none">Add</property></emphasis> button:</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Add Server to be Configured</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + +<para>Click on <emphasis><property moreinfo="none">Browse</property></emphasis> and select the server location. Fields Name, Type and Version will be filled in automatically:</para> + + <figure float="0"> + <title>Specify Server Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + + <para>Click on <emphasis><property moreinfo="none">Ok</property></emphasis>. The server is added to the list with the details on its type, version and location.</para> + + + + <para>The <emphasis><property moreinfo="none">Remove</property></emphasis> button will the remove the selected server from the list. If necessary, you can edit the server details clicking on the <emphasis><property moreinfo="none">Edit</property></emphasis> button:</para> + + <figure float="0"> + <title>Edit Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para></para> + + + +  + + <itemizedlist> + <listitem> + <para>Click <emphasis><property moreinfo="none">Next</property></emphasis>. Check your installation paths and see the components to install. If you'd like to change + something, press the <emphasis> + <property moreinfo="none">Previous</property> + </emphasis> button. Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to start installation. </para> + </listitem> + </itemizedlist> + + <para></para> + + <figure float="0"> + <title>Summary Information</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jbds_jbosstools"> + + <title>JBoss Developer Studio and JBoss Tools</title> + + <para>This section uncovers the points on the differences between <property moreinfo="none">JBoss Developer + Studio</property> and <property moreinfo="none">JBoss Tools</property> and provides the steps on <property moreinfo="none">JBoss + Tools</property> installation as well.</para> + + <section id="WhatDifferenceBetweenJBDSAndJBossTools"> + <title>What is the difference?</title> + + <para><property moreinfo="none">JBoss Tools</property> is what went into our <property moreinfo="none">JBoss Developer + Studio</property> which comes as an easy-to-install Eclipse based IDE fully configured and ready + to run with the bundled <property moreinfo="none">JBoss Enterprise Application Platform</property>.</para> + + <para>In short <property moreinfo="none">JBoss Tools</property> are just a set of Eclipse plugins and + <property moreinfo="none">JBoss Developer Studio</property> adds:</para> + <itemizedlist> + <listitem> + <para>An installer</para> + </listitem> + <listitem> + <para>Eclipse and Web Tools preconfigured</para> + </listitem> + <listitem> + <para>JBoss EAP with JBoss AS and Seam preconfigured</para> + </listitem> + <listitem> + <para>3rd party plugins bundled and configured</para> + </listitem> + <listitem> + <para>Access to RHEL and Red Hat Network</para> + </listitem> + <listitem> + <para>Access to the JBoss/Red Hat supported software</para> + </listitem> + </itemizedlist> + <para> For additional information see <ulink url="http://www.jboss.com/products/devstudio">JBoss.com</ulink></para> + </section> + + <section id="JBossToolsInstall"> + <title>JBoss Tools Installation and Update</title> + <para>Here, let's consider the installation of the <property moreinfo="none">JBoss Tools</property> + modules.</para> + <para><property moreinfo="none">JBoss Tools</property> is an umbrella project for the JBoss developed plugins + that will make it into <property moreinfo="none">JBoss Developer Studio</property>. The JBoss Tools modules are:</para> + <itemizedlist> + <listitem> + <para>JBoss AS Tools</para> + </listitem> + <listitem> + <para>Seam Tools</para> + </listitem> + <listitem> + <para>Hibernate Tools</para> + </listitem> + <listitem> + <para>Visual Page Editor</para> + </listitem> + <listitem> + <para>JST Tools</para> + </listitem> + <listitem> + <para>JBPM Tools</para> + </listitem> + </itemizedlist> + + <para>To install the JBoss Tools plugins for Eclipse, you need the following:</para> + + <itemizedlist> + <listitem> + <para>Get Eclipse and Web Tools (make sure you have the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">appropriate version of Eclipse</ulink>)</para> + </listitem> + </itemizedlist> + <para>The current version of JBoss Tools (3.1.M2) targets at Eclipse 3.5/Galileo which is available from <ulink url="http://www.eclipse.org/downloads/">eclipse.org</ulink></para> + + <tip> + <title>Tip:</title> + <para>We recommend you do not use Eclipse.org update site to go from old version of Eclipse to new one. + Instead we suggest that you download the full binary from <ulink url="http://www.eclipse.org/downloads/">here</ulink>.</para> + </tip> + + <para>If you can only use Eclipse 3.3 use <ulink url="http://www.jboss.org/tools/download.html">JBoss Tools 2.1.2</ulink>, but + JBoss Tools 2.x will not have any of the new features.</para> + + <note> + <title>Note:</title> + <para>Remember to choose the download that matches your OS and use Java 5 when you run + it.</para> + </note> + + <itemizedlist> + <listitem> + <para>Get the <ulink url="http://download.jboss.org/jbosstools/builds/nightly/latestBuild.html">latest JBoss Tools build</ulink></para> + </listitem> + </itemizedlist> + + <para>Some of our newer plugins, like TPTP and BIRT, need additional drivers. On the left side of + the download page you can find all of the required drivers for chosen build and their versions.</para> + <para><diffmk:wrapper diffmk:change="added">If you need to install any standalone plug-in from JBoss Tools visit a </diffmk:wrapper><ulink diffmk:change="added" url="http://labs.jboss.com/wiki/InstallingJBossTools"><diffmk:wrapper diffmk:change="added">JBoss Tools Wiki</diffmk:wrapper></ulink><diffmk:wrapper diffmk:change="added"> page to read + about dependencies between standalone plug-ins.</diffmk:wrapper></para> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Installation From Update Site</diffmk:wrapper></title> + + + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Instead of downloading installation/updating manually, it's also possible to + get the latest release of </diffmk:wrapper><property moreinfo="none">JBoss Tools</property><diffmk:wrapper diffmk:change="changed"> from one of our update sites: + </diffmk:wrapper><itemizedlist id="sites"> + <listitem> + <para>Stable Updates: <ulink url="http://download.jboss.org/jbosstools/updates/stable">http://download.jboss.org/jbosstools/updates/stable</ulink></para> + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://download.jboss.org/jbosstools/updates/development">http://download.jboss.org/jbosstools/updates/development</ulink></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Nightly Builds: </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/updates/nightly/trunk/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/updates/nightly/trunk/</diffmk:wrapper></ulink></para> + </listitem> + </itemizedlist> + </para> +<itemizedlist> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">To install/update Jboss Tools from one of the update sites you should follow the steps:</diffmk:wrapper></para> + <listitem><para><diffmk:wrapper diffmk:change="changed">First, download the correct version of Eclipse + for your platform which is compatible with the version of JBoss + Tools you plan to install.For example if you want to install + 3.1.0.GA Eclipse 3.5 is required.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you do not already have Java 5 or 6 installed and in your path, + download and install it.</diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When Eclipse is started, go to </diffmk:wrapper><itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="changed">Help->Software Updates... ->Available Software->Manage Sites...->Add...</diffmk:wrapper><emphasis><diffmk:wrapper diffmk:change="added">(Eclipse 3.4)</diffmk:wrapper></emphasis></para></listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">Help->Install New Software->Add..</diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">(Eclipse 3.5)</diffmk:wrapper></emphasis></para></listitem> + </itemizedlist> + </para></listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="added">After clicking </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Add</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> button </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Add Site</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> View should appear. + In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Location</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> field you should paste one of the update sites described + </diffmk:wrapper><link diffmk:change="added" linkend="sites"><diffmk:wrapper diffmk:change="added">above</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">.In </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Name</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> you can write any name you like. + In the end press the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Add Update Site</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added" id="from_point"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">In the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Install</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> View select features to install, then click </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Jboss Tools installation</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"> <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If Jboss Tools are already installed on your Eclipse and you are doing updating but not + installation the following messages will appear in your </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Details</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> section. + Ignore them and press </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Next.</diffmk:wrapper></emphasis></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Possible messages</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4c.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="changed">When you click Finish the prosses of Installation/Updating starts up. </diffmk:wrapper></para></listitem> + <listitem diffmk:change="added"><para><diffmk:wrapper diffmk:change="changed">Install. Restart when prompted.</diffmk:wrapper></para> + <figure float="0"> + <title><diffmk:wrapper diffmk:change="changed">Message dialog</diffmk:wrapper></title> + <mediaobject> + <imageobject> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4d.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After fetching all the features and plugins for installation, + you may be prompted that your selection contains unsigned jars. + This is normal,simply accept the warning and continue. </diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Warning Message</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4e.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> +</itemizedlist> + + <note> + <title>Note:</title> + <para>While installing JBoss Tools on GNU/Linux (64-bit) through the eclipse installation manager you may run into some problems which can interrupt your installation process. + Please, read the + <ulink url="http://www.jboss.org/community/wiki/ManualinstallationofJBossTools31xonEc...">Manual installation of JBoss Tools 3.1.x on Eclipse 3.5 on GNU/Linux (64-bit)</ulink> + wiki article which provides you with the necessary steps to do it correct.</para> + </note> + </section> + <section diffmk:change="added"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Installation From Zip file</diffmk:wrapper></title> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">You can download Jboss tools in a zip file from one of the pages below:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added" id="zip_sites"> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Stable Releases: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/tools/download/stable.html"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/tools/download/stable.html</diffmk:wrapper></ulink></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Development Updates: </diffmk:wrapper><ulink diffmk:change="added" url="http://www.jboss.org/tools/download/dev.html"><diffmk:wrapper diffmk:change="added">http://www.jboss.org/tools/download/dev.html</diffmk:wrapper></ulink></para> + </listitem> + <listitem diffmk:change="added"> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added"> Nightly Builds: </diffmk:wrapper><ulink diffmk:change="added" url="http://download.jboss.org/jbosstools/updates/nightly/"><diffmk:wrapper diffmk:change="added">http://download.jboss.org/jbosstools/updates/nightly/</diffmk:wrapper></ulink></para> + </listitem> + </itemizedlist> + <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When you downloaded Jboss Tools Zip please </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">DO NOT UNZIP IT</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> and follow the steps described below:</diffmk:wrapper></para> + <itemizedlist diffmk:change="added"> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">When Eclipse is started, go to </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Help -> Install New Software... -> Add... -> Archive...</diffmk:wrapper></property></para></listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Browse for the update site zip.In the </diffmk:wrapper><emphasis diffmk:change="added"><diffmk:wrapper diffmk:change="added">Name</diffmk:wrapper></emphasis><diffmk:wrapper diffmk:change="added"> field you can write any name you like. + In the end press </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Ok</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> + <figure diffmk:change="added" float="0"> + <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Installation from a zip file</diffmk:wrapper></title> + <mediaobject diffmk:change="added"> + <imageobject diffmk:change="added"> + <imagedata diffmk:change="added" fileref="images/getting_started/getting_started_4f.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All the other steps are the same as it was described in the </diffmk:wrapper><link diffmk:change="added" linkend="from_point"><diffmk:wrapper diffmk:change="added"> + Installation From Update Site section</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added">. </diffmk:wrapper></para> + </listitem> + </itemizedlist> + + </section> + + </section> + </section> + + <section id="Welcome"> + <title>Welcome to JBoss Developer Studio</title> + <para>In this section we'll show you how to work with the welcome page of the <property moreinfo="none">JBoss + Developer Studio</property>.</para> + <para>The welcome page is the first page you see when you first launch <property moreinfo="none">JBoss Developer + Studio</property>. </para> + + <figure float="0"> + <title>Welcome to JBoss Developer Studio</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With the help of its page you will be able:</para> + <itemizedlist> + <listitem> + <para>to get quick access to Getting Started Documentation (guides, tutorials and + viewlets)</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Getting Started Documentation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to create new Seam projects, jBPM Process, JSF or Struts projects using JBDS + wizards</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Create New...</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to get short description of perspectives that JBDS offers for more productive + development</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Perspectives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to visit JBoss Developer Studio web resources.</para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>Web Resources</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_9.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Start work with <property moreinfo="none">JBoss Developer Studio</property> by clicking on <emphasis> + <property moreinfo="none">Workbench</property> + </emphasis> button or simply close the Welcome page.</para> + + </section> + + <section id="Upgrading"> + <?dbhtml filename="Upgrading.html"?> + <title>Upgrading</title> + <para>To upgrade, of course you can uninstall your current version and install the new one.</para> + <para>Now it's possible to upgrade from JBDS 2.0 to 2.1 using the update site which is available at + <ulink url="is available at http://devstudio.jboss.com/updates/2.1">http://devstudio.jboss.com/updates/2.1</ulink>. + This is described more fully in the <ulink url="http://www.jboss.com/products/devstudio/update/">JBDS Update Guide</ulink>.</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">You </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">CAN NOT</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> upgrade from 2.1 to 3.0 using update site because of some platform change.Full installation is required.</diffmk:wrapper></para> + </note> + </section> + + <section id="Uninstalling"> + <?dbhtml filename="Uninstalling.html"?> + <title>Uninstalling</title> + <itemizedlist> + <listitem> + <para>Make sure <property moreinfo="none">JBoss Developer Studio</property> is not running</para> + </listitem> + <listitem> + <para>Uninstall your current version of <property moreinfo="none">JBoss Developer Studio</property> by running + Uninstaller</para> + </listitem> + </itemizedlist> + </section> + + <section id="Support"> + <?dbhtml filename="Support.html"?> + <title>Support</title> + <para>If you have comments or questions, you can discuss them at our + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss + Developer Studio Forum</ulink>.</para> + <para>When writing to the forum for questions, please include the following information:</para> + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>JBoss Developer Studio version</para> + </listitem> + <listitem> + <para>Exact error message</para> + </listitem> + <listitem> + <para>Steps to reproduce the issue</para> + </listitem> + </orderedlist> + + <para><property moreinfo="none">JBDS</property> subscribers can get necessary support on our <ulink url="https://network.jboss.com/jbossnetwork/login.html">Support Portal</ulink>.</para> + </section> + + + <section id="OtherRelevantResourcesOnTheTopic33"> + <?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> + <title>Other relevant resources on the topic</title> + <para>JBDS on RedHat: <ulink url="http://www.redhat.com/developer_studio">JBoss Developer + Studio</ulink></para> + <para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258">JBoss + Forum</ulink></para> + <para> + Wiki: <ulink url="http://www.jboss.org/community/wiki/JBossTools"> JBossToolsWiki </ulink> + </para> + <para>Subscription: <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_studio.html">JBDS + Subscription</ulink></para> + + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">here</ulink>.</para> + + <para> + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsruntimesand...">Matrix of supported platforms, runtimes and technologies in JBossTools/JBDS</ulink></para> + </section> + +</chapter> + + +<chapter id="manage" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/manage.xml" xreflabel="manage"> + <?dbhtml filename="manage.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Manage JBoss AS from JBoss Developer Studio</title> + + <para>In this chapter we'll focus more on how to operate the <property moreinfo="none">JBoss + AS</property> from <property moreinfo="none">JBoss Developer Studio</property>.</para> + <para><property moreinfo="none">JBoss Developer Studio 2.1.0.GA</property> is shipped with <property moreinfo="none">JBoss EAP 5 + </property>. When you followed the default installation of <property moreinfo="none">JBoss + Developer Studio</property>, you should already have a JBoss EAP 5 Server installed and + defined. To run JBoss AS you need JDK 1.5, JDK 6 is not formally supported yet, although + you may be able to start the server with it.</para> + + <section id="JBossbundled"> + <?dbhtml filename="JBossbundled.html"?> + <title>How to Manage the JBoss AS Bundled in JBDS</title> + <para>This section covers the basics of working with the <property moreinfo="none">JBoss Server</property> + supported directly by <property moreinfo="none">JBDS</property> via bundled AS plug-in. The server points to + the JBoss Enterprise Application Platform 5.0 Runtime shipped with <property moreinfo="none">JBDS</property>.</para> + + <figure float="0"> + <title>JBoss EAP 5.0 Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/eap5runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>To read more about AS plug-in, refer to the <ulink url="../../as/html_single/index.html">Server Manager guide</ulink>.</para> + <section id="StartingServer"> + <?dbhtml filename="StartingServer.html"?> + <title>Starting JBoss Server</title> + <para>Starting <property moreinfo="none">JBoss Server</property> is quite simple. <property moreinfo="none">JBoss + Developer Studio</property> allows you to control its behaviour with the help of + a special toolbar, where you could start it in a regular or debug mode, stop it or + restart it.</para> + + <itemizedlist> + <listitem> + <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> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Starting from Icon</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>While launching, server output is written to the <property moreinfo="none">Console + view</property>:</para> + + <figure float="0"> + <title>Console Output</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the server is started you should see <emphasis> + <property moreinfo="none">Started</property> + </emphasis> in the square brackets right next its name in <property moreinfo="none">JBoss Server + View</property>.</para> + + <figure float="0"> + <title>Server is Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> +  + </section> + + <section id="StoppingJBoss"> + <?dbhtml filename="StoppingJBoss.html"?> + <title>Stopping JBoss Server</title> + <para>To stop the server, click the <emphasis> + <property moreinfo="none">Stop</property> + </emphasis> icon in <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>Stopping Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>When the server is stopped you will see <emphasis> + <property moreinfo="none">Stopped</property> + </emphasis> in the square brackets next to its name.</para> + </section> + <section id="ServerPreferences"> + <?dbhtml filename="ServerPreferences.html"?> + <title>Server Container Preferences</title> + <para>You can control how <property moreinfo="none">JBoss Developer Studio</property> interacts with + server containers in the <property moreinfo="none">Server editor</property>. Double-click the server + to open it in the editor.</para> + + <figure float="0"> + <title>Server Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here you can specify some common settings: host name, server name, runtime as well + as settings related to the publishing, timeouts and server ports.</para> + + </section> + </section> + + <section id="JBossInstances"> + <?dbhtml filename="JBossInstances.html"?> + <title>How to Use Your Own JBoss AS Instance with JBDS</title> + <para>Although <property moreinfo="none">JBoss Developer Studio</property> works closely with + <property moreinfo="none">JBoss EAP 5</property> we do not ultimately tie you to any particular + server for deployment. There are some servers that Studio supports directly (via the + bundled Eclipse WTP plug-ins). In this section we discuss how to manage self-installed + JBoss AS. Suppose you want to deploy the application to <property moreinfo="none">JBoss 4.2.3 + server</property>. First of all you need to install it.</para> + <section id="JBossInstalling"> + <?dbhtml filename="JBossInstalling.html"?> + <title>JBoss AS Installation</title> + <itemizedlist> + <listitem> + <para>Download the binary package of JBoss AS, e.g. <property moreinfo="none">JBoss 4.2.3</property> and save + it on your computer: <ulink url="http://labs.jboss.com/jbossas/downloads">http://labs.jboss.com/jbossas/downloads</ulink></para> + </listitem> + </itemizedlist> + <para>It does not matter where on your system you install JBoss server.</para> + + <note> + <title>Note:</title> + <para>The installation of JBoss server into a directory that has a name containing + spaces provokes problems in some situations with Sun-based VMs. Try to avoid + using installation folders that have spaces in their names.</para> + </note> + + <para>There is no requirement for root access to run JBoss Server on UNIX/Linux systems + because none of the default ports are within the 0-1023 privileged port + range.</para> + <itemizedlist> + <listitem> + <para>After you have the binary archive you want to install, use the JDK jar + tool (or any other ZIP extraction tool) to extract the jboss-4.2.3.GA.zip + archive contents into a location of your choice. The jboss-4.2.3.GA.tgz + archive is a gzipped tar file that requires a gnutar compatible tar which + can handle the long pathnames in the archive. The extraction process will + create a jboss-4.2.3.GA directory. </para> + </listitem> + </itemizedlist> + </section> + + <section id="AddingJBossServer"> + <?dbhtml filename="AddingJBossServer.html"?> + <title>Adding and Configuring JBoss Server</title> + <para>Now we should add just installed server into server manager in <property moreinfo="none">JBoss + Developer Studio</property>.</para> + <itemizedlist> + <listitem> + <para>Open the <property moreinfo="none">JBoss Server View</property> by selecting <emphasis> + <property moreinfo="none">Window > Show View > Other > Server + > JBoss Server View</property> + </emphasis></para> + </listitem> + <listitem> + <para>Right click anywhere in this view and select <emphasis> + <property moreinfo="none">New Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">JBoss Community > JBoss 4.2 Server</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Selecting Server Name and Server Type</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + + <para>Now in the <property moreinfo="none">New Server wizard</property> there is a separation + between the .org servers (the <emphasis> + <property moreinfo="none">JBoss Community</property> + </emphasis> category) and product server that comes bundled with JBoss EAP (the + <emphasis> + <property moreinfo="none">JBoss Enterprise Middleware</property></emphasis> category).</para> + </note> + + <itemizedlist> + <listitem> + <para>To create a new runtime, which Jboss AS 4.2 matches to, click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>In the next step make <property moreinfo="none">JBoss Developer Studio</property> to know + where you have installed the Server and define JRE.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Defining JBoss Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>When adding a new server you will need to specify what JRE to use. It is + important to set this value to a full JDK, not JRE. Again, you need a full JDK + to run Web applications, JRE will not be enough.</para> + </note> + + <itemizedlist> + <listitem> + <para>In the next dialog verify the specified information and if something is + unfair go back and correct it</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>JBoss Runtime Summary</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the last wizard's dialog modify the projects that are + configured on the server and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis>.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Configuring Projects</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>A new <property moreinfo="none">JBoss Server</property> should now appear in the <property moreinfo="none">JBoss + Server view</property>.</para> + <figure float="0"> + <title>New JBoss Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/manage/manage_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, we are ready to create the first web application.</para> + </section> + + </section> +</chapter> + + +<chapter id="first_seam" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/first_seam.xml" xreflabel="first_seam"> + <?dbhtml filename="first_seam.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Seam</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Write Your First Project with JBoss Developer Studio</title> + + <para>This chapter is a set of hands-on labs. You get step-by-step information about how the JBoss + Developer Studio can be used during the development process.</para> + + <section id="create_seam_application"> + <title>Create a Seam Application</title> + + <para>In this section you get to know how to create a Seam project in JBDS, how to start the + server and what a structure your project has after creating.</para> + + <section id="start_dev_db"> + <title>Start Development Database</title> + + <para>Before opening the JBoss Developer studio you need to <ulink url="http://anonsvn.jboss.org/repos/jbosstools/trunk/documentation/guides/Gett...">download</ulink> and start a Workshop Database.</para> + <para>To start the database just run <property moreinfo="none">./runDBServer.sh</property> or + <property moreinfo="none">runDBServer.bat</property> from the database directory.</para> + <para>The end result should be a console window that looks like:</para> + + <figure float="0"> + <title>Starting DataBase</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="create_deploy_seam"> + <title>Create and deploy Seam Web Project</title> + + <para>Minimize the terminal window and run the <property moreinfo="none">JBoss Developer Studio</property> + from Applications Menu or from the desktop icon.</para> + <para>First of all you get the Workspace Launcher. Change the default workspace location if + it's needed. Click on <property moreinfo="none">Ok</property>. </para> + + <figure float="0"> + <title>Workspace Launcher Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After startup, you see the welcome page. You could read how to work with welcome pages + in <link linkend="Welcome">previous</link> chapter. Now select <property moreinfo="none">Create + New...</property> icon and then press on <property moreinfo="none">Create Seam Project</property> + link.</para> + + <para>The <property moreinfo="none">New Seam Project wizard</property> is started. You need to enter a name + (e.g., "workshop") and a location directory for your new project. The + wizard has an option for selecting the actual Server (and not just WTP runtime) that will be + used for the project. This allows the wizard to correctly identify where the needed + datasource and driver libraries need to go.</para> + + <figure float="0"> + <title>New Seam Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>All settings are already specified here, you can just modify the Configuration. Click on + the <emphasis> + <property moreinfo="none">Modify...</property> + </emphasis> button to configure your custom facets pattern:</para> + + + <figure float="0" id="ProjectFacetsSpecifyingScreen"> + <title>Project Facets Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole the dialog allows to select the "features" you want to use in your project. + Doing this <property moreinfo="none">JBoss Developer Studio</property> setups the appropriate tooling for + your project. Since JBoss Seam integrates all popular Java EE frameworks, you can select any + combination of technologies from the list. Here, for the default configuration, Dynamic Web + Module, Java, JavaServer Faces (JSF), and Seam Facet are already selected for a typical + database-driven web application. The default project facets should suffice.</para> + + <para>In the <property moreinfo="none">Project Facets</property> form you can also bring up server runtimes + panel by clicking <property moreinfo="none"> Runtimes</property> tab on the right corner. This panel shows + available server runtimes.</para> + + <figure float="0"> + <title>Runtimes Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> and then <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to proceed further.</para> + + <para>A dynamic web application contains both web pages and Java code. The wizard will ask you + where you want to put those files. You can just leave the default values or choose another + folder.</para> + + <figure float="0"> + <title>Web Module Settings</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next form, you will be able to select where those library JARs come from. The + easiest is just to select the JARs provided by the JBoss AS runtime associated with this + project. That is why it is important to chose the right JBoss AS 4.2 runtime in the project + setup window.</para> + <itemizedlist> + <listitem> + <para>Check <emphasis> + <property moreinfo="none">Server Supplied JSF Implementation</property> + </emphasis>. We will use <ulink url="../../seam/html_single/index.html#addJSFCapab">JSF + implementation</ulink> that comes with JBoss server</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <figure float="0"> + <title>JSF Capabilities Adding</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next wizard step needs more settings that previous. Let's start with + <property moreinfo="none">General</property> section.</para> + <para>Leave the default Seam runtime and check a WAR deployment.</para> + + <figure float="0"> + <title>Seam Facet Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Next <property moreinfo="none">Database</property> section is a little tricky. The <property moreinfo="none">Connection + Profile</property> needs to be edited so that the new project works properly with the + external HSQLDB server. By default the project wizard tries to use the JBoss embedded + HSQLDB, but the tutorial uses an external database to replicate a more real world + development scenario. Click on <property moreinfo="none">Edit</property> to modify the Connection + Profile.</para> + + <figure float="0"> + <title>DataBase Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam8_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property moreinfo="none">JDBC Connection Properties</property>. Make sure the URL is set to <emphasis> + <property moreinfo="none">jdbc:hsqldb:hsql://localhost:1701</property> + </emphasis></para> + + <figure float="0"> + <title>JDBC Connection Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Try click on <property moreinfo="none">Test Connection</property> button. It probably won’t work. This + happens if the hsql jdbc driver is not exactly the same. This can be worked around by + modifying the HSQLDB database driver settings. To modify the settings, click the + <property moreinfo="none">“...”</property> next to the drop-down box.</para> + + <para>The proper Driver JAR File should be listed under <property moreinfo="none">Driver File(s)</property>. + Select the hsqldb.jar file found in the database/lib directory and click on + <property moreinfo="none">Ok</property>.</para> + + <figure float="0"> + <title>Driver Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Select <property moreinfo="none">Hypersonic DB</property> and click on <property moreinfo="none">Ok</property>. Again, + this only happens if the selected hsqldb.jar is different from the running database.</para> + + <figure float="0"> + <title>Hypersonic DB Selecting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, the <property moreinfo="none">Test Connection</property> should succeed. After testing the + connection, click on Ok.</para> + + <figure float="0"> + <title>Connection Testing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can leave the <property moreinfo="none">Code Generation</property> section as is. It refers to Java + packages in which the generated code will be placed.</para> + + <figure float="0"> + <title>Code Generation Setting</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on <property moreinfo="none">Finish</property> button. Now, there should be a new Seam project + called “workshop” listed in Package Explorer view.</para> + + <figure float="0"> + <title>"worskhop" Project in the Package Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="start_JBossAS"> + <title>Start JBoss Application Server</title> + + <para>The complete information on how to manage JBoss AS from JBoss Developer Studio you can + read in a <link linkend="manage">corresponding chapter</link>.</para> + <para>Now you just need to start the server by clicking on the Start the server icon ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam15.png"></imagedata> + </imageobject> + </inlinemediaobject> ) in the + JBoss Server View.</para> + + <para>Then run the project by selecting the project and use <emphasis><property moreinfo="none">Run As... > + Run on Server</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the project does not show up, then you can use a normal browser and use <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/home.seam</property> + </emphasis> as the url.</para> + </note> + + <para>Your project looks like this:</para> + + <figure float="0"> + <title>"workshop" Project Started</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="workshop_code_overview"> + <title>Workshop Project Code Overview</title> + + <para>Now let's examine the project and its structure. Go back to the Package Explorer view in + JBoss Developer Studio.</para> + + <para>It seems like it's not much for project but this shell application contains a login + screen with default login logic, a menu template that can be further modified, and other + layout templates.</para> + + <para>It's important to note that the business logic will reside in the <emphasis> + <property moreinfo="none">src/hot</property> + </emphasis> folder, by default. And, the package naming conventions that were used in <property moreinfo="none">New Seam + project wizard</property> could have been changed to something different from <emphasis> + <property moreinfo="none">org.domain.workshop.session</property>. + </emphasis> Also, notice that there is a default <property moreinfo="none">Authenticator. java</property> + file. This is where custom security logic can be added. Seam has a nice declarative security + model that we will explore in a bit more detail later on. The <emphasis> + <property moreinfo="none">src/main</property> + </emphasis> folder is a model directory. It stores the project's JPA entity beans.</para> + + <figure float="0"> + <title>Project Structure</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The view tier of the + application is also important. Seam uses facelets and there is a built-in facelets GUI + editor that has some nice WYSIWYG and component drag/drop functionality. Try this out by + opening <property moreinfo="none">home.xhtml</property> from <property moreinfo="none">WebContent</property> folder.</para> + + <figure float="0"> + <title>Facelets GUI Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam18.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that the templates reside in the <emphasis> + <property moreinfo="none">WebContent/layout</property> + </emphasis> folder. There is a stylesheet in the <emphasis> + <property moreinfo="none">WebContent/stylesheet</property> + </emphasis> folder. There is also a login and default error page. The Facelet editor will be + explored in more detail later in the lab.</para> + + <para>The project already has a datasource that was created per the Seam project wizard + database settings. And, obviously all of the Seam specific configuration files and JAR + dependencies are included and placed in the proper locations. On last noteworthy line item + is related to the build script. There isn’t a build script because the Eclipse WTP(Web Tools + Project) plugin is used to publish web application changes. As you can see, JBoss Developer + Studio is removing a great deal of complexity from the enterprise Java project + setup/deployment process. The end result is a developer that is writing code, not spending + days/weeks trying to figure out how to get a decent development environment and project + build process.</para> + + </section> + + </section> + + + <section id="seam_action_dev"> + <title>Seam Action Development</title> + + <para>Now, it’s time to write some code. The good news is that JBoss Developer Studio can also + help out in this respect. In this section, we will create a new Seam Action POJO and facelet + with some custom business logic and some GUI changes.</para> + + <section id="create_seam_action"> + <title>Create a New Seam Action</title> + + <para>Go to main menu bar and click on <emphasis> + <property moreinfo="none">File > New > New Seam Action</property> + </emphasis> to start the New Seam Action wizard.</para> + + <para>Specify a <property moreinfo="none">Seam component name</property> (e.g., "myAction"). + The other properties will be auto-completed for you so there is no need to change them. + Click on <property moreinfo="none">Finish</property>.</para> + + <figure float="0"> + <title>New Seam Action Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, open the <property moreinfo="none">MyAction.java</property> file and replace the + "myAction" method with this logic:</para> + + <programlisting format="linespecific"><![CDATA[public void myAction() { +Calendar cal = Calendar.getInstance(); +log.info("myAction.myAction() action called"); +facesMessages.add("MyAction Executed on:" + cal.getTime()); +}]]></programlisting> + + <para>You also need to import the <property moreinfo="none">java.util.Calendar</property> class by clicking + <emphasis><property moreinfo="none">CTRL + Shift + O</property>.</emphasis></para> + + </section> + + <section id="test_seam_action"> + <title>Test Seam Action</title> + + <para>The new action can be tested by browsing the workshop-test project. JBoss Developer + Studio has already created a TestNG test case for you.</para> + + <figure float="0"> + <title>"workshop-test" Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam20.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The test case simulates a Seam component/method execution for the + <property moreinfo="none">MyAction.myAction()</property> logic.</para> + <para>To run the test case, right click on <property moreinfo="none">MyActionTest.xml</property> and click <emphasis> + <property moreinfo="none">Run As > TestNG Suite</property> + </emphasis> or use the <property moreinfo="none">Run As...</property> toolbar shortcut as shown + below.</para> + + <figure float="0"> + <title>TestNG Running</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam21.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>With any luck, the test case will pass. Look at the TestNG view.</para> + + <figure float="0"> + <title>TestNG Results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam22.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, it’s safe to test the new Seam Action in a web browser. The fastest way to do that + is to right click on <property moreinfo="none">myAction.xhtml</property> and use <emphasis> + <property moreinfo="none">Run As... > Run On Server</property> + </emphasis> which will show the appropriate url in the browser. Alternatively you can + manually enter <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> into a browser.</para> + + <figure float="0"> + <title>Seam Action in a Web Browser</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam23.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="modify_seam_action"> + <title>Modify Seam Action User Interface</title> + + <para>Browse to <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and click on <property moreinfo="none">myAction</property>. This executes the “myAction” method. + This looks pretty good, but we could make this page look a little better.</para> + + <para>Open <emphasis> + <property moreinfo="none">WebContent/myAction.xhtml</property> + </emphasis> in JBoss Developer Studio to use the nice facelets editor.</para> + + <figure float="0"> + <title>Open Seam Action with Editor </title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam24.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the "myAction!" button in the visual part of editor and + select <property moreinfo="none"><h:commandButton> Attributes</property>.</para> + + <figure float="0"> + <title>Seam Action Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam25.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Change the <property moreinfo="none">value</property> of the button to something different. If desired, + you can change any other text on the page. Then, type <emphasis> + <property moreinfo="none">CTRL + S</property> + </emphasis> to save the facelet.</para> + + <figure float="0"> + <title>Attributes Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam26.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> and now you should see your changes.</para> + + <para>Notice that you did not have to publish the application. JBoss Developer Studio + auto-published it for you.</para> + + <figure float="0"> + <title>Seam Action Is Modified</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam27.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + + </section> + + <section id="declarative_security"> + <title>Declarative Security</title> + + <para>In this section you will see how it’s easy to secure the facelets and facelet components + in Seam. Let’s go ahead and secure the action button, then we will secure the entire + page.</para> + + <section id="edit_login"> + <title>Edit Login Authentication Logic</title> + + <para>There is a class called <property moreinfo="none">Authenticator.java</property>. The login page will + execute the <property moreinfo="none">Authenticator.authenticate()</property> method by default, so we’ll + start by adding some custom login logic.</para> + <para>Open <property moreinfo="none">Authenticator.java</property> in JBoss Developer Studio and replace the + <property moreinfo="none">authenticate()</property> method with this code:</para> + + <programlisting format="linespecific"><![CDATA[public boolean authenticate() { +if (identity.getUsername().equals("admin") +&& identity.getPassword().equals("password")) { +identity.addRole("admin"); +return true; +} +else +return true; +}]]></programlisting> + + </section> + <section id="secure_seam_page"> + <title>Secure Seam Page Component</title> + + <para>Open <property moreinfo="none">myAction.xhtml</property> and add a new secured command button:</para> + <programlisting format="linespecific"><![CDATA[<h:commandButton id="myActionSecured" +value="Secured Action Button" +action="#{myAction.myAction}" +rendered="#{s:hasRole('admin')}"/>]]></programlisting> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will only see one button. If you are logged in, + there will be two buttons.</para> + + + <figure float="0"> + <title>One Button on a Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam28.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The secured button is not visible because the user isn’t logged in as + <property moreinfo="none">"admin"</property>.</para> + + <figure float="0"> + <title>Secured Button is Visible</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam29.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The user is logged in as <property moreinfo="none">"admin"</property>. Securing + components is easy but securing pages is pretty simple as well. </para> + <para>Open <emphasis> + <property moreinfo="none">WebContent/WEB-INF/pages.xml</property> + </emphasis>. Then add this markup directly underneath the <pages> + element:</para> + + <programlisting format="linespecific"><![CDATA[<page view-id="/myAction.xhtml" login-required="true"/>]]></programlisting> + + <para>Refresh <emphasis> + <property moreinfo="none">http://localhost:8080/workshop/myAction.seam</property> + </emphasis> If you are not logged in you will get bounced back to the login page.</para> + + <figure float="0"> + <title>Login Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam30.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Thus, if you enter login credentials for the + <property moreinfo="none">"admin"</property> user, you will be re-directed to the + secured page and secured component. If you enter different login credentials, page access + will be granted, but the secured component will not be displayed.</para> + + <para>Congratulations! You have secured your new action both at the facelet component and page + level. You also added custom authentication logic to the login action.</para> + + </section> + + </section> + + <section id="browsing_workshop_db"> + <title>Browsing Workshop Database</title> + + <para>In this section you get to know how to use the workshop database that was started at the + beginning of the lab.</para> + + <section id="database_connectivity"> + <title>Database Connectivity Setup</title> + + <para>The workshop data can be browsed inside of JBoss Developer Studio.</para> + + <para>To open the Data Source Explorer, click on <emphasis><property moreinfo="none">Window > Open Perspective + > Other > Database Development</property>.</emphasis></para> + <para>In the Data Source Explorer, expand a <property moreinfo="none">Databases</property> node and select a + <property moreinfo="none">Default</property> database. Right click on it, select + <property moreinfo="none">Connect</property> from the context menu.</para> + + <figure float="0"> + <title>Data Source Explorer</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam31.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="browsing_workshop_db2"> + <title>Browse Workshop Database</title> + + <para>Then in the current view, drill down to the <property moreinfo="none">CUSTOMERS</property> table.</para> + + <figure float="0"> + <title>"CUSTOMERS" Table</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam32.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on <property moreinfo="none">CUSTOMERS</property>, select <emphasis> + <property moreinfo="none">Data > Sample Contents</property> + </emphasis> to view the data in the table.</para> + + <para>There should be a SQL Results view on the workbench, but it could be hidden. Click on + the <property moreinfo="none">"Result1"</property> tab in the right side and you should + see the data in the CUSTOMERS table.</para> + + + <figure float="0"> + <title>SQL Results View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam33.png" scale="92"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <note> + <title>Note:</title> + <para>If you can’t find the SQL Results view tab, click on <emphasis><property moreinfo="none">Window > Show + View > Other > SQL Development > SQL Results</property>.</emphasis></para> + </note> + + <para>Congratulations! You just connected to the workshop database and queried the content + using Database Explorer tools.</para> + + </section> + + </section> + + <section id="db_programming"> + <title>Database Programming</title> + + <para>Now, it’s time to reverse engineer the workshop database into a fully functioning Seam + CRUD(Create Read Update Delete) application.</para> + + <section id="reverse_engineer_crud"> + <title>Reverse Engineer CRUD from a Running Database</title> + + <para>In <property moreinfo="none">JBoss Developer Studio</property>, switch to <property moreinfo="none">Seam + perspective</property>, and then right-click the project and select + <emphasis><property moreinfo="none">New > Seam Generate Entities</property>.</emphasis></para> + + <para>"workshop" project in the <property moreinfo="none">Seam Generate Entities + wizard</property> will be selected automatically. There is no need to change something + more, click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to proceed further.</para> + + <figure float="0"> + <title>Generate Seam Entities</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the next page use the <emphasis> + <property moreinfo="none">Include</property> + </emphasis> button to include all the tables from the database and click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + + <figure float="0"> + <title>Selecting Tables</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam34a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After running the Generate Entities action, you will see new <emphasis> + <property moreinfo="none">org.domain.workshop.entity</property> + </emphasis> classes. These classes represent insert/update/delete/query logic.</para> + + <figure float="0"> + <title>org.domain.workshop.entity Classes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam35.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>There are also <emphasis> + <property moreinfo="none">org.domain.workshop.entity</property> + </emphasis> package that contains the JPA classes. These are the entity beans that are + mapped to database tables.Note,that you can use Seam refactoring tools with Seam components. + Read more about it in <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/seam/html_single/ind...">Seam refactoring tools chapter</ulink> of Seam Dev Tools Reference Guide.</para> + + <para>Last, but not least, there are facelets for all of the CRUD screens. The best way to get + a feel for the generated code is to open a browser and play around with the application. Go + to <emphasis> + <property moreinfo="none">http://localhost:8080/workshop</property> + </emphasis> and insert/update/delete/query a few records. There is quite a bit of AJAX in + this application, but which we will explore further later on in the lab. For now, take note + of the page tabs, required field logic and data table sorting in the list pages. </para> + + <figure float="0"> + <title>CustomersList.xhtml in the Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam36.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You now have a fully functioning CRUD application that is already AJAX + enabled.</para> + + </section> + + <section id="use_hibernate_tools"> + <title>Use Hibernate Tools to Query Data via JPA</title> + + <para>Now, it's time to write some JPA queries using the Hibernate perspective in + <property moreinfo="none">JBoss Developer Studio</property>.</para> + <para>In the upper right corner of the workbench there is a small icon (see the figure below), + click on it and choose <property moreinfo="none">Hibernate</property>.</para> + + <figure float="0"> + <title>Hibernate Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam37.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Look at the Hibernate Configurations view. In the "workshop" project, + drill down on the <property moreinfo="none">Session Factory</property> and notice that the JPA + entities/attributes are listed in a nice tree view.</para> + + <figure float="0"> + <title>Hibernate Configurations View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam38.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Right click on the <property moreinfo="none">Session Factory</property> and select <property moreinfo="none">HQL + Editor</property>. This will open a JPA query scratch pad window.</para> + + <para>Write your query and click on the "Hibernate Dynamic SQL Preview" tab. + You should see the SQL that will be executed if this JPA query is run.</para> + + <figure float="0"> + <title>JPA Query Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam39.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Run the query by clicking on the green run icon.</para> + + <para>The results are listed in the "Hibernate Query Result" tab. There is a + "Properties" tab in the workbench that can be used to see a specific JPA + result. These results represent the JPA objects because our query did not specify column + names.</para> + + <figure float="0"> + <title>Hibernate Query Result View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam40.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The query can be refined, and take note that there is nice code completion in the JPA + query editor.</para> + + <figure float="0"> + <title>Code Completion</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam41.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>A refined query will return results that are more ResultSet oriented. Notice the join + logic that JPA supports.</para> + + <figure float="0"> + <title>The Hibernate Query Result</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam42.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>There was no need to specify an <property moreinfo="none">Employees</property> table in the + <property moreinfo="none">from</property> part of the JPA query because JPA supports reference traversal + via Java class attribute references. Not only are JPA and HQL queries fully supported, but + Criteria based queries can also be written in the Criteria Editor. You should spend some + time tinkering with different queries and possibly Criteria based queries, even though the + instructions are not provided in this lab.</para> + + <figure float="0"> + <title>Criteria Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam43.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="use_hibernate_to_vizualize"> + <title>Use Hibernate Tools to visualize the Data Model</title> + + <para>Now, it’s time to view the data model for the workshop database.</para> + + <para>In the Hibernate Configurations view, select "workshop" project and + expand the <property moreinfo="none">Configuration</property> node. Select the + <property moreinfo="none">Customers</property> entity, right click on it, choose <property moreinfo="none">Open Mapping + Diagram</property>.</para> + + <figure float="0"> + <title>Mapping Diagram Opening</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam44.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You see a Diagram tab for the CUSTOMERS table and any tables that have FK references. + This is a handy way to view the data model and JPA mappings. Now, you’ve got access to + something that the Erwin Data Modeler can’t do.</para> + + + <figure float="0"> + <title>Diagram Tab</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam45.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + </section> + + + <section id="rich_components"> + <title>Rich Components</title> + + <para>This lab will conclude with one last AJAX twist. In this section we add a RichFaces + <property moreinfo="none">inputNumberSlider</property> to the Order Details edit screen.</para> + + <section id="add_richfaces"> + <title>Add a Richfaces component to the CRUD Application</title> + + <para>Switch to Seam perspective, open <emphasis> + <property moreinfo="none">WebContent/OrderdetailsEdit.xhtml</property> + </emphasis> in JBoss Developer Studio.</para> + <para>Change the form field values using the visual editor. Seam has generated the form field + names that match the database column names. This is not ideal for business users.</para> + + <figure float="0"> + <title>Form Fields Editing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam46.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Also, replace the QTY Ordered input field with a <property moreinfo="none">inputNumberSlider</property>. + You can use the JBoss Developer Studio palette or right click on the form and insert the + RichFaces component.</para> + + <figure float="0"> + <title>Insert RichFaces Component from Context Menu</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam47.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>One the last option is to use the source view and manually copy the inputNumberSlider + markup listed below:</para> + + <programlisting format="linespecific"><![CDATA[<rich:inputNumberSlider id="quantityOrdered" required="true" + value="#{orderdetailsHome.instance.quantityordered}"/>]]></programlisting> + + <figure float="0"> + <title>Manually coping Source Code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam48.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The end result is an edit page that has better form labels and a new RichFaces + control.</para> + + <figure float="0"> + <title>The Result Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/first_seam/first_seam49.png" scale="85"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Congratulations! You have completed the JBoss Developer Studio lab.</para> + + </section> + + </section> +</chapter> + + +<chapter id="jsp_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/jsp_application.xml" xreflabel="jsp_application"> + <?dbhtml filename="jsp_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSP</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Developing a simple JSP web application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property moreinfo="none">Seam</property>. This chapter is for users + who for some reason cannot use Seam.</para> + </note> + + <para>In this chapter you'll find out how to create a simple <ulink url="http://java.sun.com/products/jsp/">JSP</ulink> application using the + <property moreinfo="none">JBoss Developer Studio</property>. The application will show a classic + "Hello World!" on the page.</para> + <para>We'll assume that you have already launched <property moreinfo="none">JBoss Developer + Studio</property> and also that the <property moreinfo="none">Web Development</property> perspective is the + current perspective. If not, make it active by selecting <emphasis> + <property moreinfo="none">Window > Open Perspective > Web Development</property> + </emphasis> from the menu bar or by selecting <emphasis> + <property moreinfo="none">Window > Open Perspective > Other...</property> + </emphasis> from the menu bar and then selecting Web Development from the Select Perspective + dialog box.</para> + + <section id="SettingUpTheProject"> + <?dbhtml filename="SettingUpTheProject.html"?> + <title>Setting Up the Project</title> + <para>We are going to start with the creating a Dynamic Web Project with a minimal + structure, i.e. with just required facets. Thus this section will perform you all + necessary steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis> + <property moreinfo="none">File > New > Other...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Web > Dynamic Web Project</property> + </emphasis> in the New Project dialog box</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> + </para> + </listitem> + <listitem> + <para>Enter "jspHello" as a project name</para> + </listitem> + <listitem> + <para>Then select <emphasis> + <property moreinfo="none">Minimal Configuration</property> + </emphasis> from the list of possible configurations and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property moreinfo="none">jspHello</property> + </emphasis> node should appear in the upper-left <property moreinfo="none">Package Explorer</property> + view.</para> + <figure float="0"> + <title>New Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingJSPPage"> + <?dbhtml filename="CreatingJSPPage.html"?> + <title>Creating JSP Page</title> + <para>This section covers all the points how to create, edit and then preview JSP page.</para> + <para>In our simple application we need to create only one JSP page which displays a + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis><property moreinfo="none">WebContent > New > + JSP</property>. </emphasis></para> + </listitem> + <listitem> + <para>Type "hello.jsp" for a file name and click the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <para>In the next window you can choose a template for your jsp page and see its preview.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">New JSP File (xhtml)</property> + </emphasis> template and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button.</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Our <emphasis><property moreinfo="none">hello.jsp</property></emphasis> page will now appear in + <property moreinfo="none">Project Explorer</property>. + </para> + <section id="EditingJSPPage"> + <?dbhtml filename="EditingJSPPage.html"?> + <title>Editing a JSP Page</title> + <para>Let's now make a little change so that a jsp page displays + <emphasis>"Hello World!"</emphasis> message.</para> + <itemizedlist> + <listitem> +  + <para> + + Insert this line inside the + <code><body> </body> + </code> + tag: + </para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<% System.out.println("Hello World!"); %>]]> + </programlisting> + + <para>Notice that content assist functionality is always available when you are typing:</para> + <figure float="0"> + <title>Content Assist in JSP Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>After changes made your <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page should look like this:</para> + <figure float="0"> + <title>Hello.jsp Page Source</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This line will actually output <emphasis>"Hello + World!"</emphasis> message in the <property moreinfo="none">Console</property>. To make the + message displayed in the Browser, just replace this line with the simple + <emphasis>Hello World!</emphasis>.</para> + </section> + + <section id="WebXML"> + <?dbhtml filename="WebXML.html"?> + <title>web.xml file</title> + <para>When you are creating web project the wizard creates the <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> for you automatically. The <property moreinfo="none">web.xml file editor</property> + provided by <property moreinfo="none">JBoss Developer Studio</property> is available in two modes: + <property moreinfo="none">Tree</property> and <property moreinfo="none">Source</property>.</para> + <figure float="0"> + <title>Web.xml in Design and Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_6.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Both modes are fully synchronized. Let's add mapping to our <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page in <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file.</para> + <itemizedlist> + <listitem> + <para>Switch to <property moreinfo="none">Source</property> tab.</para> + </listitem> + <listitem> + <para>Add the next code into + <code><welcome-file-list></code> + :</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<welcome-file>hello.jsp</welcome-file> +]]></programlisting> + <para>If you come back to <property moreinfo="none">Tree</property> mode you will see that the changes + made are automatically reflected in that mode.</para> + <para>Actually you don't really need to do any configurations right now.</para> + </section> + + <section id="DeployTheProject"> + <?dbhtml filename="DeployTheProject.html"?> + <title>Deploying the project</title> + <para>While creating any web project you could experience a pain writing ant scripts and + managing the packaging even when writing the most trivial web applications. With + <property moreinfo="none">JBoss Developer Studio</property> you are saved from such a pain. All + you need is to start <property moreinfo="none">JBoss Server</property> and launch your application + in your favorite browser.</para> + <para>You can also create a war archive with <ulink url="../../as/html_single/index.html#Project_archivesView">JBDS's Archive Tools</ulink> + and export it to any web server.</para> + <section id="WarConfig"> + <?dbhtml filename="WarConfig.html"?> + <title>WAR Config</title> + <para>Project archives managing is available through <ulink url="../../as/html_single/index.html#Project_archivesView">Project Archives view</ulink>.</para> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Window > Show view > Other > JBoss + Tools > Project archives</property> + </emphasis> from menu bar</para> + </listitem> + <listitem> + <para>Select a project in Package Explorer you want to be archived</para> + </listitem> + </itemizedlist> + <para>In <property moreinfo="none">Project Archives</property> you will see available archive types + for the project:</para> + <figure float="0"> + <title>Project Archives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click, for example, <emphasis> + <property moreinfo="none">WAR</property> + </emphasis> option to create war archive</para> + </listitem> + </itemizedlist> + <para>In the <property moreinfo="none">New WAR</property> dialog you can see automatically selected + default values.</para> + <figure float="0"> + <title>New WAR Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis> to see a stub archive configuration for your project: <figure float="0"> + <title>Stub Archive Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property>. </emphasis> The + <emphasis>.war</emphasis> file will appear in <property moreinfo="none">Package + Explorer</property> and also in <property moreinfo="none">Project Archives</property> + view as structure tree: <figure float="0"> + <title>Archive is Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Archive in Project Archives View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>Via <property moreinfo="none">Project Archives</property> view you could now edit your + archive, add new folders, publish to server, and so on:</para> + <figure float="0"> + <title>Configure Archive</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="AutoRedeploy"> + <?dbhtml filename="AutoRedeploy.html"?> + <title>Auto redeploy</title> + <para>When you are creating a web application and register it on <property moreinfo="none">JBoss + Server</property> it is automatically deployed into + <emphasis>/deploy</emphasis> directory of the server. JBDS comes with the + feature of auto-redeploy. It means that you don't need to restart + <property moreinfo="none">JBoss Server</property>. Any changes made in the application in + exploded format will trigger a redeployment on the server.</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/jsp_application/jsp_application_19_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> + + </section> + + </section> + + <section id="Previewtab"> + <?dbhtml filename="Previewtab.html"?> + <title>JSP Page Preview</title> + <para><property moreinfo="none">JBDS</property> comes with JSP design-time preview features. When + designing JSP pages you can easily preview how they will look during runtime. You + can even <ulink url="../../jsf/html_single/index.html#el_exp_para">attach your stylesheet to the + Preview</ulink>.</para> + <itemizedlist> + <listitem> + <para>Make a little change to <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page, e.g. put this code snippet:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<%= new java.util.Date() %> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>Switch to Preview page by clicking <property moreinfo="none">Preview</property> tab at the + bottom of the page. You will see how the page will look at runtime.</para> + </listitem> + </itemizedlist> +  + </section> + <section id="LaunchingTheProject"> + <?dbhtml filename="LaunchingTheProject.html"?> + <title>Launch JSP Project</title> + <para>Let's now launch our project on server. We'll use + <property moreinfo="none">JBoss Server</property> that is shipped with <property moreinfo="none">JBoss Developer + Studio</property>. You can do it by performing one of the following actions:</para> + <itemizedlist> + <listitem> + <para>Start JBoss Server from <ulink url="../../as/html_single/index.html#JBossServerView">JBoss + Server view</ulink> by clicking the Start the server icon ( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_18.png"></imagedata> + </imageobject> + </inlinemediaobject> ) .</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Click the Run icon or right click your project folder and select <emphasis> + <property moreinfo="none">Run As > Run on Server</property>. </emphasis> If you + haven't made any changes in <emphasis> + <property moreinfo="none">web.xml</property> + </emphasis> file or cleared it out you can launch the application by right + clicking the <emphasis> + <property moreinfo="none">hello.jsp</property> + </emphasis> page and selecting <emphasis> + <property moreinfo="none">Run on the Server</property> </emphasis>( + <inlinemediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_16.png"></imagedata> + </imageobject> + </inlinemediaobject> ).</para> + </listitem> + </itemizedlist> + + <para>You should see the next page in a Browser :</para> + <figure float="0"> + <title>Running Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/jsp_application/jsp_application_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus with the help of this chapter you've learnt how to organize a Dynamic + Web Project with a minimal configuration, add any staff to it (in our case it's + just one jsp page) and deploy and run it on the <property moreinfo="none">JBoss Server</property> + shipped with <property moreinfo="none">JBDS</property>. + </para> + </section> + + </section> +</chapter> + + +<chapter id="rad_jsf_application" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/rad_jsf_application.xml" xreflabel="rad_jsf_application"> + <?dbhtml filename="rad_jsf_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSF</keyword> + <keyword>JBoss</keyword> + <keyword>RAD</keyword> + </keywordset> + </chapterinfo> + <title>RAD development of a simple JSF application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property moreinfo="none">Seam</property>. This chapter is for users + who for some reason cannot use <property moreinfo="none">Seam</property>.</para> + </note> + + <para>In this chapter you will see how to create a simple JSF application being based on + <property moreinfo="none">"RAD"</property> philosophy. We will create the familiar + Guess Number application. The scenario is the following. You are asked to guess a number + between 0 and 100. If the guess is correct, a success page is displayed with a link to play + again. If the guess is incorrect, a message is printed notifying that a smaller or a larger + number should be entered and the game continues.</para> + <para>We'll show you how to create such an application from scratch, along the way + demonstrating powerful features of JBoss Developer Studio such as project templating, Visual + Page Editor, code completion and others. You will design the JSF application and then run + the application from inside JBoss Developer Studio using the bundled JBoss server.</para> + + <section id="SettingUpTheProject12"> + <?dbhtml filename="SettingUpTheProject12.html"?> + <title>Setting up the project</title> + <para>First, you should create a JSF 1.2 project using an integrated JBDS's new + project wizard and predefined templates. Follow the next steps:</para> + <itemizedlist> + <listitem> + <para>In Web Projects View (if it is not open select <emphasis> + <property moreinfo="none">Window > Show View > Others > JBoss Tools Web + > Web Projects View</property>) </emphasis> click <emphasis> + <property moreinfo="none">Create New JSF Project</property> + </emphasis> button. <figure float="0"> + <title>Create New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure></para> + </listitem> + + <listitem> + <para>Put <property moreinfo="none">GuessNumber</property> as a project name, in JSF Environment + drop down list choose <property moreinfo="none">JSF 1.2</property></para> + </listitem> + <listitem> + <para>Leave everything else as it is and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Our project will appear in Project Explorer and Web Projects Views. As you can see + JBoss Developer Studio has created for us the whole skeleton for the project with all + needed libraries, faces-config.xml and web.xml files.</para> + <figure float="0"> + <title>New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As the project has been set up, new JSP pages should be created now.</para> + </section> + <section id="CreatingJSPPages"> + <?dbhtml filename="CreatingJSPPages.html"?> + <title>Creating JSP Pages</title> + + <para>Here, we are going to add two pages to our application. The first page is + inputnumber.jsp. It prompts you to enter a number. If the guess is incorrect, the same + page will be redisplayed with a message indicating whether a smaller or a larger number + should be tried. The second page is success.jsp. This page will be shown after you guess + the number correctly. From this page you also have the option to play the game again.</para> + + <para>Now, we will guide you through the steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Open <emphasis> + <property moreinfo="none">faces-config.xml</property> + </emphasis> file</para> + </listitem> + <listitem> + <para>Right click anywhere on the diagram mode</para> + </listitem> + <listitem> + <para>From the context menu select <emphasis> + <property moreinfo="none">New View</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Create New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + + <listitem> + <para>Type <emphasis> + <property moreinfo="none">pages/inputnumber</property> + </emphasis> as the value for <emphasis> + <property moreinfo="none">From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Leave everything else as is and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In the same way create another jsf view. Type <emphasis> + <property moreinfo="none">pages/success</property> + </emphasis> as the value for <emphasis> + <property moreinfo="none">From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File > Save</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>On the diagram you will see two created views.</para> + <figure float="0"> + <title>New Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingTransition"> + <?dbhtml filename="CreatingTransition.html"?> + <title>Creating Transition between two views</title> + <para>Then, we should create connection between jsp pages.</para> + <itemizedlist> + <listitem> + <para>In the diagram, select the <emphasis> + <property moreinfo="none">Create New Connection</property> + </emphasis> icon third from the top along the upper left side of the diagram to + get an arrow cursor with a two-pronged plug at the arrow's bottom <figure float="0"> + <title>Create Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">pages/inputnumber</property> + </emphasis> page icon and then click on the <emphasis> + <property moreinfo="none">pages/success</property> + </emphasis> page icon</para> + </listitem> + </itemizedlist> + <para>A transition should appear between the two icons of views.</para> + <figure float="0"> + <title>Created Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + + <section id="CreatingResourceFile"> + <?dbhtml filename="CreatingResourceFile.html"?> + <title>Creating Resource File</title> + <para>A resource file is just a file with a <emphasis>.properties</emphasis> extension for + collecting text messages in one central place. JBoss Developer Studio allows you to + create quickly a resource file. The messages stored in resource file can be displayed to + you on a Web page during application execution. </para> + <para>With resource file first, you don't hard code anything into the JSP pages. + And second, it makes it easier to translate your application to other languages. All you + have to do is to translate all your messages to the other language and save them in a + new properties file with a name that ends with the appropriate ISO-639 language code.</para> + <para>It is a good idea to keep your resources inside the <emphasis> + <property moreinfo="none">JavaSource</property> + </emphasis> folder, where you keep your .java files. Every time you build the project, + all <emphasis>.properties</emphasis> files will then be copied to the + <emphasis>classes</emphasis> folder by default.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">JavaSource</property> + </emphasis> folder and select <emphasis> + <property moreinfo="none">New > Folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">game</property> + </emphasis> for Folder name and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Your resource file and java bean will be stored in this folder.</para> + <itemizedlist> + <listitem> + <para>Right click on <emphasis> + <property moreinfo="none">game folder</property> + </emphasis> and select <emphasis> + <property moreinfo="none">New > Properties File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">messages</property> + </emphasis> as the value for "name" attribute and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>JBoss Developer Studio will automatically open + <property moreinfo="none">messages.properties</property> file for editing.</para> + <figure float="0"> + <title>Messages.properties File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button for adding new attribute to your resource file</para> + </listitem> + <listitem> + <para>Type <emphasis role="italic"> + <property moreinfo="none">how_to_play</property> + </emphasis> for "name" and <emphasis role="italic"> + <property moreinfo="none">Please pick a number between 0 and 100.</property> + </emphasis> for value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In such a way add the next properties:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[makeguess_button=Make Guess +trayagain_button=Play Again? +success_text=How cool.. You have guessed the number, {0} is correct! +tryagain_smaller=Oops..incorrect guess. Please try a smaller number. +tryagain_bigger=Oops..incorrect guess. Please try a bigger number. +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + <para>Your .properties file should now look like follows:</para> + <figure float="0"> + <title>Properties are Added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para><emphasis> + <property moreinfo="none">Up</property></emphasis> + and <emphasis> + <property moreinfo="none">Down</property> + </emphasis> buttons allow you to move you attribute on the list. For delete the attribute, choose it and press <emphasis> + <property moreinfo="none">Delete</property></emphasis> button.</para> + <para>If you want to change a value or a name of your attribute, click on it and than on <emphasis> + <property moreinfo="none">Edit</property></emphasis> button.</para> + + <para>If the .properties file is rather big and there are a lot of entries in it, you can use filtering and regular expressions to find the necessary ones. The Filter and Regular Expressions Search is implemented by an expandable panel, closed by default: </para> + <para>When "Expression" is not selected (as by default), filter is case insensitive. When "Expression" is selected, filter uses regular expressions which are case sensitive</para> + <figure float="0"> + <title>Filter and Regular Expressions Search Panel</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8a.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Enter the characters that should be searched for in the entries to the 'name' or 'value' input fields accordingly. The filtered results will be displayed in the table below:</para> + + <figure float="0"> + <title>Filter results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8b.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>When using regular expressions please note, that regular expression syntax does not use "*" for any characters and "?" for any one character. It's necessary to use "." for any one character and ".*" for any characters. Symbols "*" and "?" are used to show that the preceding token is not required, for example, "a.a" matches "aba" but not "aa", while "a.?a" or a.*a" matches both; besides "a.*a" matches "abcda".</para> + <para>To find the exact match, use sequences \A and \z in expression. For example, expression "\Adate\z" matches only string "date"; expression "\Adate" matches "date" and "dateline", expression "date\z" matches "date" and "Begin date", and expression "date" matches all of them.</para> + + </section> + + <section id="CreatingJavaBean"> + <?dbhtml filename="CreatingJavaBean.html"?> + <title>Creating Java Bean</title> + <para>In this section you'll see how to create a Java bean that will hold business + logic of our application.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">game folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">New > Class</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">NumberBean</property> + </emphasis> for bean name</para> + </listitem> + </itemizedlist> + <para>A java bean is created.</para> + <itemizedlist> + <listitem> + <para>Declare the variable of your entered number:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[Integer userNumber; +]]></programlisting> + <para>JBDS allows to quickly generate getters and setters for java bean.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">NumberBean.java</property> + </emphasis> in Package Explorer</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">Source > Generate Getters and Setters...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Check <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> box and click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> + <figure float="0"> + <title>Generate Getters and Setters</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Add the declaration of the second variable</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[int randomNumber; +]]></programlisting> + <itemizedlist> + <listitem> + <para>.. other bean methods:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[public NumberBean () +{ + randomNumber = (int)(Math.random()*100); + System.out.println ( "Random number: "+randomNumber); + } + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + public String checkGuess () + { + + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } +else + { + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +]]></programlisting> + <itemizedlist> + <listitem> + <para>And the import declarations:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; +]]></programlisting> + <para>The whole java bean should look as follows:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; + +public class NumberBean +{ + Integer userNumber; + int randomNumber; // random number generated by application +public Integer getUserNumber () + { + return userNumber; + } + public void setUserNumber (Integer value) + { + this.userNumber = value; + } + + // constructor, generates random number + public NumberBean () + { + randomNumber = (int)(Math.random()*100); + System.out.println ( + "Random number: " + randomNumber); + } + + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + + // check if user guessed the number + public String checkGuess () + { + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } + // incorrect guess + else + { + // get a reference to properties file to retrieve messages + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = + ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number is bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +} +]]></programlisting> + </section> + + <section id="EditingFacesConfig"> + <?dbhtml filename="EditingFacesConfig.html"?> + <title>Editing faces-config.xml File</title> + <para>In this section you know about faces-config.xml file.</para> + <para>This file holds two navigation rules and defines the backing bean used.</para> + <itemizedlist> + <listitem> + <para>Open faces-config.xml file in a source mode</para> + </listitem> + <listitem> + <para>Add here one more navigation rule and a managed bean declarations that the + content of the file looks like this:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<faces-config version="1.2" xmlns="http://java.sun.com/xml/ns/javaee +xmlns:xi="http://www.w3.org/2001/XInclude" +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +xsi:schemaLocation="http://java.sun.com/xml/ns/javaee + http://java.sun.com/xml/ns/javaee/web-facesconfig_1_2_.xsd"> + + <navigation-rule> + <from-view-id>*</from-view-id> + <navigation-case> + <from-outcome>playagain</from-outcome> + <to-view-id>/pages/inputnumber.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <navigation-rule> + <from-view-id>/pages/inputnumber.jsp</from-view-id> + <navigation-case> + <from-outcome>success</from-outcome> + <to-view-id>/pages/success.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <managed-bean> + <managed-bean-name>NumberBean</managed-bean-name> + <managed-bean-class>game.NumberBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + +</faces-config> +]]></programlisting> + <para>The first navigation rule states that from any page (<property moreinfo="none">*</property> stands for + any page) an outcome of playagain will take you to <emphasis> + <property moreinfo="none">/pages/inputnumber.jsp</property> + </emphasis>. Outcome values are returned from backing bean methods in this example. The + second navigation rule states that if you are at the page <emphasis> + <property moreinfo="none">/pages/inputnumber.jsp</property> + </emphasis>, and the outcome is success, then navigate to the <emphasis> + <property moreinfo="none">/pages/success.jsp</property> + </emphasis> page. </para> + </section> + <section id="EditingTheJSPViewFiles2"> + <?dbhtml filename="EditingTheJSPViewFiles2.html"?> + <title>Editing the JSP View Files</title> + <para>Now, we will continue editing the JSP files for our two "views" using + Visual Page Editor.</para> + <section id="EditingInputjsp"> + <?dbhtml filename="EditingInputjsp.html"?> + <title>Editing inputnumber.jsp page</title> + <para>First, let's dwell on how to edit inputnumber.jsp.</para> + <para>On this page we will have an output text component displaying a message, a text + field for user's number entering and a button for input submission.</para> + <itemizedlist> + <listitem> + <para>Open inputnumber.jsp by double-clicking on the <emphasis> + <property moreinfo="none">/pages/inputnumber. jsp</property> + </emphasis> icon</para> + </listitem> + </itemizedlist> + <para>The Visual Page Editor will open in a screen split between source code along the + top and a WYSIWIG view along the bottom. You can see that some JSF code will be + already generated as we choose a template when creating the page.</para> + <para>At the beginning it's necessary to create a + <code><h:form></code> + component where all others components are put.</para> + <itemizedlist> + <listitem> + <para>Place the mouse cursor inside + <code><f:view> + </f:view></code> + </para> + </listitem> + <listitem> + <para>Go to JBoss Tools Palette and expand JSF HTML folder by selecting + it</para> + </listitem> + <listitem> + <para>Click on + <code><h:form></code> + tag <figure float="0"> + <title>Insert h:form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>In the dialog Insert Tag select <emphasis> + <property moreinfo="none">id</property> + </emphasis> and click on this line below the value header. A blinking cursor + will appear in a input text field inviting to enter a value of id <figure float="0"> + <title>Define Id of Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_11.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">inputNumbers</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>In source view you can see the declaration of a form.</para> + <figure float="0"> + <title>Created Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_12.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First let's declare the properties file in inputnumber.jsp page using the + loadBundle JSF tag.</para> + <itemizedlist> + <listitem> + <para>Put this declaration on the top of a page, right after the first two + lines:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<f:loadBundle basename="game.messages" var="msg"/> +]]></programlisting> + <para>As always JBDS provides code assist:</para> + <figure float="0"> + <title>Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_13.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Visual tab, so it could be possible to work with the editor + completely in its WYSIWYG mode</para> + </listitem> + <listitem> + <para>Click on <emphasis> + <property moreinfo="none">outputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the blue box in the editor</para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + </itemizedlist> + <para>JBDS will nicely propose you to choose within available values:</para> + <figure float="0"> + <title>Choose Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_14.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Resource Bundles > msg</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">how_to_play</property> + </emphasis> value and click <emphasis> + <property moreinfo="none">Ok</property>. </emphasis> Then click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> + <figure float="0"> + <title>Selecting Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_15.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>The text will appear on the page:</para> + <figure float="0"> + <title>Created OutputText Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_16.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Source mode and insert + <code><br/></code> + tag after + <code><h:outputText></code> + component to make a new line.</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property moreinfo="none">inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text.</para> + </listitem> + <listitem> + <para>Switch to a Source mode and insert + <code><br/></code> + tag after + <code><h:outputText></code> + component to make a new line</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property moreinfo="none">inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Managed Beans > NumberBean</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> value and click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Switch <emphasis> + <property moreinfo="none">Advanced</property> + </emphasis> tab</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">id</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">userNumber</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">required</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Enumeration</property> + </emphasis> and select <emphasis> + <property moreinfo="none">true</property> + </emphasis> as a value</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Add "required" Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_17.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Ok</property>, </emphasis> then click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>Go to Source mode</para> + </listitem> + <listitem> + <para>Add the validation attribute to + <code><f:validateLongRange></code> + for user input validation</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<h:inputText id="userNumber" value="#{NumberBean.userNumber}" required="true"> + <f:validateLongRange minimum="0" maximum="100"/> +</h:inputText> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Again select <emphasis> + <property moreinfo="none">Visual</property> + </emphasis> mode</para> + </listitem> + <listitem> + <para>On the Palette, click on <emphasis> + <property moreinfo="none">commandButton</property>, </emphasis> drag the cursor over to + the editor, and drop it inside the editor after the inputText + component.</para> + </listitem> + <listitem> + <para>In the editing dialog select <emphasis> + <property moreinfo="none">value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property moreinfo="none">...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property moreinfo="none">Resource Bundles > msg</property> + </emphasis> and select <emphasis> + <property moreinfo="none">makeguess_button</property> + </emphasis> as a value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property moreinfo="none">action</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">NumberBean.checkGuess</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In Source mode add + <code><br/></code> + tags between + <code><outputText></code> + , <code><inputText></code> + and <code><commandButton></code> + components to place them on different lines</para> + </listitem> + </itemizedlist> + <para>inputnumber.jsp page should look like this:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg" /> +<html> +<head> +<title></title> +</head> + <body> + <f:view> + <h:form id="inputNumbers"> + <h:outputText value="#{msg.how_to_play}" /> + <br /> + <h:messages style="color: blue" /> + <br /> + <h:inputText value="#{NumberBean.userNumber}" id="userNumber" + required="true"> + <f:validateLongRange minimum="0" maximum="100" /> + </h:inputText> + <br /> + <br /> + <h:commandButton value="#{msg.makeguess_button}" + action="#{NumberBean.checkGuess}" /> + </h:form> + </f:view> + </body> +</html> +]]></programlisting> + </section> + <section id="EditingSuccessJsp"> + <?dbhtml filename="EditingSuccessJsp.html"?> + <title>Editing success.jsp page</title> + <para>In the same way like inputnumber.jsp, edit success.jsp page. Its whole source + should be the next:</para> + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg"/> + +<html> + <head> + <title></title> + </head> + <body> + <f:view> + <h:form id="result"> + <h:outputFormat value="#{msg.success_text}"> + <f:param value="#{NumberBean.userNumber}" /> + </h:outputFormat> + <br /> + <br /> + <h:commandButton value="#{msg.trayagain_button}" + action="#{NumberBean.playagain}" /> + </h:form> + </f:view> + </body> +</html> + +]]></programlisting> + <para>Again you can use code assist provided by JBDS when editing jsp page:</para> + <figure float="0"> + <title>Code Assist for <f:param></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_18.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>This page, success.jsp, is shown if you correctly guessed the number. The + <code><h:outputFormat></code> + tag will get the value of success_text from the properties file. The {0} + in success_text will be substituted for by the value of the value attribute within + the <code><f:param></code> + tag during runtime.</para> + <para>At the end, you have a button which allows you to replay the game. The action + value references a backing bean method. In this case, the method only terminates the + current session so that when you are shown the first page, the input text box is + clear and a new random number is generated.</para> + <itemizedlist> + <listitem> + <para>Switch to Preview mode to see how this page will look in a browser:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Success.jsp in Preview Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_19.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="CreatingIndexjsp"> + <?dbhtml filename="CreatingIndexjsp.html"?> + <title>Creating index.jsp page</title> + <para>Now you know how to create index.jsp page.</para> + <para>The index.jsp page is the entry point of our application. It's just + forwarding to inputnumber.jsp page.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property moreinfo="none">WebContent > New > JSP File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">index</property> + </emphasis> for name field and choose <emphasis> + <property moreinfo="none">JSPRedirect</property> + </emphasis> as a template</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>The source for this page should be like the following:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> + <body> + <jsp:forward page="/pages/inputnumber.jsf" /> + </body> +</html> + +]]></programlisting> + <para>Note the <emphasis>.jsf</emphasis> extension of a page. It means that we trigger the + JSF controller servlet to handle the page according the servlet mapping in the + faces-config.xml file.</para> + </section> + <section id="RunningTheApplication33"> + <?dbhtml filename="RunningTheApplication33.html"?> + <title>Running the Application</title> + <para>Finally, we have all the pieces needed to run the application.</para> + <itemizedlist> + <listitem> + <para>Start up JBoss server by clicking on the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> icon in JBoss Server view. (If JBoss is already running, stop it by + clicking on the red icon and then start it again. After the messages in the + Console tabbed view stop scrolling, JBoss is available)</para> + </listitem> + <listitem> + <para>Right-click on project <emphasis> + <property moreinfo="none">Run AS > Run on Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Play with the application by entering correct as well as incorrect + values</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>You are Asked to Enter a Number Between 0 and 100</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_20.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Your Input is Validated and an Error Message is Displayed if Invalid Input was + Entered</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_21.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>After You Enter a Guess, the Application Tells You Whether a Smaller or a Larger + Number Should be Tried</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_22.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <figure float="0"> + <title>Your Guess is Correct</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_23.png" scale="90"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + + + +<chapter id="project_examples" role="new" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/project_examples.xml" xreflabel="project_examples"> + <?dbhtml filename="project_examples.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Project Examples</title> + + <para><emphasis><property moreinfo="none">JBoss Developer Studio</property></emphasis> provides an option to download and import a ready-made + project that you can explore and derive some useful technology implementation lessons from. </para> + + <para> + To adjust the settings of the Project Examples feature you need to navigate to <property moreinfo="none">Windows> Preferences > JBoss Tools > Project Examples + </property>. </para> + + <figure float="0"> + <title>Project Examples Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Show experimental sites</property> checkbox serves to enable/disable representing the user sites in the <property moreinfo="none">Project Example</property> dialog ( <property moreinfo="none">Help > Project Examples</property>). </para> + + + <section id="UserSites"> + <title>User Sites</title> + <para> + As you can see from the <emphasis role="bold">Project Examples Preferences</emphasis> image you can add a custom project example that can be provided by anyone. + This feature can, for example, facilitate project testing. + + </para> + <para> + In oder to add a new project example you need to select the <property moreinfo="none">User sites</property> + option and press the <property moreinfo="none">Add</property> button to the right. + </para> + <para>When the <property moreinfo="none">Add</property> button is pressed the + <property moreinfo="none">Add Project Example Site</property> dialog is displayed. The dialog contains 2 + input fields: <property moreinfo="none">Name</property> where you need to specify the name of the new entry and <property moreinfo="none">URL</property> + that has to point to the xml file that contains example project(s) properties. + In more detail the structure of the xml file is discussed further in the chapter of the guide. + Alternatively, if the xml is stored on your local machine, you can hit the <property moreinfo="none">Browse</property> button to select the file in the file system.</para> + <para>Here is an example of the xml file that holds project example settings:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[ +<projects> + <project> + <category>User Examples</category> + <name>User Project Example</name> + <shortDescription> + Short project description. + </shortDescription> + <description> + Full project description. + </description> + <size>10900</size> + <url> + http://projectexample.org/projectexample.zip + </url> + </project> +</projects> +]]></programlisting> + + <para>Once you define the location of the xml file with projects settings you will see a new user site entry added. + Please note now if you select the entry you can edit and remove it with the corresponding buttons to the right. + You can not do such operations with the <property moreinfo="none">Plugin provides sites</property>.</para> + + <para>When the user sites location is set up you can download and install the project(s). + Please see the next chapter of the guide. </para> + </section> + + + + <section id="DownloadingProjectExample"> + <title>Downloading a Project Example</title> + + <para>To download a project example and start working with it you need to take a few steps:</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis><property moreinfo="none">File > New > Other...</property></emphasis> + </para></listitem> + + <listitem><para>Select <emphasis><property moreinfo="none">Jboss Tools > Project Examples</property></emphasis> (You can also call the <emphasis><property moreinfo="none">Project Examples</property></emphasis> from menu bar: <property moreinfo="none">Help > Project Examples...</property> or directly from <emphasis><property moreinfo="none">File > New > Example...</property></emphasis> menu )</para></listitem> + + + </itemizedlist> + + <figure float="0"> + <title>Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> + Alternatively, you should navigate to <property moreinfo="none">New > Other..</property>, scroll down to find the <property moreinfo="none">JBoss Tools</property> option (or just type in the first letters of the word "JBoss" for quick search), expand the option and select <property moreinfo="none">Project Examples</property>, click <property moreinfo="none">Next</property>. + </para> + <itemizedlist> + <listitem><para>Now in the <property moreinfo="none">New Project Example</property> dialog you can select a project you would like to explore and a site to download it from</para> + <para>Project Examples Wizard provides a filter field to more easily locate the project examples you want, so you can type in the project you would like to explore in the field.</para></listitem> + + </itemizedlist> + + + <figure float="0"> + <title>Selecting a Project Example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>If you have previously specified user sites (see the <link linkend="UserSites">User Sites</link> chapter) they also will be displayed in the list of project examples in the category that was defined in the xml file with user sites settings. </para> + <figure float="0"> + <title>User Site</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_user_site.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> + Pleas note that to view the user sites you need to have <property moreinfo="none">Show experimental sites</property> checked. + </para> + + <note> + <title>Note:</title> + <para> + The <emphasis><property moreinfo="none">Show the Quick Fix Dialog</property></emphasis> option is described in the <link linkend="QuickFixes">Quick Fixes</link> section. + </para> + </note> + + <itemizedlist> + <listitem><para>Press <emphasis><property moreinfo="none">Finish</property></emphasis> to start downloading the project from the repository + </para></listitem> + + </itemizedlist> + + <para>When downloading is finished the project will be imported automatically and you will be able to see it in the Package Explorer.</para> + + <para>Now you can run the application on the server. + + </para> + + + <figure float="0"> + <title>Seam Demo Application run on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="QuickFixes"> + <title>Quick Fixes</title> + <para> + Project Examples Wizard has an option for making quick fixes + for the imported project to easily fix possible issues like missing servers, Seam runtimes etc. + </para> + <para>To enable quick fixing option you need to check the + <emphasis><property moreinfo="none">Show the Quick Fix dialog</property></emphasis> while choosing the <link linkend="DownloadingProjectExample">Project Example</link>.</para> + + <para>When the project you selected is downloaded it will be checked for missing dependences and if there are some you will see a dialog listing the problems.</para> + <figure float="0"> + <title>Quick Fix Dialog box</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>To fix the problem you need to:</para> + + <itemizedlist> + <listitem><para>Select the problem from the list</para></listitem> + <listitem><para>Click <emphasis><property moreinfo="none">Quick Fix</property></emphasis> button</para></listitem> + </itemizedlist> + + <para>You will be offered a solution or a number of solutions to the problem.</para> + + <figure float="0"> + <title>Quick Fix Dialog box: Selecting a Fix</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>In this case(see the image above), when the <emphasis><property moreinfo="none">Finish</property></emphasis> button is pressed, Seam Settings dialog box will be displayed where you need to provide a path to the Seam environment to fix the issue.</para> + + <para>When the problem is fixed you will be returned to the Quick Fix dialog box with the remaining problems to be fixed.</para> + + </section> + + +</chapter> + + + +<chapter id="gsg_faq" role="updated" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/gsg_faq.xml" xreflabel="gsg_faq"> + <?dbhtml filename="gsg_faq.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>FAQ</title> + + <para>For more information on <property moreinfo="none">JBoss Developer Studio</property> features, refer to the + following FAQ to get the answers on the most "popular" questions.</para> + + <section id="question_1"> + <title>What should I do if Visual Page Editor does not start under Linux</title> + + <para>Linux users may need to do the following to get the <property moreinfo="none">Visual Page + Editor</property> to work correctly on their machines.</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>On Red Hat based Linux distributions install the xpLib.i386 package</para> + </listitem> + <listitem> + <para>Type</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[ln -s libstdc++.so.5.0.7 libstdc++.so.5 +]]></programlisting> + </listitem> + <listitem> + <para>and/or use</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[yum install libXp +]]></programlisting> + </listitem> + <listitem> + <para>Open the JBDS perspective. If you see the Help view open, close it and restart + JBDS</para> + </listitem> + <listitem><para> If it doesn't help and you use Fedora Core Linux and Eclipse Version: 3.4.1,the issue can be produced because libswt-xulrunner-gtk-3449.so file doesn't present + in eclipse-swt-3.4.1-5.fc10.x86_64.rpm/eclipse/plugins/org.eclipse.swt.gtk.linux.x86_64_3.4.1.v3449c.jar.To add this file to eclipse you should: + </para> + <itemizedlist> + <listitem> + <para>Decompress eclipse/plugins/org.eclipse.swt.gtk.linux.x86_3.4.1.v3449c.jar form eclipse-SDK-3.4.1-linux-gtk-x86_64.tar.gz</para> + </listitem> + <listitem> + <para>Copy <property moreinfo="none">libswt-xulrunner-gtk-3449.so</property> file to your Fedora Eclipse location.</para> + </listitem> + + <listitem> + <para>Open the file eclipse.ini,which can be found in your Fedora Eclipse location and add the following line: </para> + <programlisting format="linespecific" role="JAVA"><![CDATA[-Dswt.library.path=/usr/lib/eclipse +]]></programlisting><para>,where <code>/usr/lib/eclipse</code> is the path to your eclipse folder.</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>If none of these work, do the following:</para> + <itemizedlist> + <listitem> + <para>Clear the Eclipse log file, + <emphasis><workspace>\.metadata\.log</emphasis></para> + </listitem> + <listitem> + <para>Start Eclipse with the -debug option:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[eclipse -debug +]]></programlisting> + </listitem> + <listitem> + <para>Post the Eclipse log file + (<emphasis><workspace>\.metadata\.log</emphasis>) on + the forums.</para> + </listitem> + </itemizedlist> + </listitem> + </orderedlist> + </section> + + <section id="question_2"> + <title>Do I need to have JBoss Server installed to run JBoss Developer Studio?</title> + + <para>No. <property moreinfo="none">JBoss Developer Studio</property> already comes bundled with JBoss + Server. We bundle it together so that you don't need to download any additional + software and can test your application in a Web browser right away.</para> + <para>If you want to use a different JBoss server installation, after <property moreinfo="none">JBoss + Developer Studio</property> is installed open Servers View (select + <emphasis><property moreinfo="none">Window > Show View > Others > Server + > Servers</property>),</emphasis> then right click on this <emphasis> + <property moreinfo="none">view > New > Server</property> + </emphasis> and follow the wizards steps to point to another Jboss Server + installation.</para> + <para><property moreinfo="none">JBoss Developer Studio</property> works with any servlet container, not just + JBoss. For more information on deployment, please see the Deploying Your Application + section.</para> + </section> + + <section id="question_3"> + <title>I have an existing Seam 1.2.1 project. Can I migrate/import the project to a JBDS + Seam project?</title> + + <para>We highly recommend you to create Seam 1.2.1 project using the + <property moreinfo="none">JBDS</property>. In other case try to do manually:</para> + + <itemizedlist> + <listitem> + <para>Create a Seam Web project to get the JBoss tools structure</para> + </listitem> + </itemizedlist> + <para>Then from your Seam 1.2.1 seam-gen project start doing the following:</para> + <itemizedlist> + <listitem> + <para>Copy <property moreinfo="none">src</property> to <property moreinfo="none">src</property></para> + </listitem> + <listitem> + <para>Copy <property moreinfo="none">view</property> to <property moreinfo="none">Web content</property></para> + </listitem> + <listitem> + <para>Copy resources individual files to where they are in the seam web project + etc.</para> + </listitem> + </itemizedlist> + + </section> + <section id="questio_4"> + <title>I have an existing Struts or JSF project. Can I open the project in JBDS?</title> + + <para>Yes. From main menu select <emphasis> + <property moreinfo="none">File > Import > Other > JSF Project (or Struts + Project)</property> + </emphasis> and follow wizards steps.</para> + + </section> + + <section id="question_5"> + <title>Can I import a .war file?</title> + + <para>Yes. Select <emphasis><property moreinfo="none">File > Import > Web > WAR + file</property>, </emphasis> then follow importing steps.</para> + </section> + + <section id="question_6"> + <title>Is it possible to increase the performance of Eclipse after installing your + product?</title> + + <para><property moreinfo="none">JBoss Developer Studio</property> preconfigures eclipse via the eclipse.ini + file to allocate extra memory, but if you for some reason need more memory then by + default, you can manually make adjustments in this file. For example:</para> + <programlisting format="linespecific" role="XML"> + <![CDATA[-vmargs -Xms128m -Xmx512m -XX:MaxPermSize=128m +]]></programlisting> + </section> + + <section id="question_7"> + <title>How can I add my own tag library to the JBoss Tools Palette?</title> + + <para>See <ulink url="../../jsf/html_single/index.html#AddingCustomJSFTagsToTheRedHatPalette7433">Adding Tag + Libraries</ulink> in Visual Web Tools Guide.</para> + </section> + + <section id="question_8"> + <title>How to get Code Assist for Seam specific resources in an externally generated + project?</title> + + <para>To get Code Assist for Seam specific resources in an externally generated project, you + should enable Seam features in Project Preferences. Right click an imported project and + navigate <emphasis> + <property moreinfo="none">Properties > Seam Settings</property>.</emphasis> Check <emphasis> + <property moreinfo="none">Seam support</property> + </emphasis> box to enable all available <ulink url="../../seam/html_single/index.html#project_pref">Seam + Settings</ulink>.</para> + </section> + + <section id="question_9"> + <title>How to import an example Seam project from jboss-eap directory?</title> + + <para>To import an example Seam project from <emphasis> + <property moreinfo="none">jboss-eap</property> + </emphasis> into your working directory, you should perform the following steps:</para> + + <itemizedlist> + <listitem> + <para>Go to <emphasis> + <property moreinfo="none">New > Other > Java Project from Existing Buildfile</property> + </emphasis></para> + </listitem> + + <listitem> + <para>Point to the <emphasis> + <property moreinfo="none">build.xml</property> + </emphasis> of any chosen project by pressing <emphasis> + <property moreinfo="none">Browse</property> + </emphasis> button</para> + </listitem> + + <listitem> + <para>Hit <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> to open the project</para> + </listitem> + </itemizedlist> + + <para>As these seam examples are non WTP projects, next you should enable Seam support for + them. To do that, right click the project and go to <emphasis> + <property moreinfo="none">Properties > Seam Settings</property>.</emphasis></para> + </section> + + <section id="question_10"> + <title>Is a cross-platform project import possible for JBDS?</title> + + <para>Yes. You can easily import created in Linux JSF, Struts or Seam project to Windows and + vice versa.</para> + + <para>To do the transferring JSF, Struts or Seam project, go to <emphasis> + <property moreinfo="none">Menu > Import > General > Existing Projects into Workspace</property>,</emphasis> + select the folder where your project stored and press <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + </section> +</chapter> + + +<chapter id="further_reading" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/documentation/guides/GettingStartedGuide/en/modules/further_reading.xml" xreflabel="further_reading"> + <?dbhtml filename="further_reading.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Deploy</keyword> + <keyword>Deployment</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + + <title>Further Reading</title> +<itemizedlist> + + <listitem> + <para> + <emphasis role="bold">Seam Dev Tools Reference Guide</emphasis> + <ulink url="../../seam/html_single/index.html">(html)</ulink> + </para> + <para> This guide helps you to understand what Seam is and how to install Seam plug-in into + Eclipse. It tells you the necessary steps to start working with Seam Framework and assists in a + simple Seam Project creation. Also you will learn how to create and run the CRUD Database + Application with Seam as well as find out what Seam Editors Features and Seam Components are. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Visual Web Tools Reference Guide</emphasis> + <ulink url="../../jsf/html_single/index.html">(html)</ulink> provides general orientation and an overview of JBDS visual web tools functionality. This guide discusses the following topics: editors, palette, web properties view, openOn, content assist, RichFaces support. + </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Server Manager Reference Guide</emphasis> + <ulink url="../../as/html_single/index.html">(html)</ulink> + </para> + <para> This guide covers the basics of working with the JBoss server manager. You will read how to + install runtimes and servers and quickly learn how to configure, start, stop the server and know + how deployment and archiving process. You will find out how to manage installed JBoss Servers + via JBoss AS Perspective. You will also read how to deploy modules onto the server. </para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">jBPM Tools Reference Guide</emphasis> + <ulink url="../../jbpm/html_single/index.html">(html)</ulink> + </para> + <para>With jBPM Tools Reference Guide we'll help you to facilitate a cross-product + learning and know how you can speed your development using special editors and visual designers. + We'll also guide you through the steps on how to create a simple process and test it + within jBPM jPDL perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Hibernate Tools Reference Guide</emphasis> + <ulink url="../../hibernatetools/html_single/index.html">(html)</ulink> + </para> + <para>Throughout this guide you will learn how to install and use Hibernate Tools bath via Ant and + through Eclipse. We'll supply you with the information on how to create mapping files, + configuration file as well as a file for controlling reverse engineering by using specific + wizards that Hibernate tooling provides. Also you will know about Code Generation and + peculiarities of work within Hibernate Console Perspective.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">ESB Editor Reference Guide</emphasis> + <ulink url="../../esb_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>This guide provides you with the information on ESB Editor and all necessary wizards for ESB + files development.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss Portal Tools Reference Guide</emphasis> + <ulink url="../../jboss_portal_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>The guide gives a detail look at how you can easily build a Portlet Web Application with + JBoss Tools and deploy it onto JBoss Portal.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JBoss WS User Guide</emphasis> + <ulink url="../../ws_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>This guide gives you practical help on JBossWS usage. You will learn how to create a web service using JBossWS runtime, find out how to create a web service client from a WSDL document using JBoss WS and also see how to set your development environment.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Smooks Tools Reference Guide</emphasis> + <ulink url="../../jboss_smooks_plugin_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>This guide is packed with useful and easy-to-understand information about graphical, configuration and source editor pages.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Drools Tools Reference Guide</emphasis> + <ulink url="../../drools_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>The guide help you to discover how to create a new Drools project, use debugging rules and work with different editors.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">JMX Tools Reference Guide</emphasis> + <ulink url="../../jmx_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>With the help of this guide you'll explore the best practices to follow when working with MBean Explorer, MBean Editor, Connections and etc.</para> + </listitem> + + <listitem> + <para> + <emphasis role="bold">Eclipse Guvnor Tools Reference Guide</emphasis> + <ulink url="../../guvnor_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para>The purpose of this guide is to describe briefly the functionality present in the Eclipse Guvnor Tools (EGT) for Drools 5.</para> + </listitem> + + + + <listitem> + <para> + <emphasis role="bold">JSF Tools Tutorial</emphasis> + <ulink url="../../jsf_tools_tutorial/html_single/index.html">(html)</ulink> + </para> + <para> This tutorial will describe how to deal with classic/old style of JSF development and how + to create a simple JSF application using the JBoss Developer Studio. </para> + </listitem> + + <listitem> <para> + <emphasis role="bold">JSF Tools Reference Guide</emphasis> + <ulink url="../../jsf_tools_ref_guide/html_single/index.html">(html)</ulink> + + </para> + <para> From this guide you'll discover all peculiarities of work at a JSF project. You'll + learn all shades that cover the process of project creation and take a closer look at the JSF + configuration file. Also you'll get to know managed beans and how to work with them and + find out, how to create and register a custom converter, custom validator and referenced beans + in a JSF project. </para> + </listitem> + + <listitem> <para> + <emphasis role="bold">Struts Tools Reference Guide</emphasis> + <ulink url="../../struts_tools_ref_guide/html_single/index.html">(html)</ulink> + </para> + <para> In Struts Tools Reference Guide you will learn how to create and work with a new struts + project. This guide also provides information about graphical editor for struts configuration + files, tiles files, and struts validation files. </para> + </listitem> + +<listitem> + <para> + <emphasis role="bold">Struts Tools Tutorial</emphasis> + <ulink url="../../struts_tools_tutorial/html_single/index.html">(html)</ulink> + </para> + <para> This tutorial will describe the classical style of Struts development, and will + step-by-step show you how to create a simple Struts application in JBoss Developer Studio.</para> +</listitem> + + + <listitem> + <para> + <emphasis role="bold">Exadel Studio Migration Guide</emphasis> + <ulink url="../../Exadel-migration/html_single/index.html">(html)</ulink> + </para> + <para>This document is intended to help you to migrate an existing Exadel JSF or Struts projects + from Exadel Studio into JBoss Developer Studio. </para> + </listitem> + + <para>If there's anything we didn't cover in this guide, + please feel free to visit our + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=258"> + JBoss Developer Studio Users Forum</ulink> or + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201"> + JBoss Tools Users Forum</ulink> to ask questions. There we are also looking for + your suggestions and comments.</para> +</itemizedlist> + +</chapter> + + +</book> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/project_examples.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/project_examples.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/project_examples.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,211 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<chapter id="project_examples" xreflabel="project_examples" role="new"> + <?dbhtml filename="project_examples.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Project Examples</title> + + <para><emphasis><property>JBoss Developer Studio</property></emphasis> provides an option to download and import a ready-made + project that you can explore and derive some useful technology implementation lessons from. </para> + + <para> + To adjust the settings of the Project Examples feature you need to navigate to <property>Windows> Preferences > JBoss Tools > Project Examples + </property>. </para> + + <figure> + <title>Project Examples Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Show experimental sites</property> checkbox serves to enable/disable representing the user sites in the <property>Project Example</property> dialog ( <property>Help > Project Examples</property>). </para> + + + <section id="UserSites"> + <title>User Sites</title> + <para> + As you can see from the <emphasis role="bold">Project Examples Preferences</emphasis> image you can add a custom project example that can be provided by anyone. + This feature can, for example, facilitate project testing. + + </para> + <para> + In oder to add a new project example you need to select the <property>User sites</property> + option and press the <property>Add</property> button to the right. + </para> + <para>When the <property>Add</property> button is pressed the + <property>Add Project Example Site</property> dialog is displayed. The dialog contains 2 + input fields: <property>Name</property> where you need to specify the name of the new entry and <property>URL</property> + that has to point to the xml file that contains example project(s) properties. + In more detail the structure of the xml file is discussed further in the chapter of the guide. + Alternatively, if the xml is stored on your local machine, you can hit the <property>Browse</property> button to select the file in the file system.</para> + <para>Here is an example of the xml file that holds project example settings:</para> + + <programlisting role="XML"><![CDATA[ +<projects> + <project> + <category>User Examples</category> + <name>User Project Example</name> + <shortDescription> + Short project description. + </shortDescription> + <description> + Full project description. + </description> + <size>10900</size> + <url> + http://projectexample.org/projectexample.zip + </url> + </project> +</projects> +]]></programlisting> + + <para>Once you define the location of the xml file with projects settings you will see a new user site entry added. + Please note now if you select the entry you can edit and remove it with the corresponding buttons to the right. + You can not do such operations with the <property>Plugin provides sites</property>.</para> + + <para>When the user sites location is set up you can download and install the project(s). + Please see the next chapter of the guide. </para> + </section> + + + + <section id="DownloadingProjectExample"> + <title>Downloading a Project Example</title> + + <para>To download a project example and start working with it you need to take a few steps:</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis><property>File > New > Other...</property></emphasis> + </para></listitem> + + <listitem><para>Select <emphasis><property>Jboss Tools > Project Examples</property></emphasis> (You can also call the <emphasis><property>Project Examples</property></emphasis> from menu bar: <property>Help > Project Examples...</property> or directly from <emphasis><property>File > New > Example...</property></emphasis> menu )</para></listitem> + + + </itemizedlist> + + <figure> + <title>Project Examples</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Alternatively, you should navigate to <property>New > Other..</property>, scroll down to find the <property>JBoss Tools</property> option (or just type in the first letters of the word "JBoss" for quick search), expand the option and select <property>Project Examples</property>, click <property>Next</property>. + </para> + <itemizedlist> + <listitem><para>Now in the <property>New Project Example</property> dialog you can select a project you would like to explore and a site to download it from</para> + <para>Project Examples Wizard provides a filter field to more easily locate the project examples you want, so you can type in the project you would like to explore in the field.</para></listitem> + + </itemizedlist> + + + <figure> + <title>Selecting a Project Example</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>If you have previously specified user sites (see the <link linkend="UserSites">User Sites</link> chapter) they also will be displayed in the list of project examples in the category that was defined in the xml file with user sites settings. </para> + <figure> + <title>User Site</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_user_site.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> + Pleas note that to view the user sites you need to have <property>Show experimental sites</property> checked. + </para> + + <note> + <title>Note:</title> + <para> + The <emphasis><property>Show the Quick Fix Dialog</property></emphasis> option is described in the <link linkend="QuickFixes">Quick Fixes</link> section. + </para> + </note> + + <itemizedlist> + <listitem><para>Press <emphasis><property>Finish</property></emphasis> to start downloading the project from the repository + </para></listitem> + + </itemizedlist> + + <para>When downloading is finished the project will be imported automatically and you will be able to see it in the Package Explorer.</para> + + <para>Now you can run the application on the server. + + </para> + + + <figure> + <title>Seam Demo Application run on the Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_3.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="QuickFixes"> + <title>Quick Fixes</title> + <para> + Project Examples Wizard has an option for making quick fixes + for the imported project to easily fix possible issues like missing servers, Seam runtimes etc. + </para> + <para>To enable quick fixing option you need to check the + <emphasis><property>Show the Quick Fix dialog</property></emphasis> while choosing the <link linkend="DownloadingProjectExample">Project Example</link>.</para> + + <para>When the project you selected is downloaded it will be checked for missing dependences and if there are some you will see a dialog listing the problems.</para> + <figure> + <title>Quick Fix Dialog box</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>To fix the problem you need to:</para> + + <itemizedlist> + <listitem><para>Select the problem from the list</para></listitem> + <listitem><para>Click <emphasis><property>Quick Fix</property></emphasis> button</para></listitem> + </itemizedlist> + + <para>You will be offered a solution or a number of solutions to the problem.</para> + + <figure> + <title>Quick Fix Dialog box: Selecting a Fix</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/project_examples/pr_example_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>In this case(see the image above), when the <emphasis><property>Finish</property></emphasis> button is pressed, Seam Settings dialog box will be displayed where you need to provide a path to the Seam environment to fix the issue.</para> + + <para>When the problem is fixed you will be returned to the Quick Fix dialog box with the remaining problems to be fixed.</para> + + </section> + + +</chapter> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/en-US/rad_jsf_application.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,1121 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="rad_jsf_application" xreflabel="rad_jsf_application"> + <?dbhtml filename="rad_jsf_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>JSF</keyword> + <keyword>JBoss</keyword> + <keyword>RAD</keyword> + </keywordset> + </chapterinfo> + <title>RAD development of a simple JSF application</title> + + <note> + <title>Note:</title> + <para>We highly recommend developing in <property>Seam</property>. This chapter is for users + who for some reason cannot use <property>Seam</property>.</para> + </note> + + <para>In this chapter you will see how to create a simple JSF application being based on + <property>"RAD"</property> philosophy. We will create the familiar + Guess Number application. The scenario is the following. You are asked to guess a number + between 0 and 100. If the guess is correct, a success page is displayed with a link to play + again. If the guess is incorrect, a message is printed notifying that a smaller or a larger + number should be entered and the game continues.</para> + <para>We'll show you how to create such an application from scratch, along the way + demonstrating powerful features of JBoss Developer Studio such as project templating, Visual + Page Editor, code completion and others. You will design the JSF application and then run + the application from inside JBoss Developer Studio using the bundled JBoss server.</para> + + <section id="SettingUpTheProject12"> + <?dbhtml filename="SettingUpTheProject12.html"?> + <title>Setting up the project</title> + <para>First, you should create a JSF 1.2 project using an integrated JBDS's new + project wizard and predefined templates. Follow the next steps:</para> + <itemizedlist> + <listitem> + <para>In Web Projects View (if it is not open select <emphasis> + <property>Window > Show View > Others > JBoss Tools Web + > Web Projects View</property>) </emphasis> click <emphasis> + <property>Create New JSF Project</property> + </emphasis> button. <figure> + <title>Create New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_1.png"/> + </imageobject> + </mediaobject> + </figure></para> + </listitem> + + <listitem> + <para>Put <property>GuessNumber</property> as a project name, in JSF Environment + drop down list choose <property>JSF 1.2</property></para> + </listitem> + <listitem> + <para>Leave everything else as it is and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Our project will appear in Project Explorer and Web Projects Views. As you can see + JBoss Developer Studio has created for us the whole skeleton for the project with all + needed libraries, faces-config.xml and web.xml files.</para> + <figure> + <title>New JSF Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As the project has been set up, new JSP pages should be created now.</para> + </section> + <section id="CreatingJSPPages"> + <?dbhtml filename="CreatingJSPPages.html"?> + <title>Creating JSP Pages</title> + + <para>Here, we are going to add two pages to our application. The first page is + inputnumber.jsp. It prompts you to enter a number. If the guess is incorrect, the same + page will be redisplayed with a message indicating whether a smaller or a larger number + should be tried. The second page is success.jsp. This page will be shown after you guess + the number correctly. From this page you also have the option to play the game again.</para> + + <para>Now, we will guide you through the steps on how to do this.</para> + <itemizedlist> + <listitem> + <para>Open <emphasis> + <property>faces-config.xml</property> + </emphasis> file</para> + </listitem> + <listitem> + <para>Right click anywhere on the diagram mode</para> + </listitem> + <listitem> + <para>From the context menu select <emphasis> + <property>New View</property> + </emphasis></para> + </listitem> + </itemizedlist> + <figure> + <title>Create New View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_3.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + + <listitem> + <para>Type <emphasis> + <property>pages/inputnumber</property> + </emphasis> as the value for <emphasis> + <property>From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Leave everything else as is and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In the same way create another jsf view. Type <emphasis> + <property>pages/success</property> + </emphasis> as the value for <emphasis> + <property>From-view-id</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>File > Save</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>On the diagram you will see two created views.</para> + <figure> + <title>New Views</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_4.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="CreatingTransition"> + <?dbhtml filename="CreatingTransition.html"?> + <title>Creating Transition between two views</title> + <para>Then, we should create connection between jsp pages.</para> + <itemizedlist> + <listitem> + <para>In the diagram, select the <emphasis> + <property>Create New Connection</property> + </emphasis> icon third from the top along the upper left side of the diagram to + get an arrow cursor with a two-pronged plug at the arrow's bottom <figure> + <title>Create Connection</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_5.png"/> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Click on the <emphasis> + <property>pages/inputnumber</property> + </emphasis> page icon and then click on the <emphasis> + <property>pages/success</property> + </emphasis> page icon</para> + </listitem> + </itemizedlist> + <para>A transition should appear between the two icons of views.</para> + <figure> + <title>Created Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_6.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select <emphasis> + <property>File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + + <section id="CreatingResourceFile"> + <?dbhtml filename="CreatingResourceFile.html"?> + <title>Creating Resource File</title> + <para>A resource file is just a file with a <emphasis>.properties</emphasis> extension for + collecting text messages in one central place. JBoss Developer Studio allows you to + create quickly a resource file. The messages stored in resource file can be displayed to + you on a Web page during application execution. </para> + <para>With resource file first, you don't hard code anything into the JSP pages. + And second, it makes it easier to translate your application to other languages. All you + have to do is to translate all your messages to the other language and save them in a + new properties file with a name that ends with the appropriate ISO-639 language code.</para> + <para>It is a good idea to keep your resources inside the <emphasis> + <property>JavaSource</property> + </emphasis> folder, where you keep your .java files. Every time you build the project, + all <emphasis>.properties</emphasis> files will then be copied to the + <emphasis>classes</emphasis> folder by default.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property>JavaSource</property> + </emphasis> folder and select <emphasis> + <property>New > Folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>game</property> + </emphasis> for Folder name and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>Your resource file and java bean will be stored in this folder.</para> + <itemizedlist> + <listitem> + <para>Right click on <emphasis> + <property>game folder</property> + </emphasis> and select <emphasis> + <property>New > Properties File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>messages</property> + </emphasis> as the value for "name" attribute and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>JBoss Developer Studio will automatically open + <property>messages.properties</property> file for editing.</para> + <figure> + <title>Messages.properties File</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_7.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>Add</property> + </emphasis> button for adding new attribute to your resource file</para> + </listitem> + <listitem> + <para>Type <emphasis role="italic"> + <property>how_to_play</property> + </emphasis> for "name" and <emphasis role="italic"> + <property>Please pick a number between 0 and 100.</property> + </emphasis> for value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In such a way add the next properties:</para> + </listitem> + </itemizedlist> + <programlisting role="JAVA"><![CDATA[makeguess_button=Make Guess +trayagain_button=Play Again? +success_text=How cool.. You have guessed the number, {0} is correct! +tryagain_smaller=Oops..incorrect guess. Please try a smaller number. +tryagain_bigger=Oops..incorrect guess. Please try a bigger number. +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + <para>Your .properties file should now look like follows:</para> + <figure> + <title>Properties are Added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8.png"/> + </imageobject> + </mediaobject> + </figure> + <para><emphasis> + <property>Up</property></emphasis> + and <emphasis> + <property>Down</property> + </emphasis> buttons allow you to move you attribute on the list. For delete the attribute, choose it and press <emphasis> + <property>Delete</property></emphasis> button.</para> + <para>If you want to change a value or a name of your attribute, click on it and than on <emphasis> + <property>Edit</property></emphasis> button.</para> + + <para>If the .properties file is rather big and there are a lot of entries in it, you can use filtering and regular expressions to find the necessary ones. The Filter and Regular Expressions Search is implemented by an expandable panel, closed by default: </para> + <para>When "Expression" is not selected (as by default), filter is case insensitive. When "Expression" is selected, filter uses regular expressions which are case sensitive</para> + <figure> + <title>Filter and Regular Expressions Search Panel</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8a.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Enter the characters that should be searched for in the entries to the 'name' or 'value' input fields accordingly. The filtered results will be displayed in the table below:</para> + + <figure> + <title>Filter results</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_8b.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>When using regular expressions please note, that regular expression syntax does not use "*" for any characters and "?" for any one character. It's necessary to use "." for any one character and ".*" for any characters. Symbols "*" and "?" are used to show that the preceding token is not required, for example, "a.a" matches "aba" but not "aa", while "a.?a" or a.*a" matches both; besides "a.*a" matches "abcda".</para> + <para>To find the exact match, use sequences \A and \z in expression. For example, expression "\Adate\z" matches only string "date"; expression "\Adate" matches "date" and "dateline", expression "date\z" matches "date" and "Begin date", and expression "date" matches all of them.</para> + + </section> + + <section id="CreatingJavaBean"> + <?dbhtml filename="CreatingJavaBean.html"?> + <title>Creating Java Bean</title> + <para>In this section you'll see how to create a Java bean that will hold business + logic of our application.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property>game folder</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>New > Class</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>NumberBean</property> + </emphasis> for bean name</para> + </listitem> + </itemizedlist> + <para>A java bean is created.</para> + <itemizedlist> + <listitem> + <para>Declare the variable of your entered number:</para> + </listitem> + </itemizedlist> + <programlisting role="JAVA"><![CDATA[Integer userNumber; +]]></programlisting> + <para>JBDS allows to quickly generate getters and setters for java bean.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property>NumberBean.java</property> + </emphasis> in Package Explorer</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>Source > Generate Getters and Setters...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Check <emphasis> + <property>userNumber</property> + </emphasis> box and click <emphasis> + <property>OK</property> + </emphasis> + <figure> + <title>Generate Getters and Setters</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_9.png"/> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Add the declaration of the second variable</para> + </listitem> + </itemizedlist> + <programlisting role="JAVA"><![CDATA[int randomNumber; +]]></programlisting> + <itemizedlist> + <listitem> + <para>.. other bean methods:</para> + </listitem> + </itemizedlist> + <programlisting role="JAVA"><![CDATA[public NumberBean () +{ + randomNumber = (int)(Math.random()*100); + System.out.println ( "Random number: "+randomNumber); + } + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + public String checkGuess () + { + + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } +else + { + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +]]></programlisting> + <itemizedlist> + <listitem> + <para>And the import declarations:</para> + </listitem> + </itemizedlist> + <programlisting role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; +]]></programlisting> + <para>The whole java bean should look as follows:</para> + <programlisting role="JAVA"><![CDATA[import javax.faces.context.FacesContext; +import javax.servlet.http.HttpSession; +import javax.faces.application.FacesMessage; +import java.util.Locale; +import java.util.ResourceBundle; + +public class NumberBean +{ + Integer userNumber; + int randomNumber; // random number generated by application +public Integer getUserNumber () + { + return userNumber; + } + public void setUserNumber (Integer value) + { + this.userNumber = value; + } + + // constructor, generates random number + public NumberBean () + { + randomNumber = (int)(Math.random()*100); + System.out.println ( + "Random number: " + randomNumber); + } + + public String playagain () + { + FacesContext context = FacesContext.getCurrentInstance(); + HttpSession session = + (HttpSession) context.getExternalContext().getSession(false); + session.invalidate(); + return "playagain"; + } + + // check if user guessed the number + public String checkGuess () + { + // if guessed, return 'success' for navigation + if ( userNumber.intValue() == randomNumber ) + { + return "success"; + } + // incorrect guess + else + { + // get a reference to properties file to retrieve messages + FacesContext context = FacesContext.getCurrentInstance(); + ResourceBundle bundle = + ResourceBundle.getBundle("game.messages", + context.getViewRoot().getLocale()); + String msg = ""; + // if number is bigger, get appropriate message + if ( userNumber.intValue() > randomNumber ) + msg = bundle.getString("tryagain_smaller"); + else // if number smaller, get appropriate message + msg = bundle.getString("tryagain_bigger"); + + // add message to be displayed on the page via <h:messages> tag + context.addMessage (null, new FacesMessage(msg)); + // return 'tryagain' for navigation + return "tryagain"; + } + } +} +]]></programlisting> + </section> + + <section id="EditingFacesConfig"> + <?dbhtml filename="EditingFacesConfig.html"?> + <title>Editing faces-config.xml File</title> + <para>In this section you know about faces-config.xml file.</para> + <para>This file holds two navigation rules and defines the backing bean used.</para> + <itemizedlist> + <listitem> + <para>Open faces-config.xml file in a source mode</para> + </listitem> + <listitem> + <para>Add here one more navigation rule and a managed bean declarations that the + content of the file looks like this:</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<?xml version="1.0" encoding="UTF-8"?> +<faces-config version="1.2" xmlns="http://java.sun.com/xml/ns/javaee +xmlns:xi="http://www.w3.org/2001/XInclude" +xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" +xsi:schemaLocation="http://java.sun.com/xml/ns/javaee + http://java.sun.com/xml/ns/javaee/web-facesconfig_1_2_.xsd"> + + <navigation-rule> + <from-view-id>*</from-view-id> + <navigation-case> + <from-outcome>playagain</from-outcome> + <to-view-id>/pages/inputnumber.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <navigation-rule> + <from-view-id>/pages/inputnumber.jsp</from-view-id> + <navigation-case> + <from-outcome>success</from-outcome> + <to-view-id>/pages/success.jsp</to-view-id> + </navigation-case> + </navigation-rule> + + <managed-bean> + <managed-bean-name>NumberBean</managed-bean-name> + <managed-bean-class>game.NumberBean</managed-bean-class> + <managed-bean-scope>session</managed-bean-scope> + </managed-bean> + +</faces-config> +]]></programlisting> + <para>The first navigation rule states that from any page (<property>*</property> stands for + any page) an outcome of playagain will take you to <emphasis> + <property>/pages/inputnumber.jsp</property> + </emphasis>. Outcome values are returned from backing bean methods in this example. The + second navigation rule states that if you are at the page <emphasis> + <property>/pages/inputnumber.jsp</property> + </emphasis>, and the outcome is success, then navigate to the <emphasis> + <property>/pages/success.jsp</property> + </emphasis> page. </para> + </section> + <section id="EditingTheJSPViewFiles2"> + <?dbhtml filename="EditingTheJSPViewFiles2.html"?> + <title>Editing the JSP View Files</title> + <para>Now, we will continue editing the JSP files for our two "views" using + Visual Page Editor.</para> + <section id="EditingInputjsp"> + <?dbhtml filename="EditingInputjsp.html"?> + <title>Editing inputnumber.jsp page</title> + <para>First, let's dwell on how to edit inputnumber.jsp.</para> + <para>On this page we will have an output text component displaying a message, a text + field for user's number entering and a button for input submission.</para> + <itemizedlist> + <listitem> + <para>Open inputnumber.jsp by double-clicking on the <emphasis> + <property>/pages/inputnumber. jsp</property> + </emphasis> icon</para> + </listitem> + </itemizedlist> + <para>The Visual Page Editor will open in a screen split between source code along the + top and a WYSIWIG view along the bottom. You can see that some JSF code will be + already generated as we choose a template when creating the page.</para> + <para>At the beginning it's necessary to create a + <code><h:form></code> + component where all others components are put.</para> + <itemizedlist> + <listitem> + <para>Place the mouse cursor inside + <code><f:view> + </f:view></code> + </para> + </listitem> + <listitem> + <para>Go to JBoss Tools Palette and expand JSF HTML folder by selecting + it</para> + </listitem> + <listitem> + <para>Click on + <code><h:form></code> + tag <figure> + <title>Insert h:form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_10.png" + /> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>In the dialog Insert Tag select <emphasis> + <property>id</property> + </emphasis> and click on this line below the value header. A blinking cursor + will appear in a input text field inviting to enter a value of id <figure> + <title>Define Id of Form</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_11.png" + /> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>inputNumbers</property> + </emphasis> and click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>In source view you can see the declaration of a form.</para> + <figure> + <title>Created Form</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_12.png"/> + </imageobject> + </mediaobject> + </figure> + <para>First let's declare the properties file in inputnumber.jsp page using the + loadBundle JSF tag.</para> + <itemizedlist> + <listitem> + <para>Put this declaration on the top of a page, right after the first two + lines:</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<f:loadBundle basename="game.messages" var="msg"/> +]]></programlisting> + <para>As always JBDS provides code assist:</para> + <figure> + <title>Code Assist</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_13.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Visual tab, so it could be possible to work with the editor + completely in its WYSIWYG mode</para> + </listitem> + <listitem> + <para>Click on <emphasis> + <property>outputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the blue box in the editor</para> + </listitem> + + <listitem> + <para>Select <emphasis> + <property>value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property>...</property> button next to the value field</para> + </listitem> + </itemizedlist> + <para>JBDS will nicely propose you to choose within available values:</para> + <figure> + <title>Choose Value</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_14.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Expand <emphasis> + <property>Resource Bundles > msg</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>how_to_play</property> + </emphasis> value and click <emphasis> + <property>Ok</property>. </emphasis> Then click <emphasis> + <property>Finish</property> + </emphasis> + <figure> + <title>Selecting Value</title> + <mediaobject> + <imageobject> + <imagedata + fileref="images/rad_jsf_application/rad_jsf_application_15.png" + /> + </imageobject> + </mediaobject> + </figure> + </para> + </listitem> + </itemizedlist> + <para>The text will appear on the page:</para> + <figure> + <title>Created OutputText Component</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_16.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Switch to Source mode and insert + <code><br/></code> + tag after + <code><h:outputText></code> + component to make a new line.</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Save</property> + </emphasis> button.</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property>inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text.</para> + </listitem> + <listitem> + <para>Switch to a Source mode and insert + <code><br/></code> + tag after + <code><h:outputText></code> + component to make a new line</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>On the Palette click on <emphasis> + <property>inputText</property>, </emphasis> drag the cursor over to the + editor, and drop it inside the editor after the text</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property>...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property>Managed Beans > NumberBean</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>userNumber</property> + </emphasis> value and click <emphasis> + <property>Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Switch <emphasis> + <property>Advanced</property> + </emphasis> tab</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>id</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>userNumber</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>required</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property>...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property>Enumeration</property> + </emphasis> and select <emphasis> + <property>true</property> + </emphasis> as a value</para> + </listitem> + </itemizedlist> + <figure> + <title>Add "required" Attribute</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_17.png"/> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>Ok</property>, </emphasis> then click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>Go to Source mode</para> + </listitem> + <listitem> + <para>Add the validation attribute to + <code><f:validateLongRange></code> + for user input validation</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<h:inputText id="userNumber" value="#{NumberBean.userNumber}" required="true"> + <f:validateLongRange minimum="0" maximum="100"/> +</h:inputText> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property>Save</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Again select <emphasis> + <property>Visual</property> + </emphasis> mode</para> + </listitem> + <listitem> + <para>On the Palette, click on <emphasis> + <property>commandButton</property>, </emphasis> drag the cursor over to + the editor, and drop it inside the editor after the inputText + component.</para> + </listitem> + <listitem> + <para>In the editing dialog select <emphasis> + <property>value</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Click <property>...</property> button next to the value field</para> + </listitem> + <listitem> + <para>Expand <emphasis> + <property>Resource Bundles > msg</property> + </emphasis> and select <emphasis> + <property>makeguess_button</property> + </emphasis> as a value</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Ok</property> + </emphasis></para> + </listitem> + <listitem> + <para>Select <emphasis> + <property>action</property> + </emphasis> and click on this line below "value" + header</para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>NumberBean.checkGuess</property> + </emphasis> in text field</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In Source mode add + <code><br/></code> + tags between + <code><outputText></code> + , <code><inputText></code> + and <code><commandButton></code> + components to place them on different lines</para> + </listitem> + </itemizedlist> + <para>inputnumber.jsp page should look like this:</para> + <programlisting role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg" /> +<html> +<head> +<title></title> +</head> + <body> + <f:view> + <h:form id="inputNumbers"> + <h:outputText value="#{msg.how_to_play}" /> + <br /> + <h:messages style="color: blue" /> + <br /> + <h:inputText value="#{NumberBean.userNumber}" id="userNumber" + required="true"> + <f:validateLongRange minimum="0" maximum="100" /> + </h:inputText> + <br /> + <br /> + <h:commandButton value="#{msg.makeguess_button}" + action="#{NumberBean.checkGuess}" /> + </h:form> + </f:view> + </body> +</html> +]]></programlisting> + </section> + <section id="EditingSuccessJsp"> + <?dbhtml filename="EditingSuccessJsp.html"?> + <title>Editing success.jsp page</title> + <para>In the same way like inputnumber.jsp, edit success.jsp page. Its whole source + should be the next:</para> + <programlisting role="XML"><![CDATA[<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %> +<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %> +<f:loadBundle basename="game.messages" var="msg"/> + +<html> + <head> + <title></title> + </head> + <body> + <f:view> + <h:form id="result"> + <h:outputFormat value="#{msg.success_text}"> + <f:param value="#{NumberBean.userNumber}" /> + </h:outputFormat> + <br /> + <br /> + <h:commandButton value="#{msg.trayagain_button}" + action="#{NumberBean.playagain}" /> + </h:form> + </f:view> + </body> +</html> + +]]></programlisting> + <para>Again you can use code assist provided by JBDS when editing jsp page:</para> + <figure> + <title>Code Assist for <f:param></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_18.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + <para>This page, success.jsp, is shown if you correctly guessed the number. The + <code><h:outputFormat></code> + tag will get the value of success_text from the properties file. The {0} + in success_text will be substituted for by the value of the value attribute within + the <code><f:param></code> + tag during runtime.</para> + <para>At the end, you have a button which allows you to replay the game. The action + value references a backing bean method. In this case, the method only terminates the + current session so that when you are shown the first page, the input text box is + clear and a new random number is generated.</para> + <itemizedlist> + <listitem> + <para>Switch to Preview mode to see how this page will look in a browser:</para> + </listitem> + </itemizedlist> + <figure> + <title>Success.jsp in Preview Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_19.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + </section> + <section id="CreatingIndexjsp"> + <?dbhtml filename="CreatingIndexjsp.html"?> + <title>Creating index.jsp page</title> + <para>Now you know how to create index.jsp page.</para> + <para>The index.jsp page is the entry point of our application. It's just + forwarding to inputnumber.jsp page.</para> + <itemizedlist> + <listitem> + <para>Right click <emphasis> + <property>WebContent > New > JSP File</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property>index</property> + </emphasis> for name field and choose <emphasis> + <property>JSPRedirect</property> + </emphasis> as a template</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property>Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>The source for this page should be like the following:</para> + </listitem> + </itemizedlist> + <programlisting role="XML"><![CDATA[<!doctype html public "-//w3c//dtd html 4.0 transitional//en"> +<html> + <body> + <jsp:forward page="/pages/inputnumber.jsf" /> + </body> +</html> + +]]></programlisting> + <para>Note the <emphasis>.jsf</emphasis> extension of a page. It means that we trigger the + JSF controller servlet to handle the page according the servlet mapping in the + faces-config.xml file.</para> + </section> + <section id="RunningTheApplication33"> + <?dbhtml filename="RunningTheApplication33.html"?> + <title>Running the Application</title> + <para>Finally, we have all the pieces needed to run the application.</para> + <itemizedlist> + <listitem> + <para>Start up JBoss server by clicking on the <emphasis> + <property>Start</property> + </emphasis> icon in JBoss Server view. (If JBoss is already running, stop it by + clicking on the red icon and then start it again. After the messages in the + Console tabbed view stop scrolling, JBoss is available)</para> + </listitem> + <listitem> + <para>Right-click on project <emphasis> + <property>Run AS > Run on Server</property> + </emphasis></para> + </listitem> + <listitem> + <para>Play with the application by entering correct as well as incorrect + values</para> + </listitem> + </itemizedlist> + <figure> + <title>You are Asked to Enter a Number Between 0 and 100</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_20.png"/> + </imageobject> + </mediaobject> + </figure> + <figure> + <title>Your Input is Validated and an Error Message is Displayed if Invalid Input was + Entered</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_21.png" + scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>After You Enter a Guess, the Application Tells You Whether a Smaller or a Larger + Number Should be Tried</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_22.png" + scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <figure> + <title>Your Guess is Correct</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/rad_jsf_application/rad_jsf_application_23.png" + scale="90"/> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> Modified: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/pom.xml =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/pom.xml 2010-03-11 23:51:54 UTC (rev 20771) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/pom.xml 2010-03-11 23:57:54 UTC (rev 20772) @@ -23,7 +23,7 @@ <profile> <id>releaseJBDS</id> <properties> - <master>master.xml</master> + <master>master_output.xml</master> <xsl-single>classpath:/xslt/com/jboss/tools/xhtml-single-release.xsl</xsl-single> <xsl-chunked>classpath:/xslt/com/jboss/tools/xhtml-release.xsl</xsl-chunked> <xsl-pdf>classpath:/xslt/com/jboss/tools/pdf.xsl</xsl-pdf> @@ -81,9 +81,9 @@ </dependencies> <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> <include>database.zip</include> Added: branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/publican.cfg =================================================================== --- branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/publican.cfg (rev 0) +++ branches/jbosstools-3.1.x/documentation/guides/GettingStartedGuide/publican.cfg 2010-03-11 23:57:54 UTC (rev 20772) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

16 years, 1 month

1
0
0 / 0

2026

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits March 2010