December 2009 - jbosstools-commits

JBoss Tools SVN: r19406 - in trunk/portlet/docs/reference/en/images: reference and 1 other directory.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 05:38:55 -0500 (Thu, 17 Dec 2009) New Revision: 19406 Added: trunk/portlet/docs/reference/en/images/reference/ trunk/portlet/docs/reference/en/images/reference/javaPortlet2.png trunk/portlet/docs/reference/en/images/reference/javaPortlet3.png trunk/portlet/docs/reference/en/images/reference/javaPortlet4.png trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet1.png trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet2.png trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet3.png trunk/portlet/docs/reference/en/images/reference/portlet_preferences.png Log: https://jira.jboss.org/jira/browse/JBDS-907 - adding new images; Added: trunk/portlet/docs/reference/en/images/reference/javaPortlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/javaPortlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/javaPortlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/javaPortlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/javaPortlet4.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/javaPortlet4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet1.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet2.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet3.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/jsf_seam_portlet3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/portlet/docs/reference/en/images/reference/portlet_preferences.png =================================================================== (Binary files differ) Property changes on: trunk/portlet/docs/reference/en/images/reference/portlet_preferences.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream

15 years

1
0
0 / 0

JBoss Tools SVN: r19405 - trunk/portlet/docs/reference/en/modules.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 05:38:06 -0500 (Thu, 17 Dec 2009) New Revision: 19405 Modified: trunk/portlet/docs/reference/en/modules/intro.xml trunk/portlet/docs/reference/en/modules/jsf_portlet.xml trunk/portlet/docs/reference/en/modules/seam_portlet.xml trunk/portlet/docs/reference/en/modules/starting_project.xml Log: https://jira.jboss.org/jira/browse/JBDS-907 - restructuring and updating the chapters; Modified: trunk/portlet/docs/reference/en/modules/intro.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/intro.xml 2009-12-17 10:38:02 UTC (rev 19404) +++ trunk/portlet/docs/reference/en/modules/intro.xml 2009-12-17 10:38:06 UTC (rev 19405) @@ -3,25 +3,33 @@ <?dbhtml filename="intro.html"?> <title>Introduction</title> - <para>Starting from 3.0.0.Alpha1 version, JBoss set of plugins extends <property>JBoss Portal</property> - features. Thus, this guide is intended to explain you how to manage the functionality - <property>JBoss Tools</property> provide to ease the development with <property>JBoss - Portal</property>.</para> + <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>Preface</title> + <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.</para> + 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</title> - <para>The next table lists key features supplied by <property>JBoss Portal Tools</property>.</para> + <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 Functionality of JBoss Portal Tools</title> + <title>Key Features of JBoss Portlet Tools</title> <tgroup cols="3"> <colspec colnum="1" align="left" colwidth="1*"/> @@ -40,93 +48,77 @@ <row> <entry> - <para>Wizards for creating Projects with Portlet Facets</para> + <para>JBoss Portlet facets</para> </entry> <entry> - <para>New Dynamic Web Project wizard allows you to select a proper - Configuration to enable Portlet Facet in it.</para> + <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="creating_project_with_jbossportal">Creating a Dynamic - Web Project</link> + <link linkend="portlet_tools_tasks">JBoss Portlet Tools Tasks</link> </entry> </row> - <row> <entry> - <para>Create Java Portlet wizard</para> + <para>Java Portlet wizard</para> </entry> <entry> - <para>The wizard enables creating a JSR-186/JSR-286 compliant - portlet.</para> + <para>The wizard helps create a JSR-186/JSR-286 compliant + portlets</para> </entry> <entry> - <link linkend="adding_java_portlet">Adding Java Portlet to a - project</link> + <link linkend="java_portlet_wizard">Java Portlet Wizard</link> </entry> </row> <row> <entry> - <para>Create JSF/Seam Portlet wizard</para> + <para>JSF/Seam Portlet wizard</para> </entry> <entry> - <para>This wizard allows to create JSF/Seam portlets</para> + <para>This wizard helps create JSF/Seam portlets</para> </entry> <entry> - <link linkend="jsf_portlet">Creating JSF Portlet</link> - <link linkend="seam_portlet">Creating Seam Portlet</link> + <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> - <section id="rel_resources"> - <title>Other relevant resources on the topic</title> - - <itemizedlist> - <listitem> - <para> - <ulink url="http://www.jboss.org/jbossportal/">JBoss Portal Home Page</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://wiki.jboss.org/wiki/JBossPortal">JBoss Portal Wiki</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> - </para> - </listitem> - - <listitem> - <para> - <ulink - url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201" - >JBoss Tools Forum</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>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> + <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> Modified: trunk/portlet/docs/reference/en/modules/jsf_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/jsf_portlet.xml 2009-12-17 10:38:02 UTC (rev 19404) +++ trunk/portlet/docs/reference/en/modules/jsf_portlet.xml 2009-12-17 10:38:06 UTC (rev 19405) @@ -1,190 +1,258 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="jsf_portlet" xreflabel="jsf_portlet"> - <?dbhtml filename="jsf_portlet.html"?> - <title>Creating JSF Portlet</title> +<section id="jsf_portlet"> + <title>Creating and Deploying a JSF Portlet</title> - <para>This chapter will explain how you can configure JSF Portlet within Dynamic Web - Project and JSF Project by using the wizards <property>JBoss Tools</property> provides.</para> + <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>Adding JSF Portlet to Dynamic Web Project</title> + <title>Creating a JSF Project with JBoss Portlet Capabilities</title> - <para>To add JSF Portlet to a Dynamic Web Project, you should set the Configuration to <emphasis> - <property>JavaServer Faces v1.1 Project</property> - </emphasis> or <emphasis> - <property>JavaServer Faces v1.2 Project</property> - </emphasis> and configure the JSF Portlet Facets in the <property>New Dynamic Web - Project wizard</property> by clicking the <emphasis> - <property>Modify</property> - </emphasis> button.</para> - - <figure> - <title>Setting the JSF Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On the Project Facets dialog you should select <property>JBoss Core Portlet</property> - and <property>JBoss JSF Portlet</property> check boxes.</para> - - <figure> - <title>Enabling the Portlet Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet2.png"/> - </imageobject> - </mediaobject> - </figure> - - <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> - - <para>To support Portlets in JSF/Seam applications <property>JBoss Tools</property> works - with <property>JBoss Portlet Bridge</property>. Thus on the next page you should add JSF Portlet - capabilities by pointing to the Portletbridge Runtime location.</para> - - <figure> - <title>JSF Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet4.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - - <para>You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink - url="http://www.jboss.org/portletbridge/download/">Portletbridge Download page</ulink>.</para> - </tip> - - <para>Next click <emphasis> - <property>Finish</property> - </emphasis> to organize the Project.</para> - <para id="add_jsf_portlet">To add JSF Portlet to generated project you should call the - <property>Create Portlet wizard</property> by navigating to <emphasis> - <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property>.</emphasis></para> - - <figure> - <title>Calling New Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As you see, the Seam and JSF Portlet wizards are merged into one. We set JSF - Configuration for the project, so default values in this wizard will be set as for a JSF - portlet.</para> - - <figure> - <title>Creating JSF Portlet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Click <emphasis> - <property>Finish</property> - </emphasis> to complete JSF Portlet creation. Now you can deploy the project the same - way as it was <link linkend="deploying_to_portal">described above</link>.</para> - - <para>In the Browser JSF Portlet looks as follows.</para> - - <figure> - <title>JSF Portlet in the Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet7.png"/> - </imageobject> - </mediaobject> - </figure> + <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 <ulink + url="&jsfreflink;#new_jsf_project">JSF Tools User Guide</ulink>. 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 JSF Portlet to JSF Project</title> + <title>Adding a JSF Portlet to the Project and Deploying It to JBoss Portal</title> - <para>How to organize a JSF Project you can find out in our <ulink - url="&jsfreflink;#new_jsf_project">JSF Tools Reference Guide</ulink>. Just - remember to point Target Runtime to JBoss Portal directory location.</para> - - <figure> - <title>Creating New JSF Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Before adding a Portlet to the project you should enable necessary facets for it. - Right-click the created project and click <emphasis> - <property>Preferences</property> - </emphasis> to open the <property>Project Preferences</property> screen.</para> - <para>On the <property>Project Facets</property> page select the <emphasis> - <property>JBoss Core Portlet</property> - </emphasis> and <emphasis> - <property>JBoss JSF Portlet</property> - </emphasis> checkboxes. And then the screen will ask you to enable <emphasis> - <property>JavaServer Faces</property> - </emphasis> facet as well.</para> - - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Notice, <emphasis> - <property>"Further configuration required..."</property> - </emphasis> warning appears at the bottom of the screen. It means that you should click - it to configure JSF and JSF Portlet Capabilities in the project.</para> - - <figure> - <title>JSF Capabilities</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet10.png"/> - </imageobject> - </mediaobject> - </figure> - - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/jsf_portlet/jsf_portlet11.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>After setting the path to Portletbridge Runtime location, click <emphasis> - <property>OK</property> - </emphasis> and then <emphasis> - <property>OK</property> - </emphasis> again.</para> - - <para>Now you can add JSF Portlet to the generated JSF Project. How to do it we showed in - <link linkend="add_jsf_portlet">the previous section</link>.</para> + <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> -</chapter> +</section> Modified: trunk/portlet/docs/reference/en/modules/seam_portlet.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/seam_portlet.xml 2009-12-17 10:38:02 UTC (rev 19404) +++ trunk/portlet/docs/reference/en/modules/seam_portlet.xml 2009-12-17 10:38:06 UTC (rev 19405) @@ -1,139 +1,220 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="seam_portlet" xreflabel="seam_portlet"> - <?dbhtml filename="seam_portlet.html"?> - <title>Creating Seam Portlet</title> +<section id="seam_portlet"> + <title>Creating and Deploying a Seam Portlet</title> - <para>This chapter covers the steps on how to configure Seam Portlet within Dynamic Web - Project and Seam Project by using the wizards <property>JBoss Tools</property> provides.</para> + <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>Adding Seam Portlet to Dynamic Web Project</title> + <title>Creating a Seam Project with JBoss Portlet Capabilities</title> - <para>To add Seam Portlet to a Dynamic Web Project first you should organize New Dynamic Web - Project with the Configuration setting to <emphasis> - <property>JBoss Seam Portlet Project v2.0</property>.</emphasis></para> - - <figure> - <title>Calling New Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>It will add all needed facets to your project. By clicking the <emphasis> - <property>Modify</property> - </emphasis> button you can observe the chosen configuration of facets as well as modify - it. As you can see, all JBoss Portlets are checked.</para> - - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next wizard pages are for adjusting the Project Web Modules and JSF Configuration. - They include default values, so you can skip them by pressing <emphasis> - <property>Next</property>.</emphasis></para> - - <para>On the <property>Seam Facet</property> page <ulink url="&seamlink;#seamFacet">set - Connection Profile</ulink> and hit <emphasis> - <property>Next</property>.</emphasis></para> - - <figure> - <title>Seam Facet Settings</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Last wizard page will prompt you to set the path to Portletbridge Runtime - location.</para> - - <figure> - <title>Setting the Portletbridge Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet4.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - - <para>Thus you should have JBoss Portlet Bridge downloaded and extracted somewhere on - your hard drive. You can download JBoss Portlet Bridge 1.0.0.B4 from <ulink - url="http://www.jboss.org/portletbridge/download/">www.jboss.org/portletbridge/download</ulink>.</para> - </tip> - - <para>Now, to add Seam Portlet to the project you should follow to <emphasis> - <property>New > Other > JBoss Tools Web > Portlet > JSF/Seam - Portlet</property>.</emphasis> This will call the wizard for creating JSF/Seam - Portlets.</para> - - <figure> - <title>Calling the Create Portlet Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>As we set Seam Configuration for the Dynamic Web 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> - - <para>After creating the Seam Portlet, you should <link linkend="deploying_to_portal">deploy - the project to JBoss Portal</link> and start the Server. In a Browser - you'll see the following:</para> - - <figure> - <title>Seam Portlet in the Browser</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet7.png"/> - </imageobject> - </mediaobject> - </figure> + <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 + <ulink url="&seamlink;#seamFacet">"Configure Seam Facet Settings"</ulink> in the Chapter 2, + <ulink url="&seamlink;">"Seam Dev Tools Reference Guide"</ulink>.</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 Seam Portlet to Seam Project</title> + <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> - <para>First start a Seam Project by following to <emphasis> - <property>New > Other > Seam > Seam Web Project</property>. </emphasis> On the first - wizard page specify JBoss Portal directory location as <property>Target - Runtime</property> and <emphasis> - <property>JBoss Seam Portlet Project v2.0</property> - </emphasis> as <property>Configuration</property>.</para> - - <figure> - <title>Project Facets</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/seam_portlet/seam_portlet8.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next steps will be the same as we did for the Dynamic Web Project in the <link - linkend="seam_portlet1">Adding Seam Portlet to Dynamic Web Project</link> - section.</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> -</chapter> +</section> Modified: trunk/portlet/docs/reference/en/modules/starting_project.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/starting_project.xml 2009-12-17 10:38:02 UTC (rev 19404) +++ trunk/portlet/docs/reference/en/modules/starting_project.xml 2009-12-17 10:38:06 UTC (rev 19405) @@ -1,413 +1,297 @@ <?xml version="1.0" encoding="UTF-8"?> -<chapter id="starting_project" xreflabel="starting_project"> - <?dbhtml filename="starting_project.html"?> - <title>Starting the Project with JBoss Portal</title> +<section id="starting_project"> + <title>Creating and Deploying a Java Portlet</title> - <para>To get started with <property>JBoss Portal</property> and <property>JBoss - Tools</property>, you should first have a Web Project pointed to the JBoss Portal Runtime. - Thus, in this chapter we are going to show you how to create a Dynamic Web Project, add Java + <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="creating_project_with_jbossportal"> - <title>Creating a Dynamic Web Project</title> - - <para>To create a Dynamic Web Project, go to <emphasis> - <property>File > New > Dynamic Web Project</property> - </emphasis> if you are in the <property>Web Perspective</property> or <property>File > - New > Other > Web > Dynamic Web Project</property> in any other Perspective. The - first page of the New Dynamic Web Project wizard looks as follows.</para> - - <figure> - <title>New Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Fill out the name of your project. Next, click the <emphasis> - <property>New</property> - </emphasis> button in the <emphasis> - <property>Target Runtime</property> - </emphasis> section to specify a new Target Runtime. Choose <emphasis> - <property> JBoss Community > JBoss 4.2 Runtime</property> - </emphasis> and select the <emphasis> - <property>Create a new local server</property> - </emphasis> checkbox. 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> - - <para>On the next page you should give a name to the runtime. Let's call it <emphasis> - <property>JBoss Portal 2.7 Runtime</property> - </emphasis>, and then point it to the location of your JBoss AS + Portal - installation.</para> - - <figure> - <title>New Server Runtime Environment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/server_runtime_environment.png"/> - </imageobject> - </mediaobject> - </figure> - - <note> - <title>Note:</title> - - <para>The JBoss Tools Portlet feature 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> - - <para>At this point a new JBoss Server instance will be created. Here you can verify the - defined runtime information. If something is incorrect, press <emphasis> - <property>Back</property> - </emphasis> to return on the previous wizard page.</para> - - <figure> - <title>Target Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Click <emphasis> - <property>Finish</property>.</emphasis></para> - - <para>On the next step you should click the <emphasis> - <property>Modify</property> - </emphasis> button next to the <property>Configuration</property> section to enable - Portlet Facets 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> - - <para>On this page you should check the <emphasis> - <property>JBoss Core Portlet</property> - </emphasis> and press <emphasis> - <property>OK</property> - </emphasis>.</para> - - <figure> - <title>Enabling the 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, - JBoss Portlet facets will be hidden on this page.</para> - <para>To made portal functionality always visible no matter what the runtime support, - you should go to <emphasis> - <property>Window > Preferences</property> - </emphasis> and then <emphasis> - <property>JBoss Tools > JBoss Portlet</property> - </emphasis> and deselect <emphasis> - <property>Check runtimes for Portlet Components</property> - </emphasis> checkbox (see figure below).</para> - </note> - - <figure> - <title>JBoss Runtime Preferences</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_preferences.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The next page is for configuring web modules. Here all values are set, so you can - leave everything as it is.</para> - - <figure> - <title>The Project Web Modules</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Finally, the last wizard page will ask you to add JBoss Portlet capabilities to your - project. Here you can choose whether to set up user libraries, libraries provided by - server runtime or not include libraries at all.</para> - - <itemizedlist> - <listitem><para>To set up server runtime libraries, you need to select <emphasis> - <property>Libraries provided by server runtime</property></emphasis> in the list box.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Including Server Runtime Libraries</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities6.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>For setting up user libraries, select <emphasis> - <property>User library</property></emphasis> in the list box and then press <emphasis> - <property>Add</property></emphasis> in the <emphasis> - <property>User Library</property></emphasis> section.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Adding User Library</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Then press <emphasis> - <property>New</property></emphasis> and type the user library name in the appeared dialog.</para> - - <figure> - <title>Adding User Library</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities2.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Next add necessary jar's.</para> - - <figure> - <title>Adding the Portlet API Jar</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities3.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Hit <emphasis> - <property>OK</property>.</emphasis> The user library will be added. - </para> - - <figure> - <title>User Library Added</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities4.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem><para>If you don't need to include libraries at all, just deselect the <emphasis> - <property>Enable implementation library</property></emphasis> checkbox.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Disabling Implementation Libraries</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/portlet_capabilities5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>After setting JBoss Portlet capabilities press <emphasis> - <property>Finish</property>.</emphasis></para> - - <para>That's it! Our base project is done.</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="structure_overview"> - <title>The Project Structure Overview</title> - - <para>Now, let's look at the structure of the just created project.</para> - - <figure> - <title>The Project Structure Overview</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_6.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Here <property>JBoos Tools</property> added JBoss Portlet facet to the project, - created an empty <emphasis> - <property>portlet.xml</property> - </emphasis> file and added the Portlet library to the project classpath.</para> - </section> - <section id="adding_java_portlet"> - <title>Adding a Java Portlet to the Project</title> + <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> - <para>At this point we'll show what the steps you need to proceed 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>Call the <property>Create Portlet wizard</property> by selecting <emphasis> - <property>New > Other > JBoss Tools Web > Portlet > Java - Portlet</property>.</emphasis></para> + <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>New Java Portlet</title> + <title>Structure of the Project with a Java Portlet</title> <mediaobject> <imageobject> - <imagedata fileref="images/starting_project/starting_project_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The wizard fills in the Web Project and Source Folder fields for you. Then you need to - specify the Java package and the Class name and 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> - - <para>On the other page you will be able to set the display name of the Portlet, a title, a - description, the supported modes and init parameters.</para> - - <figure> - <title>Specifying Class File Destination</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_9.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>On the next screen you can define which methods from - <emphasis>GenericPortlet</emphasis> you want to override.</para> - - <figure> - <title>Specifying Class File Destination</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_10.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>The last screen lets you build <property>JBoss Portal</property> specific descriptors - to create an instance during the deployment and place it directly on the Portal.</para> - - <figure> - <title>Specifying Class File Destination</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_11.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - - <para>If you uncheck the <emphasis> Create Portlet Instance</emphasis> checkbox, - <property>JBoss Tools</property> won't create the deployment elements - in the <emphasis> default-object.xml</emphasis> and <emphasis> - portlet-instances.xml</emphasis> files.</para> - </tip> - - <para>Once Java Portlet is created, new resources have been added to the project structure. - As you can see on the figure below, it adds a Java Portlet class (<emphasis> - <property>TestPortlet.java</property> - </emphasis> in our case), <emphasis> - <property>default-object.xml</property> - </emphasis> and <emphasis> - <property>portlet-instances.xml</property> - </emphasis> files and updates <emphasis> - <property>portlet.xml</property> - </emphasis> as well.</para> - - <figure> - <title>The structure of Web Project with Java Portlet created</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> + + <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 the created project in the way you deploy any other Web Application. - Right click on the project and do <emphasis> - <property>Run As > Run On Server</property> - </emphasis> and accept the defaults. On the <emphasis> - <property>Add and Remove Projects</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 Web Application and start <property>JBoss - AS</property>.</para> - - <tip> - <title>Tip:</title> - - <para>You should use <emphasis>http://localhost:8080/portal</emphasis> URL to see your - Portlet in the Browser.</para> - </tip> - - <para>In the Browser the Portlet looks as follows:</para> - - <figure> - <title>Java Portlet in the Browser Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/starting_project/starting_project_14.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>Consequently, here you learnt how to create a Dynamic Web Project, add Java Portlet to - it and deploy the project to <property>JBoss Portal</property>.</para> + <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> -</chapter> +</section>

15 years

1
0
0 / 0

JBoss Tools SVN: r19404 - trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards.

by jbosstools-commits＠lists.jboss.org

Author: dgeraskov Date: 2009-12-17 05:38:02 -0500 (Thu, 17 Dec 2009) New Revision: 19404 Removed: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage.java Log: https://jira.jboss.org/jira/browse/JBIDE-5330 removed unused class. Deleted: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage.java =================================================================== --- trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage.java 2009-12-17 10:36:01 UTC (rev 19403) +++ trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage.java 2009-12-17 10:38:02 UTC (rev 19404) @@ -1,147 +0,0 @@ -/******************************************************************************* - * Copyright (c) 2008-2009 Red Hat, Inc. - * Distributed under license by Red Hat, Inc. All rights reserved. - * This program is made available under the terms of the - * Eclipse Public License v1.0 which accompanies this distribution, - * and is available at http://www.eclipse.org/legal/epl-v10.html - * - * Contributor: - * Red Hat, Inc. - initial API and implementation - ******************************************************************************/ -package org.hibernate.eclipse.jdt.ui.wizards; - -import org.eclipse.core.resources.ResourcesPlugin; -import org.eclipse.jdt.core.IJavaElement; -import org.eclipse.jdt.core.IParent; -import org.eclipse.jdt.core.JavaCore; -import org.eclipse.jdt.core.JavaModelException; -import org.eclipse.jdt.internal.compiler.env.ICompilationUnit; -import org.eclipse.jdt.internal.core.JarPackageFragmentRoot; -import org.eclipse.jdt.ui.JavaElementLabelProvider; -import org.eclipse.jdt.ui.StandardJavaElementContentProvider; -import org.eclipse.jface.viewers.ISelectionChangedListener; -import org.eclipse.jface.viewers.IStructuredSelection; -import org.eclipse.jface.viewers.SelectionChangedEvent; -import org.eclipse.jface.viewers.TreeViewer; -import org.eclipse.jface.viewers.Viewer; -import org.eclipse.jface.viewers.ViewerFilter; -import org.eclipse.jface.wizard.WizardPage; -import org.eclipse.swt.SWT; -import org.eclipse.swt.layout.GridData; -import org.eclipse.swt.layout.GridLayout; -import org.eclipse.swt.widgets.Composite; -import org.hibernate.eclipse.console.HibernateConsoleMessages; - -@SuppressWarnings("restriction") -public class NewHibernateMappingElementsSelectionPage extends WizardPage { - - // sizing constants - private static final int SIZING_SELECTION_PANE_WIDTH = 320; - - private static final int SIZING_SELECTION_PANE_HEIGHT = 300; - - // the current selection - private IStructuredSelection fCurrentSelection; - - private TreeViewer fViewer; - - private boolean fAllowMultiple = true; - - public NewHibernateMappingElementsSelectionPage(IStructuredSelection selection) { - super("", "", null); //$NON-NLS-1$ //$NON-NLS-2$ - fCurrentSelection = selection; - } - - public void createControl(Composite parent) { - GridData gd = new GridData(SWT.FILL, SWT.FILL, true, true); - gd.widthHint = SIZING_SELECTION_PANE_WIDTH; - gd.heightHint = SIZING_SELECTION_PANE_HEIGHT; - parent.setLayoutData(gd); - Composite composite = new Composite(parent, SWT.NULL); - composite.setLayout(new GridLayout()); - - createTreeViewer(composite); - fViewer.getTree().setLayoutData(new GridData(GridData.FILL_BOTH)); - setControl(composite); - } - - public IStructuredSelection getSelection(){ - return fCurrentSelection; - } - - - public void setAllowMultiple(boolean isAllowMultiple){ - fAllowMultiple = isAllowMultiple; - } - - protected TreeViewer createTreeViewer(Composite composite) { - int style = SWT.BORDER | SWT.V_SCROLL | (fAllowMultiple ? SWT.MULTI : SWT.SINGLE); - fViewer = new TreeViewer(composite, style); - fViewer.setContentProvider(new StandardJavaElementContentProvider()); - fViewer.setLabelProvider(new JavaElementLabelProvider()); - fViewer.setFilters(getFilters()); - fViewer.addSelectionChangedListener(new ISelectionChangedListener() { - public void selectionChanged(SelectionChangedEvent event) { - fCurrentSelection = (IStructuredSelection) event.getSelection(); - updateStatus(); - } - }); - fViewer.setInput(getInput()); - fViewer.setSelection(fCurrentSelection, true); - return fViewer; - } - - protected ViewerFilter[] getFilters(){ - return new ViewerFilter[] { new ViewerFilter() { - - @Override - public boolean select(Viewer viewer, Object parentElement, - Object element) { - if (element instanceof JarPackageFragmentRoot) { - return false; - } else if (element instanceof ICompilationUnit) { - return true; - } else if (element instanceof IParent) { - return hasCompilationUnits((IParent)element); - } else { - return false; - } - } - - public boolean hasCompilationUnits(IParent parent){ - IJavaElement[] elements; - try { - elements = parent.getChildren(); - for (int i = 0; i < elements.length; i++) { - if (elements[i].getElementType() == IJavaElement.COMPILATION_UNIT){ - return true; - } else if (elements[i] instanceof IParent - && !(elements[i] instanceof JarPackageFragmentRoot)){ - if (hasCompilationUnits((IParent)elements[i])) { - return true; - } - } - } - } catch (JavaModelException e) { - return false; - } - return false; - } - - } }; - } - - protected Object getInput(){ - return JavaCore.create( ResourcesPlugin.getWorkspace().getRoot() ); - } - - protected void updateStatus() { - setPageComplete((fCurrentSelection != null && !fCurrentSelection.isEmpty())); - if (isPageComplete()){ - setMessage(null); - } else { - setMessage(HibernateConsoleMessages.NewHibernateMappingElementsSelectionPage_select); - } - } - -}

15 years

1
0
0 / 0

JBoss Tools SVN: r19403 - trunk/portlet/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 05:36:01 -0500 (Thu, 17 Dec 2009) New Revision: 19403 Modified: trunk/portlet/docs/reference/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-907 - restructuring the guide; Modified: trunk/portlet/docs/reference/en/master.xml =================================================================== --- trunk/portlet/docs/reference/en/master.xml 2009-12-17 10:29:24 UTC (rev 19402) +++ trunk/portlet/docs/reference/en/master.xml 2009-12-17 10:36:01 UTC (rev 19403) @@ -4,10 +4,12 @@ [<!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 portlets_to_nonWTP_projects SYSTEM "modules/portlets_to_nonWTP_projects.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"> @@ -25,7 +27,7 @@ <book> <bookinfo> - <title>JBoss Portal Tools Reference Guide</title> + <title>JBoss Portlet Tools User Guide</title> <corpauthor> <inlinemediaobject> <imageobject role="fo"> @@ -48,7 +50,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.M2 + Version: 1.1.0.CR1 </releaseinfo> <abstract> @@ -64,10 +66,7 @@ &intro; - &installation; - &starting_project; - &jsf_portlet; - &seam_portlet; - &portlets_to_nonWTP_projects; - + &portlet_tools_tasks; + &reference; + &summary; </book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19402 - trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards.

by jbosstools-commits＠lists.jboss.org

Author: dgeraskov Date: 2009-12-17 05:29:24 -0500 (Thu, 17 Dec 2009) New Revision: 19402 Modified: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage2.java trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFilePage.java trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFileWizard.java Log: https://jira.jboss.org/jira/browse/JBIDE-5330 Modified: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage2.java =================================================================== --- trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage2.java 2009-12-17 10:20:22 UTC (rev 19401) +++ trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingElementsSelectionPage2.java 2009-12-17 10:29:24 UTC (rev 19402) @@ -18,7 +18,6 @@ import org.eclipse.swt.widgets.Button; import org.eclipse.swt.widgets.Composite; import org.eclipse.swt.widgets.TableItem; -import org.hibernate.eclipse.jdt.ui.internal.JdtUiMessages; /** * @author Dmitry Geraskov @@ -33,7 +32,6 @@ public NewHibernateMappingElementsSelectionPage2(String pageName, IStructuredSelection selection) { super(pageName); this.selection = selection; - setDescription(JdtUiMessages.NewHibernateMappingElementsSelectionPage2_description); } public void createControl(Composite parent) { Modified: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFilePage.java =================================================================== --- trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFilePage.java 2009-12-17 10:20:22 UTC (rev 19401) +++ trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFilePage.java 2009-12-17 10:29:24 UTC (rev 19402) @@ -45,6 +45,8 @@ import org.eclipse.swt.widgets.Table; import org.eclipse.swt.widgets.TableColumn; import org.eclipse.swt.widgets.TableItem; +import org.eclipse.ui.ISharedImages; +import org.eclipse.ui.ide.IDE; import org.eclipse.ui.model.IWorkbenchAdapter; import org.hibernate.console.ImageConstants; import org.hibernate.eclipse.console.utils.EclipseImages; @@ -59,14 +61,15 @@ public class NewHibernateMappingFilePage extends WizardPage { private TableViewer viewer; + + private boolean hideFilename; /** * @param pageName */ - protected NewHibernateMappingFilePage() { + protected NewHibernateMappingFilePage(boolean hideFilename) { super(""); //$NON-NLS-1$ - setTitle(JdtUiMessages.NewHibernateMappingFilePage_hibernate_xml_mapping_file); - setMessage(JdtUiMessages.NewHibernateMappingFilePage_this_wizard_creates, WARNING); + this.hideFilename = hideFilename; } public void createControl(Composite parent) { @@ -97,7 +100,16 @@ public void setInput(Map<IJavaProject, Collection<EntityInfo>> project_infos){ viewer.setInput(project_infos); //Hide "project" column if only 1 project's CUs selected - viewer.getTable().getColumn(1).setWidth(project_infos.size() == 1 ? 0 : 120); + if (project_infos.size() == 1){ + viewer.getTable().getColumn(1).setWidth(0); + } else { + viewer.getTable().getColumn(1).setWidth(120); + viewer.getTable().getColumn(1).pack(); + } + viewer.getTable().getColumn(2).pack(); + if (!hideFilename){ + viewer.getTable().getColumn(3).pack(); + } } private void createTableColumns(Table table){ @@ -107,6 +119,7 @@ /* Hide the column while JBIDE-4269 is not implemented. * (Filtering generated elements) */ + //if (hideFilename) column.setWidth(0); column.setResizable(false); @@ -118,9 +131,11 @@ column.setText(JdtUiMessages.NewHibernateMappingFilePage_class_name_column); column.setWidth(200); - column = new TableColumn(table, SWT.LEFT, coulmnIndex++); - column.setText(JdtUiMessages.NewHibernateMappingFilePage_file_name_column); - column.setWidth(150); + if (!hideFilename) { + column = new TableColumn(table, SWT.LEFT, coulmnIndex++); + column.setText(JdtUiMessages.NewHibernateMappingFilePage_file_name_column); + column.setWidth(150); + } } private TableViewer createTableViewer(Table table) { @@ -135,7 +150,9 @@ editors[coulmnIndex++] = new CheckboxCellEditor( result.getTable() ); editors[coulmnIndex++] = new TextCellEditor( result.getTable() ); editors[coulmnIndex++] = new TextCellEditor( result.getTable() ); - editors[coulmnIndex++] = new TextCellEditor( result.getTable() ); + if (!hideFilename) { + editors[coulmnIndex++] = new TextCellEditor( result.getTable() ); + } result.setCellEditors( editors ); result.setCellModifier( new TableCellModifier(result) ); @@ -210,6 +227,8 @@ private final ImageDescriptorRegistry registry = JavaPlugin.getImageDescriptorRegistry(); + private ImageDescriptor DESC_OBJ_PROJECT = null; + public TableLableProvider(TableViewer tv) { this.tv = tv; } @@ -233,6 +252,12 @@ new JavaElementImageDescriptor(descriptor, 0, IMAGE_SIZE)); } } + } else if (Columns.PROJECT.toString().equals(property)){ + if (DESC_OBJ_PROJECT == null) { + ISharedImages images= JavaPlugin.getDefault().getWorkbench().getSharedImages(); + DESC_OBJ_PROJECT= images.getImageDescriptor(IDE.SharedImages.IMG_OBJ_PROJECT); + } + return registry.get(new JavaElementImageDescriptor(DESC_OBJ_PROJECT, 0, IMAGE_SIZE)); } return null; } Modified: trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFileWizard.java =================================================================== --- trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFileWizard.java 2009-12-17 10:20:22 UTC (rev 19401) +++ trunk/hibernatetools/plugins/org.hibernate.eclipse.jdt.ui/src/org/hibernate/eclipse/jdt/ui/wizards/NewHibernateMappingFileWizard.java 2009-12-17 10:29:24 UTC (rev 19402) @@ -42,6 +42,7 @@ import org.eclipse.jdt.internal.core.JavaProject; import org.eclipse.jdt.internal.core.PackageFragment; import org.eclipse.jdt.internal.core.PackageFragmentRoot; +import org.eclipse.jface.dialogs.IMessageProvider; import org.eclipse.jface.dialogs.IPageChangingListener; import org.eclipse.jface.dialogs.PageChangingEvent; import org.eclipse.jface.operation.IRunnableWithProgress; @@ -89,8 +90,6 @@ private NewHibernateMappingElementsSelectionPage2 page0 = null; private WizardNewFileCreationPage cPage; - - //private NewHibernateMappingElementsSelectionPage page1 = null; private NewHibernateMappingFilePage page2 = null; @@ -109,20 +108,19 @@ } page0 = new NewHibernateMappingElementsSelectionPage2(JdtUiMessages.NewHibernateMappingFileWizard_create_hibernate_xml_mapping_file, selection); + page0.setDescription(JdtUiMessages.NewHibernateMappingElementsSelectionPage2_description); addPage(page0); - //page1 = new NewHibernateMappingElementsSelectionPage(selection); - //page1.setTitle( HibernateConsoleMessages.NewHibernateMappingFileWizard_create_hibernate_xml_mapping_file ); - //page1.setDescription( HibernateConsoleMessages.NewHibernateMappingFileWizard_create_new_xml_mapping_file ); - //addPage(page1); - cPage = new WizardNewFileCreationPage( "Ccfgxml", selection ); //$NON-NLS-1$ cPage.setTitle( JdtUiMessages.NewHibernateMappingFileWizard_create_hibernate_xml_mapping_file ); cPage.setDescription( JdtUiMessages.NewHibernateMappingFileWizard_create_empty_xml_mapping_file ); cPage.setFileName("hibernate.hbm.xml"); //$NON-NLS-1$ addPage( cPage ); - page2 = new NewHibernateMappingFilePage(); + page2 = new NewHibernateMappingFilePage(true); + page2.setTitle(JdtUiMessages.NewHibernateMappingFilePage_hibernate_xml_mapping_file); + page2.setMessage(JdtUiMessages.NewHibernateMappingFilePage_this_wizard_creates, IMessageProvider.WARNING); + addPage(page2); }

15 years

1
0
0 / 0

JBoss Tools SVN: r19401 - trunk/portlet/docs/reference/en/modules.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 05:20:22 -0500 (Thu, 17 Dec 2009) New Revision: 19401 Added: trunk/portlet/docs/reference/en/modules/portlet_tools_tasks.xml trunk/portlet/docs/reference/en/modules/reference.xml trunk/portlet/docs/reference/en/modules/summary.xml Log: https://jira.jboss.org/jira/browse/JBDS-907 - adding new chapters; Added: trunk/portlet/docs/reference/en/modules/portlet_tools_tasks.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/portlet_tools_tasks.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/portlet_tools_tasks.xml 2009-12-17 10:20:22 UTC (rev 19401) @@ -0,0 +1,9 @@ +<?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> + + &starting_project; + &jsf_portlet; + &seam_portlet; +</chapter> \ No newline at end of file Added: trunk/portlet/docs/reference/en/modules/reference.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/reference.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/reference.xml 2009-12-17 10:20:22 UTC (rev 19401) @@ -0,0 +1,670 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="reference" xreflabel="reference"> + <?dbhtml filename="reference.html"?> + <title>Reference</title> + + <para>This chapter includes detailed reference information about <property>JBoss Portlet Tools</property>.</para> + <section id="project_overview"> + <title>JBoss Portlet Descriptors</title> + + <para>In order to a web project with portlets could be deployed to <property>JBoss Portal</property>, it should include certain descriptors. + The next table lists and describes these configuration files.</para> + + <table> + <title>JBoss Portlet Descriptors</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Name</entry> + + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>portlet.xml</entry> + <entry>The mandatory portlet descriptor defined by the <ulink url="http://www.jcp.org/en/jsr/detail?id=168">JSR-168 Portlet Specification</ulink>. + It is used during deployment.</entry> + </row> + + <row> + <entry>portlet-instances.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to create a portlet instance from a portlet class definition.</entry> + </row> + + <row> + <entry>*-object.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It helps define the layout of the portal.</entry> + </row> + + <row> + <entry>jboss-portlet.xml</entry> + <entry>The optional <property>JBoss Portal</property> specific descriptor. It allows to use JBoss + specific functionality within a portlet application.</entry> + </row> + </tbody> + </tgroup> + </table> + + <para>For more detail information about each descriptor, see + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/#descrip...">"Portlet Descriptors"</ulink> in Chapter 6, + <ulink url="http://docs.jboss.org/jbportal/v2.7.1/referenceGuide/html_single/">"JBoss Portal Reference Guide"</ulink>.</para> + </section> + + <section id="wizards"> + <title>Wizards</title> + <para>This section describes the <property>JBoss Portlet Tools</property> wizards:</para> + <itemizedlist> + <listitem><para><link linkend="java_portlet_wizard">Java Portlet wizard</link></para></listitem> + <listitem><para><link linkend="jsf_seam_portlet_wizard">JSF/Seam Portlet wizard</link></para></listitem> + </itemizedlist> + + <section id="java_portlet_wizard"> + <title>Java Portlet Wizard</title> + + <para>The <property>Java Portlet</property> wizard helps you create a new Java portlet (1.0 or 2.0). It is based on the WTP's Create Servlet wizard, + but adapted to JBoss Portlet. You can call it from the <emphasis><property>File</property></emphasis> or context menu of your project by following to + <emphasis><property>New > Other > JBoss Tools Web > Portlet > Java Portlet</property>.</emphasis></para> + + <para>The wizard consists of the four pages:</para> + + <orderedlist> + <listitem> + <para>The first one includes the next options to adjust:</para> + + <table> + <title>Java Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new Java portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Source folder</entry> + <entry>The path to the source folder relative to the selected project</entry> + <entry>The source folder of the project selected in the <emphasis><property>Project</property></emphasis> field</entry> + </row> + + <row> + <entry>Java package</entry> + <entry>Enter a package to contain a new portlet. Either type a valid package name or click + <emphasis><property>Browse</property></emphasis> to select a package via the dialog box.</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type a name for a new Java portlet class</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Superclass</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a superclass for a Java portlet class</entry> + <entry>javax.portlet.GenericPortlet</entry> + </row> + + <row> + <entry>Use an existing Portlet class</entry> + <entry>Select this check box if you want to use an existing Java portlet class. In the appeared + <emphasis><property>Class name</property></emphasis> field type or + click <emphasis><property>Browse</property></emphasis> to select an existing portlet class.</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second wizard page is for specifying modifiers, interfaces to implement and method stubs to generate.</para> + + <figure> + <title>Second Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The descriptions of the options listed on this page are in the following table.</para> + + <table> + <title>Java Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Modifiers</entry> + <entry>Select one or more access modifiers for a new Java portlet class: + <itemizedlist> + <listitem><para>Public</para></listitem> + <listitem><para>Abstract</para></listitem> + <listitem><para>Final</para></listitem> + </itemizedlist> + </entry> + <entry>Public</entry> + </row> + + <row> + <entry>Interfaces</entry> + <entry>Click <emphasis><property>Add</property></emphasis> to choose interfaces that a new class implements</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Which method stubs would you like to create?</entry> + <entry>Choose which methods from superclass to override in the Java portlet class: + <itemizedlist> + <listitem><para>Constructors from superclass</para></listitem> + <listitem><para>Inherited abstract methods</para></listitem> + <listitem><para>init</para></listitem> + <listitem><para>doView</para></listitem> + <listitem><para>doDispatch</para></listitem> + <listitem><para>destroy</para></listitem> + <listitem><para>doEdit</para></listitem> + <listitem><para>processAction</para></listitem> + <listitem><para>getPortletConfig</para></listitem> + <listitem><para>doHelp</para></listitem> + <listitem><para>render</para></listitem> + </itemizedlist> + </entry> + <entry>Inherited abstract methods, doView</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The third page is for adjusting the portlet deployment descriptor settings.</para> + + <figure> + <title>Third Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>The name of the portlet class</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet;</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet;</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet.</para></listitem> + </itemizedlist> + </entry> + <entry>View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry><blank></entry> + </row> + </tbody> + </tgroup> + </table> + + </listitem> + + <listitem> + <para>The last wizard page helps configure the JBoss Portlet specific descriptors.</para> + + <figure> + <title>Last Page of the Java Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/javaPortlet4.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>Java Portlet Wizard. Last Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>[Portlet class name]Instance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>[Portlet class name]Window</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object. The syntax for this element is <literal>[portal-instance].[portal-page]</literal>.</para> + <para>For example, <literal>default.default</literal> means that the window appears on the default page, in the default portal.</para> + </entry> + <entry>default.default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + + <section id="jsf_seam_portlet_wizard"> + <title>JSF/Seam Portlet Wizard</title> + + <para>The <property>JSF/Seam Portlet</property> wizard, that is merged into one JSF and Seam Portlet wizards, helps you create a + JSF/Seam portlet that uses the <property>JBoss Portlet Bridge</property> libraries. The default values in this wizard + depend on the configuration set for the project. For instance, if you set the JSF configuration, the default values in this wizard will be + as for a JSF portlet.</para> + + <para>The <property>JSF/Seam Portlet</property> wizard could be started from the <emphasis><property>File</property></emphasis> or + context menu of your project by following to + <emphasis><property>New > Other > JBoss Tools Web > Portlet > JSF/Seam Portlet</property>.</emphasis></para> + + <para>The wizard includes three pages to adjust JSF/Seam portlet setting:</para> + + <orderedlist> + <listitem> + <para>The first wizard page asks to select a project to add JSF/Seam portlet and set a class file destination.</para> + + <figure> + <title>First Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet1.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. First Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default</entry> + </row> + </thead> + <tbody> + <row> + <entry>Project</entry> + <entry>Select the project to add a new JSF/Seam portlet</entry> + <entry>The project selected when the wizard has been started</entry> + </row> + + <row> + <entry>Class name</entry> + <entry>Type or click <emphasis><property>Browse</property></emphasis> to select a class for a JSF/Seam portlet</entry> + <entry>javax.portlet.faces.GenericFacesPortlet</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The second page allows to configure a portlet deployment descriptors.</para> + + <figure> + <title>Second Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet2.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Second Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Name</entry> + <entry>Enter the portlet name. It does not have to be the portlet class name.</entry> + <entry>riPortlet / seamPortlet</entry> + </row> + + <row> + <entry>Display name</entry> + <entry>Enter the display name of the Java portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Title</entry> + <entry>Enter the title of the portlet</entry> + <entry>JBoss JSF Portlet / JBoss Seam Portlet</entry> + </row> + + <row> + <entry>Description</entry> + <entry>Enter the description of the portlet's function</entry> + <entry><blank></entry> + </row> + + <row> + <entry>Portlet Modes</entry> + <entry>Select one or more of three modes defined by the JSR-286 specification: + <itemizedlist> + <listitem><para><emphasis>View</emphasis> - generates markup reflecting the current state of the portlet</para></listitem> + <listitem><para><emphasis>Edit</emphasis> - allows customizing the behavior of the portlet</para></listitem> + <listitem><para><emphasis>Help</emphasis> - provides an information on how to use the portlet</para></listitem> + </itemizedlist> + </entry> + <entry>View, Edit, Help / View</entry> + </row> + + <row> + <entry>Initialization Parameters</entry> + <entry>Specify initialization parameters to create an initial state inside your portlet class. Click + <emphasis><property>Add</property></emphasis> and fill in the + <emphasis><property>Name</property>,</emphasis> <emphasis><property>Value</property></emphasis> and + <emphasis><property>Description</property></emphasis> (optional) fields to set a parameter.</entry> + <entry>javax.portlet.faces.defaultViewId.view, javax.portlet.faces.defaultViewId.edit, + javax.portlet.faces.defaultViewId.help / javax.portlet.faces.defaultViewId.view</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + + <listitem> + <para>The last wizard page helps you configure the JBoss Portlet specific information.</para> + + <figure> + <title>Third Page of the JSF Portlet Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/jsf_seam_portlet3.png"/> + </imageobject> + </mediaobject> + </figure> + + <table> + <title>JSF/Seam Portlet Wizard. Third Page Options.</title> + <tgroup cols="3"> + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" align="left" colwidth="3*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + <entry>Default (JSF / Seam)</entry> + </row> + </thead> + <tbody> + <row> + <entry>Create Portlet Instance</entry> + <entry>Clear the <emphasis><property>Create Portlet Instance</property></emphasis> check box, + if you don't wont the wizard to create the deployment elements + in the <literal>default-object.xml</literal> and <literal> + portlet-instances.xml</literal> files</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>If Exists</entry> + <entry>Select one of two options: + <itemizedlist> + <listitem><para><emphasis>overwrite</emphasis> - destroys the existing object and creates a new one based on the content of the deployment</para></listitem> + <listitem><para><emphasis>keep</emphasis> - maintains the existing object deployment or creates a new one if it does not exist</para></listitem> + </itemizedlist> + </entry> + <entry>overwrite</entry> + </row> + + <row> + <entry>Instance Name</entry> + <entry>Enter a name of the portlet instance that the portlet window represents</entry> + <entry>JSFPortletInstance / SeamPortletInstance</entry> + </row> + + <row> + <entry>Page Name</entry> + <entry>If set, the portlet page is created with the name defined</entry> + <entry>JSFPortlet / SeamPortlet</entry> + </row> + + <row> + <entry>Window Name</entry> + <entry>Enter a name of the portlet window</entry> + <entry>JSFPortletWindow / SeamPortletWindow</entry> + </row> + + <row> + <entry>Parent Reference</entry> + <entry> + <para>Define a reference to the parent object.</para> + <para>For example, <literal>default</literal> means that the page appears in the default portal.</para> + </entry> + <entry>default</entry> + </row> + + <row> + <entry>Region</entry> + <entry>Specify the region where the window should appear on the page</entry> + <entry>center</entry> + </row> + + <row> + <entry>Height</entry> + <entry>Define the height of the window</entry> + <entry>1</entry> + </row> + + <row> + <entry>Initial Window State</entry> + <entry>Set the window state indicator by selecting one of three states defined by the JSR-168 specification: + <itemizedlist> + <listitem><para><emphasis>normal</emphasis> - a portlet shares this page with other portlets</para></listitem> + <listitem><para><emphasis>minimized</emphasis> - a portlet may show very little information or none at all</para></listitem> + <listitem><para><emphasis>maximized</emphasis> - a portlet may be the only portlet displayed on this page</para></listitem> + </itemizedlist> + </entry> + <entry>maximized</entry> + </row> + + <row> + <entry>Create JBoss Application</entry> + <entry> + <para>Select to add the <literal>jboss-app.xml</literal> descriptor.</para> + <para><emphasis>riPortletApp / seamPortletApp</emphasis> - the default name of the JBoss application. You can change it by + typing a new one in the <emphasis><property>JBoss Application Name</property></emphasis> field.</para> + </entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Add the jboss-portlet.xml file</entry> + <entry>Select to create the <literal>jboss-portlet.xml</literal> file</entry> + <entry>Selected</entry> + </row> + + <row> + <entry>Copy JSF Templates</entry> + <entry>Select to add the folder with JSF templates (<literal>edit.jsp</literal>, <literal>help.jsp</literal>, + <literal>view.jsp</literal>) to the project</entry> + <entry>Cleared</entry> + </row> + </tbody> + </tgroup> + </table> + </listitem> + </orderedlist> + </section> + </section> + + <section id="preferences"> + <title>JBoss Portlet Preferences</title> + + <para>To open <property>JBoss Portlet Preferences</property> property sheet, go to <emphasis> + <property>Window > Preferences</property> + </emphasis> and then <emphasis> + <property>JBoss Tools > JBoss Portlet</property>. + </emphasis></para> + + <figure> + <title>JBoss Runtime Preferences</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/reference/portlet_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <emphasis> + <property>Check runtimes for Portlet Components</property> + </emphasis> option makes the JBoss Portlet functionality always visible no matter what the runtime is set. By default the option is checked.</para> + </section> +</chapter> \ No newline at end of file Added: trunk/portlet/docs/reference/en/modules/summary.xml =================================================================== --- trunk/portlet/docs/reference/en/modules/summary.xml (rev 0) +++ trunk/portlet/docs/reference/en/modules/summary.xml 2009-12-17 10:20:22 UTC (rev 19401) @@ -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

15 years

1
0
0 / 0

JBoss Tools SVN: r19400 - trunk/ws/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 04:32:54 -0500 (Thu, 17 Dec 2009) New Revision: 19400 Modified: trunk/ws/docs/reference/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: trunk/ws/docs/reference/en/master_output.xml =================================================================== --- trunk/ws/docs/reference/en/master_output.xml 2009-12-17 09:32:24 UTC (rev 19399) +++ trunk/ws/docs/reference/en/master_output.xml 2009-12-17 09:32:54 UTC (rev 19400) @@ -7,683 +7,698 @@ <!ENTITY preference SYSTEM "modules/preference.xml"> <!ENTITY webproject SYSTEM "modules/webproject.xml"> <!ENTITY client SYSTEM "modules/client.xml"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - - <bookinfo> - <title>JBoss WS User Guide</title> - - <corpauthor diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> - <imagedata diffmk:change="added" fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject diffmk:change="added" role="html"> - <imagedata diffmk:change="added"></imagedata> - </imageobject> - </inlinemediaobject> - </corpauthor> - <author><firstname>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> - <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> - <pubdate>July 2008</pubdate> - <copyright> - <year>2008</year> - <year>2009</year> - <holder><diffmk:wrapper diffmk:change="changed">JBoss by Red Hat</diffmk:wrapper></holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.M2 - </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_guide/pdf/WS_...">PDF version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - -<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/overview.xml"> - <title>JBossWS Runtime Overview</title> - - <para>JBossWS 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> - <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para> - -<section diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of JBossWS</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of JBossWS Runtime:</diffmk:wrapper></para> - - <table diffmk:change="added"> - - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Functionality for JBossWS</diffmk:wrapper></title> - <tgroup cols="2" diffmk:change="added"> - - <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec> - <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec> - - - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry> - - </row> - </thead> - - <tbody diffmk:change="added"> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JAX-RPC and JAX-WS support</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBossWS implements both the JAX-WS and JAX-RPC specifications.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">EJB 2.1, EJB3 and JSE endpoints</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBossWS supports EJB 2.1, EJB3 and JSE as Web Service Endpoints.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">WS-Security 1.0 for XML Encryption/Signature of the SOAP message</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">WS-Security standardizes authorization, encryption, and digital signature processing of web services.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss AS</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Application Server 5 (JavaEE 5 compliant) web service stack.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Support for MTOM/XOP and SwA-Ref</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Message Transmission Optimization Mechanism (MTOM) and XML-binary Optimized Packaging (XOP) more efficiently serialize XML Infosets that have certain types of content.</diffmk:wrapper></para></entry> - - </row> - - </tbody> - - </tgroup> - </table> - - -</section> - - - -</chapter> - -<chapter id="create_ws_topdown" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/topdown.xml"> - <?dbhtml filename="topdown.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Web Service</keyword> - <keyword>JBossWS Web Service runtime</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a Web Service using JBossWS runtime</title> - <para>In this chapter we provide you with the necessary steps to create a Web Service using - JBossWS runtime. First you need to create a Dynamic Web project:</para> - - <section id="createproject"> - <title>Creating a Dynamic Web project</title> - - <para>Before creating a web service, you should have a Dynamic Web Project created:</para> - <figure float="0"> - <title>Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Create a Web project by selecting <emphasis> - <property moreinfo="none">New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: </para> - <itemizedlist> - <listitem> - <para>Project Name: enter a project name</para> - </listitem> - <listitem> - <para><diffmk:wrapper diffmk:change="added">Target runtime: any server depending on your installation. If it is not listed, - click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button and browse to the location where it is installed to. You may set </diffmk:wrapper><emphasis> - <property moreinfo="none">Target Runtime</property> - </emphasis> to <emphasis> - <property moreinfo="none">None</property></emphasis>, in this case, you should add <link linkend="addfacet">JBoss Web Service - facet to the project</link>.</para> - <figure float="0"> - <title>Dynamic Web Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para><diffmk:wrapper diffmk:change="added">Configuration: You may add </diffmk:wrapper><link diffmk:change="added" linkend="addfacet"><diffmk:wrapper diffmk:change="added">JBoss Web Service - facet to the project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> by clicking </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify...</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. The opened page is like </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Figure 2.4</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> - </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added">Configure Web Module values:</para> - <figure float="0"> - <title>Web Module Settings Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para><diffmk:wrapper diffmk:change="added">If you added the JBoss Web Service facet to the project, now the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button is disable. You must click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button to set more information about the JBoss Web Service facet. The page is like </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Figure 2.5</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Then click on the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you didn't add the JBoss Web Service facet to the project, click on the </diffmk:wrapper><property diffmk:change="added" moreinfo="none">Finish</property><diffmk:wrapper diffmk:change="changed"> button. Next you will need to add JBoss Web Service facet to the project.</diffmk:wrapper></para> - </section> - - <section id="addfacet"> - <title>Configure JBoss Web Service facet settings</title> - <para><diffmk:wrapper diffmk:change="changed">If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web - Service facet to the project. Right-click on the project, select its </diffmk:wrapper><emphasis><property moreinfo="none">Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis><diffmk:wrapper diffmk:change="added"> in the tree-view on the left-side of the project properties dialog. - Tick on the check box for JBoss Web Services. You will see what like this: </diffmk:wrapper></para> - <figure diffmk:change="added" float="0" id="figure_addfacet_0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choose JBoss Web Service Facet</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/topdown/jbossws_facet_0.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">At the bottom-left of the right-side of the project properties dialog, there is a error link: </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Further configuration required...</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> . You must click the link to set more information about JBoss Web Service facet.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click on the </diffmk:wrapper><emphasis><property moreinfo="none">Further configuration required...</property></emphasis> link. In the opened window</para> - <figure float="0" id="figure_addfacet"> - <title>Configure JBoss Web Service Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_facet.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the - project's target runtime, you may choose <emphasis> - <property moreinfo="none">Server Supplied JBossWS Runtime</property> - </emphasis> and then click <emphasis> - <property moreinfo="none">Ok</property> - </emphasis> to finish the configuration of JBoss Web Service facet. </para> - <para>If the project has no <emphasis> - <property moreinfo="none">Target Runtime</property> - </emphasis> settings, you should check the second radio button and specify a JBossWS - runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> - <property moreinfo="none">New...</property> - </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para> - <figure float="0" id="figure_addfacet1"> - <title>Configure JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_newruntime.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>See how to configure a new JBossWS runtime <link linkend="preference">here</link>.</para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After setting the information about JBoss Web Service facet, for saving the result, you should click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button at the bottom-right of the right-side of the project properties dialog.</diffmk:wrapper></para> - </section> - - - <section id="topdownwebservice"> - <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> - <para>In this chapter we provide you with the necessary steps to create a Web Service from a - WSDL document using JBossWS runtime.</para> - <para>At first, please make sure that you have already created a dynamic Web project with - JBoss Web Service facet installed. </para> - <para>See how to make it <link linkend="createproject">here</link> and <link linkend="addfacet">here</link>.</para> - - <para>To create a Web Service using JBossWS runtime select<emphasis> - <property moreinfo="none">File > New > Other > Web Services > Web Service</property> - </emphasis> to run Web Service creation wizard. </para> - <para>Let's get through the wizard step-by-step:</para> - <figure float="0" id="figure_create_ws_topdown"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>First, please select <property moreinfo="none">Top down Java bean Web Service</property> from the Web - Service type list, and select a WSDL document from workspace, click on the Server name - link on the page will bring you to another dialog. Here you can specify the server to a - JBoss Server and Web Service runtime to JBossWS runtime:</para> - <figure float="0" id="figure_create_ws_topdown_setserver"> - <title>Select Server and Web Service runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button to see the next wizard view opened:</para> - - <figure float="0" id="figure_create_ws_topdown1"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> button to proceed:</para> - <figure float="0" id="figure_create_ws_topdown_codegen"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>On this page, the default package name comes from the namespace of the WSDL document, - you also can change it to any valid package name you want. JAX-WS specification should be - set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can - specify a catalog file and binding files if you have them. If you want the wizard to - generate empty implementation classes for the Web Service, check the <emphasis> - <property moreinfo="none">Generate default Web Service implementation classes</property> - </emphasis> check box. If you want to update the default Web.xml file with the Web Service - servlets configured, check the <emphasis> - <property moreinfo="none">Update the default Web.xml</property> - </emphasis> check box. Click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> or on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button to generate code.</para> - - <para>Once the Web Service code is generated, you can view the implementation class and add - business logic to each method.</para> - <figure float="0" id="figure_impl_code"> - <title>The generated implementation Java code</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>View the Web.xml file:</para> - <figure float="0" id="figure_webxml"> - <title>Web.xml</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_webxml.png"></imagedata> - </imageobject> - </mediaobject> - </figure> -<para>In the next chapter you will find out how to create a Web service from a Java bean.</para> - </section> - - <section id="bottomupws" role="updated"> - <title>Creating a Web service from a Java bean using JBossWS runtime</title> - <para>The Web Service wizard assists you in creating a new Web service, configuring it for - deployment, and then deploying it to the server.</para> - <para>To create a Web service from a bean using JBoss WS:</para> - <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> - <para>Create <link linkend="createproject">a Dynamic Web project</link>.</para> - <para>Add <link linkend="addfacet">JBossWS Facet</link> to Web project.</para> - <para>Create a Web Service from a java bean: </para> - <itemizedlist> - <listitem> - <para>Switch to the Java EE perspective <emphasis> - <property moreinfo="none">Window > Open Perspective > Java EE</property></emphasis>.</para> - </listitem> - <listitem> - <para>In the Project Explorer view, select the bean that you created or imported into - the source folder of your Web project.</para> - <figure float="0"> - <title>Select the Bean Created</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">File > New > Other</property></emphasis>. Select Web Services in order to display various Web service wizards. - Select the Web Service wizard. Click on the <property moreinfo="none">Next</property> button.</para> - <figure float="0"> - <title>New Web Service</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the first Web Service wizard page: select <property moreinfo="none">Bottom up Java bean Web - service</property> as your Web service type, and select the Java bean from which - the service will be created:</para> - <figure float="0"> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Select the stages of Web service development that you want to complete using - the slider: </para> - <itemizedlist> - <listitem> - <para>Develop: this will develop the WSDL definition and implementation of - the Web service. This includes such tasks as creating modules that will - contain generated code, WSDL files, deployment descriptors, and Java - files when appropriate.</para> - </listitem> - <listitem> - <para>Assemble: this ensures the project that will host the Web service or - client gets associated to an EAR when required by the target application - server.</para> - </listitem> - <listitem> - <para>Deploy: this will create the deployment code for the service.</para> - </listitem> - <listitem> - <para>Install: this will install and configure the Web module and EARs on - the target server.</para> - </listitem> - <listitem> - <para>Start: this will start the server once the service has been installed - on it. The server-config.wsdd file will be generated.</para> - </listitem> - <listitem> - <para>Test: this will provide various options for testing the service, such - as using the Web Service Explorer or sample JSPs.</para> - </listitem> - </itemizedlist> - </listitem> - <listitem> - <para>Select your server: the default server is displayed. If you want to deploy - your service to a different server click the link to specify a different server. - </para> - </listitem> - <listitem> - <para>Select your runtime: ensure the JBoss WS runtime is selected.</para> - </listitem> - <listitem> - <para>Select the service project: the project selected in your workspace is - displayed. To select a different project click on the project link. If you are - deploying to JBoss Application Server you will also be asked to select the EAR - associated with the project. Ensure that the project selected as the Client Web - Project is different from the Service Web Project, or the service will be - overwritten by the client's generated artifacts.</para> - </listitem> - <listitem> - <para>If you want to create a client, select the type of proxy to be generated - and repeat the above steps for the client. The better way is to create a web - service client project separately.</para> - </listitem> - </itemizedlist> - <para>Click on the <property moreinfo="none">Next</property> button.</para> - </listitem> - <listitem> - <para>On the JBoss Web Service Code Generation Configuration page, set the following - values:</para> - <figure float="0"> - <title>Set Web Service values for Code Generation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Generate WSDL file: select it, you will get a generated WSDL file in your - project. But this wsdl's services' address location values are not a real - address. </para> - </listitem> - <listitem> - <para>After the Web service has been created, the following option can become - available depending on the options you selected: Update the default web.xm - file. If selected, you may test the web service by Explorer.</para> - </listitem> - </itemizedlist> - <para>Click on the <property moreinfo="none">Next</property> button.</para> - </listitem> - <listitem> - <para>On this page, the project is deployed to the server. You can start the server and - test the web service. If you want to publish the web service to a UDDI registry, you - may click the <property moreinfo="none">Next</property> button to publish it. If not, you may click - the <property moreinfo="none">Finish</property> button.</para> - <figure float="0"> - <title>Start a Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>After the Web Service has been created, the following options may become available - depending on the options selected:</para> - <itemizedlist> - <listitem> - <para>the generated web services code</para> - </listitem> - <listitem> - <para>If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</para> - <figure float="0"> - <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_6.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>If you selected to update the default web.xml, you will test the web service in - the browser. Open the Explorer, input the url for the web service according to - web.xml plus <property moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> - <figure float="0"> - <title>The Updated web.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_5.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS.</para> - - </section> - -</chapter> - - -<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/client.xml"> - <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> - <para>To create a Web Service Client from a WSDL Document using JBoss WS you need to fulfil the following steps:</para> - <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> - <para><link linkend="createproject">Create a Dynamic Web project</link>.</para> - <para><link linkend="addfacet">Add JBossWS Facet to Web project</link>.</para> - <para>Then you can create a Web Service Client from a WSDL document: </para> - <itemizedlist> - <listitem> - <para>Switch to the Java EE perspective <emphasis><property moreinfo="none">Window > Open Perspective > Java EE</property></emphasis>.</para> - </listitem> - <listitem> - <para>Click <emphasis><property moreinfo="none">File > New > Other</property></emphasis>. Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click on the <property moreinfo="none">Next</property> button.</para> - <figure float="0"> - <title>New Web Service Client</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>The first and the second Web Service Client wizard pages are the same as for <link linkend="topdownwebservice">Web Service from a WSDL document</link>.</para> - <figure float="0"> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <figure float="0"> - <title>Set Web Service values related to WSDL file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The only difference is:</para> - <itemizedlist> - <listitem> - <para><property moreinfo="none">Client Type:</property> Support of Java Proxy only.</para> - </listitem> - </itemizedlist> - <para>Click on the <property moreinfo="none">Finish</property> button.</para> - </listitem> - </itemizedlist> - <para>After the Web Service Client has been created, the following may occur depending on the options you selected:</para> - <itemizedlist> - <listitem> - <para> the generated web service and client codes</para> - </listitem> - <listitem> - <para>a client sample class.</para> - <figure float="0"> - <title>Client Sample Class</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_3.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> -</chapter> - - -<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/preference.xml"> - <title>JBoss WS and development environment</title> - - <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> - <section id="jbosswspreference"> - - - <title>JBossWS Preferences</title> - - <para>In this section you will know how JBossWS preferences can be modified during the - development process.</para> - - <para>JBossWS preferences can be set on the JBossWS preference page. Click on - <emphasis><property moreinfo="none">Window > Preferences > JBoss Tools > Web > JBossWS - Preferences</property>.</emphasis></para> - - <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to - <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that - are not needed.</para> - - <figure float="0"> - <title>JBossWS Preferences Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on <emphasis> - <property moreinfo="none">Add</property> - </emphasis> or <emphasis> - <property moreinfo="none">Edit</property> - </emphasis> button will open the form where you can configure a new JBossWS runtime and - change the path to JBossWS runtime home folder, modify the name and version of the - existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the - changes.</para> - - <figure float="0"> - <title>Edit JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference_new.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - - - - <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, 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/preference/jbossws_container1.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/preference/jbossws_container2.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="serverruntime"> - <title>Default Server and Runtime</title> - <para>Open <emphasis> - <property moreinfo="none">Window > Preferences > Web Services > Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para> - <para>For ease of use, the better way is to set runtime to JBoss WS.</para> - <para>After server and runtime are specified, click on the <property moreinfo="none">Apply</property> button - to save the values.</para> - <figure float="0"> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_server_runtime.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>On the whole, this guide covers the fundamental concepts of work with tooling for - <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using - JBossWS Runtime and adjust JBossWS and development environment as well.</para> - - <para>If the information on JBossWS tools in this guide isn't enough for you, ask - questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para> - </section> -</chapter> - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss WS 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>Denny</firstname><surname>Xu</surname><email>dxu(a)redhat.com</email></author> + <author><firstname>Grid</firstname><surname>Qian</surname><email>fqian(a)redhat.com</email></author> + <pubdate>July 2008</pubdate> + <copyright> + <year>2008</year> + <year>2009</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.CR1 + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_guide/pdf/WS_...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/overview.xml"> + <title>JBossWS Runtime Overview</title> + + <para>JBossWS 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> + <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para> + +<section> + <title>Key Features of JBossWS</title> + <para>For a start, we propose you to look through the table of main features of JBossWS Runtime:</para> + + <table> + + <title>Key Functionality for JBossWS</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>JAX-RPC and JAX-WS support</para></entry> + <entry><para>JBossWS implements both the JAX-WS and JAX-RPC specifications.</para></entry> + + </row> + + <row> + <entry><para>EJB 2.1, EJB3 and JSE endpoints</para></entry> + <entry><para>JBossWS supports EJB 2.1, EJB3 and JSE as Web Service Endpoints.</para></entry> + + </row> + + <row> + <entry><para>WS-Security 1.0 for XML Encryption/Signature of the SOAP message</para></entry> + <entry><para>WS-Security standardizes authorization, encryption, and digital signature processing of web services.</para></entry> + + </row> + + <row> + <entry><para>JBoss AS</para></entry> + <entry><para>JBoss Application Server 5 (JavaEE 5 compliant) web service stack.</para></entry> + + </row> + + <row> + <entry><para>Support for MTOM/XOP and SwA-Ref</para></entry> + <entry><para>Message Transmission Optimization Mechanism (MTOM) and XML-binary Optimized Packaging (XOP) more efficiently serialize XML Infosets that have certain types of content.</para></entry> + + </row> + + </tbody> + + </tgroup> + </table> + + +</section> +<section> + <title>Other relevant resources on the topic</title> + + <para>You can find some extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/community/wiki/JBossWS-FAQ#Tools">JBossWS Tools Wiki FAQ.</ulink> + </para> + </listitem> + </itemizedlist> + + + </section> + + + + +</chapter> + +<chapter id="create_ws_topdown" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/topdown.xml"> + <?dbhtml filename="topdown.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Web Service</keyword> + <keyword>JBossWS Web Service runtime</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a Web Service using JBossWS runtime</title> + <para>In this chapter we provide you with the necessary steps to create a Web Service using + JBossWS runtime. First you need to create a Dynamic Web project:</para> + + <section id="createproject"> + <title>Creating a Dynamic Web project</title> + + <para>Before creating a web service, you should have a Dynamic Web Project created:</para> + <figure float="0"> + <title>Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Create a Web project by selecting <emphasis> + <property moreinfo="none">New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: </para> + <itemizedlist> + <listitem> + <para>Project Name: enter a project name</para> + </listitem> + <listitem> + <para>Target runtime: any server depending on your installation. If it is not listed, + click <property moreinfo="none">New</property> button and browse to the location where it is installed to. You may set <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> to <emphasis> + <property moreinfo="none">None</property></emphasis>, in this case, you should add <link linkend="addfacet">JBoss Web Service + facet to the project</link>.</para> + <figure float="0"> + <title>Dynamic Web Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Configuration: You may add <link linkend="addfacet">JBoss Web Service + facet to the project</link> by clicking <property moreinfo="none">Modify...</property> button. The opened page is like <property moreinfo="none">Figure 2.4</property>.</para> + </listitem> + <listitem> + <para>Configure Web Module values:</para> + <figure float="0"> + <title>Web Module Settings Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>If you added the JBoss Web Service facet to the project, now the <property moreinfo="none">Finish</property> button is disable. You must click <property moreinfo="none">Next</property> button to set more information about the JBoss Web Service facet. The page is like <property moreinfo="none">Figure 2.5</property>. Then click on the <property moreinfo="none">Finish</property> button.</para> + <para>If you didn't add the JBoss Web Service facet to the project, click on the <property moreinfo="none">Finish</property> button. Next you will need to add JBoss Web Service facet to the project.</para> + </section> + + <section id="addfacet"> + <title>Configure JBoss Web Service facet settings</title> + <para>If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web + Service facet to the project. Right-click on the project, select its <emphasis><property moreinfo="none">Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog. + Tick on the check box for JBoss Web Services. You will see what like this: </para> + <figure float="0" id="figure_addfacet_0"> + <title>Choose JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet_0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property moreinfo="none">Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet.</para> + <para>Click on the <emphasis><property moreinfo="none">Further configuration required...</property></emphasis> link. In the opened window</para> + <figure float="0" id="figure_addfacet"> + <title>Configure JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the + project's target runtime, you may choose <emphasis> + <property moreinfo="none">Server Supplied JBossWS Runtime</property> + </emphasis> and then click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> to finish the configuration of JBoss Web Service facet. </para> + <para>If the project has no <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> settings, you should check the second radio button and specify a JBossWS + runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> + <property moreinfo="none">New...</property> + </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para> + <figure float="0" id="figure_addfacet1"> + <title>Configure JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_newruntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>See how to configure a new JBossWS runtime <link linkend="preference">here</link>.</para> + <para>After setting the information about JBoss Web Service facet, for saving the result, you should click the <property moreinfo="none">Apply</property> or <property moreinfo="none">OK</property> button at the bottom-right of the right-side of the project properties dialog.</para> + </section> + + + <section id="topdownwebservice"> + <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> + <para>In this chapter we provide you with the necessary steps to create a Web Service from a + WSDL document using JBossWS runtime.</para> + <para>At first, please make sure that you have already created a dynamic Web project with + JBoss Web Service facet installed. </para> + <para>See how to make it <link linkend="createproject">here</link> and <link linkend="addfacet">here</link>.</para> + + <para>To create a Web Service using JBossWS runtime select<emphasis> + <property moreinfo="none">File > New > Other > Web Services > Web Service</property> + </emphasis> to run Web Service creation wizard. </para> + <para>Let's get through the wizard step-by-step:</para> + <figure float="0" id="figure_create_ws_topdown"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First, please select <property moreinfo="none">Top down Java bean Web Service</property> from the Web + Service type list, and select a WSDL document from workspace, click on the Server name + link on the page will bring you to another dialog. Here you can specify the server to a + JBoss Server and Web Service runtime to JBossWS runtime:</para> + <figure float="0" id="figure_create_ws_topdown_setserver"> + <title>Select Server and Web Service runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to see the next wizard view opened:</para> + + <figure float="0" id="figure_create_ws_topdown1"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to proceed:</para> + <figure float="0" id="figure_create_ws_topdown_codegen"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this page, the default package name comes from the namespace of the WSDL document, + you also can change it to any valid package name you want. JAX-WS specification should be + set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can + specify a catalog file and binding files if you have them. If you want the wizard to + generate empty implementation classes for the Web Service, check the <emphasis> + <property moreinfo="none">Generate default Web Service implementation classes</property> + </emphasis> check box. If you want to update the default Web.xml file with the Web Service + servlets configured, check the <emphasis> + <property moreinfo="none">Update the default Web.xml</property> + </emphasis> check box. Click on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> or on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to generate code.</para> + + <para>Once the Web Service code is generated, you can view the implementation class and add + business logic to each method.</para> + <figure float="0" id="figure_impl_code"> + <title>The generated implementation Java code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>View the Web.xml file:</para> + <figure float="0" id="figure_webxml"> + <title>Web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_webxml.png"></imagedata> + </imageobject> + </mediaobject> + </figure> +<para>In the next chapter you will find out how to create a Web service from a Java bean.</para> + </section> + + <section id="bottomupws"> + <title>Creating a Web service from a Java bean using JBossWS runtime</title> + <para>The Web Service wizard assists you in creating a new Web service, configuring it for + deployment, and then deploying it to the server.</para> + <para>To create a Web service from a bean using JBoss WS:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para>Create <link linkend="createproject">a Dynamic Web project</link>.</para> + <para>Add <link linkend="addfacet">JBossWS Facet</link> to Web project.</para> + <para>Create a Web Service from a java bean: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis> + <property moreinfo="none">Window > Open Perspective > Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>In the Project Explorer view, select the bean that you created or imported into + the source folder of your Web project.</para> + <figure float="0"> + <title>Select the Bean Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">File > New > Other</property></emphasis>. Select Web Services in order to display various Web service wizards. + Select the Web Service wizard. Click on the <property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>On the first Web Service wizard page: select <property moreinfo="none">Bottom up Java bean Web + service</property> as your Web service type, and select the Java bean from which + the service will be created:</para> + <figure float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Select the stages of Web service development that you want to complete using + the slider: </para> + <itemizedlist> + <listitem> + <para>Develop: this will develop the WSDL definition and implementation of + the Web service. This includes such tasks as creating modules that will + contain generated code, WSDL files, deployment descriptors, and Java + files when appropriate.</para> + </listitem> + <listitem> + <para>Assemble: this ensures the project that will host the Web service or + client gets associated to an EAR when required by the target application + server.</para> + </listitem> + <listitem> + <para>Deploy: this will create the deployment code for the service.</para> + </listitem> + <listitem> + <para>Install: this will install and configure the Web module and EARs on + the target server.</para> + </listitem> + <listitem> + <para>Start: this will start the server once the service has been installed + on it. The server-config.wsdd file will be generated.</para> + </listitem> + <listitem> + <para>Test: this will provide various options for testing the service, such + as using the Web Service Explorer or sample JSPs.</para> + </listitem> + </itemizedlist> + </listitem> + <listitem> + <para>Select your server: the default server is displayed. If you want to deploy + your service to a different server click the link to specify a different server. + </para> + </listitem> + <listitem> + <para>Select your runtime: ensure the JBoss WS runtime is selected.</para> + </listitem> + <listitem> + <para>Select the service project: the project selected in your workspace is + displayed. To select a different project click on the project link. If you are + deploying to JBoss Application Server you will also be asked to select the EAR + associated with the project. Ensure that the project selected as the Client Web + Project is different from the Service Web Project, or the service will be + overwritten by the client's generated artifacts.</para> + </listitem> + <listitem> + <para>If you want to create a client, select the type of proxy to be generated + and repeat the above steps for the client. The better way is to create a web + service client project separately.</para> + </listitem> + </itemizedlist> + <para>Click on the <property moreinfo="none">Next</property> button.</para> + </listitem> + <listitem> + <para>On the JBoss Web Service Code Generation Configuration page, set the following + values:</para> + <figure float="0"> + <title>Set Web Service values for Code Generation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Generate WSDL file: select it, you will get a generated WSDL file in your + project. But this wsdl's services' address location values are not a real + address. </para> + </listitem> + <listitem> + <para>After the Web service has been created, the following option can become + available depending on the options you selected: Update the default web.xm + file. If selected, you may test the web service by Explorer.</para> + </listitem> + </itemizedlist> + <para>Click on the <property moreinfo="none">Next</property> button.</para> + </listitem> + <listitem> + <para>On this page, the project is deployed to the server. You can start the server and + test the web service. If you want to publish the web service to a UDDI registry, you + may click the <property moreinfo="none">Next</property> button to publish it. If not, you may click + the <property moreinfo="none">Finish</property> button.</para> + <figure float="0"> + <title>Start a Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>After the Web Service has been created, the following options may become available + depending on the options selected:</para> + <itemizedlist> + <listitem> + <para>the generated web services code</para> + </listitem> + <listitem> + <para>If you selected to generate a WSDL file, you will get the file in your project's wsdl folder.</para> + <figure float="0"> + <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>If you selected to update the default web.xml, you will test the web service in + the browser. Open the Explorer, input the url for the web service according to + web.xml plus <property moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> + <figure float="0"> + <title>The Updated web.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS.</para> + + </section> + +</chapter> + + +<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/client.xml"> + <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> + <para>To create a Web Service Client from a WSDL Document using JBoss WS you need to fulfil the following steps:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><link linkend="createproject">Create a Dynamic Web project</link>.</para> + <para><link linkend="addfacet">Add JBossWS Facet to Web project</link>.</para> + <para>Then you can create a Web Service Client from a WSDL document: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis><property moreinfo="none">Window > Open Perspective > Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>Click <emphasis><property moreinfo="none">File > New > Other</property></emphasis>. Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click on the <property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service Client</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>The first and the second Web Service Client wizard pages are the same as for <link linkend="topdownwebservice">Web Service from a WSDL document</link>.</para> + <figure float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Set Web Service values related to WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The only difference is:</para> + <itemizedlist> + <listitem> + <para><property moreinfo="none">Client Type:</property> Support of Java Proxy only.</para> + </listitem> + </itemizedlist> + <para>Click on the <property moreinfo="none">Finish</property> button.</para> + </listitem> + </itemizedlist> + <para>After the Web Service Client has been created, the following may occur depending on the options you selected:</para> + <itemizedlist> + <listitem> + <para> the generated web service and client codes</para> + </listitem> + <listitem> + <para>a client sample class.</para> + <figure float="0"> + <title>Client Sample Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> +</chapter> + + +<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/preference.xml"> + <title>JBoss WS and development environment</title> + + <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> + <section id="jbosswspreference"> + + + <title>JBossWS Preferences</title> + + <para>In this section you will know how JBossWS preferences can be modified during the + development process.</para> + + <para>JBossWS preferences can be set on the JBossWS preference page. Click on + <emphasis><property moreinfo="none">Window > Preferences > JBoss Tools > Web > JBossWS + Preferences</property>.</emphasis></para> + + <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to + <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that + are not needed.</para> + + <figure float="0"> + <title>JBossWS Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on <emphasis> + <property moreinfo="none">Add</property> + </emphasis> or <emphasis> + <property moreinfo="none">Edit</property> + </emphasis> button will open the form where you can configure a new JBossWS runtime and + change the path to JBossWS runtime home folder, modify the name and version of the + existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the + changes.</para> + + <figure float="0"> + <title>Edit JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + + <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, 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/preference/jbossws_container1.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/preference/jbossws_container2.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="serverruntime"> + <title>Default Server and Runtime</title> + <para>Open <emphasis> + <property moreinfo="none">Window > Preferences > Web Services > Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para> + <para>For ease of use, the better way is to set runtime to JBoss WS.</para> + <para>After server and runtime are specified, click on the <property moreinfo="none">Apply</property> button + to save the values.</para> + <figure float="0"> + <title>Specifing a default server and runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_server_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole, this guide covers the fundamental concepts of work with tooling for + <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using + JBossWS Runtime and adjust JBossWS and development environment as well.</para> + + <para>If the information on JBossWS tools in this guide isn't enough for you, ask + questions on our <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">forum</ulink>. Your comments and suggestions are also welcome.</para> + </section> +</chapter> + +</book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19399 - trunk/ws/docs/reference/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 04:32:24 -0500 (Thu, 17 Dec 2009) New Revision: 19399 Modified: trunk/ws/docs/reference/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: trunk/ws/docs/reference/en/master.xml =================================================================== --- trunk/ws/docs/reference/en/master.xml 2009-12-17 09:31:52 UTC (rev 19398) +++ trunk/ws/docs/reference/en/master.xml 2009-12-17 09:32:24 UTC (rev 19399) @@ -33,7 +33,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.0.M2 + Version: 1.1.0.CR1 </releaseinfo> <abstract> <title/>

15 years

1
0
0 / 0

JBoss Tools SVN: r19398 - trunk/struts/docs/struts_tools_tutorial/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 04:31:52 -0500 (Thu, 17 Dec 2009) New Revision: 19398 Modified: trunk/struts/docs/struts_tools_tutorial/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: trunk/struts/docs/struts_tools_tutorial/en/master_output.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en/master_output.xml 2009-12-17 09:31:20 UTC (rev 19397) +++ trunk/struts/docs/struts_tools_tutorial/en/master_output.xml 2009-12-17 09:31:52 UTC (rev 19398) @@ -22,1371 +22,1371 @@ <!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>Struts Tools Tutorial</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> - - <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: 3.1.0.M2 - </diffmk:wrapper></releaseinfo> - -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - - -<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction"> - <?dbhtml filename="introduction.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - <title>Introduction</title> - <para>The following chapters describe how to deal with classic/old style of Struts development. We - recommend users to use <ulink url="../../seam/html_single/index.html">JBoss Seam</ulink> to - simplify development, but until then you can read about classical Struts usage here.</para> - - <para>We are going to show you how to create a simple <emphasis> - <property moreinfo="none">Struts application</property> - </emphasis> using the JBoss Tools. The completed application will ask a user to enter - a name and click a button. The resulting new page will display the familiar message, - "Hello <name>!"</para> - <para>This document will show you how to create such an application from the beginning, along the - way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the - application, generate stub code for the application, fill in the stub coding, compile the - application, and finally run it all from inside the Eclipse.</para> - - <section> - <title><diffmk:wrapper diffmk:change="added">Key Features Struts Tools</diffmk:wrapper></title> - - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of Struts - Tools:</diffmk:wrapper></para> - <table diffmk:change="added"> - - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Functionality of Struts Tools</diffmk:wrapper></title> - <tgroup cols="2" diffmk:change="added"> - - <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec> - <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec> - - - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry> - - </row> - </thead> - <tbody diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Struts Support</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Step-by-step wizards for creating a new struts project with a number - of predefined templates, importing existing ones and adding struts - capabilities to non-struts web projects.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Support for Struts Configuration File</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">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. Working with - struts projects that have multiple modules. Possibility to use Struts - configuration file debugger allowing to set break points on struts - diagram and then launch the server in debug mode.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Support for Struts modules</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">A Struts module (struts-config.xml) is automatically created while - creating a new project. There is also possibility to add new ones or edit - already existing modules in your existing project or while importing Struts project.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Verification and Validation</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">All occurring 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.</diffmk:wrapper></para></entry> - - - </row> - </tbody> - </tgroup> - </table> - </section> - - - - <section diffmk:change="added"> - <title diffmk:change="added">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="struts_application" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/struts_application.xml" xreflabel="struts_application"> - <?dbhtml filename="struts_application.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Creating a Simple Struts Application</title> - - <para>Firstly, we assume that you have already launched Eclipse with <property moreinfo="none">JBoss Tools</property> installed and - also that the <property moreinfo="none">Web Development perspective</property> is the current perspective. (If not, make it - active by selecting <emphasis> - <property moreinfo="none">Window > Open Perspective > Other > Web - Development</property> - </emphasis> from the menu bar.)</para> - - <section id="StartingUp"> - <title>Starting Up</title> - <para>We are first going to create a new project for the application.</para> - <itemizedlist> - <listitem> - <para>Go to the menu bar and select <emphasis> - <property moreinfo="none">File > New > Struts Project</property> - </emphasis></para> - </listitem> - <listitem> - <para>Next enter "StrutsHello" as the project name</para> - </listitem> - <listitem> - <para>Leave everything else as it is, and click <emphasis> - <property moreinfo="none">Next</property> - </emphasis></para> - </listitem> - <listitem> - <para>If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis> - <property moreinfo="none">Runtime</property></emphasis> section click the <emphasis> - <property moreinfo="none">New</property></emphasis> button and target at needed server runtime environment. Click <emphasis> - <property moreinfo="none">Finish</property>.</emphasis></para> - </listitem> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Next</property> - </emphasis></para> - </listitem> - <listitem> - <para>Make sure that <emphasis> - <property moreinfo="none">struts-bean.tld</property> - </emphasis>, <emphasis> - <property moreinfo="none">struts-html.tld</property> - </emphasis>, and <emphasis> - <property moreinfo="none">struts-logic.tld</property> - </emphasis> are checked in the list of included tag libraries and then hit <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>A "StrutsHello" node should appear in the <property moreinfo="none">Package - Explorer view</property>.</para> - <itemizedlist> - <listitem> - <para>Click the plus sign next to <emphasis> - <property moreinfo="none">StrutsHello</property> - </emphasis> to reveal the child nodes</para> - </listitem> - <listitem> - <para>Click the plus sign next to <emphasis> - <property moreinfo="none">WebContent</property> - </emphasis> under <emphasis> - <property moreinfo="none">StrutsHello</property></emphasis></para> - </listitem> - <listitem> - <para>Click the plus sign next to <emphasis> - <property moreinfo="none">WEB-INF</property> - </emphasis> under <emphasis> - <property moreinfo="none">WebContent</property></emphasis></para> - </listitem> - <listitem> - <para>Then, double-click on the <emphasis> - <property moreinfo="none">struts-config.xml</property> - </emphasis> node to display a diagram of the Struts application configuration - file in the editing area</para> - </listitem> - </itemizedlist> - <para>At this point, its empty except for the background grid lines.</para> - </section> - - <section id="CreatingtheApplicationComponents"> - <?dbhtml filename="CreatingtheApplicationComponents.html"?> - <title>Creating the Application Components</title> - <para>Now, we will design the application by creating the individual components as - placeholders first. (We don't have to complete all of the details inside the components - until afterwards.)</para> - <section id="CreatingJSPPagePlaceholders"> - <title>Creating JSP Page Placeholders</title> - <para>Next, let's create and place two JSP pages. We will not write any code - for the files, but only create them as placeholders so that we can create links to - them in the diagram. We will write the code a little bit later.</para> - <section id="CreatingthePagePlaceholders"> - <title>Creating the Page Placeholders</title> - <itemizedlist> - <listitem> - <para>Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property> - by selecting the <emphasis> - <property moreinfo="none">Web Projects</property> - </emphasis> tab next to that tab.</para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent)</property> - </emphasis> folder in the <property moreinfo="none">Web Projects view</property> and select <emphasis> - <property moreinfo="none">New > Folder...</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property moreinfo="none">pages</property> - </emphasis> for a folder name and click <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - - <listitem> - <para>We will keep our presentation files in this folder</para> - </listitem> - - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">pages</property></emphasis> folder and select <emphasis> - <property moreinfo="none">New > File > JSP...</property> - </emphasis> - </para> - </listitem> - <listitem> - <para>For Name type in <emphasis> - <property moreinfo="none">inputname</property> - </emphasis> (the JSP extension will be automatically added to the file), - for Template select <emphasis> - <property moreinfo="none">StrutsForm</property> - </emphasis> and then click on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button</para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">pages</property></emphasis> folder again and select <emphasis> - <property moreinfo="none">New > File > JSP...</property> - </emphasis></para> - </listitem> - <listitem> - <para>For Name type in <emphasis> - <property moreinfo="none">greeting</property> - </emphasis>, for Template leave as <emphasis> - <property moreinfo="none">Blank</property>,</emphasis> and then click on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button</para> - </listitem> - </itemizedlist> - <para>Just leave these files as is for now.</para> - </section> - <section id="PlacingthePagePlaceholders"> - <title>Placing the Page Placeholders</title> - <para>Lets now place the two pages just created on the diagram.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">struts-config.xml</property> - </emphasis> tab in the editing area to bring the diagram to the - front</para> - </listitem> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">inputname.jsp</property> - </emphasis> page in the <property moreinfo="none">Web Projects view</property>, drag it onto the diagram, and - drop it</para> - </listitem> - <listitem><para>Click on the <emphasis> - <property moreinfo="none">greeting.jsp</property> - </emphasis> page in the <property moreinfo="none">Web Projects view</property>, drag it onto the diagram, and - drop it to the right of the <emphasis> - <property moreinfo="none">/pages/inputname.jsp</property> - </emphasis> icon with some extra space</para></listitem> - </itemizedlist> - <para>You should now have two JSP pages in the diagram.</para> - </section> - </section> - <section id="CreatinganActionMappings"> - <title>Creating an Action Mappings</title> - <para>Using a context menu on the diagram, we are next going to create an Action - mapping.</para> - <itemizedlist> - <listitem> - <para>Right-click between the two icons and select <emphasis> - <property moreinfo="none">New > Action</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter the following values:</para> - </listitem> - </itemizedlist> - <table> - <title>Action values</title> - <tgroup cols="2"> - <tbody> - <row> - <entry>path</entry> - <entry>/greeting</entry> - </row> - <row> - <entry>name</entry> - <entry>GetNameForm</entry> - </row> - <row> - <entry>scope</entry> - <entry>request</entry> - </row> - <row> - <entry>type</entry> - <entry>sample.GreetingAction</entry> - </row> - <row> - <entry>validate</entry> - <entry><leave blank></entry> - </row> - </tbody> - </tgroup> - </table> - <para>("GetNameForm" is the name for a form bean that we will create - later.)</para> - <itemizedlist> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - - <para>The <emphasis> - <property moreinfo="none">/greeting</property> - </emphasis> action should appear in four places, in the diagram, under the - <emphasis> - <property moreinfo="none">action-mappings</property></emphasis> node, under the <emphasis> - <property moreinfo="none">struts-config.xml</property></emphasis> node in Tree view, in <property moreinfo="none">Web Projects - view</property> and in the <property moreinfo="none">Outline view</property>. Also, note the asterisk to the right of the name, - <emphasis> - <property moreinfo="none">struts-config.xml</property>,</emphasis> in the <property moreinfo="none">Outline view</property> showing that the file has been changed, but - not saved to disk.</para> - </section> - <section id="CreatingaLink"> - <title>Creating a Link</title> - <para>Let's now create a link from the <emphasis> - <property moreinfo="none">inputname.jsp</property></emphasis> page to the action.</para> - <itemizedlist> - <listitem> - <para>On the left-hand side of the diagram in the column of icons, click on the Create New Connection - icon( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata> - </imageobject> - </inlinemediaobject>).</para> - </listitem> - </itemizedlist> - <itemizedlist> - <listitem> - <para>In the connect-the-components mode you are in now, click on the <emphasis> - <property moreinfo="none">/pages/inputname.jsp</property> - </emphasis> icon in the diagram and then click on the <emphasis> - <property moreinfo="none">/greeting</property> - </emphasis> action</para> - </listitem> - </itemizedlist> - <para>A link will be created from the page to the action.</para> - </section> - <section id="CreatingaForward"> - <title>Creating a Forward</title> - <para>Next, we are going to create a forward for the action.</para> - <itemizedlist> - <listitem> - <para>On the left-hand side of the diagram in the column of icons, click on - the Create New Connection - icon( <inlinemediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata> - </imageobject> - </inlinemediaobject>), again.</para> - </listitem> - </itemizedlist> - - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">/greeting</property> - </emphasis> action icon in the diagram and then click on the <emphasis> - <property moreinfo="none">pages/greeting.jsp</property> - </emphasis> icon</para> - </listitem> - <listitem> - <para>That's it. A link will be drawn from the actions new greeting - forward to the <emphasis> - <property moreinfo="none">greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be - set based on the name of the target JSP file name. If you don't - like it, you can easily change it</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property moreinfo="none">Tree</property> - </emphasis> tab at the bottom of the editor window (between Diagram and - Source)</para> - </listitem> - <listitem> - <para>Expand the <emphasis> - <property moreinfo="none">struts-config.xml/action-mappings/ /greeting</property> - </emphasis> node and then select the greeting forward</para> - </listitem> - <listitem> - <para>In the Properties Editor to the right, change the text to - "sayHello" in the <emphasis> - <property moreinfo="none">Name</property></emphasis> field</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property moreinfo="none">Diagram</property> - </emphasis> tab at the bottom of the editor window and see how the diagram - is also updated to reflect the change</para> - </listitem> - </itemizedlist> - </section> - <section id="CreatingaGlobalForward"> - <title>Creating a Global Forward</title> - <para>One last component that we need to create in the diagram is a global forward.</para> - <itemizedlist> - <listitem> - <para>Somewhere in the top-left corner of diagram, right-click and select <emphasis> - <property moreinfo="none">New > Global Forward</property> - </emphasis></para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property moreinfo="none">getName</property> - </emphasis> in the <emphasis> - <property moreinfo="none">Name</property></emphasis> field</para> - </listitem> - <listitem> - <para>Select the <emphasis> - <property moreinfo="none">Change...</property> - </emphasis>button for Path</para> - </listitem> - <listitem> - <para>In the Edit Path window, switch to the <emphasis> - <property moreinfo="none">Pages</property> - </emphasis> tab</para> - </listitem> - <listitem> - <para>Expand the <emphasis> - <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent) > pages</property> - </emphasis> node and then select the inputname.jsp page</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Ok</property> - </emphasis>.</para> - </listitem> - <listitem> - <para>Leave the rest of the fields blank and click <emphasis> - <property moreinfo="none">OK</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>A forward object now appears on the diagram and also in the global-forwards folder - in the Outline view.</para> - <itemizedlist> - <listitem> - <para>Tidy up the diagram, by clicking and dragging around each icon, so that - the diagram looks something like this:</para> - </listitem> - </itemizedlist> - <figure float="0"> - <title>Diagram View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="CreatingaFormBean"> - <title>Creating a Form Bean</title> - <para>One last thing that we need to do is to create a form bean.</para> - <itemizedlist> - <listitem> - <para>Switch to the Tree viewer in the editor for the <emphasis> - <property moreinfo="none">struts-config.xml</property></emphasis> file, by - selecting the <emphasis> - <property moreinfo="none">Tree</property> - </emphasis> tab at the bottom of the editor window</para> - </listitem> - <listitem> - <para>Right-click <emphasis> - <property moreinfo="none">struts-config.xml > form-beans</property> - </emphasis> and select Create Form Bean</para> - </listitem> - <listitem> - <para>Enter <emphasis> - <property moreinfo="none">GetNameForm</property> - </emphasis> in the name field and <emphasis> - <property moreinfo="none">sample.GetNameForm</property> - </emphasis> for type</para> - </listitem> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - <listitem> - <para>To save your changes to struts-config.xml, select <emphasis> - <property moreinfo="none">File > Save</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - <para>Note the disappearance of the asterisk next to the name, <emphasis> - <property moreinfo="none">struts-config.xml</property>.</emphasis></para> - </section> - </section> -</chapter> - -<chapter id="generating_stub" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/generating_stub.xml" xreflabel="generating_stub"> - <?dbhtml filename="generating_stub.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Generating Stub Coding</title> - <para>We are done with designing the application through the diagram. Now we need to write - code for the action component. We also need to write an action class for the <emphasis> - <property moreinfo="none">/greeting</property> - </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer - Studio can generate Java class stubs for all of the components shown in the diagram.</para> - <itemizedlist> - <listitem> - <para>Switch back to the diagram, by selecting the <emphasis> - <property moreinfo="none">Diagram</property> - </emphasis> tab at the bottom of the editor window</para> - </listitem> - <listitem> - <para>Right-click a blank space in the diagram and select <emphasis> - <property moreinfo="none">Generate Java Code</property> - </emphasis></para> - </listitem> - <listitem> - <para>Leave everything as is in the dialog box and click <emphasis> - <property moreinfo="none">Generate</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>You should see a screen that says:</para> - <para>Generated classes: 2</para> - <para>Actions: 1</para> - <para>Form beans: 1</para> - <itemizedlist> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - </itemizedlist> - <para>The Java files will be generated in a <emphasis> - <property moreinfo="none">JavaSource > sample</property> - </emphasis> folder that you can see in the <property moreinfo="none">Package Explorer view</property> under the - "StrutsHello" node. One Action stub and one FormBean stub will have - been generated.</para> - </chapter> - -<chapter id="coding_files" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/coding_files.xml" xreflabel="coding_files"> - <?dbhtml filename="coding_files.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Coding the Various Files</title> - <para>We will now code both the Java stub classes just generated, the JSP files left in as - placeholders from previous steps, and a new start JSP page we will have to create.</para> - <section id="JavaStubClasses"> - <title>Java Stub Classes</title> - <itemizedlist> - <listitem> - <para>To finish the two Java classes, switch to the <emphasis> - <property moreinfo="none">Package Explorer</property> - </emphasis> view and expand the <emphasis> - <property moreinfo="none">JavaSource > sample</property> - </emphasis> folder</para> - </listitem> - </itemizedlist> - <section id="GetNameForm.java"> - <title>GetNameForm.java</title> - <itemizedlist> - <listitem> - <para>Double-click <emphasis> - <property moreinfo="none">GetNameForm.java</property> - </emphasis> for editing</para> - </listitem> - - <listitem> - <para>You are looking at a Java stub class that was generated by JBoss - Tools. Now we are going to edit the file</para> - </listitem> - - <listitem> - <para>Add the following attributes at the beginning of the class:</para> - </listitem> - </itemizedlist> - <programlisting format="linespecific" role="JAVA"><![CDATA[private String name = ""; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Inside the reset method, delete the TO DO and throw lines and - add:</para> - </listitem> - </itemizedlist> - <programlisting format="linespecific" role="JAVA"><![CDATA[this.name = ""; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Inside the validate method, delete the TO DO and throw lines and - add:</para> - </listitem> - </itemizedlist> - <programlisting format="linespecific" role="JAVA"><![CDATA[ActionErrors errors = new ActionErrors(); - return errors; -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Right-click and select <emphasis> - <property moreinfo="none">Source > Generate Getters and Setters</property> - </emphasis>from the context menu</para> - </listitem> - <listitem> - <para>In the dialog box, check the check box for <emphasis> - <property moreinfo="none">name</property>,</emphasis> - select First method for Insertion point, and click on the <emphasis> - <property moreinfo="none">OK</property> - </emphasis> button</para> - </listitem> - </itemizedlist> - <para>The final <emphasis> - <property moreinfo="none">GetNameForm.java</property></emphasis> file should look like this:</para> - <programlisting format="linespecific" role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import org.apache.struts.action.ActionErrors; -import org.apache.struts.action.ActionMapping; - -public class GetNameForm extends org.apache.struts.action.ActionForm -{ - - private String name = ""; - - public String getName() - { - return name; - } - public void setName(String name) - { - this.name = name; - } - - public GetNameForm() - { - } - - public void reset(ActionMapping actionMapping, HttpServletRequest request) - { - this.name = ""; - } - - public ActionErrors validate(ActionMapping actionMapping, - HttpServletRequest request) - { - ActionErrors errors = new ActionErrors(); - return errors; - } -} -]]></programlisting> - - <itemizedlist> - <listitem> - <para>Save the file</para> - </listitem> - </itemizedlist> - </section> - <section id="GreetingAction.java"> - <title>GreetingAction.java</title> - <itemizedlist> - <listitem> - <para>Open <emphasis> - <property moreinfo="none">GreetingAction.java</property></emphasis> for editing</para> - </listitem> - <listitem> - <para>Inside the execute method, delete the TO DO lines and add the - following:</para> - </listitem> - </itemizedlist> - - <programlisting format="linespecific" role="JAVA"><![CDATA[String name = ((GetNameForm)form).getName(); -String greeting = "Hello, "+name+"!"; -((GetNameForm)form).setName(greeting); -return mapping.findForward(FORWARD_sayHello); -]]></programlisting> - - <para>The final version of <emphasis> - <property moreinfo="none">GreetingAction.java</property></emphasis> should look like this:</para> - - <programlisting format="linespecific" role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import javax.servlet.http.HttpServletResponse; -import org.apache.struts.action.ActionForm; -import org.apache.struts.action.ActionForward; -import org.apache.struts.action.ActionMapping; - -public class GreetingAction extends org.apache.struts.action.Action -{ - - // Global Forwards - public static final String GLOBAL_FORWARD_getName = "getName"; - - // Local Forwards - public static final String FORWARD_sayHello = "sayHello"; - - public GreetingAction() - { - } - public ActionForward execute(ActionMapping mapping, ActionForm form, - HttpServletRequest request, HttpServletResponse response) throws Exception - { - String name = ((GetNameForm)form).getName(); - String greeting = "Hello, "+name+"!"; - ((GetNameForm)form).setName(greeting); - return mapping.findForward(FORWARD_sayHello); - } -} -]]></programlisting> - <itemizedlist> - <listitem> - <para>Save the file</para> - </listitem> - <listitem> - <para>Close the editors for the two Java files</para> - </listitem> - </itemizedlist> - <para>The last thing left to do is to code the JSP files whose editors should still - be open from having been created as placeholders.</para> - </section> - </section> - <section id="JSPPages"> - <title>JSP Pages</title> - <section id="inputname.jsp"> - <title>inputname.jsp</title> - <para>In this page, the user will enter any name and click the <emphasis> - <property moreinfo="none">submit</property> - </emphasis> button. Then, the greeting action will be called through the form.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">inputname.jsp</property> - </emphasis> tab in the Editing area to bring its editor forward</para> - </listitem> - <listitem> - <para>In the Web Projects view, expand <emphasis> - <property moreinfo="none">StrutsHello > Configuration > default - > struts-config.xml > action-mappings</property> - </emphasis> and select <emphasis> - <property moreinfo="none">/greeting</property> - </emphasis></para> - </listitem> - <listitem> - <para>Drag it and drop it between the quotes for the <emphasis role="italic"> - <property moreinfo="none">"action"</property> - </emphasis> attribute to the - <code><html:form></code> - element in the Source pane of the editor</para> - </listitem> - <listitem> - <para>Then type this text on a new line just below this line:</para> - <programlisting format="linespecific" role="XML"><![CDATA[Input name: - ]]></programlisting> - </listitem> - - <listitem> - <para>Select the <emphasis> - <property moreinfo="none">Visual</property> - </emphasis> pane of the editor</para> - </listitem> - <listitem> - <para>Then, in the JBoss Tools Palette, expand the <emphasis> - <property moreinfo="none">Struts Form</property> - </emphasis> library, select <emphasis> - <property moreinfo="none">text</property> - </emphasis>, and drag it onto the box - <note> - <title>Note:</title> - <para>By default there are only four groups on the JBoss Tools - Palette. If you wish to make some group visible click the <emphasis> - <property moreinfo="none">Show/Hide</property> - </emphasis> button on the top of palette and in the prompted - dialog check the group (or groups) you want to be shown.</para> - </note> - </para> - </listitem> - </itemizedlist> - <figure float="0"> - <title>JBoss Tools Palette</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>In the Insert Tag dialog box, type in name for property and select <emphasis> - <property moreinfo="none">Finish</property> - </emphasis></para> - </listitem> - <listitem> - <para>In the StrutsForm library in the <property moreinfo="none">JBoss Tools Palette</property>, select <emphasis> - <property moreinfo="none">submit</property> - </emphasis>, and drag it to right after the text box in the Visual pane - of the editor</para> - </listitem> - <listitem> - <para>Right-click the <emphasis> - <property moreinfo="none">submit</property> - </emphasis> button and select - <code><html:submit></code> - Attributes from the context menu</para> - </listitem> - <listitem> - <para>In the Attributes dialog box, select the <emphasis> - <property moreinfo="none">value</property> - </emphasis> field and type in "Say Hello!" for its - value</para> - </listitem> - </itemizedlist> - <para>After tidying the page source, the Editor window for the file should look - something like this:</para> - <figure float="0"> - <title>Editor Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_4.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="greeting.jsp"> - <title>greeting.jsp</title> - <para>Next, we will fill in the result page.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">greeting.jsp</property> - </emphasis> tab in the Editing area to bring its editor forward</para> - </listitem> - <listitem> - <para>Type in the following code:</para> - </listitem> - </itemizedlist> - <programlisting format="linespecific" role="XML"><![CDATA[<html> -<head> - <title>Greeting</title> -</head> - <body> - <p> - </p> - </body> -</html> -]]></programlisting> - - <para>To complete editing of this file, we will use macros from the <property moreinfo="none">JBoss Tools - Palette</property>. This palette is a view that should be available to the right of the - editing area.</para> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">Struts Common</property> - </emphasis> folder in the <property moreinfo="none">JBoss Tools Palette</property> to open it</para> - </listitem> - <listitem> - <para>Position the cursor at the beginning of the <emphasis> - <property moreinfo="none">greeting.jsp</property></emphasis> file in the - Source pane and then click on <emphasis> - <property moreinfo="none">bean taglib</property></emphasis> in the <property moreinfo="none">JBoss Tools - Palette</property></para> - </listitem> - </itemizedlist> - <para>This will insert the following line at the top of the file:</para> - <programlisting format="linespecific" role="JAVA"><![CDATA[ -<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %> -]]></programlisting> - <itemizedlist> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">Struts Bean</property> - </emphasis> folder in the <property moreinfo="none">JBoss Tools Palette</property> to open it</para> - </listitem> - <listitem> - <para>Position the cursor inside the - <code><p></code> - element</para> - </listitem> - <listitem> - <para>Click on <emphasis> - <property moreinfo="none">write</property></emphasis> in the <property moreinfo="none">JBoss Tools Palette</property></para> - </listitem> - <listitem> - <para>Type in "GetNameForm" for the <emphasis role="italic"> - <property moreinfo="none">name</property> - </emphasis> attribute and add a <emphasis role="italic"> - <property moreinfo="none">property</property> - </emphasis> attribute with "name" as its - value</para> - </listitem> - </itemizedlist> - <para>The editor should now look like this:</para> - <figure float="0"> - <title>Editor Window</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_5.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="index.jsp"> - <title>index.jsp</title> - <para>Finally, we will need to create and edit an <emphasis> - <property moreinfo="none">index.jsp</property></emphasis> page. This page will use - a Struts forward to simply redirect us to the getName global forward.</para> - <itemizedlist> - <listitem> - <para>In the Web Projects view, right-click on <emphasis> - <property moreinfo="none">StrutsHello > WEB-ROOT(WebContent)</property> - </emphasis> node and select <emphasis> - <property moreinfo="none">New > File > JSP</property> - </emphasis></para> - </listitem> - <listitem> - <para>Type <emphasis> - <property moreinfo="none">index</property></emphasis> for Name and click on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button</para> - </listitem> - <listitem> - <para>On the <property moreinfo="none">JBoss Tools Palette</property>, select the <emphasis> - <property moreinfo="none">Struts Common</property> - </emphasis> folder of macros by clicking on it in the palette</para> - </listitem> - <listitem> - <para>Click on the <emphasis> - <property moreinfo="none">logic taglib</property></emphasis> icon</para> - </listitem> - <listitem> - <para>Press the <emphasis> - <property moreinfo="none">Enter</property> - </emphasis> key in the editor to go to the next line</para> - </listitem> - <listitem> - <para>Back on the palette, select the <emphasis> - <property moreinfo="none">Struts Logic</property> - </emphasis> folder of macros</para> - </listitem> - <listitem> - <para>Click on <emphasis> - <property moreinfo="none">redirect</property></emphasis></para> - </listitem> - <listitem> - <para>Delete the ending tag, put a forward slash in front of the closing - angle bracket, and type "forward=getName" in front of - the slash</para> - </listitem> - </itemizedlist> - <para>The finished code for the page is shown below:</para> - <programlisting format="linespecific" role="JAVA"><![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %> -<logic:redirect forward="getName"/> -]]></programlisting> - <itemizedlist> - <listitem> - <para>To save all the edits to files, select <emphasis> - <property moreinfo="none">File>Save All</property> - </emphasis> from the menu bar</para> - </listitem> - </itemizedlist> - </section> - </section> - </chapter> - -<chapter id="compiling_and_running" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/compiling_and_running.xml" xreflabel="compiling_and_running"> - <?dbhtml filename="compiling_and_running.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Compiling the Classes and Running the Application</title> - - <para>As this is the Eclipse environment, no explicit compilation step is required. By - default, Eclipse compiles as you go.</para> - - <para>Thus at this point everything is ready for running our application without having to leave JBoss - Developer Studio by using the JBoss Application Server engine that comes with the JBoss - Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is JBoss - Server view.</para> - <figure float="0"> - <title>JBoss Server Panel</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/struts_application/struts_application_6.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <itemizedlist> - <listitem> - <para>Start up JBoss AS by clicking on the icon in JBoss Server view. (If JBoss AS - is already running, stop it by clicking on the red icon and then start it again. - Remember, the Struts run-time requires restarting the servlet engine when any - changes have been made.)</para> - </listitem> - <listitem> - <para>After the messages in the Console tabbed view stop scrolling, JBoss AS is - available. At this point, right-click on the getName global forward in the - struts-config.xml diagram view and select Run on Server.</para> - </listitem> - </itemizedlist> - <para>The browser should appear with the application started.</para> - </chapter> - -<chapter id="struts_validation" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/struts_validation.xml" xreflabel="struts_validation"> - <?dbhtml filename="struts_validation.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Struts</keyword> - <keyword>Struts Validation</keyword> - </keywordset> - </chapterinfo> -<title>Struts Validation Examples</title> - -<para><property moreinfo="none">Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks, -including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web -application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.</para> - - <para>JBoss Developer Studio makes using the <property moreinfo="none">Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.</para> - -<section id="StartingPoint"> -<?dbhtml filename="StartingPoint.html"?> -<title>Starting Point</title> -<para>The example assumes that you have already created our sample "StrutsHello" application from the -Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective - open on this StrutsHello project.</para> -</section> - -<section id="DefiningTheValidationRule"> -<?dbhtml filename="DefiningTheValidationRule.html"?> -<title>Defining the Validation Rule</title> -<para>In these steps you will set up the validation that can be used for either client-side or -server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.</para> - -<itemizedlist> -<listitem><para>Right-click on a "plug-ins" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property moreinfo="none">Create Special Plugin > Validators</property></emphasis> from the context menu</para></listitem> -<listitem><para>Further down in the Web Projects view, right-click on the -<emphasis><property moreinfo="none">StrutsHello > ResourceBundles</property></emphasis> node and select <emphasis><property moreinfo="none"> New > Properties File...</property></emphasis>from the context menu</para></listitem> -<listitem><para>In the dialog box, click on the <emphasis><property moreinfo="none">Browse...</property></emphasis>button next to the Folder field, expand the - JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property moreinfo="none">OK</property></emphasis> button</para></listitem> - <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button</para></listitem> -<listitem><para>Right-click on a newly created file and select <emphasis><property moreinfo="none">Add > Default Error Messages</property></emphasis> - from the context menu</para></listitem> - -<listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem> -<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>All from the menu bar</para></listitem> -<listitem><para>Select validation.xml under the <emphasis><property moreinfo="none">StrutsHello > Validation</property></emphasis> node and double-click it to open it with the JBoss Tools XML Editor</para></listitem> -<listitem><para>Here you must create a Formset.</para></listitem> -<listitem><para>In the validation.xml file editor click the button <emphasis><property moreinfo="none">Create Formset</property></emphasis> on the panel <emphasis><property moreinfo="none">Formsets</property></emphasis></para></listitem> -<listitem><para>In the dialog <emphasis><property moreinfo="none">Add Formset</property></emphasis> fill the fields <emphasis><property moreinfo="none">Language</property></emphasis> and <emphasis><property moreinfo="none">Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property moreinfo="none">OK</property></emphasis></para></listitem> -</itemizedlist> -<figure float="0"> - <title>Create Formset</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/struts_validation/struts_validation.png"></imagedata> - </imageobject> -</mediaobject> -</figure> -<itemizedlist> -<listitem><para>Expand the "form-beans" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml node.</property></emphasis> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property moreinfo="none">XML</property> Editor</para></listitem> -<listitem><para>In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property moreinfo="none">Create Field...</property></emphasis> from the context menu</para></listitem> -<listitem><para>Enter a name for Property in the dialog box. A new property will be created:</para></listitem> -</itemizedlist> -<figure float="0"> - <title>New Property Is Added</title> -<mediaobject> - <imageobject> - <imagedata fileref="images/struts_validation/struts_validation_2.png"></imagedata> - </imageobject> -</mediaobject> -</figure> -<itemizedlist> -<listitem><para>In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the Depends entry field</para></listitem> -<listitem><para>In the displayed double list, select <emphasis><property moreinfo="none">required</property></emphasis> from the left list and then click <emphasis><property moreinfo="none">Add</property></emphasis></para></listitem> - <listitem><para>Click <emphasis><property moreinfo="none">Ok</property></emphasis></para></listitem> -<listitem><para>Right-click name and select <emphasis><property moreinfo="none">Add Arg...</property></emphasis> from the context menu</para></listitem> -<listitem><para>In the Add Arg dialog box, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the <emphasis><property moreinfo="none">Key</property></emphasis> field</para></listitem> - <listitem><para>In the Key dialog box that appears now, click on the <emphasis><property moreinfo="none">Add</property></emphasis> button</para></listitem> - <listitem><para>Enter "name.required" in the Name field, and enter a person's name in the Value field</para></listitem> - <listitem><para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>, then <emphasis><property moreinfo="none">Ok</property></emphasis>, and then <emphasis><property moreinfo="none">Ok</property></emphasis> again</para></listitem> -<listitem><para>Select <emphasis><property moreinfo="none">File > Save All</property></emphasis> from the menu bar</para></listitem> -</itemizedlist> -</section> - -<section id="Client-SideValidation"> -<?dbhtml filename="Client-SideValidation.html"?> -<title>Client-Side Validation</title> -<para>Client-side <property moreinfo="none">validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property moreinfo="none">validation</property>. In a Struts application using the <property moreinfo="none">Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property moreinfo="none">Validation</property> Framework handles this.</para> -<para>To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.</para> -<itemizedlist> -<listitem><para>Double-click inputname.jsp under <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages</property></emphasis> to open it for editing</para></listitem> -<listitem><para>Find the tag near the top and hit Return to make a new line under it</para></listitem> - <listitem><para>In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag</para></listitem> -<listitem><para>Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu</para></listitem> -<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem> -<listitem><para>Modify the <code><html:form></code> tag by inserting this attribute:</para></listitem> -</itemizedlist> -<programlisting format="linespecific" role="XML"><![CDATA[onsubmit="return validateGetNameForm(this)" -]]></programlisting> -<para></para> -<para>The file should now look like this:</para> -<programlisting format="linespecific" role="XML"><![CDATA[ -<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> - -<html:html > - <head> - <html:javascript formName="GetNameForm"/> - <title></title> - </head> - <body> - <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)"> - Input name:<html:text property="name"/><html:submit value="Say Hello!"/> - </html:form> - </body> -</html:html> -]]></programlisting> -<itemizedlist> -<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>from the menu bar</para></listitem> -<listitem><para>Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar</para></listitem> - <listitem><para>Click the Run icon(<inlinemediaobject> <imageobject> - <imagedata fileref="images/struts_validation/struts_validation_1.png"></imagedata> - </imageobject></inlinemediaobject>) or right click your project folder and select <emphasis><property moreinfo="none">Run As > Run on Server</property></emphasis></para></listitem> -</itemizedlist> - -<itemizedlist><listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem></itemizedlist> -<para>A JavaScript error message should be displayed in an alert box.</para> -</section> -<section id="Server-SideValidation"> -<?dbhtml filename="Server-SideValidation.html"?> -<title>Server Side Validation</title> -<para>Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.</para> -</section> - -<section id="EditingTheJSPFile"> -<?dbhtml filename="EditingTheJSPFile.html"?> -<title>Editing the JSP File</title> -<itemizedlist> -<listitem><para>Reopen inputname.jsp for editing</para></listitem> -<listitem><para>Delete the <emphasis role="italic"><property moreinfo="none">"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation</para></listitem> - -<listitem><para>Add an <code><html:errors/></code> tag after the - <code><html:form></code> - tag</para></listitem> -</itemizedlist> -<para>The JSP file should now look like this:</para> - - <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> -<html:html > -<head> - <html:javascript formName="GetNameForm"/> - <title></title> - </head> - <body> - <html:form action="/greeting.do" >Input name:<html:text property="name"/> - <html:submit value="Say Hello!"/> - </html:form> - <html:errors/> - </body> -</html:html> -]]></programlisting> - -</section> - -<section id="EditingTheAction"> -<?dbhtml filename="EditingTheAction.html"?> -<title>Editing the Action</title> -<itemizedlist> -<listitem><para>In the Web Projects view, expand the node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > action-mappings</property></emphasis> node, right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action, and then select <emphasis><property moreinfo="none">Properties...</property></emphasis>from the context menu</para></listitem> - - <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property moreinfo="none">...</property> button</para></listitem> - - <listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages > inputname.jsp</property></emphasis>, click the <emphasis><property moreinfo="none">Ok</property></emphasis> button, and then click on the <emphasis><property moreinfo="none">Close</property></emphasis> button</para></listitem> -</itemizedlist> -</section> -<section id="EditingTheFormBean"> -<?dbhtml filename="EditingTheFormBean.html"?> - -<title>Editing the Form Bean</title> -<itemizedlist> -<listitem><para>Right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing</para></listitem> -<listitem><para>Change the class that it extends from: <emphasis><property moreinfo="none">org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property moreinfo="none">org.apache.struts.validator.ValidatorForm</property></emphasis></para></listitem> -<listitem><para>Comment out a validate method</para></listitem> -</itemizedlist> -<para>The file should now look like this:</para> -<programlisting format="linespecific" role="JAVA"><![CDATA[package sample; -import javax.servlet.http.HttpServletRequest; -import org.apache.struts.action.ActionErrors; -import org.apache.struts.action.ActionMapping; -public class GetNameForm extends - -org.apache.struts.validator.ValidatorForm -{ - - private String name = ""; - - /** - * @return Returns the name. - */ - public String getName() - { - return name; - } - - /** - * @param name The name to set. - */ - public void setName(String name) - { - this.name = name; - } - - public GetNameForm () - { - } - - public void reset(ActionMapping actionMapping, - HttpServletRequest request) - { - this.name = ""; - } - - // public ActionErrors validate(ActionMapping actionMapping, - // HttpServletRequest request) - //{ - // ActionErrors errors = new ActionErrors(); - // return errors; - // } - } -]]></programlisting> - -<itemizedlist> -<listitem><para>Select <emphasis><property moreinfo="none">File > Save All </property></emphasis>from the menu bar</para></listitem> -<listitem><para>Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar</para></listitem> -<listitem><para>Run the application</para></listitem> -<listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem> -</itemizedlist> -<para>The error message should appear in a refreshed version of the form.</para> -</section> - -</chapter> - -<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/struts/docs/struts_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources"> - <?dbhtml filename="relevant_resources.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - <keyword>Struts</keyword> - <keyword>Struts Application</keyword> - </keywordset> - </chapterinfo> - - <title>Other Relevant Resources on the topic</title> - - <para>Our reference: <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink></para> - <para>Apache Struts: <ulink url="http://struts.apache.org/">Struts Technology</ulink></para> - <para>Struts 2: <ulink url="http://struts.apache.org/2.x/">Apache Struts 2</ulink></para> - <para>Get Started: <ulink url="http://struts.apache.org/2.x/docs/home.html">Struts Getting - Started</ulink></para> - <para>Struts on IBM: <ulink url="http://www.ibm.com/developerworks/library/j-struts/">Struts - - An open-source MVC implementation</ulink></para> - <para>FAQ: <ulink url="http://struts.apache.org/2.x/docs/faqs.html">Struts FAQ</ulink></para> - <para>Download: <ulink url="http://struts.apache.org/download.cgi#struts206">Release of Apache - Struts</ulink></para> - - <para>Thus, this tutorial should help you to execute the hole development circle for building a - sample Struts-based Web application using <property moreinfo="none">JBoss Tools</property> bundle of Eclipse - plugins starting from organizing a new Struts project and ending with the running and - deploying it onto the <property moreinfo="none">JBoss Server</property>.</para> - - <para>To find out all the features of <property moreinfo="none">JBoss Tools</property> for working with Struts - refer to our <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink>. If you - still have questions you are always welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss - Tools Forum</ulink>.</para> -</chapter> - - - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>Struts Tools Tutorial</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> + + <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: 3.1.0.CR1 + </diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/struts_tools_tutoria...">PDF version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/introduction.xml" xreflabel="introduction"> + <?dbhtml filename="introduction.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>The following chapters describe how to deal with classic/old style of Struts development. We + recommend users to use <ulink url="../../seam/html_single/index.html">JBoss Seam</ulink> to + simplify development, but until then you can read about classical Struts usage here.</para> + + <para>We are going to show you how to create a simple <emphasis> + <property moreinfo="none">Struts application</property> + </emphasis> using the JBoss Tools. The completed application will ask a user to enter + a name and click a button. The resulting new page will display the familiar message, + "Hello <name>!"</para> + <para>This document will show you how to create such an application from the beginning, along the + way demonstrating some of the powerful features of JBoss Tools. With the help of our tutorial you will design the + application, generate stub code for the application, fill in the stub coding, compile the + application, and finally run it all from inside the Eclipse.</para> + + <section> + <title>Key Features Struts Tools</title> + + <para>For a start, we propose you to look through the table of main features of Struts + Tools:</para> + <table> + + <title>Key Functionality of Struts Tools</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>Struts Support</para></entry> + <entry><para>Step-by-step wizards for creating a new struts project with a number + of predefined templates, importing existing ones and adding struts + capabilities to non-struts web projects.</para></entry> + + </row> + + <row> + <entry><para>Support for Struts Configuration File</para></entry> + <entry><para>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. Working with + struts projects that have multiple modules. Possibility to use Struts + configuration file debugger allowing to set break points on struts + diagram and then launch the server in debug mode.</para></entry> + + </row> + + <row> + <entry><para>Support for Struts modules</para></entry> + <entry><para>A Struts module (struts-config.xml) is automatically created while + creating a new project. There is also possibility to add new ones or edit + already existing modules in your existing project or while importing Struts project.</para></entry> + + </row> + + <row> + <entry><para>Verification and Validation</para></entry> + <entry><para>All occurring 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.</para></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="struts_application" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/struts_application.xml" xreflabel="struts_application"> + <?dbhtml filename="struts_application.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Struts</keyword> + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + + <title>Creating a Simple Struts Application</title> + + <para>Firstly, we assume that you have already launched Eclipse with <property moreinfo="none">JBoss Tools</property> installed and + also that the <property moreinfo="none">Web Development perspective</property> is the current perspective. (If not, make it + active by selecting <emphasis> + <property moreinfo="none">Window > Open Perspective > Other > Web + Development</property> + </emphasis> from the menu bar.)</para> + + <section id="StartingUp"> + <title>Starting Up</title> + <para>We are first going to create a new project for the application.</para> + <itemizedlist> + <listitem> + <para>Go to the menu bar and select <emphasis> + <property moreinfo="none">File > New > Struts Project</property> + </emphasis></para> + </listitem> + <listitem> + <para>Next enter "StrutsHello" as the project name</para> + </listitem> + <listitem> + <para>Leave everything else as it is, and click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + <listitem> + <para>If you have server runtime already defined, just pass to next point. Otherwise in the <emphasis> + <property moreinfo="none">Runtime</property></emphasis> section click the <emphasis> + <property moreinfo="none">New</property></emphasis> button and target at needed server runtime environment. Click <emphasis> + <property moreinfo="none">Finish</property>.</emphasis></para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Next</property> + </emphasis></para> + </listitem> + <listitem> + <para>Make sure that <emphasis> + <property moreinfo="none">struts-bean.tld</property> + </emphasis>, <emphasis> + <property moreinfo="none">struts-html.tld</property> + </emphasis>, and <emphasis> + <property moreinfo="none">struts-logic.tld</property> + </emphasis> are checked in the list of included tag libraries and then hit <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>A "StrutsHello" node should appear in the <property moreinfo="none">Package + Explorer view</property>.</para> + <itemizedlist> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">StrutsHello</property> + </emphasis> to reveal the child nodes</para> + </listitem> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">WebContent</property> + </emphasis> under <emphasis> + <property moreinfo="none">StrutsHello</property></emphasis></para> + </listitem> + <listitem> + <para>Click the plus sign next to <emphasis> + <property moreinfo="none">WEB-INF</property> + </emphasis> under <emphasis> + <property moreinfo="none">WebContent</property></emphasis></para> + </listitem> + <listitem> + <para>Then, double-click on the <emphasis> + <property moreinfo="none">struts-config.xml</property> + </emphasis> node to display a diagram of the Struts application configuration + file in the editing area</para> + </listitem> + </itemizedlist> + <para>At this point, its empty except for the background grid lines.</para> + </section> + + <section id="CreatingtheApplicationComponents"> + <?dbhtml filename="CreatingtheApplicationComponents.html"?> + <title>Creating the Application Components</title> + <para>Now, we will design the application by creating the individual components as + placeholders first. (We don't have to complete all of the details inside the components + until afterwards.)</para> + <section id="CreatingJSPPagePlaceholders"> + <title>Creating JSP Page Placeholders</title> + <para>Next, let's create and place two JSP pages. We will not write any code + for the files, but only create them as placeholders so that we can create links to + them in the diagram. We will write the code a little bit later.</para> + <section id="CreatingthePagePlaceholders"> + <title>Creating the Page Placeholders</title> + <itemizedlist> + <listitem> + <para>Bring the <property moreinfo="none">Web Projects view</property> to the front of the <property moreinfo="none">Package Explorer view</property> + by selecting the <emphasis> + <property moreinfo="none">Web Projects</property> + </emphasis> tab next to that tab.</para> + </listitem> + <listitem> + <para>Right-click the <emphasis> + <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent)</property> + </emphasis> folder in the <property moreinfo="none">Web Projects view</property> and select <emphasis> + <property moreinfo="none">New > Folder...</property> + </emphasis></para> + </listitem> + <listitem> + <para>Enter <emphasis> + <property moreinfo="none">pages</property> + </emphasis> for a folder name and click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + + <listitem> + <para>We will keep our presentation files in this folder</para> + </listitem> + + <listitem> + <para>Right-click the <emphasis> + <property moreinfo="none">pages</property></emphasis> folder and select <emphasis> + <property moreinfo="none">New > File > JSP...</property> + </emphasis> + </para> + </listitem> + <listitem> + <para>For Name type in <emphasis> + <property moreinfo="none">inputname</property> + </emphasis> (the JSP extension will be automatically added to the file), + for Template select <emphasis> + <property moreinfo="none">StrutsForm</property> + </emphasis> and then click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>Right-click the <emphasis> + <property moreinfo="none">pages</property></emphasis> folder again and select <emphasis> + <property moreinfo="none">New > File > JSP...</property> + </emphasis></para> + </listitem> + <listitem> + <para>For Name type in <emphasis> + <property moreinfo="none">greeting</property> + </emphasis>, for Template leave as <emphasis> + <property moreinfo="none">Blank</property>,</emphasis> and then click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + </itemizedlist> + <para>Just leave these files as is for now.</para> + </section> + <section id="PlacingthePagePlaceholders"> + <title>Placing the Page Placeholders</title> + <para>Lets now place the two pages just created on the diagram.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">struts-config.xml</property> + </emphasis> tab in the editing area to bring the diagram to the + front</para> + </listitem> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">inputname.jsp</property> + </emphasis> page in the <property moreinfo="none">Web Projects view</property>, drag it onto the diagram, and + drop it</para> + </listitem> + <listitem><para>Click on the <emphasis> + <property moreinfo="none">greeting.jsp</property> + </emphasis> page in the <property moreinfo="none">Web Projects view</property>, drag it onto the diagram, and + drop it to the right of the <emphasis> + <property moreinfo="none">/pages/inputname.jsp</property> + </emphasis> icon with some extra space</para></listitem> + </itemizedlist> + <para>You should now have two JSP pages in the diagram.</para> + </section> + </section> + <section id="CreatinganActionMappings"> + <title>Creating an Action Mappings</title> + <para>Using a context menu on the diagram, we are next going to create an Action + mapping.</para> + <itemizedlist> + <listitem> + <para>Right-click between the two icons and select <emphasis> + <property moreinfo="none">New > Action</property> + </emphasis></para> + </listitem> + <listitem> + <para>Enter the following values:</para> + </listitem> + </itemizedlist> + <table> + <title>Action values</title> + <tgroup cols="2"> + <tbody> + <row> + <entry>path</entry> + <entry>/greeting</entry> + </row> + <row> + <entry>name</entry> + <entry>GetNameForm</entry> + </row> + <row> + <entry>scope</entry> + <entry>request</entry> + </row> + <row> + <entry>type</entry> + <entry>sample.GreetingAction</entry> + </row> + <row> + <entry>validate</entry> + <entry><leave blank></entry> + </row> + </tbody> + </tgroup> + </table> + <para>("GetNameForm" is the name for a form bean that we will create + later.)</para> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + + <para>The <emphasis> + <property moreinfo="none">/greeting</property> + </emphasis> action should appear in four places, in the diagram, under the + <emphasis> + <property moreinfo="none">action-mappings</property></emphasis> node, under the <emphasis> + <property moreinfo="none">struts-config.xml</property></emphasis> node in Tree view, in <property moreinfo="none">Web Projects + view</property> and in the <property moreinfo="none">Outline view</property>. Also, note the asterisk to the right of the name, + <emphasis> + <property moreinfo="none">struts-config.xml</property>,</emphasis> in the <property moreinfo="none">Outline view</property> showing that the file has been changed, but + not saved to disk.</para> + </section> + <section id="CreatingaLink"> + <title>Creating a Link</title> + <para>Let's now create a link from the <emphasis> + <property moreinfo="none">inputname.jsp</property></emphasis> page to the action.</para> + <itemizedlist> + <listitem> + <para>On the left-hand side of the diagram in the column of icons, click on the Create New Connection + icon( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata> + </imageobject> + </inlinemediaobject>).</para> + </listitem> + </itemizedlist> + <itemizedlist> + <listitem> + <para>In the connect-the-components mode you are in now, click on the <emphasis> + <property moreinfo="none">/pages/inputname.jsp</property> + </emphasis> icon in the diagram and then click on the <emphasis> + <property moreinfo="none">/greeting</property> + </emphasis> action</para> + </listitem> + </itemizedlist> + <para>A link will be created from the page to the action.</para> + </section> + <section id="CreatingaForward"> + <title>Creating a Forward</title> + <para>Next, we are going to create a forward for the action.</para> + <itemizedlist> + <listitem> + <para>On the left-hand side of the diagram in the column of icons, click on + the Create New Connection + icon( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_1.png"></imagedata> + </imageobject> + </inlinemediaobject>), again.</para> + </listitem> + </itemizedlist> + + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">/greeting</property> + </emphasis> action icon in the diagram and then click on the <emphasis> + <property moreinfo="none">pages/greeting.jsp</property> + </emphasis> icon</para> + </listitem> + <listitem> + <para>That's it. A link will be drawn from the actions new greeting + forward to the <emphasis> + <property moreinfo="none">greeting.jsp</property></emphasis> JSP page. Note that the forwards name will be + set based on the name of the target JSP file name. If you don't + like it, you can easily change it</para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Tree</property> + </emphasis> tab at the bottom of the editor window (between Diagram and + Source)</para> + </listitem> + <listitem> + <para>Expand the <emphasis> + <property moreinfo="none">struts-config.xml/action-mappings/ /greeting</property> + </emphasis> node and then select the greeting forward</para> + </listitem> + <listitem> + <para>In the Properties Editor to the right, change the text to + "sayHello" in the <emphasis> + <property moreinfo="none">Name</property></emphasis> field</para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Diagram</property> + </emphasis> tab at the bottom of the editor window and see how the diagram + is also updated to reflect the change</para> + </listitem> + </itemizedlist> + </section> + <section id="CreatingaGlobalForward"> + <title>Creating a Global Forward</title> + <para>One last component that we need to create in the diagram is a global forward.</para> + <itemizedlist> + <listitem> + <para>Somewhere in the top-left corner of diagram, right-click and select <emphasis> + <property moreinfo="none">New > Global Forward</property> + </emphasis></para> + </listitem> + <listitem> + <para>Enter <emphasis> + <property moreinfo="none">getName</property> + </emphasis> in the <emphasis> + <property moreinfo="none">Name</property></emphasis> field</para> + </listitem> + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Change...</property> + </emphasis>button for Path</para> + </listitem> + <listitem> + <para>In the Edit Path window, switch to the <emphasis> + <property moreinfo="none">Pages</property> + </emphasis> tab</para> + </listitem> + <listitem> + <para>Expand the <emphasis> + <property moreinfo="none">StrutsHello > WEB-ROOT (WebContent) > pages</property> + </emphasis> node and then select the inputname.jsp page</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis>.</para> + </listitem> + <listitem> + <para>Leave the rest of the fields blank and click <emphasis> + <property moreinfo="none">OK</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>A forward object now appears on the diagram and also in the global-forwards folder + in the Outline view.</para> + <itemizedlist> + <listitem> + <para>Tidy up the diagram, by clicking and dragging around each icon, so that + the diagram looks something like this:</para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>Diagram View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="CreatingaFormBean"> + <title>Creating a Form Bean</title> + <para>One last thing that we need to do is to create a form bean.</para> + <itemizedlist> + <listitem> + <para>Switch to the Tree viewer in the editor for the <emphasis> + <property moreinfo="none">struts-config.xml</property></emphasis> file, by + selecting the <emphasis> + <property moreinfo="none">Tree</property> + </emphasis> tab at the bottom of the editor window</para> + </listitem> + <listitem> + <para>Right-click <emphasis> + <property moreinfo="none">struts-config.xml > form-beans</property> + </emphasis> and select Create Form Bean</para> + </listitem> + <listitem> + <para>Enter <emphasis> + <property moreinfo="none">GetNameForm</property> + </emphasis> in the name field and <emphasis> + <property moreinfo="none">sample.GetNameForm</property> + </emphasis> for type</para> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>To save your changes to struts-config.xml, select <emphasis> + <property moreinfo="none">File > Save</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + <para>Note the disappearance of the asterisk next to the name, <emphasis> + <property moreinfo="none">struts-config.xml</property>.</emphasis></para> + </section> + </section> +</chapter> + +<chapter id="generating_stub" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/generating_stub.xml" xreflabel="generating_stub"> + <?dbhtml filename="generating_stub.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Struts</keyword> + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + + <title>Generating Stub Coding</title> + <para>We are done with designing the application through the diagram. Now we need to write + code for the action component. We also need to write an action class for the <emphasis> + <property moreinfo="none">/greeting</property> + </emphasis> mapping along with a FormBean. To aid in the coding phase, JBoss Developer + Studio can generate Java class stubs for all of the components shown in the diagram.</para> + <itemizedlist> + <listitem> + <para>Switch back to the diagram, by selecting the <emphasis> + <property moreinfo="none">Diagram</property> + </emphasis> tab at the bottom of the editor window</para> + </listitem> + <listitem> + <para>Right-click a blank space in the diagram and select <emphasis> + <property moreinfo="none">Generate Java Code</property> + </emphasis></para> + </listitem> + <listitem> + <para>Leave everything as is in the dialog box and click <emphasis> + <property moreinfo="none">Generate</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>You should see a screen that says:</para> + <para>Generated classes: 2</para> + <para>Actions: 1</para> + <para>Form beans: 1</para> + <itemizedlist> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + </itemizedlist> + <para>The Java files will be generated in a <emphasis> + <property moreinfo="none">JavaSource > sample</property> + </emphasis> folder that you can see in the <property moreinfo="none">Package Explorer view</property> under the + "StrutsHello" node. One Action stub and one FormBean stub will have + been generated.</para> + </chapter> + +<chapter id="coding_files" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/coding_files.xml" xreflabel="coding_files"> + <?dbhtml filename="coding_files.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Struts</keyword> + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + + <title>Coding the Various Files</title> + <para>We will now code both the Java stub classes just generated, the JSP files left in as + placeholders from previous steps, and a new start JSP page we will have to create.</para> + <section id="JavaStubClasses"> + <title>Java Stub Classes</title> + <itemizedlist> + <listitem> + <para>To finish the two Java classes, switch to the <emphasis> + <property moreinfo="none">Package Explorer</property> + </emphasis> view and expand the <emphasis> + <property moreinfo="none">JavaSource > sample</property> + </emphasis> folder</para> + </listitem> + </itemizedlist> + <section id="GetNameForm.java"> + <title>GetNameForm.java</title> + <itemizedlist> + <listitem> + <para>Double-click <emphasis> + <property moreinfo="none">GetNameForm.java</property> + </emphasis> for editing</para> + </listitem> + + <listitem> + <para>You are looking at a Java stub class that was generated by JBoss + Tools. Now we are going to edit the file</para> + </listitem> + + <listitem> + <para>Add the following attributes at the beginning of the class:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[private String name = ""; +]]></programlisting> + + <itemizedlist> + <listitem> + <para>Inside the reset method, delete the TO DO and throw lines and + add:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[this.name = ""; +]]></programlisting> + + <itemizedlist> + <listitem> + <para>Inside the validate method, delete the TO DO and throw lines and + add:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="JAVA"><![CDATA[ActionErrors errors = new ActionErrors(); + return errors; +]]></programlisting> + + <itemizedlist> + <listitem> + <para>Right-click and select <emphasis> + <property moreinfo="none">Source > Generate Getters and Setters</property> + </emphasis>from the context menu</para> + </listitem> + <listitem> + <para>In the dialog box, check the check box for <emphasis> + <property moreinfo="none">name</property>,</emphasis> + select First method for Insertion point, and click on the <emphasis> + <property moreinfo="none">OK</property> + </emphasis> button</para> + </listitem> + </itemizedlist> + <para>The final <emphasis> + <property moreinfo="none">GetNameForm.java</property></emphasis> file should look like this:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import org.apache.struts.action.ActionErrors; +import org.apache.struts.action.ActionMapping; + +public class GetNameForm extends org.apache.struts.action.ActionForm +{ + + private String name = ""; + + public String getName() + { + return name; + } + public void setName(String name) + { + this.name = name; + } + + public GetNameForm() + { + } + + public void reset(ActionMapping actionMapping, HttpServletRequest request) + { + this.name = ""; + } + + public ActionErrors validate(ActionMapping actionMapping, + HttpServletRequest request) + { + ActionErrors errors = new ActionErrors(); + return errors; + } +} +]]></programlisting> + + <itemizedlist> + <listitem> + <para>Save the file</para> + </listitem> + </itemizedlist> + </section> + <section id="GreetingAction.java"> + <title>GreetingAction.java</title> + <itemizedlist> + <listitem> + <para>Open <emphasis> + <property moreinfo="none">GreetingAction.java</property></emphasis> for editing</para> + </listitem> + <listitem> + <para>Inside the execute method, delete the TO DO lines and add the + following:</para> + </listitem> + </itemizedlist> + + <programlisting format="linespecific" role="JAVA"><![CDATA[String name = ((GetNameForm)form).getName(); +String greeting = "Hello, "+name+"!"; +((GetNameForm)form).setName(greeting); +return mapping.findForward(FORWARD_sayHello); +]]></programlisting> + + <para>The final version of <emphasis> + <property moreinfo="none">GreetingAction.java</property></emphasis> should look like this:</para> + + <programlisting format="linespecific" role="JAVA"><![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import javax.servlet.http.HttpServletResponse; +import org.apache.struts.action.ActionForm; +import org.apache.struts.action.ActionForward; +import org.apache.struts.action.ActionMapping; + +public class GreetingAction extends org.apache.struts.action.Action +{ + + // Global Forwards + public static final String GLOBAL_FORWARD_getName = "getName"; + + // Local Forwards + public static final String FORWARD_sayHello = "sayHello"; + + public GreetingAction() + { + } + public ActionForward execute(ActionMapping mapping, ActionForm form, + HttpServletRequest request, HttpServletResponse response) throws Exception + { + String name = ((GetNameForm)form).getName(); + String greeting = "Hello, "+name+"!"; + ((GetNameForm)form).setName(greeting); + return mapping.findForward(FORWARD_sayHello); + } +} +]]></programlisting> + <itemizedlist> + <listitem> + <para>Save the file</para> + </listitem> + <listitem> + <para>Close the editors for the two Java files</para> + </listitem> + </itemizedlist> + <para>The last thing left to do is to code the JSP files whose editors should still + be open from having been created as placeholders.</para> + </section> + </section> + <section id="JSPPages"> + <title>JSP Pages</title> + <section id="inputname.jsp"> + <title>inputname.jsp</title> + <para>In this page, the user will enter any name and click the <emphasis> + <property moreinfo="none">submit</property> + </emphasis> button. Then, the greeting action will be called through the form.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">inputname.jsp</property> + </emphasis> tab in the Editing area to bring its editor forward</para> + </listitem> + <listitem> + <para>In the Web Projects view, expand <emphasis> + <property moreinfo="none">StrutsHello > Configuration > default + > struts-config.xml > action-mappings</property> + </emphasis> and select <emphasis> + <property moreinfo="none">/greeting</property> + </emphasis></para> + </listitem> + <listitem> + <para>Drag it and drop it between the quotes for the <emphasis role="italic"> + <property moreinfo="none">"action"</property> + </emphasis> attribute to the + <code><html:form></code> + element in the Source pane of the editor</para> + </listitem> + <listitem> + <para>Then type this text on a new line just below this line:</para> + <programlisting format="linespecific" role="XML"><![CDATA[Input name: + ]]></programlisting> + </listitem> + + <listitem> + <para>Select the <emphasis> + <property moreinfo="none">Visual</property> + </emphasis> pane of the editor</para> + </listitem> + <listitem> + <para>Then, in the JBoss Tools Palette, expand the <emphasis> + <property moreinfo="none">Struts Form</property> + </emphasis> library, select <emphasis> + <property moreinfo="none">text</property> + </emphasis>, and drag it onto the box + <note> + <title>Note:</title> + <para>By default there are only four groups on the JBoss Tools + Palette. If you wish to make some group visible click the <emphasis> + <property moreinfo="none">Show/Hide</property> + </emphasis> button on the top of palette and in the prompted + dialog check the group (or groups) you want to be shown.</para> + </note> + </para> + </listitem> + </itemizedlist> + <figure float="0"> + <title>JBoss Tools Palette</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>In the Insert Tag dialog box, type in name for property and select <emphasis> + <property moreinfo="none">Finish</property> + </emphasis></para> + </listitem> + <listitem> + <para>In the StrutsForm library in the <property moreinfo="none">JBoss Tools Palette</property>, select <emphasis> + <property moreinfo="none">submit</property> + </emphasis>, and drag it to right after the text box in the Visual pane + of the editor</para> + </listitem> + <listitem> + <para>Right-click the <emphasis> + <property moreinfo="none">submit</property> + </emphasis> button and select + <code><html:submit></code> + Attributes from the context menu</para> + </listitem> + <listitem> + <para>In the Attributes dialog box, select the <emphasis> + <property moreinfo="none">value</property> + </emphasis> field and type in "Say Hello!" for its + value</para> + </listitem> + </itemizedlist> + <para>After tidying the page source, the Editor window for the file should look + something like this:</para> + <figure float="0"> + <title>Editor Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="greeting.jsp"> + <title>greeting.jsp</title> + <para>Next, we will fill in the result page.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">greeting.jsp</property> + </emphasis> tab in the Editing area to bring its editor forward</para> + </listitem> + <listitem> + <para>Type in the following code:</para> + </listitem> + </itemizedlist> + <programlisting format="linespecific" role="XML"><![CDATA[<html> +<head> + <title>Greeting</title> +</head> + <body> + <p> + </p> + </body> +</html> +]]></programlisting> + + <para>To complete editing of this file, we will use macros from the <property moreinfo="none">JBoss Tools + Palette</property>. This palette is a view that should be available to the right of the + editing area.</para> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">Struts Common</property> + </emphasis> folder in the <property moreinfo="none">JBoss Tools Palette</property> to open it</para> + </listitem> + <listitem> + <para>Position the cursor at the beginning of the <emphasis> + <property moreinfo="none">greeting.jsp</property></emphasis> file in the + Source pane and then click on <emphasis> + <property moreinfo="none">bean taglib</property></emphasis> in the <property moreinfo="none">JBoss Tools + Palette</property></para> + </listitem> + </itemizedlist> + <para>This will insert the following line at the top of the file:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[ +<%@ taglib uri="/WEB-INF/struts-bean.tld" prefix="bean" %> +]]></programlisting> + <itemizedlist> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">Struts Bean</property> + </emphasis> folder in the <property moreinfo="none">JBoss Tools Palette</property> to open it</para> + </listitem> + <listitem> + <para>Position the cursor inside the + <code><p></code> + element</para> + </listitem> + <listitem> + <para>Click on <emphasis> + <property moreinfo="none">write</property></emphasis> in the <property moreinfo="none">JBoss Tools Palette</property></para> + </listitem> + <listitem> + <para>Type in "GetNameForm" for the <emphasis role="italic"> + <property moreinfo="none">name</property> + </emphasis> attribute and add a <emphasis role="italic"> + <property moreinfo="none">property</property> + </emphasis> attribute with "name" as its + value</para> + </listitem> + </itemizedlist> + <para>The editor should now look like this:</para> + <figure float="0"> + <title>Editor Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="index.jsp"> + <title>index.jsp</title> + <para>Finally, we will need to create and edit an <emphasis> + <property moreinfo="none">index.jsp</property></emphasis> page. This page will use + a Struts forward to simply redirect us to the getName global forward.</para> + <itemizedlist> + <listitem> + <para>In the Web Projects view, right-click on <emphasis> + <property moreinfo="none">StrutsHello > WEB-ROOT(WebContent)</property> + </emphasis> node and select <emphasis> + <property moreinfo="none">New > File > JSP</property> + </emphasis></para> + </listitem> + <listitem> + <para>Type <emphasis> + <property moreinfo="none">index</property></emphasis> for Name and click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button</para> + </listitem> + <listitem> + <para>On the <property moreinfo="none">JBoss Tools Palette</property>, select the <emphasis> + <property moreinfo="none">Struts Common</property> + </emphasis> folder of macros by clicking on it in the palette</para> + </listitem> + <listitem> + <para>Click on the <emphasis> + <property moreinfo="none">logic taglib</property></emphasis> icon</para> + </listitem> + <listitem> + <para>Press the <emphasis> + <property moreinfo="none">Enter</property> + </emphasis> key in the editor to go to the next line</para> + </listitem> + <listitem> + <para>Back on the palette, select the <emphasis> + <property moreinfo="none">Struts Logic</property> + </emphasis> folder of macros</para> + </listitem> + <listitem> + <para>Click on <emphasis> + <property moreinfo="none">redirect</property></emphasis></para> + </listitem> + <listitem> + <para>Delete the ending tag, put a forward slash in front of the closing + angle bracket, and type "forward=getName" in front of + the slash</para> + </listitem> + </itemizedlist> + <para>The finished code for the page is shown below:</para> + <programlisting format="linespecific" role="JAVA"><![CDATA[<%@ taglib uri="/WEB-INF/struts-logic.tld" prefix="logic" %> +<logic:redirect forward="getName"/> +]]></programlisting> + <itemizedlist> + <listitem> + <para>To save all the edits to files, select <emphasis> + <property moreinfo="none">File>Save All</property> + </emphasis> from the menu bar</para> + </listitem> + </itemizedlist> + </section> + </section> + </chapter> + +<chapter id="compiling_and_running" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/compiling_and_running.xml" xreflabel="compiling_and_running"> + <?dbhtml filename="compiling_and_running.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Struts</keyword> + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + + <title>Compiling the Classes and Running the Application</title> + + <para>As this is the Eclipse environment, no explicit compilation step is required. By + default, Eclipse compiles as you go.</para> + + <para>Thus at this point everything is ready for running our application without having to leave JBoss + Developer Studio by using the JBoss Application Server engine that comes with the JBoss + Developer Studio. For controlling JBoss AS within JBoss Developer Studio, there is JBoss + Server view.</para> + <figure float="0"> + <title>JBoss Server Panel</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/struts_application/struts_application_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <itemizedlist> + <listitem> + <para>Start up JBoss AS by clicking on the icon in JBoss Server view. (If JBoss AS + is already running, stop it by clicking on the red icon and then start it again. + Remember, the Struts run-time requires restarting the servlet engine when any + changes have been made.)</para> + </listitem> + <listitem> + <para>After the messages in the Console tabbed view stop scrolling, JBoss AS is + available. At this point, right-click on the getName global forward in the + struts-config.xml diagram view and select Run on Server.</para> + </listitem> + </itemizedlist> + <para>The browser should appear with the application started.</para> + </chapter> + +<chapter id="struts_validation" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/struts_validation.xml" xreflabel="struts_validation"> + <?dbhtml filename="struts_validation.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Struts</keyword> + <keyword>Struts Validation</keyword> + </keywordset> + </chapterinfo> +<title>Struts Validation Examples</title> + +<para><property moreinfo="none">Validation</property> of input is an important part of any Web application. All Apache Jakarta frameworks, +including Struts, can use a common Jakarta Validation Framework for streamlining this aspect of Web +application development. The Validation Framework allows you to define validation rules and then apply these rules on the client-side or the server-side.</para> + + <para>JBoss Developer Studio makes using the <property moreinfo="none">Validation Framework</property> in Struts even easier with the help of a specialized editor for the XML files that controls validation in a project. In this document, we'll show you how this all works by creating some simple client-side validation and server-side validation examples.</para> + +<section id="StartingPoint"> +<?dbhtml filename="StartingPoint.html"?> +<title>Starting Point</title> +<para>The example assumes that you have already created our sample "StrutsHello" application from the +Getting Started Guide for Creating a Struts Application. You should have the JBoss Developer Studio perspective + open on this StrutsHello project.</para> +</section> + +<section id="DefiningTheValidationRule"> +<?dbhtml filename="DefiningTheValidationRule.html"?> +<title>Defining the Validation Rule</title> +<para>In these steps you will set up the validation that can be used for either client-side or +server side validation. You need to enable validation as a part of the project, define an error message, and tie it into an appropriate part of the application.</para> + +<itemizedlist> +<listitem><para>Right-click on a "plug-ins" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml</property></emphasis> node in the Web Projects view and select <emphasis><property moreinfo="none">Create Special Plugin > Validators</property></emphasis> from the context menu</para></listitem> +<listitem><para>Further down in the Web Projects view, right-click on the +<emphasis><property moreinfo="none">StrutsHello > ResourceBundles</property></emphasis> node and select <emphasis><property moreinfo="none"> New > Properties File...</property></emphasis>from the context menu</para></listitem> +<listitem><para>In the dialog box, click on the <emphasis><property moreinfo="none">Browse...</property></emphasis>button next to the Folder field, expand the + JavaSource folder in this next dialog box, select the sample subfolder, and click on the <emphasis><property moreinfo="none">OK</property></emphasis> button</para></listitem> + <listitem><para>Back in the first dialog box, type in "applResources" for the Name field and click on the <emphasis><property moreinfo="none">Finish</property></emphasis> button</para></listitem> +<listitem><para>Right-click on a newly created file and select <emphasis><property moreinfo="none">Add > Default Error Messages</property></emphasis> + from the context menu</para></listitem> + +<listitem><para>Drag up the sample.applResources icon until you can drop it on the resources folder under struts-config.xml</para></listitem> +<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>All from the menu bar</para></listitem> +<listitem><para>Select validation.xml under the <emphasis><property moreinfo="none">StrutsHello > Validation</property></emphasis> node and double-click it to open it with the JBoss Tools XML Editor</para></listitem> +<listitem><para>Here you must create a Formset.</para></listitem> +<listitem><para>In the validation.xml file editor click the button <emphasis><property moreinfo="none">Create Formset</property></emphasis> on the panel <emphasis><property moreinfo="none">Formsets</property></emphasis></para></listitem> +<listitem><para>In the dialog <emphasis><property moreinfo="none">Add Formset</property></emphasis> fill the fields <emphasis><property moreinfo="none">Language</property></emphasis> and <emphasis><property moreinfo="none">Country</property></emphasis> or just leave them empty to create a default formset. Click <emphasis><property moreinfo="none">OK</property></emphasis></para></listitem> +</itemizedlist> +<figure float="0"> + <title>Create Formset</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/struts_validation/struts_validation.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<itemizedlist> +<listitem><para>Expand the "form-beans" node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml node.</property></emphasis> Then, drag the form bean "GetNameForm" and drop it onto a formset in the <property moreinfo="none">XML</property> Editor</para></listitem> +<listitem><para>In the Validation Editor, expand the formset node, right-click GetNameForm, and select <emphasis><property moreinfo="none">Create Field...</property></emphasis> from the context menu</para></listitem> +<listitem><para>Enter a name for Property in the dialog box. A new property will be created:</para></listitem> +</itemizedlist> +<figure float="0"> + <title>New Property Is Added</title> +<mediaobject> + <imageobject> + <imagedata fileref="images/struts_validation/struts_validation_2.png"></imagedata> + </imageobject> +</mediaobject> +</figure> +<itemizedlist> +<listitem><para>In the Properties view for the name field to the right of the "tree" for the validation.xml file, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the Depends entry field</para></listitem> +<listitem><para>In the displayed double list, select <emphasis><property moreinfo="none">required</property></emphasis> from the left list and then click <emphasis><property moreinfo="none">Add</property></emphasis></para></listitem> + <listitem><para>Click <emphasis><property moreinfo="none">Ok</property></emphasis></para></listitem> +<listitem><para>Right-click name and select <emphasis><property moreinfo="none">Add Arg...</property></emphasis> from the context menu</para></listitem> +<listitem><para>In the Add Arg dialog box, click on the <emphasis><property moreinfo="none">Change...</property></emphasis>button next to the <emphasis><property moreinfo="none">Key</property></emphasis> field</para></listitem> + <listitem><para>In the Key dialog box that appears now, click on the <emphasis><property moreinfo="none">Add</property></emphasis> button</para></listitem> + <listitem><para>Enter "name.required" in the Name field, and enter a person's name in the Value field</para></listitem> + <listitem><para>Click <emphasis><property moreinfo="none">Finish</property></emphasis>, then <emphasis><property moreinfo="none">Ok</property></emphasis>, and then <emphasis><property moreinfo="none">Ok</property></emphasis> again</para></listitem> +<listitem><para>Select <emphasis><property moreinfo="none">File > Save All</property></emphasis> from the menu bar</para></listitem> +</itemizedlist> +</section> + +<section id="Client-SideValidation"> +<?dbhtml filename="Client-SideValidation.html"?> +<title>Client-Side Validation</title> +<para>Client-side <property moreinfo="none">validation</property> uses a scripting language (like JavaScript) running in the client browser to actually do the <property moreinfo="none">validation</property>. In a Struts application using the <property moreinfo="none">Validation</property> Framework, however, you don't actually have to do any of the script coding. The <property moreinfo="none">Validation</property> Framework handles this.</para> +<para>To see how this works in our application, you'll just need to make a couple of modifications to one of the JSP files.</para> +<itemizedlist> +<listitem><para>Double-click inputname.jsp under <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages</property></emphasis> to open it for editing</para></listitem> +<listitem><para>Find the tag near the top and hit Return to make a new line under it</para></listitem> + <listitem><para>In the JBoss Tools Palette view to the right, open the Struts HTML folder and click on the javascript tag</para></listitem> +<listitem><para>Back in the editor, just in front of the closing slash for this inserted tag, hit Ctrl+Space and select "formName" from the prompting menu</para></listitem> +<listitem><para>Over in the Web Projects view, select GetNameForm under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > form-beans</property></emphasis> node, drag it, and drop it between the quotes in the editor</para></listitem> +<listitem><para>Modify the <code><html:form></code> tag by inserting this attribute:</para></listitem> +</itemizedlist> +<programlisting format="linespecific" role="XML"><![CDATA[onsubmit="return validateGetNameForm(this)" +]]></programlisting> +<para></para> +<para>The file should now look like this:</para> +<programlisting format="linespecific" role="XML"><![CDATA[ +<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> + +<html:html > + <head> + <html:javascript formName="GetNameForm"/> + <title></title> + </head> + <body> + <html:form action="/greeting.do" onsubmit="return validateGetNameForm(this)"> + Input name:<html:text property="name"/><html:submit value="Say Hello!"/> + </html:form> + </body> +</html:html> +]]></programlisting> +<itemizedlist> +<listitem><para>Select<emphasis><property moreinfo="none"> File > Save </property></emphasis>from the menu bar</para></listitem> +<listitem><para>Start JBoss Application Server by clicking on its icon (a right-pointing arrow) in the toolbar</para></listitem> + <listitem><para>Click the Run icon(<inlinemediaobject> <imageobject> + <imagedata fileref="images/struts_validation/struts_validation_1.png"></imagedata> + </imageobject></inlinemediaobject>) or right click your project folder and select <emphasis><property moreinfo="none">Run As > Run on Server</property></emphasis></para></listitem> +</itemizedlist> + +<itemizedlist><listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem></itemizedlist> +<para>A JavaScript error message should be displayed in an alert box.</para> +</section> +<section id="Server-SideValidation"> +<?dbhtml filename="Server-SideValidation.html"?> +<title>Server Side Validation</title> +<para>Server side validation does the validation inside the application on the server. In a Struts application using the Validation Framework, you still don't have to do any of the actual validation coding. The Validation Framework handles this. You will though have to make a few changes to the JSP file you modified for client-side validation along with a change to an action and a few changes to the form bean class.</para> +</section> + +<section id="EditingTheJSPFile"> +<?dbhtml filename="EditingTheJSPFile.html"?> +<title>Editing the JSP File</title> +<itemizedlist> +<listitem><para>Reopen inputname.jsp for editing</para></listitem> +<listitem><para>Delete the <emphasis role="italic"><property moreinfo="none">"onsubmit"</property></emphasis> attribute in the <code><html:form></code> element that you put in for client-side validation</para></listitem> + +<listitem><para>Add an <code><html:errors/></code> tag after the + <code><html:form></code> + tag</para></listitem> +</itemizedlist> +<para>The JSP file should now look like this:</para> + + <programlisting format="linespecific" role="XML"><![CDATA[<%@ taglib uri="/WEB-INF/struts-html" prefix="html" %> +<html:html > +<head> + <html:javascript formName="GetNameForm"/> + <title></title> + </head> + <body> + <html:form action="/greeting.do" >Input name:<html:text property="name"/> + <html:submit value="Say Hello!"/> + </html:form> + <html:errors/> + </body> +</html:html> +]]></programlisting> + +</section> + +<section id="EditingTheAction"> +<?dbhtml filename="EditingTheAction.html"?> +<title>Editing the Action</title> +<itemizedlist> +<listitem><para>In the Web Projects view, expand the node under the <emphasis><property moreinfo="none">StrutsHello > Configuration > default > struts-config.xml > action-mappings</property></emphasis> node, right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action, and then select <emphasis><property moreinfo="none">Properties...</property></emphasis>from the context menu</para></listitem> + + <listitem><para>In the Edit Properties window, insert the cursor into the value column for the input property and click on the <property moreinfo="none">...</property> button</para></listitem> + + <listitem><para>In the dialog box, make sure the Pages tab is selected, select <emphasis><property moreinfo="none">StrutsHello > WEB-ROOT(WebContent) > pages > inputname.jsp</property></emphasis>, click the <emphasis><property moreinfo="none">Ok</property></emphasis> button, and then click on the <emphasis><property moreinfo="none">Close</property></emphasis> button</para></listitem> +</itemizedlist> +</section> +<section id="EditingTheFormBean"> +<?dbhtml filename="EditingTheFormBean.html"?> + +<title>Editing the Form Bean</title> +<itemizedlist> +<listitem><para>Right-click the <emphasis><property moreinfo="none">/greeting</property></emphasis> action again and select Open Form-bean Source to open the GetNameForm.java file for editing</para></listitem> +<listitem><para>Change the class that it extends from: <emphasis><property moreinfo="none">org.apache.struts.action.ActionForm</property></emphasis> to <emphasis><property moreinfo="none">org.apache.struts.validator.ValidatorForm</property></emphasis></para></listitem> +<listitem><para>Comment out a validate method</para></listitem> +</itemizedlist> +<para>The file should now look like this:</para> +<programlisting format="linespecific" role="JAVA"><![CDATA[package sample; +import javax.servlet.http.HttpServletRequest; +import org.apache.struts.action.ActionErrors; +import org.apache.struts.action.ActionMapping; +public class GetNameForm extends + +org.apache.struts.validator.ValidatorForm +{ + + private String name = ""; + + /** + * @return Returns the name. + */ + public String getName() + { + return name; + } + + /** + * @param name The name to set. + */ + public void setName(String name) + { + this.name = name; + } + + public GetNameForm () + { + } + + public void reset(ActionMapping actionMapping, + HttpServletRequest request) + { + this.name = ""; + } + + // public ActionErrors validate(ActionMapping actionMapping, + // HttpServletRequest request) + //{ + // ActionErrors errors = new ActionErrors(); + // return errors; + // } + } +]]></programlisting> + +<itemizedlist> +<listitem><para>Select <emphasis><property moreinfo="none">File > Save All </property></emphasis>from the menu bar</para></listitem> +<listitem><para>Reload the application into JBoss AS by clicking on the "Change Time Stamp" icon (a finger pointing with a little star) in the toolbar</para></listitem> +<listitem><para>Run the application</para></listitem> +<listitem><para>In the browser window, click on the "Say Hello!" button without having entered any name in the form</para></listitem> +</itemizedlist> +<para>The error message should appear in a refreshed version of the form.</para> +</section> + +</chapter> + +<chapter id="relevant_resources" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/struts/docs/struts_tools_tutorial/en/modules/relevant_resources.xml" xreflabel="relevant_resources"> + <?dbhtml filename="relevant_resources.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Struts</keyword> + <keyword>Struts Application</keyword> + </keywordset> + </chapterinfo> + + <title>Other Relevant Resources on the topic</title> + + <para>Our reference: <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink></para> + <para>Apache Struts: <ulink url="http://struts.apache.org/">Struts Technology</ulink></para> + <para>Struts 2: <ulink url="http://struts.apache.org/2.x/">Apache Struts 2</ulink></para> + <para>Get Started: <ulink url="http://struts.apache.org/2.x/docs/home.html">Struts Getting + Started</ulink></para> + <para>Struts on IBM: <ulink url="http://www.ibm.com/developerworks/library/j-struts/">Struts - + An open-source MVC implementation</ulink></para> + <para>FAQ: <ulink url="http://struts.apache.org/2.x/docs/faqs.html">Struts FAQ</ulink></para> + <para>Download: <ulink url="http://struts.apache.org/download.cgi#struts206">Release of Apache + Struts</ulink></para> + + <para>Thus, this tutorial should help you to execute the hole development circle for building a + sample Struts-based Web application using <property moreinfo="none">JBoss Tools</property> bundle of Eclipse + plugins starting from organizing a new Struts project and ending with the running and + deploying it onto the <property moreinfo="none">JBoss Server</property>.</para> + + <para>To find out all the features of <property moreinfo="none">JBoss Tools</property> for working with Struts + refer to our <ulink url="../../struts_tools_ref_guide/html_single/index.html">Struts Tools Reference Guide</ulink>. If you + still have questions you are always welcome on <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss + Tools Forum</ulink>.</para> +</chapter> + + + +</book>

15 years

1
0
0 / 0

JBoss Tools SVN: r19397 - trunk/struts/docs/struts_tools_tutorial/en.

by jbosstools-commits＠lists.jboss.org

Author: ochikvina Date: 2009-12-17 04:31:20 -0500 (Thu, 17 Dec 2009) New Revision: 19397 Modified: trunk/struts/docs/struts_tools_tutorial/en/master.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating the plugin version; Modified: trunk/struts/docs/struts_tools_tutorial/en/master.xml =================================================================== --- trunk/struts/docs/struts_tools_tutorial/en/master.xml 2009-12-17 09:31:03 UTC (rev 19396) +++ trunk/struts/docs/struts_tools_tutorial/en/master.xml 2009-12-17 09:31:20 UTC (rev 19397) @@ -49,7 +49,7 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 3.1.0.M2 + Version: 3.1.0.CR1 </releaseinfo> <abstract>

15 years

1
0
0 / 0

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits December 2009