Author: irooskov(a)redhat.com Date: 2010-11-16 01:32:40 -0500 (Tue, 16 Nov 2010) New Revision: 26599 Added: trunk/ws/docs/reference/en-US/deployment-sample_web_service_wizards.xml trunk/ws/docs/reference/en-US/generation-sample_web_service_wizards.xml trunk/ws/docs/reference/en-US/preliminaries-web_service_test_view.xml trunk/ws/docs/reference/en-US/prerequisites-resteasy_simple_project_example.xml trunk/ws/docs/reference/en-US/proc-jbt-export-war_export.xml trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_web_service.xml trunk/ws/docs/reference/en-US/proc-jbt-install-add_repository.xml trunk/ws/docs/reference/en-US/proc-jbt-new_dynamic_web_project.xml trunk/ws/docs/reference/en-US/proc-jbt-new_other.xml trunk/ws/docs/reference/en-US/proc-jbt-new_project.xml trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml trunk/ws/docs/reference/en-US/proc-jbt-test_web_service_prelim.xml trunk/ws/docs/reference/en-US/proc-jbt-web_service_test_view.xml trunk/ws/docs/reference/en-US/resteasy_sample_project-web_service_test_view.xml trunk/ws/docs/reference/en-US/resteasy_simple_project_example.xml trunk/ws/docs/reference/en-US/restfulsample_project-web_service_test_view.xml trunk/ws/docs/reference/en-US/sample_restful_web_service-sample_web_service_wizards.xml trunk/ws/docs/reference/en-US/sample_web_service-sample_web_service_wizards.xml trunk/ws/docs/reference/en-US/sample_web_service_wizards.xml trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml trunk/ws/docs/reference/en-US/the_example_project-resteasy_simple_project_example.xml trunk/ws/docs/reference/en-US/web_service_test_view.xml Modified: trunk/ws/docs/reference/en-US/Author_Group.xml trunk/ws/docs/reference/en-US/Book_Info.xml trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml trunk/ws/docs/reference/en-US/Revision_History.xml trunk/ws/docs/reference/en-US/master.xml Log: integrating ben clare's tester view book into the main web services book Modified: trunk/ws/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/ws/docs/reference/en-US/Author_Group.xml 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/Author_Group.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -1,5 +1,14 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> -&lt;authorgroup&gt;&lt;author&gt;&lt;firstname&gt;Denny&lt;/firstname&gt;&lt;surname&gt;Xu&lt;/surname&gt;&lt;email&gt;dxu(a)redhat.com&lt;/email&gt;&lt;/author&gt; - <author&gt;&lt;firstname&gt;Grid&lt;/firstname&gt;&lt;surname&gt;Qian&lt;/surname&gt;&lt;email&gt;fqian(a)redhat.com&lt;/email&gt;&lt;/author&gt;&lt;/authorgroup&gt; +&lt;authorgroup&gt;&lt;author&gt;&lt;firstname&gt;Denny&lt;/firstname&gt;&lt;surname&gt;Xu&lt;/surname&gt;&lt;email&gt;dxu(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <author&gt;&lt;firstname&gt;Grid&lt;/firstname&gt;&lt;surname&gt;Qian&lt;/surname&gt;&lt;email&gt;fqian(a)redhat.com&lt;/email&gt;&lt;/author&gt;&lt;author&gt; + <firstname>Brian </firstname> + <surname>Fitzpatrick</surname> + <email&gt;bfitzpatrick(a)redhat.com&lt;/email&gt; + </author> + <author> + <firstname>Ben </firstname> + <surname>Clare</surname> + <email&gt;bclare(a)redhat.com&lt;/email&gt; + </author></authorgroup> Modified: trunk/ws/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/ws/docs/reference/en-US/Book_Info.xml 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/Book_Info.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -1,4 +1,4 @@ <?xml version='1.0' encoding='utf-8' ?> <!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ ]> -<bookinfo><title>JBoss Web Services User Guide</title><subtitle>Provides information relating to the JBoss Web Services module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>3.0.1</edition><pubsnumber>0</pubsnumber><abstract><para>The JBoss Web Services User Guide explains how to use the JBoss Web Services module to implement web services in Java.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<bookinfo><title>JBoss Web Services User Guide</title><subtitle>Provides information relating to the JBoss Web Services module.</subtitle><productname>JBoss Developer Studio</productname><productnumber>4.0</productnumber><edition>4.0.0</edition><pubsnumber>1</pubsnumber><abstract><para>The JBoss Web Services User Guide explains how to use the JBoss Web Services module to implement web services in Java.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... Modified: trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent =================================================================== --- trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.ent 2010-11-16 06:32:40 UTC (rev 26599) @@ -2,3 +2,7 @@ <!ENTITY BOOKID "JBoss_Web_Services_User_Guide"> <!ENTITY YEAR "2010"> <!ENTITY HOLDER "Red Hat"> + + +<!--<!ENTITY HORIZ_LINE "&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;&boxh;"> +--> Modified: trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml =================================================================== --- trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -9,5 +9,8 @@ <xi:include href="client.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="preference.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <!--<xi:include href="webproject.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include&g... +<xi:include href="sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +<xi:include href="resteasy_simple_project_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +<xi:include href="web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> <xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> </book> Modified: trunk/ws/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/ws/docs/reference/en-US/Revision_History.xml 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/Revision_History.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -1,4 +1,4 @@ <?xml version='1.0' encoding='utf-8' ?> -<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> -<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>1</revnumber><date>Wed Jun 09 2010</date><author><firstname>JBoss Tools</firstname><surname>Documentation Team</surname></author><revdescription><simplelist><member>General updates</member></simplelist></revdescription></revision><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> +<!--<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]>--> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>2.0</revnumber><date>Tue Nov 16 2010</date><author><firstname>JBoss</firstname><surname>Documentation Team</surname></author><revdescription><simplelist><member>Integrated Ben Clare's Web Service Test View documentation</member></simplelist></revdescription></revision><revision><revnumber>1.0</revnumber><date>Wed Jun 09 2010</date><author><firstname>JBoss Tools</firstname><surname>Documentation Team</surname></author><revdescription><simplelist><member>General updates</member></simplelist></revdescription></revision><revision><revnumber>0.0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov@redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/ws/docs/reference/en-US/deployment-sample_web_service_wizards.xml =================================================================== --- trunk/ws/docs/reference/en-US/deployment-sample_web_service_wizards.xml (rev 0) +++ trunk/ws/docs/reference/en-US/deployment-sample_web_service_wizards.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,13 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<section id="sample_web_service_wizards-sample_restful_web_service-deployment"> + <title>Deployment</title> + <para> + Once created, the sample web service can be deployed to the target runtime as described in <xref linkend="proc-jbt-export-war_export"/>. + </para> + <xi:include href="proc-jbt-export-war_export.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/generation-sample_web_service_wizards.xml =================================================================== --- trunk/ws/docs/reference/en-US/generation-sample_web_service_wizards.xml (rev 0) +++ trunk/ws/docs/reference/en-US/generation-sample_web_service_wizards.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<section id="sample_web_service_wizards-sample_restful_web_service-generation"> + <title>Generation</title> + <para> + A sample web service can be created by using the <guilabel>Create a Sample Web Service</guilabel> wizard as described in <xref linkend="proc-jbt-generate_a_sample_web_service"/> + </para> + <xi:include href="proc-jbt-generate_a_sample_web_service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</section> \ No newline at end of file Modified: trunk/ws/docs/reference/en-US/master.xml =================================================================== --- trunk/ws/docs/reference/en-US/master.xml 2010-11-16 06:29:57 UTC (rev 26598) +++ trunk/ws/docs/reference/en-US/master.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -7,6 +7,9 @@ <!ENTITY preference SYSTEM "preference.xml"> <!ENTITY webproject SYSTEM "webproject.xml"> <!ENTITY client SYSTEM "client.xml"> +<!ENTITY samplewizard SYSTEM "sample_web_service_wizards.xml"> +<!ENTITY resteasyexample SYSTEM "resteasy_simple_project_example.xml"> +<!ENTITY testview SYSTEM "web_service_test_view.xml"> ]> <book> @@ -25,7 +28,21 @@ </inlinemediaobject> </corpauthor> <author&gt;&lt;firstname&gt;Denny&lt;/firstname&gt;&lt;surname&gt;Xu&lt;/surname&gt;&lt;email&gt;dxu(a)redhat.com&lt;/email&gt;&lt;/author&gt; - <author&gt;&lt;firstname&gt;Grid&lt;/firstname&gt;&lt;surname&gt;Qian&lt;/surname&gt;&lt;email&gt;fqian(a)redhat.com&lt;/email&gt;&lt;/author&gt; + <author> + <firstname>Grid</firstname> + <surname>Qian</surname> + <email&gt;fqian(a)redhat.com&lt;/email&gt; + </author> + <author> + <firstname>Brian </firstname> + <surname>Fitzpatrick</surname> + <email&gt;bfitzpatrick(a)redhat.com&lt;/email&gt; + </author> + <author> + <firstname>Ben </firstname> + <surname>Clare</surname> + <email&gt;bclare(a)redhat.com&lt;/email&gt; + </author> <copyright> <year>2008</year> @@ -34,14 +51,14 @@ <holder>JBoss by Red Hat</holder> </copyright> <releaseinfo> - Version: 1.1.1.GA + Version: 3.2.0.GA </releaseinfo> -<abstract> +<!--<abstract> <title/> <para> <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_gui... version</ulink> </para> -</abstract> + </abstract>--> </bookinfo> @@ -51,4 +68,7 @@ &topdown; &client; &preference; + &samplewizard; + &resteasyexample; + &testview; </book> Added: trunk/ws/docs/reference/en-US/preliminaries-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/preliminaries-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/preliminaries-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<section id="web_service_test_view-testing_a_restful_web_service-preliminaries"> + <title>Preliminaries</title> + <para> + The following procedure describes the steps to perform before testing a web service. + </para> + <xi:include href="proc-jbt-test_web_service_prelim.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/prerequisites-resteasy_simple_project_example.xml =================================================================== --- trunk/ws/docs/reference/en-US/prerequisites-resteasy_simple_project_example.xml (rev 0) +++ trunk/ws/docs/reference/en-US/prerequisites-resteasy_simple_project_example.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,33 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<section id="resteasy_simple_project_example-prerequisites"> + <title>Prerequisites</title> + <para> + To be able to build the example RESTEasy project, the <application>Maven</application> plugin <application>M2Eclipse</application> should be installed. The following procedure describes installing the <application>Maven Release</application>, <application>Maven Extras</application> and <application>Subclipse</application> plugins. <application>Subclipse</application> is a dependency of <application>Maven Extras</application>. + </para> + <para> + The update site urls to add in <xref linkend="site_information"/> of the following procedure, in the order of installation, are: + </para> + <orderedlist> + <listitem> + <para> + Maven release: <ulink url="http://m2eclipse.sonatype.org/sites/m2e/">http://m2ecli... + </para> + </listitem> + <listitem> + <para> + Subclipse: <ulink url="http://subclipse.tigris.org/update_1.6.x">http://subcli... + </para> + </listitem> + <listitem> + <para> + Maven extras: <ulink url="http://m2eclipse.sonatype.org/sites/m2e-extras/">http:/... + </para> + </listitem> + </orderedlist> + <xi:include href="proc-jbt-install-add_repository.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/proc-jbt-export-war_export.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-export-war_export.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-export-war_export.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,227 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-export-war_export"> + <title>Export the project as a Web Archive (WAR)</title> + <step> + <title>Access the Export dialog</title> + <orderedlist numeration ="loweralpha"> + <listitem> + <para> + Right click on the project name in the <guilabel>Project Explorer</guilabel> view. + </para> + </listitem> + <listitem> + <para> + Select <menuchoice><guisubmenu>Export</guisubmenu><guimenuitem>WAR file</guimenuitem></menuchoice>. + </para> + </listitem> + </orderedlist> + <formalpara><title>Result:</title> + <para> + The <guilabel>Export- WAR Export</guilabel> dialog displays with the selected web project highlighted. + </para> + </formalpara> + <figure id="figure-jbt-export-war_export_01"> + <title>Export - WAR Export dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-export-war_export_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>Export - WAR Export dialog</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step id="step_02"> + <title>Complete the export dialog</title> + <para> + Define the WAR file attributes as described in <xref linkend="table-jbt-export-war_export_01"/> + </para> + <table id="table-jbt-export-war_export_01" frame='all'> + <title>Export - War Export</title> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="2*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="3*"/> + <colspec colname='c4' colwidth="4*"/> + <thead> + <row> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Web project</entry> + <entry>yes</entry> + <entry>Enter the web project name.</entry> + <entry>The project name will default to the highlighted project in the <guilabel>Project Explorer</guilabel>. A different project can be selected from the list or entered directly in the editable drop-down list.</entry> + </row> + <row> + <entry>Destination</entry> + <entry>yes</entry> + <entry>Enter or browse to the destination.</entry> + <entry>Set the destination as the <filename>build</filename> folder to store the WAR file within the project. Alternatively, deploy the project directly to the <filename>deploy</filename> directory of the target server profile.</entry> + </row> + <row> + <entry>Optimize for a specific server runtime</entry> + <entry>no</entry> + <entry>Select this box to optimize the <filename>WAR</filename> file for deployment to the targeted runtime.</entry> + <entry><!--Selecting this option will <remark>[import the necessary libraries for the target runtime] OR [??]</remark>.-->The list of available runtimes will be those configured during the project set-up or by selecting <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guimenuitem>Server</guimenuitem></menuchoice>.</entry> + </row> + </tbody> + </tgroup> + </table> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Deploy the application</title> + <para> + Copy the file to the <filename>deploy</filename> directory of the required target server profile, such as the <command>all</command> profile. Note that the WAR file destination may have already been set as the deploy directory in <xref linkend="step_02"/>. + </para> + </step> + <!-- + <step> + <title>Access the Generate a Sample Web Service dialog</title> + <para> + Click the <guibutton>Next</guibutton> button to proceed. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Generate a Sample Web Service - Project and Web Service Name</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-export-war_export_02"> + <title>Generate a Sample Web Service - Project and Web Service Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-export-war_export_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>Generate a Sample Web Service - Project and Web Service Name</para> + </textobject> + </mediaobject> + </figure> + <para>&HORIZ_LINE;</para> + </step> + <step> + <title>Define the service attributes</title> + <para> + Define the project, web service, package and class names according to the options displayed in <xref linkend="table-jbt-export-war_export_01"/> + </para> + <table id="table-jbt-export-war_export_01" frame='all'> + <title>Project and Web Service Name</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="2*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="3*"/> + <colspec colname='c5' colwidth="4*"/> + <thead> + <row> + <entry>Dialog group</entry> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Dynamic Web Project</entry> + <entry>-</entry> + <entry>yes</entry> + <entry>Enter the project name</entry> + <entry>The project name will default to the highlighted project in the <guilabel>Project Explorer</guilabel>. A different project can be selected from the list or entered directly in the editable drop-down list</entry> + </row> + <row> + <entry>Web Service</entry> + <entry>Name</entry> + <entry>yes</entry> + <entry>Enter the name for the web service</entry> + <entry>The web service name will be the url for the service as mapped in the deployment descriptor (<filename>web.xml</filename>)</entry> + </row> + <row> + <entry>Sample Web Service Class</entry> + <entry>Package</entry> + <entry>yes</entry> + <entry>Enter the package for the web service servlet</entry> + <entry>The default package for the sample web service will be displayed</entry> + </row> + <row> + <entry></entry> + <entry>Class</entry> + <entry>yes</entry> + <entry>Enter the name of the web service servlet</entry> + <entry>The default class name will correspond to the default web service name resulting in an equivalent url to servlet name mapping in the deployment descriptor (<filename>web.xml</filename>)</entry> + </row> + </tbody> + </tgroup> + </table> + <para>&HORIZ_LINE;</para> + </step> + <step><title>Generate the web service</title> + <para> + Click the <guibutton>Finish</guibutton> button to complete the web service setup. + </para> + <formalpara><title>Result:</title> + <para> + The web service classes will be generated and the web.xml file updated with the deployment details. + </para> + </formalpara> + <figure id="figure-jbt-export-war_export_04"> + <title>HelloWorld Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-export-war_export_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>HelloWorld Web Service</para> + </textobject> + </mediaobject> + </figure> + </step> + <step><title>Browse the HelloWorld.java class</title> + <para> + Double click the <classname>HelloWorld.java</classname> class and note the annotated class name and method. These annotations identify the web service entities to the server. + </para> + <figure id="figure-jbt-export-war_export_05"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-export-war_export_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + </step> + <step><title>Browse the web.xml deployment decriptor</title> + <para> + Double click the <filename>web.xml</filename> file and note the servlet mapping as defined in <xref linkend="figure-jbt-export-war_export_02"/>. + </para> + <figure id="figure-jbt-export-war_export_06"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-export-war_export_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + <para>&HORIZ_LINE;</para> + </step> + --> + </procedure> Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-export-war_export.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,266 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-generate_a_sample_restful_web_service"> + <title>Generate a sample RESTful web service</title> + <important><title>Target runtime must have RESTEasy installed</title> + <para> + The sample RESTful web service will not work unless it is deployed to a server with RESTEasy installed. + </para> + </important> + <step> + <title>Access the New - Select a wizard dialog</title> + <orderedlist numeration ="loweralpha"> + <listitem> + <para> + Right click on the project name in the <guilabel>Project Explorer</guilabel> view. + </para> + </listitem> + <listitem> + <para> + Select <menuchoice><guimenu>New</guimenu><guisubmenu>Other</guisubmenu></menuchoice>. + </para> + </listitem> + <listitem> + <para> + Click the <guilabel>Create a Sample RESTful Web Service</guilabel> label by expanding the <menuchoice><guimenu>Web Services</guimenu></menuchoice> folder. + </para> + </listitem> + </orderedlist> + <formalpara><title>Result:</title> + <para> + The <guilabel>New - Select a wizard</guilabel> dialog displays with the selected wizard type highlighted. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-generate_a_sample_restful_web_service_01"> + <title>The New - Other (Wizard selection) dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New - Other (Wizard selection) dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Access the Generate a Sample RESTful Web Service dialog</title> + <para> + Click the <guibutton>Next</guibutton> button to proceed. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Generate a Sample RESTful Web Service - Project and Web Service Name</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-generate_a_sample_restful_web_service_02"> + <title>Generate a Sample RESTful Web Service - Project and Web Service Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>Generate a Sample RESTful Web Service - Project and Web Service Name</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Define the service attributes</title> + <para> + Define the project, web service, package and class names according to the options displayed in <xref linkend="table-jbt-generate_a_sample_restful_web_service_01"/> + </para> + <table id="table-jbt-generate_a_sample_restful_web_service_01" frame='all'> + <title>Project and Web Service Name</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="2*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="3*"/> + <colspec colname='c5' colwidth="4*"/> + <thead> + <row> + <entry>Dialog group</entry> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Dynamic Web Project</entry> + <entry></entry> + <entry>yes</entry> + <entry>Enter the project name.</entry> + <entry>The project name will default to the highlighted project in the <guilabel>Project Explorer</guilabel>. A different project can be selected from the list or entered directly in the editable drop-down list.</entry> + </row> + <row> + <entry>Web Service</entry> + <entry>Name</entry> + <entry>yes</entry> + <entry>Enter the name for the web service.</entry> + <entry>The web service name will be the url for the service as mapped in the deployment descriptor (<filename>web.xml</filename>).</entry> + </row> + <row> + <entry></entry> + <entry>Update web.xml</entry> + <entry>no</entry> + <entry>Check this box to add the service to the deployment descriptor.</entry> + <entry>This option is checked by default and may be unchecked when deploying to JBoss AS 6.0 or RESTEasy 2.0 servers. Service information is not required in the deployment descriptor for these servers.</entry> + </row> + <row> + <entry>Sample Web Service Class</entry> + <entry>Package</entry> + <entry>yes</entry> + <entry>Enter the package for the web service class.</entry> + <entry>The default package for the sample web service will be displayed.</entry> + </row> + <row> + <entry></entry> + <entry>Class</entry> + <entry>yes</entry> + <entry>Enter the name of the web service class containing the JAX-RS annotated path.</entry> + <entry> + <!-- <remark> --> + This class defines the path to the web service and is referenced in the Application Class Name. The Application Class Name is declared in the deployment descriptor providing indirect access to the annotated path. + <!-- </remark> --> + </entry> + </row> + <row> + <entry></entry> + <entry>Application Class Name</entry> + <entry>yes</entry> + <entry>Enter the name of the Application Class Name.</entry> + <entry> + <!-- <remark> --> + The Application Class Name constructor instantiates objects of the web service class containing the JAX-RS annotated path, GET and POST methods. It serves as a single point of access to the application for the web server. + <!-- </remark> --> + </entry> + </row> + </tbody> + </tgroup> + </table> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Generate the web service</title> + <para> + Click the <guibutton>Finish</guibutton> button to complete the web service setup. + </para> + <formalpara><title>Result:</title> + <para> + The web service classes will be generated and the web.xml file updated with the deployment details. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-generate_a_sample_restful_web_service_03"> + <title>RESTful Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>RESTful Web Service</para> + </textobject> + </mediaobject> + </figure> + --> + </step> + <step><title>Browse the MyRESTApplication.java class</title> + <para> + Double click the <classname>MyRESTApplication.java</classname> class and note the constructor instantiating objects of type HelloWorldResource. The relevance of this will be discussed shortly. + </para> + <figure id="figure-jbt-generate_a_sample_restful_web_service_04"> + <title>Application Class - MyRESTApplication.java</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>Application Class - MyRESTApplication.java</para> + </textobject> + </mediaobject> + </figure> + </step> + <step><title>Browse the HelloWorldResource.java class</title> + <para> + Double click the <filename>HelloWorldResource.java</filename> class and note the JAX-RS annotated path and the annotated GET method. + </para> + <figure id="figure-jbt-generate_a_sample_restful_web_service_05"> + <title>HelloWorldResource.java</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>HelloWorldResource.java</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Browse the web.xml deployment descriptor</title> + <para> + Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that: + </para> + <itemizedlist> + <listitem> + <para> + the main servlet for the application is <classname>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</classname> which is given the custom name Resteasy; and + </para> + </listitem> + <listitem> + <para> + the main servlet is not mapped to a particular url as indicated by <code>/*</code>. + </para> + </listitem> + </itemizedlist> + <para> + The url for sending GET requests can be resolved as follows: + </para> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Identify the Application Class as defined in the deployment descriptor. + </para> + </listitem> + <listitem> + <para> + Note the object type instantiated in the <application>Application</application> class and added to the singleton set: <classname>HelloWorldResource</classname>. + </para> + </listitem> + <listitem> + <para> + Note the JAX-RS annotated path declared in the corresponding <classname>HelloWorldResource</classname> class: <code>@Path("/MyRESTApplication")</code> <token>[1]</token>. + </para> + </listitem> + </orderedlist> + <!-- + by viewing the class containing the JAX-RS annotated path <code>@Path("/MyRESTApplication")</code> as shoen in <xref linkend="figure-jbt-generate_a_sample_restful_web_service_04"/>. This class can be identified by viewing the Application Class defined in the deployment descriptor. Objects of type (<classname>HelloWorldResource</classname>) are instantiated and added to the singleton set in the Application Class constructor (<xref linkend="figure-jbt-generate_a_sample_restful_web_service_04"/>). The url for sending GET requests therefore resolves to http://localhost:8080/RestfulSample/MyRESTApplication. + </para> + --> + <figure id="figure-jbt-generate_a_sample_restful_web_service_06"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + <para> + The url for sending GET requests is therefore <ulink url="http://localhost:8080/ProjectName/[1]">http://localhost:8080/ProjectName/[1]</ulink> or, <ulink url="http://localhost:8080/RestfulSample/MyRESTApplication">http://localhost:8080/RestfulSample/MyRESTApplication</ulink>.<!-- Testing RESTful web services is discussed in LINK HERE WHEN DONE.--> + </para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </procedure> Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_restful_web_service.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_web_service.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_web_service.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_web_service.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,200 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-generate_a_sample_web_service"> + <title>Generate a sample web service</title> + <step> + <title>Access the New - Select a wizard dialog</title> + <orderedlist numeration ="loweralpha"> + <listitem> + <para> + Right click on the project name in the <guilabel>Project Explorer</guilabel> view. + </para> + </listitem> + <listitem> + <para> + Select <menuchoice><guimenu>New</guimenu><guisubmenu>Other</guisubmenu></menuchoice>. + </para> + </listitem> + <listitem> + <para> + Click the <guilabel>Create a Sample Web Service</guilabel> label by expanding the <menuchoice><guimenu>Web Services</guimenu></menuchoice> folder. + </para> + </listitem> + </orderedlist> + <formalpara><title>Result:</title> + <para> + The <guilabel>New - Select a wizard</guilabel> dialog displays with the selected wizard type highlighted. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-generate_a_sample_web_service_01"> + <title>The New - Other (Wizard selection) dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New - Other (Wizard selection) dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Access the Generate a Sample Web Service dialog</title> + <para> + Click the <guibutton>Next</guibutton> button to proceed. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Generate a Sample Web Service - Project and Web Service Name</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-generate_a_sample_web_service_02"> + <title>Generate a Sample Web Service - Project and Web Service Name</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>Generate a Sample Web Service - Project and Web Service Name</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Define the service attributes</title> + <para> + Define the project, web service, package and class names according to the options displayed in <xref linkend="table-jbt-generate_a_sample_web_service_01"/> + </para> + <table id="table-jbt-generate_a_sample_web_service_01" frame='all'> + <title>Project and Web Service Name</title> + <tgroup cols='5' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="2*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="1*"/> + <colspec colname='c4' colwidth="3*"/> + <colspec colname='c5' colwidth="4*"/> + <thead> + <row> + <entry>Dialog group</entry> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Dynamic Web Project</entry> + <entry></entry> + <entry>yes</entry> + <entry>Enter the project name.</entry> + <entry>The project name will default to the highlighted project in the <guilabel>Project Explorer</guilabel>. A different project can be selected from the list or entered directly in the editable drop-down list.</entry> + </row> + <row> + <entry>Web Service</entry> + <entry>Name</entry> + <entry>yes</entry> + <entry>Enter the name for the web service.</entry> + <entry>The web service name will be the url for the service as mapped in the deployment descriptor (<filename>web.xml</filename>).</entry> + </row> + <row> + <entry>Sample Web Service Class</entry> + <entry>Package</entry> + <entry>yes</entry> + <entry>Enter the package for the web service servlet.</entry> + <entry>The default package for the sample web service will be displayed.</entry> + </row> + <row> + <entry></entry> + <entry>Class</entry> + <entry>yes</entry> + <entry>Enter the name of the web service servlet.</entry> + <entry>The default class name will correspond to the default web service name resulting in an equivalent url to servlet name mapping in the deployment descriptor (<filename>web.xml</filename>).</entry> + </row> + </tbody> + </tgroup> + </table> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Generate the web service</title> + <para> + Click the <guibutton>Finish</guibutton> button to complete the web service setup. + </para> + <formalpara><title>Result:</title> + <para> + The web service classes will be generated and the web.xml file updated with the deployment details. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-generate_a_sample_web_service_03"> + <title>HelloWorld Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>HelloWorld Web Service</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para> --> + </step> + <step><title>Browse the HelloWorld.java class</title> + <para> + Double click the <classname>HelloWorld.java</classname> class and note the annotated class name and method. These annotations identify the web service entities to the server. + </para> + <figure id="figure-jbt-generate_a_sample_web_service_04"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + </step> + <step><title>Browse the web.xml deployment decriptor</title> + <para> + Double click the <filename>web.xml</filename> file and note the servlet mapping as defined in <xref linkend="figure-jbt-generate_a_sample_web_service_02"/>. Note also that: + </para> + <itemizedlist> + <listitem> + <para> + the main servlet for the application is <classname>org.jboss.samples.webservices.HelloWorld</classname> which is given the custom name HelloWorld; and + </para> + </listitem> + <listitem> + <para> + the main servlet is mapped to the particular url <code>/HelloWorld</code> <token>[1]</token>. + </para> + </listitem> + </itemizedlist> + <figure id="figure-jbt-generate_a_sample_web_service_05"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + + <para> + Upon start up, the server will write a WSDL file to the <filename>server-profile/data/wsdl/</filename> directory and the WSDL can be accessed with <ulink url="http://localhost:8080/ProjectName/[1]?WSDL">http://localhost:8080/ProjectName/[1]?WSDL</ulink> or, <ulink url="http://localhost:8080/WebServiceSample/HelloWorld?WSDL">http://localhost:8080/WebServiceSample/HelloWorld?WSDL</ulink>.<!-- Testing SOAP based web services is discussed in NEED LINK HERE WHEN DONE.--> + </para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + </procedure> Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_sample_web_service.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-install-add_repository.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-install-add_repository.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-install-add_repository.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,129 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> + +<procedure id="proc-jbt-install-add_repository"> + <title>Adding an Update Site</title> + <step> + <title>Access the Install dialog box</title> + <para> + Select <menuchoice><guimenu>Help</guimenu><guisubmenu>Install New Software</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Install - Available Software</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-install-add_repository_01"> + <title>Install - Available Software dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-install-add_repository_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>Install - Available Software dialog</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Access the Add Repository dialog</title> + <para> + Click the <menuchoice><guibutton>Add</guibutton></menuchoice> button. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Add Repository</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-install-add_repository_02"> + <title>Add Repository</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-install-add_repository_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>Add Repository dialog</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step id="site_information"> + <title>Enter the site information</title> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Enter a name for the update site such as <application>Maven Release</application> in the <guilabel>Name</guilabel> field. + </para> + </listitem> + <listitem id="update_site_url"> + <para> + Enter the <acronym>url</acronym> of the update site in the <guilabel>Location</guilabel> field. + </para> + </listitem> + </orderedlist> + </step> + <step> + <title>Add the site</title> + <para> + Once the entered details have been verified, click the <menuchoice><guibutton>OK</guibutton></menuchoice> button to begin the installation. + </para> + <para> + The plug-in details are retrieved by <application>JBoss Tools</application> and the available plug-ins will be displayed in the main window of the <guilabel>Install</guilabel> dialog box. + </para> + </step> + <step> + <title>Select the plug-ins</title> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Choose the required plug-ins and any <guilabel>Optional</guilabel> plug-ins listed by selecting the relevant check boxes. Sub-items can be selected or deselected as required. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Next</guibutton> button. + </para> + </listitem> + </orderedlist> + </step> + <step> + <title>Review the plug-ins</title> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + The plug-ins to be installed will be displayed in the <guilabel>Install Details</guilabel> screen. + </para> + </listitem> + <listitem> + <para> + Choose the <guibutton>Next</guibutton> button to continue the installation or the <guibutton>Back</guibutton> button to revise the selection. + </para> + </listitem> + </orderedlist> + </step> + <step> + <title>Review the licenses</title> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Read the license information presented on the screen. Click the <guibutton>I accept</guibutton> radio button to proceed. + </para> + </listitem> + <listitem> + <para> + Choose the <guibutton>Finish</guibutton> button to complete the installation or the <guibutton>Back</guibutton> button to revise the selection. + </para> + </listitem> + </orderedlist> + </step> + <step><title>Restart <application>JBoss Tools</application></title> + <para> + When prompted, it is recommended to restart <application>JBoss Tools</application> by clicking the <guibutton>Yes</guibutton> button. + </para> + </step> +</procedure> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/proc-jbt-new_dynamic_web_project.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-new_dynamic_web_project.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-new_dynamic_web_project.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,468 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-new_dynamic_web_project"> + <title>Creating a dynamic web project</title> + <step> + <title>Access the New Project Dialog</title> + <para> + Select <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guisubmenu>Project</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>New Project</guilabel> screen displays. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_project_01"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Define the Project Type</title> + <orderedlist numeration ="loweralpha"> + <listitem> + <para> + Click the <guilabel>Dynamic Web Project</guilabel> label by expanding the <menuchoice><guimenu>Web</guimenu></menuchoice> folder. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Next</guibutton> button to proceed. + </para> + </listitem> + </orderedlist> + <formalpara><title>Result:</title> + <para> + The <guilabel>New Dynamic Web Project</guilabel> screen displays. + </para> + </formalpara> + <figure id="figure-jbt-new_dynamic_web_project_01"> + <title>Dynamic Web Project Attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Dynamic Web Project Wizard.</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Define the Project Attributes</title> + <para> + Define the Dynamic Web Project attributes according to the options displayed in <xref linkend="table-jbt-new_dynamic_web_project_01"/> + </para> + <!-- <table id="table-jbt-new_dynamic_web_project_01" frame='all'> + <title>New JSF Project</title> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="3*"/> + <colspec colname='c4' colwidth="3*"/> + <thead> + <row> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Project Name</entry> + <entry>yes</entry> + <entry>Enter the project name.</entry> + <entry>The project name can be any name defined by the user.</entry> + </row> + <row> + <entry>Use default location (checkbox)</entry> + <entry>no</entry> + <entry>Click this option to define the project location as the default path.</entry> + <entry>The path defaults to the Workspace location.</entry> + </row> + <row> + <entry>Location</entry> + <entry>yes</entry> + <entry>Enter the path to the project.</entry> + <entry>The path will default to the Workspace location if the Use default location (checkbox) is selected.</entry> + </row> + <row> + <entry>JSF Environment</entry> + <entry>yes</entry> + <entry>Select the JSF Environment from the available options</entry> + <entry> + <para> + The JSF Environment defines the base JSF implementation to use as described in <xref linkend="table-jbt-new_dynamic_web_project_02"/>. + </para> + </entry> + </row> + <row> + <entry>Template</entry> + <entry>yes</entry> + <entry>Select the Template from the available options</entry> + <entry> + <para> + The project can be based on a template as described in <xref linkend="table-jbt-new_dynamic_web_project_03"/>. + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + --> + <table id="table-jbt-new_dynamic_web_project_01" frame='all'> + <title>New Dynamic Web Project</title> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="3*"/> + <colspec colname='c4' colwidth="3*"/> + <thead> + <row> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Project name</entry> + <entry>yes</entry> + <entry>Enter the project name.</entry> + <entry>The project name can be any name defined by the user.</entry> + </row> + <row> + <entry>Project location</entry> + <entry>yes</entry> + <entry>Click the <guilabel>Use default location</guilabel> checkbox to define the project location as the Eclipse workspace or define a custom path in the <guilabel>Location</guilabel> field.</entry> + <entry>The default location corresponds to the Eclipse workspace.</entry> + </row> + <row> + <entry>Target runtime</entry> + <entry>no</entry> + <entry>Select a pre-configured runtime from the available options or configure a new runtime environment.</entry> + <entry> + <para> + The target runtime defines the server to which the application will be deployed. + </para> + </entry> + </row> + <row> + <entry>Dynamic web module version</entry> + <entry>yes</entry> + <entry>Select the required web module version.</entry> + <entry> + <para> + This option adds support for the Java Servlet API with module versions corresponding to J2EE levels as listed in <xref linkend="table-jbt-new_dynamic_web_project_02"/>. + </para> + </entry> + </row> + <row> + <entry>Configuration</entry> + <entry>yes</entry> + <entry>Select the project configuration from the available options.</entry> + <entry> + <para> + The project can be based on either a custom or a set of pre-defined configurations as described in <xref linkend="table-jbt-new_dynamic_web_project_03"/>. + </para> + </entry> + </row> + <row> + <entry>EAR membership</entry> + <entry>no</entry> + <entry>Add the project to an existing EAR project.</entry> + <entry> + <para> + The project can be added to an existing EAR project by selecting the checkbox. Once checked, a new EAR project can be defined by clicking the <guibutton>New Project</guibutton> button. + </para> + </entry> + </row> + <row> + <entry>Working sets</entry> + <entry>no</entry> + <entry>Add the project to an existing working set.</entry> + <entry> + <para> + A working set provides the ability to group projects or project attributes in a customized way to improve access. A new working set can be defined once the <guibutton>Select</guibutton> button has been clicked. + </para> + </entry> + </row> + </tbody> + </tgroup> + </table> + <table id="table-jbt-new_dynamic_web_project_02" frame="all"> + <!-- <table id="NewJSFProject_Web_ServletVersion" frame='all'> --> + <title>New Dynamic Project - Dynamic web module version</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="4*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>2.2</entry> + <entry>This web module version corresponds to the J2EE 1.2 implementation.</entry> + </row> + <row> + <entry>2.3</entry> + <entry>This web module version corresponds to the J2EE 1.3 implementation.</entry> + </row> + <row> + <entry>2.4</entry> + <entry>This web module version corresponds to the J2EE 1.4 implementation.</entry> + </row> + <row> + <entry>2.5</entry> + <entry>This web module version corresponds to the JEE 5 implementation.</entry> + </row> + </tbody> + </tgroup> + </table> + + <table id="table-jbt-new_dynamic_web_project_03"> + <title>New Dymanic Project - Configuration</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="2*"/> + <thead> + <row> + <entry>Option</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>&lt;custom&gt;</entry> + <entry>Choosing from one of the pre-defined configurations will minimise the effort required to set up the project.</entry> + </row> + <row> + <entry>BIRT Charting Web Project</entry> + <entry>A project with the BIRT Charting Runtime Component.</entry> + </row> + <row> + <entry>BIRT Charting Web Project</entry> + <entry>A project with the BIRT Reporting Runtime Component.</entry> + </row> + <row> + <entry>CXF Web Services Project v2.5</entry> + <entry>Configures a project with CXF using Web Module v2.5 and Java v5.0.</entry> + </row> + <row> + <entry>Default Configuration for JBoss 5.0 Runtime</entry> + <entry>This option is a suitable starting point. Additional facets can be installed later to add new functionality.</entry> + </row> + <row> + <entry>Dynamic Web Project with Seam 1.2</entry> + <entry>Configures a project to use Seam v1.2.</entry> + </row> + <row> + <entry>Dynamic Web Project with Seam 2.0</entry> + <entry>Configures a project to use Seam v2.0.</entry> + </row> + <row> + <entry>Dynamic Web Project with Seam 2.1</entry> + <entry>Configures a project to use Seam v2.1.</entry> + </row> + <row> + <entry>Dynamic Web Project with Seam 2.2</entry> + <entry>Configures a project to use Seam v2.2.</entry> + </row> + <row> + <entry>JBoss WS Web Service Project v3.0</entry> + <entry>Configures a project with JBossWS using Web Module v2.5 and Java v5.0.</entry> + </row> + <row> + <entry>JavaServer Faces v1.2 Project</entry> + <entry>Configures a project to use JSF v1.2.</entry> + </row> + <row> + <entry>Minimal Configuration</entry> + <entry>The minimum required facets are installed. Additional facets can be chosen later to add functionality to the project.</entry> + </row> + + </tbody> + </tgroup> + </table> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Access the <guilabel>Java</guilabel> sub-dialog</title> + <para> + Click <guilabel>Next</guilabel> to proceed. + </para> + <formalpara> + <title>Result:</title> + <para> + The <guilabel>New Dynamic Web Project - Java</guilabel> dialog displays. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_dynamic_web_project_03"> + <title>New Dynamic Web Project - Java</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New JPA Project - Java Dialog</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Define the source and ouput folders</title> + <para> + Define the Dynamic Web Project source and output folders by adding or editing folders as required. + </para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Access the <guilabel>Web Module</guilabel> sub-dialog</title> + <para> + Click <guilabel>Next</guilabel> to proceed. + </para> + <formalpara> + <title>Result:</title> + <para> + The <guilabel>New Dynamic Web Project - Web Module</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-new_dynamic_web_project_04"> + <title>New Dynamic Web Project - Web Module</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Dynamic Web Project - Web Module Dialog</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Enter the web module settings</title> + <para> + Define the settings as listed in <xref linkend="table-jbt-new_dynamic_web_project_04"/> including the root folder for path names in the web project context and the name of the web content directory. + </para> + <table id="table-jbt-new_dynamic_web_project_04" frame='all'> + <title>New Dynamic Web Project - Web Module</title> + <tgroup cols='4' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="1*"/> + <colspec colname='c3' colwidth="3*"/> + <colspec colname='c4' colwidth="3*"/> + <thead> + <row> + <entry>Field</entry> + <entry>Mandatory</entry> + <entry>Instruction</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Context root</entry> + <entry>yes</entry> + <entry>Enter the context root for the project.</entry> + <entry>The context root identifies a web application to the server and which URLs to delegate to the application.</entry> + </row> + <row> + <entry>Content directory</entry> + <entry>yes</entry> + <entry>Enter the directory name for the web content.</entry> + <entry>Web resources such as html, jsp files and graphic files will be written to the specified content directory.</entry> + </row> + <row> + <entry>Generate web.xml deployment descriptor</entry> + <entry>no</entry> + <entry>Check this box to generate a deployment descriptor for the project.</entry> + <entry>URL to servlet mappings and servlet authentication details are written to the deployment descriptor enabling the web server to serve requests.</entry> + </row> + </tbody> + </tgroup> + </table> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Open the Java EE perspective.</title> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Click the <guibutton>Finish</guibutton> button to complete the project setup. + </para> + <formalpara><title>Result:</title> + <para> + If not already set, a dialog will appear prompting the user to open the relevant perspective. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_dynamic_web_project_05"> + <title>Open Associated Perspective Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>Opening the Java EE perspective.</para> + </textobject> + </mediaobject> + </figure> + --> + </listitem> + <listitem> + <para> + Click the <guibutton>Yes</guibutton> button to display the Java EE perspective. + </para> + <formalpara><title>Result:</title> + <para> + The project is configured and the Java EE perspective is displayed. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_dynamic_web_project_06"> + <title>Java EE Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>The Java EE perspective.</para> + </textobject> + </mediaobject> + </figure> + --> + </listitem> + </orderedlist> + <!-- + <formalpara><title>Related material</title> + <para> + Further tasks and information relating to this task are accessible from: <xref linkend="document_navigation-jpa"/>. + </para> + </formalpara> + --> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </procedure> Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-new_dynamic_web_project.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-new_other.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-new_other.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-new_other.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,43 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-new_other"> + <title>JBoss Tools New - Other (Wizard Selection)</title> + <step> + <title>Access the New - Select a wizard dialog</title> + <para> + Select <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guisubmenu>Other</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>New - Select a wizard</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-new_other_01"> + <title>JSF Tools New - Other (Wizard selection) dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_web_service_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New - Other (Wizard selection) dialog.</para> + </textobject> + </mediaobject> + </figure> + <figure id="figure-jbt-new_dynamic_web_project_01_444"> + <title>Dynamic Web Project Attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_01_444.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Dynamic Web Project Wizard.</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-new_other.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-new_project.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-new_project.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-new_project.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,35 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-new_project"> + <title>JBoss Tools Project Creation</title> + <step> + <title>Access the New Project Dialog</title> + <para> + Select <menuchoice><guimenu>File</guimenu><guisubmenu>New</guisubmenu><guisubmenu>Project</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>New Project</guilabel> screen displays. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_project_01"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + + </step> +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-new_project.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,183 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-new_project_example"> + <title>JBoss Tools New Example Project</title> + <step> + <title>Access the New Example Project Dialog</title> + <para> + Select <menuchoice><guimenu>Help</guimenu><guisubmenu>Project Examples</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>New Example Project</guilabel> dialog displays. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_project_01"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!--<para>&HORIZ_LINE;</para> + --> + </step> + <step> + <title>Define the Example Project Type</title> + <orderedlist numeration ="loweralpha"> + <listitem> + <para> + Click the <guilabel>RESTEasy Simple Example</guilabel> label by expanding the <menuchoice><guimenu>RESTEasy</guimenu></menuchoice> node. + </para> + </listitem> + <listitem> + <para> + Click the <guibutton>Finish</guibutton> button to complete the project set up. + </para> + </listitem> + </orderedlist> + <formalpara><title>Result:</title> + <para> + The <guilabel>simple</guilabel> project is configured and ready to build. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_dynamic_web_project_01"> + <title>Dynamic Web Project Attributes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_dynamic_web_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Dynamic Web Project Wizard.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + <note><title>Project requirements</title> + <para> + In the event that a message is displayed indicating some requirements could not be configured, click the <guibutton>Details</guibutton> button followed by the <guibutton>Fix</guibutton> button to rectify the problem. The message will be displayed as a result of missing plugins or a requirement to select or configure a suitable runtime. + </para> + </note> + </step> + <step> + <title>Build the project</title> + <para> + Right click on the project name and select <menuchoice><guimenu>Run As</guimenu><guisubmenu>Maven package</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <filename>simple.war</filename> file is written to the project's '<filename>target</filename> directory. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_project_01"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + + </step> + <step> + <title>Deploy the project</title> + <para> + Copy the <filename>simple.war</filename> file to the <filename>deploy</filename> directory of the required server profile such as the <filename>all</filename> profile. + </para> + <formalpara><title>Result:</title> + <para> + The <filename>simple.war</filename> file is written to the <filename>target</filename> directory. + </para> + </formalpara> + <!-- + <figure id="figure-jbt-new_project_01"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-new_project_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + --> + <!-- <para>&HORIZ_LINE;</para>--> + + </step> + <step><title>Determine the URL for the web service</title> + <para> + Double click the <filename>web.xml</filename> file and note the <parameter>jax.ws.rs.Application</parameter> paramater mapped to the <application>Application</application> class. Note also that: + </para> + <itemizedlist> + <listitem> + <para> + the main servlet for the application is <classname>org.jboss.resteasy.plugins.server.servlet.HttpServletDispatcher</classname> which is given the custom name Resteasy; and + </para> + </listitem> + <listitem> + <para> + the main servlet is mapped to the url <code>/rest-services/*</code> <token>[1]</token>. + </para> + </listitem> + </itemizedlist> + <para> + The url for sending GET requests can be resolved as follows: + </para> + <orderedlist numeration="loweralpha"> + <listitem> + <para> + Identify the <application>Application</application> class as defined in the deployment descriptor. + </para> + </listitem> + <listitem> + <para> + Note the object type (<classname>CustomerResource</classname>) instantiated in the <application>Application</application> class (<classname>ShoppingApplication</classname>) and added to the singleton set (<code>singletons.add(new CustomerResource())</code>). + </para> + </listitem> + <listitem> + <para> + Note the JAX-RS annotated path declared in the corresponding <classname>CustomerResource</classname> class: <code>@Path("/customers")</code> <token>[2]</token>. + </para> + </listitem> + </orderedlist> + <!-- + by viewing the class containing the JAX-RS annotated path <code>@Path("/MyRESTApplication")</code> as shoen in <xref linkend="figure-jbt-generate_a_sample_restful_web_service_04"/>. This class can be identified by viewing the Application Class defined in the deployment descriptor. Objects of type (<classname>HelloWorldResource</classname>) are instantiated and added to the singleton set in the Application Class constructor (<xref linkend="figure-jbt-generate_a_sample_restful_web_service_04"/>). The url for sending GET requests therefore resolves to http://localhost:8080/RestfulSample/MyRESTApplication. + </para> + --> + <figure id="figure-jbt-new_project_example_01"> + <title>web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_sample_restful_web_service_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>web.xml</para> + </textobject> + </mediaobject> + </figure> + <para> + The url for sending GET requests can be formed from <ulink url="http://localhost:8080/ProjectName/[1]/[2]">http://localhost:8080/ProjectName/[1]/[2]</ulink> or, <ulink url="http://localhost:8080/simple/rest-services/customers">http://localhost:8080/simple/rest-services/customers</ulink>.<!-- Testing RESTful web services is discussed in LINK HERE WHEN DONE-->. + </para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-new_project_example.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,282 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-test_resteasy_JAX-RS"> + <title>Testing a JAX-RS web service- POST and GET requests</title> + <step> + <substeps> + <step><title>Query the available options</title> + <para> + Following the preliminary steps described in <xref linkend="proc-jbt-test_web_service_prelim"/>, select the <guilabel>OPTIONS</guilabel> method from the operations text area. + </para> + </step> + <step> + <para> + Enter the url of the web service in the editable drop-down list <ulink url="http://localhost:8080/simple/rest-services/customers">http://localhost:8080/simple/rest-services/customers</ulink>. + </para> + </step> + <step> + <para> + Click the <guilabel>Invoke</guilabel> button + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> text area indicates that the allowed options are <code>[POST, OPTIONS]</code> as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_02"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_02"> + <title>JAX-RS RESTEasy project Body Text</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-WS RESTEasy project Body Text</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Test the POST option</title> + <substeps> + <step> + <para> + Select <guilabel>POST</guilabel> method in the the operations drop-down list. + </para> + </step> + <step> + <para> + We will post xml data to this particular web service. Complete the header details by entering <code>content-type=application/xml</code> in the text area and click <guibutton>Add</guibutton> to add it to the <guilabel>Headers</guilabel> list. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>content-type</guilabel> is added to the <guilabel>Headers</guilabel> list as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_03"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_03"> + <title>content-type header</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-WS RESTEasy project Body Text</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step><title>Enter customer details</title> + <para> + Enter the customer details in the <guilabel>Body Text</guilabel> area as displayed in <xref linkend="figure-jbt-test_resteasy_JAX-RS_04"/>. + </para> + <figure id="figure-jbt-test_resteasy_JAX-RS_04"> + <title>Customer data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicated that a record was created and lists the location as <ulink url="http://localhost:8080/simple/rest-services/cuntomers/1">http://localhost:8080/simple/rest-services/cuntomers/1</ulink> as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_05"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_05"> + <title>Customer added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer added</para> + </textobject> + </mediaobject> + </figure> + <para>The console also indicates the successful creation of the customer: <code>10:44:33,846 INFO [STDOUT] Created customer 1</code></para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + + <step id="getStart"><title>Test the GET option</title> + <substeps> + <step> + <para> + Select the <guilabel>GET</guilabel> method in the the operations drop-down list. + </para> + </step> + <step> + <para> + We will retrieve the record created in the previous step. Enter the url for the record returned in the previous step <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step id="getFinish"> + <para> + Click the <guibutton>Invoke</guibutton> button. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a <code>[HTTP/1.1 200 OK]</code> response and the customer data is retrieved and displayed in the <guilabel>Response Body</guilabel> area as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_06"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_06"> + <title>GET response</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>GET response</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + + + <step><title>Test the PUT option</title> + <substeps> + <step> + <para> + Editing a record is achieved by using the <guilabel>PUT</guilabel> method. Select the <guilabel>PUT</guilabel> method in the operations drop-down list. + </para> + </step> + <step> + <para> + Enter the url of the record to be edited <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step> + <para> + Enter the data in the <guilabel>Body Text</guilabel> area. Replace the first-name with a different entry as in <xref linkend="figure-jbt-test_resteasy_JAX-RS_07"/> + </para> + <figure id="figure-jbt-test_resteasy_JAX-RS_07"> + <title>Updated customer data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_07.png" format="PNG"/> + </imageobject> + <textobject> + <para>Updated customer data</para> + </textobject> + </mediaobject> + </figure> +<!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <para> + Ensure that the <code>content-type=application/xml</code> header is in the <guilabel>Headers</guilabel> list. + </para> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a No Response (<code>[HTTP/1.1 204 No Content]</code>) <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_08"> + <title>Response header following PUT</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_08.png" format="PNG"/> + </imageobject> + <textobject> + <para>Response header following PUT</para> + </textobject> + </mediaobject> + </figure> + <para>In this instance, the console does not indicate an update was performed, however, the console may provide useful information following an operation.</para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Check the updated data with a GET</title> + <para> + Perform a GET operation by following the steps in <xref linkend="getStart"/>. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Body</guilabel> area displays the updated data. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_09"> + <title>Custmer data updated</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data updated</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + + <step><title>Test the DELETE option</title> + <substeps> + <step> + <para> + Deleting a record is a similar process to posting. Select the <guilabel>DELETE</guilabel> method in the operations drop-down list. + </para> + </step> + <step> + <para> + Enter the url of the record to be deleted <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a No Response (<code>[HTTP/1.1 204 No Content]</code>) as was the case for the PUT operation in <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>. + </para> + </formalpara> + <para>Once again, the console does not indicate an update was performed, however, the console may provide useful information following an operation.</para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Check the DELETE operation with a GET</title> + <para> + Perform a GET operation by following the steps in <xref linkend="getStart"/>. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Body</guilabel> area returns an error report indicating that <code>The requested resource () is not available</code> and the <guilabel>Response Headers</guilabel> area returns a <code>[HTTP/1.1 404 Not Found]</code>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_10"> + <title>Custmer data deleted</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data deleted</para> + </textobject> + </mediaobject> + </figure> + <para>The response header and body messages indicate that the data was successfully deleted.</para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + + +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-RS.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,112 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-test_JAX-WS"> + <title>Testing a JAX-WS web service</title> + <step> + <para> + Following the preliminary steps described in <xref linkend="proc-jbt-test_web_service_prelim"/>, select <guilabel>JAX-WS</guilabel> from the available combo box options. + </para> + <formalpara><title>Result:</title> + <para> + The SOAP message details are displayed in the <guilabel>Body Text</guilabel> textbox of the <guilabel>Request Details</guilabel> panel. + </para> + </formalpara> + <figure id="figure-jbt-test_JAX-WS_02"> + <title>JAX-WS Body Text</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_JAX-WS_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-WS Body Text</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <para> + Enter the location of the WSDL file in the editable dropdown list. The location for the <application>WebServiceSample</application> web service is <ulink url="http://localhost:8080/WebServiceSample/HelloWorld?WSDL"> http://localhost:8080/WebServiceSample/HelloWorld?WSDL</ulink> + </para> + <!--<para>&HORIZ_LINE;</para> --> + </step> + <step> + <para> + Click the <guibutton>Invoke</guibutton> button. + </para> + + <formalpara><title>Result:</title> + <para> + The <guilabel>Select WDSL</guilabel> dialog appears. + </para> + </formalpara> + <figure id="figure-jbt-test_JAX-WS_03"> + <title>Select WSDL</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_JAX-WS_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>Select WSDL</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <title>Select the required service attributes</title> + <para> + Select the <guilabel>Service</guilabel>, <guibutton>Port</guibutton> and <guibutton>Operation</guibutton> from the combo boxes and click <guibutton>OK</guibutton>. + </para> + <formalpara><title>Results:</title> + <para> + The &lt;soap:Body/&gt; section of the SOAP message is filled with the SayHello message details. + </para> + </formalpara> + <figure id="figure-jbt-test_JAX-WS_04"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_JAX-WS_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + <para> + The response header details are returned. + </para> + <figure id="figure-jbt-test_JAX-WS_05"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_JAX-WS_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + <para> + The response message body is displayed in the <guilabel>Response Body</guilabel> textbox. + </para> + <figure id="figure-jbt-test_JAX-WS_06"> + <title>JBoss Tools Project Creation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_JAX-WS_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>The New Project Dialog.</para> + </textobject> + </mediaobject> + </figure> + <para>These results indicate a successful test.</para> + <!-- <para>&HORIZ_LINE;</para> --> + </step> +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-test_JAX-WS.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,282 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-test_resteasy_JAX-RS"> + <title>Testing a JAX-RS web service- POST and GET requests</title> + <step> + <substeps> + <step><title>Query the available options</title> + <para> + Following the preliminary steps described in <xref linkend="proc-jbt-test_web_service_prelim"/>, select the <guilabel>OPTIONS</guilabel> method from the operations text area. + </para> + </step> + <step> + <para> + Enter the url of the web service in the editable drop-down list <ulink url="http://localhost:8080/simple/rest-services/customers">http://localhost:8080/simple/rest-services/customers</ulink>. + </para> + </step> + <step> + <para> + Click the <guilabel>Invoke</guilabel> button + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> text area indicates that the allowed options are <code>[POST, OPTIONS]</code> as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_02"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_02"> + <title>JAX-RS RESTEasy project Body Text</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-WS RESTEasy project Body Text</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Test the POST option</title> + <substeps> + <step> + <para> + Select <guilabel>POST</guilabel> method in the the operations drop-down list. + </para> + </step> + <step> + <para> + We will post xml data to this particular web service. Complete the header details by entering <code>content-type=application/xml</code> in the text area and click <guibutton>Add</guibutton> to add it to the <guilabel>Headers</guilabel> list. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>content-type</guilabel> is added to the <guilabel>Headers</guilabel> list as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_03"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_03"> + <title>content-type header</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-WS RESTEasy project Body Text</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + <step><title>Enter customer details</title> + <para> + Enter the customer details in the <guilabel>Body Text</guilabel> area as displayed in <xref linkend="figure-jbt-test_resteasy_JAX-RS_04"/>. + </para> + <figure id="figure-jbt-test_resteasy_JAX-RS_04"> + <title>Customer data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_04.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicated that a record was created and lists the location as <ulink url="http://localhost:8080/simple/rest-services/cuntomers/1">http://localhost:8080/simple/rest-services/cuntomers/1</ulink> as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_05"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_05"> + <title>Customer added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_05.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer added</para> + </textobject> + </mediaobject> + </figure> + <para>The console also indicates the successful creation of the customer: <code>10:44:33,846 INFO [STDOUT] Created customer 1</code></para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + + <step id="getStart"><title>Test the GET option</title> + <substeps> + <step> + <para> + Select the <guilabel>GET</guilabel> method in the the operations drop-down list. + </para> + </step> + <step> + <para> + We will retrieve the record created in the previous step. Enter the url for the record returned in the previous step <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step id="getFinish"> + <para> + Click the <guibutton>Invoke</guibutton> button. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a <code>[HTTP/1.1 200 OK]</code> response and the customer data is retrieved and displayed in the <guilabel>Response Body</guilabel> area as shown in <xref linkend="figure-jbt-test_resteasy_JAX-RS_06"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_06"> + <title>GET response</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_06.png" format="PNG"/> + </imageobject> + <textobject> + <para>GET response</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + + + <step><title>Test the PUT option</title> + <substeps> + <step> + <para> + Editing a record is achieved by using the <guilabel>PUT</guilabel> method. Select the <guilabel>PUT</guilabel> method in the operations drop-down list. + </para> + </step> + <step> + <para> + Enter the url of the record to be edited <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step> + <para> + Enter the data in the <guilabel>Body Text</guilabel> area. Replace the first-name with a different entry as in <xref linkend="figure-jbt-test_resteasy_JAX-RS_07"/> + </para> + <figure id="figure-jbt-test_resteasy_JAX-RS_07"> + <title>Updated customer data</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_07.png" format="PNG"/> + </imageobject> + <textobject> + <para>Updated customer data</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + <step> + <para> + Ensure that the <code>content-type=application/xml</code> header is in the <guilabel>Headers</guilabel> list. + </para> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a No Response (<code>[HTTP/1.1 204 No Content]</code>) <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_08"> + <title>Response header following PUT</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_08.png" format="PNG"/> + </imageobject> + <textobject> + <para>Response header following PUT</para> + </textobject> + </mediaobject> + </figure> + <para>In this instance, the console does not indicate an update was performed, however, the console may provide useful information following an operation.</para> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Check the updated data with a GET</title> + <para> + Perform a GET operation by following the steps in <xref linkend="getStart"/>. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Body</guilabel> area displays the updated data. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_09"> + <title>Custmer data updated</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_09.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data updated</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + + <step><title>Test the DELETE option</title> + <substeps> + <step> + <para> + Deleting a record is a similar process to posting. Select the <guilabel>DELETE</guilabel> method in the operations drop-down list. + </para> + </step> + <step> + <para> + Enter the url of the record to be deleted <ulink url="http://localhost:8080/simple/rest-services/customers/1">http://localhost:8080/simple/rest-services/customers/1</ulink> + </para> + </step> + <step> + <para>Click the <guibutton>Invoke</guibutton> button.</para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> area indicates a No Response (<code>[HTTP/1.1 204 No Content]</code>) as was the case for the PUT operation in <xref linkend="figure-jbt-test_resteasy_JAX-RS_08"/>. + </para> + </formalpara> + <para>Once again, the console does not indicate an update was performed, however, the console may provide useful information following an operation.</para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step><title>Check the DELETE operation with a GET</title> + <para> + Perform a GET operation by following the steps in <xref linkend="getStart"/>. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Body</guilabel> area returns an error report indicating that <code>The requested resource () is not available</code> and the <guilabel>Response Headers</guilabel> area returns a <code>[HTTP/1.1 404 Not Found]</code>. + </para> + </formalpara> + <figure id="figure-jbt-test_resteasy_JAX-RS_10"> + <title>Custmer data deleted</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_resteasy_JAX-RS_10.png" format="PNG"/> + </imageobject> + <textobject> + <para>Customer data deleted</para> + </textobject> + </mediaobject> + </figure> + <para>The response header and body messages indicate that the data was successfully deleted.</para> + <!--<para>&HORIZ_LINE;</para>--> + </step> + + +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-test_resteasy_JAX-RS.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,78 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-test_restfulsample_JAX-RS"> + <title>RestfulSample test</title> + <step> + <substeps> + <step><title>Query the available options</title> + <para> + Select <guilabel>OPTIONS</guilabel> from the available combo box options. + </para> + </step> + <step> + <para> + Enter the url of the web service in the editable drop-down list: <ulink url="http://localhost:8080/RestfulSample/MyRESTApplication">http://localhost:8080/RestfulSample/MyRESTApplication</ulink>. + </para> + </step> + <step> + <para> + Click the <guilabel>Invoke</guilabel> button + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Headers</guilabel> text area indicates that the allowed options are <code>[GET, OPTIONS, HEAD]</code> as shown in <xref linkend="figure-jbt-test_restfulsample_JAX-RS_02"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_restfulsample_JAX-RS_02"> + <title>JAX-RS Response Header Text</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_restfulsample_JAX-RS_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-RS Response Header Text</para> + </textobject> + </mediaobject> + </figure> + <!--<para>&HORIZ_LINE;</para>--> + </step> + </substeps> + </step> + <step> + <title>Test the GET request</title> + <substeps> + <step> + <para> + Having established that the <guilabel>GET</guilabel> request is valid, select <guilabel>GET</guilabel> from the available combo box options. + </para> + </step> + <step> + <para> + Click the <guilabel>Invoke</guilabel> button. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Response Body</guilabel> text area displays the expected <quote>Hello World</quote> text as shown in <xref linkend="figure-jbt-test_restfulsample_JAX-RS_03"/>. + </para> + </formalpara> + <figure id="figure-jbt-test_restfulsample_JAX-RS_03"> + <title>JAX-RS Response Body Text</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-test_restfulsample_JAX-RS_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>JAX-RS Response Body Text</para> + </textobject> + </mediaobject> + </figure> + </step> + </substeps> + <!-- <para>&HORIZ_LINE;</para> --> + </step> +</procedure> + + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-test_restfulsample_JAX-RS.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-test_web_service_prelim.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-test_web_service_prelim.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-test_web_service_prelim.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,60 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-test_web_service_prelim"> + <title>Testing a JAX-RS web service</title> + <step><title>Preliminary steps</title> + <para> + Prior to testing a web service: + </para> + <substeps> + <step> + <para> + The <guilabel>Web Service Test View</guilabel> should be opened as described in <xref linkend="proc-jbt-web_service_test_view"></xref>; + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Web Service Test View</guilabel> displays. + </para> + </formalpara> + <figure id="proc-jbt-test_web_service_01"> + <title>Web Service Test View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-web_service_test_view_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>Web Service Test View</para> + </textobject> + </mediaobject> + </figure> + </step> + <step> + <para> + A web service has been deployed to the <filename>deploy</filename> directory of the chosen server profile as described in: + <itemizedlist> + <listitem> + <para> + <xref linkend="proc-jbt-export-war_export"/> for the <application>RestfulSample</application> project; or + </para> + </listitem> + <listitem> + <para> + <xref linkend="proc-jbt-new_project_example"/> for the <application>RESTEasy</application> sample project. + </para> + </listitem> + </itemizedlist> + </para> + </step> + <step> + <para> + The server has been started with <command>run.sh -c &lt;profile&gt;</command> + </para> + </step> + </substeps> + <!-- <para>&HORIZ_LINE;</para>--> + </step> +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-test_web_service_prelim.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/proc-jbt-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,164 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Tools_Reference_Guide_Template.ent"> +%BOOK_ENTITIES; +]>--> +<procedure id="proc-jbt-web_service_test_view"> + <title>Web Services Test View</title> + <step> + <title>Access the Show View dialog</title> + <substeps> + <step> + <para> + Select <menuchoice><guimenu>Window</guimenu><guisubmenu>Show View</guisubmenu><guisubmenu>Other</guisubmenu></menuchoice> + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Show View</guilabel> dialog displays. + </para> + </formalpara> + </step> + <step> + <para> + Click on the <guilabel>Web Services Tester</guilabel> label by expanding the <guilabel>JBoss Tools Web Services</guilabel> node and click <guibutton>OK</guibutton>. + </para> + <formalpara><title>Result:</title> + <para> + The Web Services test view displays. + </para> + </formalpara> + <figure id="figure-jbt-web_service_test_view"> + <title>Web Service Test View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-web_service_test_view_01.png" format="PNG"/> + </imageobject> + <textobject> + <para>Web Service Test View</para> + </textobject> + </mediaobject> + </figure> + <!-- <para>&HORIZ_LINE;</para>--> + </step> + </substeps> + <para> + The main components of the Web Service Tester View are: + </para> + <itemizedlist> + <listitem> + <para> + WSDL path/button bar (<xref linkend="table-jbt-web_service_test_view_01"/>) + </para> + </listitem> + <listitem> + <para> + Request details panel (<xref linkend="table-jbt-web_service_test_view_02"/>) + </para> + </listitem> + <listitem> + <para> + Response details panel (<xref linkend="table-jbt-web_service_test_view_03"/>) + </para> + </listitem> + </itemizedlist> + <table id="table-jbt-web_service_test_view_01" frame='all'> + <title>WSDL path/button bar</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <thead> + <row> + <entry>Component</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Editable dropdown list</entry> + <entry>Enter the location of the WSDL file or HTTP address of the service to be tested. The combo box requires the path to the WSDL in a URI format.</entry> + </row> + <row> + <entry>Combo box</entry> + <entry>Select the type of service to test. The options are <guilabel>JAX-WS</guilabel> or any other option to test a <guilabel>JAX-RS</guilabel> service using HTTP request methods (<methodname>PUT</methodname>, <methodname>GET</methodname>, <methodname>POST</methodname>, <methodname>DELETE</methodname> or <methodname>OPTIONS</methodname>).</entry> + </row> + <row> + <entry>Toolbar button - Get From WSDL</entry> + <entry> + Click this button to display the <guilabel>Select WSDL</guilabel> dialog. Enter the <guibutton>URL</guibutton>, <guibutton>File system</guibutton> location or Eclipse <guibutton>Workspace</guibutton> location of the WSDL file. Given a vaild file, the dialog will allow selection of the <guilabel>Port</guilabel> and <guilabel>Operation</guilabel> to test. Once selected, the request details will be displayed in the <guilabel>Request Details</guilabel> panel. + </entry> + </row> + <row> + <entry>Toolbar button - Invoke</entry> + <entry>Once the WSDL file has been selected, the service can be invoked by clicking this button. Reponse details will be displayed in the <guilabel>Response Details</guilabel> panel.</entry> + </row> + </tbody> + </tgroup> + </table> + <table id="table-jbt-web_service_test_view_02" frame='all'> + <title>Request details panel</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <thead> + <row> + <entry>Component</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Prompt for Basic Authentication</entry> + <entry>Select this check box to send a username and password with the request. Entering the user details for each subsequent request is not necessary as the details are stored in memory.</entry> + </row> + <row> + <entry>Headers</entry> + <entry>Enter (<guibutton>Add</guibutton>) one or more <varname>name</varname>=<literal>value</literal> pairs. These headers will be passed with the invocation request at the HTTP level where possible.</entry> + </row> + <row> + <entry>Parameters</entry> + <entry>As for header information, enter one or more <varname>name</varname>=<literal>value</literal> pairs by clicking the <guibutton>Add</guibutton> button.</entry> + </row> + <row> + <entry>Body</entry> + <entry>Enter the JAX-WS SOAP request messages or input for JAX-RS service invocations in this text box.</entry> + </row> + </tbody> + </tgroup> + </table> + <table id="table-jbt-web_service_test_view_03" frame='all'> + <title>Response details panel</title> + <tgroup cols='2' align='left' colsep='1' rowsep='1'> + <colspec colname='c1' colwidth="1*"/> + <colspec colname='c2' colwidth="3*"/> + <thead> + <row> + <entry>Component</entry> + <entry>Description</entry> + </row> + </thead> + + <tbody> + <row> + <entry>Response headers</entry> + <entry>The headers returned by the service invocation will be displayed in this panel.</entry> + </row> + <row> + <entry>Response body</entry> + <entry>The JAX-WS and JAX-RS response bodies will be displayed in this box. The raw text returned form the web service invocation can be displayed by clicking the <guibutton>Show Raw</guibutton> button. The output will be embedded in a html browser by clicking the <guibutton>Show in Browser</guibutton> button. The output can alternatively be displayed in the Eclipse editor as xml or raw text (depending on the response content type) by clicking the <guibutton>Show in Editor</guibutton> button.</entry> + </row> + <row> + <entry>Parameters</entry> + <entry>As for header information, enter one or more <varname>name</varname>=<literal>value</literal> pairs by clicking the <guibutton>Add</guibutton> button.</entry> + </row> + <row> + <entry>Body</entry> + <entry>Enter JAX-WS SOAP request messages and input for JAX-RS service invocations in this text box.</entry> + </row> + </tbody> + </tgroup> + </table> + </step> +</procedure> + Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-web_service_test_view.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/resteasy_sample_project-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/resteasy_sample_project-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/resteasy_sample_project-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="web_service_test_view-testing_a_restful_web_service-resteasy_sample_project"> + <title>RESTEasy sample project</title> + <para> + + </para> + <xi:include href="proc-jbt-test_resteasy_JAX-RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/resteasy_simple_project_example.xml =================================================================== --- trunk/ws/docs/reference/en-US/resteasy_simple_project_example.xml (rev 0) +++ trunk/ws/docs/reference/en-US/resteasy_simple_project_example.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,13 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<chapter id="resteasy_simple_project_example"> + <title>RestEasy simple project example</title> + <para> + JBoss Tools includes many example projects which are available by selecting <menuchoice><guimenu>Help</guimenu><guisubmenu>Project Examples</guisubmenu></menuchoice>. The following sections describe setting up the example RESTEasy project. This project serves as a good example for testing the numerous <guilabel>Web Service Test View</guilabel> functions. + </para> + <!-- <xi:include href="prerequisites-resteasy_simple_project_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> + <xi:include href="the_example_project-resteasy_simple_project_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/restfulsample_project-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/restfulsample_project-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/restfulsample_project-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="web_service_test_view-testing_a_restful_web_service-restfulsample_project"> + <title>RestfulSample project</title> + <para> + + </para> + <xi:include href="proc-jbt-test_restfulsample_JAX-RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/sample_restful_web_service-sample_web_service_wizards.xml =================================================================== --- trunk/ws/docs/reference/en-US/sample_restful_web_service-sample_web_service_wizards.xml (rev 0) +++ trunk/ws/docs/reference/en-US/sample_restful_web_service-sample_web_service_wizards.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,13 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]> --> +<section id="sample_web_service_wizards-sample_restful_web_service"> + <title>Sample RESTful Web Service</title> + <para> + A sample Restful web service can be generated by following the steps outlined in <xref linkend="proc-jbt-generate_a_sample_restful_web_service"/>. + </para> + <xi:include href="proc-jbt-generate_a_sample_restful_web_service.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/sample_web_service-sample_web_service_wizards.xml =================================================================== --- trunk/ws/docs/reference/en-US/sample_web_service-sample_web_service_wizards.xml (rev 0) +++ trunk/ws/docs/reference/en-US/sample_web_service-sample_web_service_wizards.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,18 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]> --> +<section id="sample_web_service_wizards-sample_web_service"> + <title>Sample Web Service</title> + <para> + These sections describe how to generate and deploy a sample web service. + </para> + <!-- + <xi:include href="proc-jbt-new_other.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> + <xi:include href="generation-sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="deployment-sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/sample_web_service_wizards.xml =================================================================== --- trunk/ws/docs/reference/en-US/sample_web_service_wizards.xml (rev 0) +++ trunk/ws/docs/reference/en-US/sample_web_service_wizards.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,31 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; +]> --> +<chapter id="sample_web_service_wizards"> + <title>Sample Web Service wizards</title> + <para> + JBoss Tools includes wizards for the creation of sample web services. These include: + </para> + <itemizedlist> + <listitem> + <para> + <guilabel>Create a sample Web Service</guilabel> for a JAX-WS web service; and + </para> + </listitem> + <listitem> + <para> + <guilabel>Create a sample RESTful Web Service</guilabel> for a JAX-WS web service. + </para> + </listitem> + </itemizedlist> + <para> + These wizards are used within a Dynamic Web project. A dynamic web project can be created by following the steps in <xref linkend="proc-jbt-new_dynamic_web_project"/>. + </para> + <xi:include href="proc-jbt-new_dynamic_web_project.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + + <xi:include href="sample_web_service-sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="sample_restful_web_service-sample_web_service_wizards.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> Added: trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/testing_a_restful_web_service-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,52 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="web_service_test_view-testing_a_restful_web_service"> + <title>Testing a RESTful Web Service</title> + <para> + Testing a RESTful (<acronym>JAX-RS</acronym>) web service is achieved by following a similar procedure to testing a JAX-WS web service. Instead of selecting the JAX-WS option in the combo box, the JAX-RS service is invoked by sending HTTP method requests of the form OPTIONS, GET, POST, PUT and DELETE. As there is no WSDL file associated with a JAX-RS service, the available options can be determined by selecting <guilabel>OPTIONS</guilabel> in the combo box. + </para> + <para> + A JAX-RS web service can be tested by using the <guilabel>Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-RS test is specified by: + </para> + <orderedlist> + <listitem> + <para> + Selecting the <guilabel>OPTIONS</guilabel> combo box option. + </para> + </listitem> + <listitem id="restful_step2"> + <para> + Entering the url of the JAX-RS web service. + </para> + </listitem> + </orderedlist> + <para> + The test procedure is discussed in the following sections for both the <application>RestfulSample</application> and the <application>RESTEasy</application> sample projects developed earlier. + </para> + <xi:include href="restfulsample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="resteasy_sample_project-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- + <formalpara><title>Testing a JAX-RS web service - Preliminaries</title> + <para> + <xref linkend="proc-jbt-test_JAX-RS_prelim"/> lists the preliminary steps required before testing a JAX-RS web service project. + </para> + </formalpara> + <xi:include href="proc-jbt-test_JAX-RS_prelim.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + + <formalpara><title>Testing a basic JAX-RS web service - The RestfulSample project.</title> + <para> + <xref linkend="proc-jbt-test_basic_JAX-RS"/> demonstrates testing the <application>RestfulSample</application> project developed in <xref linkend="proc-jbt-generate_a_sample_restful_web_service"/>. + </para> + </formalpara> + <xi:include href="proc-jbt-test_basic_JAX-RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <formalpara><title>Testing a JAX-RS web service with POST and DELETE options- The simple project.</title> + <para> + <xref linkend="proc-jbt-test_JAX-RS"/> demonstrates testing the <application>simple</application> project developed in <xref linkend="proc-jbt-new_project_example"/>. + </para> + </formalpara> + <xi:include href="proc-jbt-test_JAX-RS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + --> +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/testing_a_web_service-web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,43 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="web_service_test_view-testing_a_web_service"> + <title>Testing a Web Service</title> + <para> + A JAX-WS web service can be tested by using the <guilabel>Web Service Tester View </guilabel> displayed in <xref linkend="figure-jbt-web_service_test_view"/>. The JAX-WS test is specified by: + </para> + <orderedlist> + <listitem> + <para> + Selecting the <guilabel>JAX-WS</guilabel> combo box option. + </para> + </listitem> + <listitem id="step2"> + <para> + Entering the location of the WDSL file. + </para> + </listitem> + </orderedlist> + <para> + Step <xref linkend="step2"/> can be performed in a number of ways including: + </para> + <itemizedlist> + <listitem> + <para> + entering the location directly in the editable dropdown list; or + </para> + </listitem> + <listitem> + <para> + clicking the <guibutton>Get from WSDL file</guibutton> button and entering the <guibutton>URL</guibutton>, <guibutton>Eclipse workspace</guibutton> or <guibutton>File system</guibutton> details. + </para> + </listitem> + </itemizedlist> + <para> + <xref linkend="proc-jbt-test_JAX-WS"/> demonstrates testing the <application>WebServiceSample</application> project developed in <xref linkend="proc-jbt-generate_a_sample_web_service"/>. + </para> + <xi:include href="proc-jbt-test_JAX-WS.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/the_example_project-resteasy_simple_project_example.xml =================================================================== --- trunk/ws/docs/reference/en-US/the_example_project-resteasy_simple_project_example.xml (rev 0) +++ trunk/ws/docs/reference/en-US/the_example_project-resteasy_simple_project_example.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,14 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]>--> +<section id="resteasy_simple_project_example-the_example_project"> + <title>The example project</title> + <para> + Once the required plugins have been installed, the example project can be set up as described in <xref linkend="proc-jbt-new_project_example"/> + </para> + + <xi:include href="proc-jbt-new_project_example.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + +</section> \ No newline at end of file Added: trunk/ws/docs/reference/en-US/web_service_test_view.xml =================================================================== --- trunk/ws/docs/reference/en-US/web_service_test_view.xml (rev 0) +++ trunk/ws/docs/reference/en-US/web_service_test_view.xml 2010-11-16 06:32:40 UTC (rev 26599) @@ -0,0 +1,19 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!--<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +<!ENTITY % BOOK_ENTITIES SYSTEM "JBoss_Web_Services_User_Guide.ent"> +%BOOK_ENTITIES; + ]> --> +<chapter id="web_service_test_view"> + <title>Web Service Test View</title> + <para> + JBoss Tools provides a view to test web services. The <guilabel>Web Services Test View</guilabel> can be displayed by following the steps in <xref linkend="proc-jbt-web_service_test_view"/>. + </para> + + <xi:include href="proc-jbt-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <para> + The following sections describe testing <acronym>JAX-WS</acronym> and <acronym>JAX-RS</acronym> web services including the necessary preliminary steps. + </para> + <xi:include href="preliminaries-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="testing_a_web_service-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <xi:include href="testing_a_restful_web_service-web_service_test_view.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> +</chapter> \ No newline at end of file