[jbosstools-commits] JBoss Tools SVN: r19405 - trunk/portlet/docs/reference/en/modules.

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... + + <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/Matrixofsupportedplatformsr... 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">h... + <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... + </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&amp;op=viewforum&... - >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/too... 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">... + 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/">Portletbr... 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 &gt; New &gt; Other &gt; Web &gt; 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 &gt; New &gt; 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">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</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"... + </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">... + </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">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</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>&quot;Further configuration available...&quot;</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">&quot;Creating a Dynamic Web Project with the JBoss Portlet Capabilities&quot;</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>&quot;Further configuration required...&quot;</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">&quot;JSF/Seam Portlet Wizard&quot;</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">&quot;Deploying a Portlet to JBoss Portal&quot;</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... - </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&apos;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 &gt; Other &gt; Web &gt; 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">&quot;Creating a Web Project with JBoss Portlet Capabilities&quot;</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"... + </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">&quot;Configure Seam Facet Settings&quot;</ulink> in the Chapter 2, + <ulink url="&seamlink;">&quot;Seam Dev Tools Reference Guide&quot;</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 &gt; Other &gt; Seam &gt; 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">&quot;Creating a Dynamic Web Project with Seam and JBoss Portlet Capabilities&quot;</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">&quot;JSF/Seam Portlet Wizard&quot;</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">&quot;Deploying a Portlet to JBoss Portal&quot;</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 &gt; 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&apos;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&apos;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 &gt; Preferences</property> - </emphasis> and then <emphasis> - <property>JBoss Tools &gt; 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&apos;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&apos;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&apos;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 &gt; 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&apos;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"... + </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&apos;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&apos;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 &gt; Other &gt; JBoss Tools Web &gt; Portlet &gt; 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">&quot;Java Portlet Wizard&quot;</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&apos;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 &gt; 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>