Author: irooskov(a)redhat.com Date: 2010-11-16 21:45:17 -0500 (Tue, 16 Nov 2010) New Revision: 26656 Added: trunk/ws/docs/reference/en-US/generation-simple_web_service_wizard.xml trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_01.png trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_02.png trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_03.png trunk/ws/docs/reference/en-US/proc-jbt-generate_a_simple_web_service.xml trunk/ws/docs/reference/en-US/simple_web_service.xml Modified: trunk/ws/docs/reference/en-US/Book_Info.xml trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml trunk/ws/docs/reference/en-US/master.xml Log: added in info for TOOLSDOC-100 Modified: trunk/ws/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/ws/docs/reference/en-US/Book_Info.xml 2010-11-17 00:59:40 UTC (rev 26655) +++ trunk/ws/docs/reference/en-US/Book_Info.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -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>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... +<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>16</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.xml =================================================================== --- trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-17 00:59:40 UTC (rev 26655) +++ trunk/ws/docs/reference/en-US/JBoss_Web_Services_User_Guide.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -5,6 +5,8 @@ <xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <xi:include href="overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="simple_web_service.xml" xmlns:xi="http://www.w3.org/2001/XInclude"> +</xi:include> <xi:include href="topdown.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> <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> Added: trunk/ws/docs/reference/en-US/generation-simple_web_service_wizard.xml =================================================================== --- trunk/ws/docs/reference/en-US/generation-simple_web_service_wizard.xml (rev 0) +++ trunk/ws/docs/reference/en-US/generation-simple_web_service_wizard.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -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="simple_web_service_wizard-simple_web_service-generation"> + <title>Generation</title> + <para> + A simple web service can be created by using the <guilabel>Simple Web Service</guilabel> wizard as described in <xref linkend="proc-jbt-generate_a_simple_web_service"/> + </para> + <xi:include href="proc-jbt-generate_a_simple_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/images/image-jbt-generate_a_simple_web_service_01.png =================================================================== (Binary files differ) Property changes on: trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_01.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_02.png =================================================================== (Binary files differ) Property changes on: trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_02.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_03.png =================================================================== (Binary files differ) Property changes on: trunk/ws/docs/reference/en-US/images/image-jbt-generate_a_simple_web_service_03.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/ws/docs/reference/en-US/master.xml =================================================================== --- trunk/ws/docs/reference/en-US/master.xml 2010-11-17 00:59:40 UTC (rev 26655) +++ trunk/ws/docs/reference/en-US/master.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -3,6 +3,7 @@ "http://www.docbook.org/xml/4.3/docbookx.dtd" [<!ENTITY overview SYSTEM "overview.xml"> +<!ENTITY simplewebservice SYSTEM "simple_web_service.xml"> <!ENTITY topdown SYSTEM "topdown.xml"> <!ENTITY preference SYSTEM "preference.xml"> <!ENTITY webproject SYSTEM "webproject.xml"> @@ -65,6 +66,7 @@ <toc/> &overview; + &simplewebservice; &topdown; &client; &preference; Added: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_simple_web_service.xml =================================================================== --- trunk/ws/docs/reference/en-US/proc-jbt-generate_a_simple_web_service.xml (rev 0) +++ trunk/ws/docs/reference/en-US/proc-jbt-generate_a_simple_web_service.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -0,0 +1,171 @@ +<?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_simple_web_service"> + <title>Generate a simple 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> + Expand the <menuchoice> + <guimenu>Web Services</guimenu> + </menuchoice> folder and click on the <guimenuitem>Simple Web Service</guimenuitem> option. + </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_simple_web_service_01"> + <title>The New - Other (Wizard selection) dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_simple_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 Simple Web Service dialog</title> + <para> + Click the <guibutton>Next</guibutton> button to proceed. + </para> + <formalpara><title>Result:</title> + <para> + The <guilabel>Simple Web Service - Project and Web Service Details</guilabel> dialog displays. + </para> + </formalpara> + <figure id="figure-jbt-generate_a_simple_web_service_02"> + <title>Simple Web Service - Project and Web Service Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_simple_web_service_02.png" format="PNG"/> + </imageobject> + <textobject> + <para>Simple Web Service - Project and Web Service Details</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_simple_web_service_01"/> + </para> + <table id="table-jbt-generate_a_simple_web_service_01" frame='all'> + <title>Project and Web Service Details</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>Technology</entry> + <entry></entry> + <entry>yes</entry> + <entry>Select the technology the Web Service will be based on.</entry> + <entry>A simple web service can be based on either the Web Service Definition Language (WSDL) or RESTful (REST) API. Click the radio button beside the technology your web service should use.</entry> + </row> + <row> + <entry>Dynamic web project</entry> + <entry></entry> + <entry>yes</entry> + <entry>Select 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 drop-down list.</entry> + </row> + <row> + <entry>Service details</entry> + <entry>Service name</entry> + <entry>yes</entry> + <entry>Enter the name to 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>Checkbox is checked by default, but is not mandatory.</entry> + <entry>Leaving this checked will add your new service to the <filename>web.xml</filename> in your project.</entry> + </row> + <row> + <entry>Service implementation</entry> + <entry>Package</entry> + <entry>yes</entry> + <entry>Enter the package for the web service servlet.</entry> + <entry>The default package is <filename>org.jboss.samples.websevices</filename>. Select your own package using the <guibutton>...</guibutton> button.</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> + <row> + <entry></entry> + <entry>Application class</entry> + <entry>only when the JAX-RS technology option is selected</entry> + <entry>Enter the name of the JAX-RS application class to use.</entry> + <entry>The default application class is <classname>MyRESTApplication</classname>.Select your own application class using the <guibutton>...</guibutton> button.</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 <filename>web.xml</filename> file updated with the deployment details if the <guilabel>Update web.xml</guilabel> option was selected. + </para> + </formalpara> + <figure id="figure-jbt-generate_a_simple_web_service_03"> + <title>Created Simple Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/image-jbt-generate_a_simple_web_service_03.png" format="PNG"/> + </imageobject> + <textobject> + <para>Simple Web Service - Project and Web Service Details</para> + </textobject> + </mediaobject> + </figure> + </step> + </procedure> Property changes on: trunk/ws/docs/reference/en-US/proc-jbt-generate_a_simple_web_service.xml ___________________________________________________________________ Name: svn:executable + * Added: trunk/ws/docs/reference/en-US/simple_web_service.xml =================================================================== --- trunk/ws/docs/reference/en-US/simple_web_service.xml (rev 0) +++ trunk/ws/docs/reference/en-US/simple_web_service.xml 2010-11-17 02:45:17 UTC (rev 26656) @@ -0,0 +1,16 @@ +<?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; + ]> --> +<chapter id="simple_web_service"> + <title>Creating a Simple Web Service</title> + <para> + This chapter describes how to create a simple web service. + </para> + + <xi:include href="generation-simple_web_service_wizard.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> + <!-- <xi:include href="deployment-simple_web_service_wizard.xml" xmlns:xi="http://www.w3.org/2001/XInclude" /> --> + + +</chapter> \ No newline at end of file