Author: Grid.Qian Date: 2008-07-02 04:56:54 -0400 (Wed, 02 Jul 2008) New Revision: 9041 Modified: trunk/ws/docs/reference/en/master.xml trunk/ws/docs/reference/en/modules/bottomup.xml trunk/ws/docs/reference/en/modules/client.xml trunk/ws/docs/reference/en/modules/preference.xml trunk/ws/docs/reference/en/modules/webproject.xml Log: JBIDE-2469: add documents for ws Modified: trunk/ws/docs/reference/en/master.xml =================================================================== --- trunk/ws/docs/reference/en/master.xml 2008-07-02 04:23:16 UTC (rev 9040) +++ trunk/ws/docs/reference/en/master.xml 2008-07-02 08:56:54 UTC (rev 9041) @@ -13,9 +13,9 @@ <book> <bookinfo> - <title>JBoss WS User Guide</title> - <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&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; + <title>JBoss WS User Guide</title> + <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; <pubdate>July 2008</pubdate> <copyright> <year>2008</year> @@ -34,4 +34,4 @@ &bottomup; &topdown; &client; -</book> \ No newline at end of file +</book> Modified: trunk/ws/docs/reference/en/modules/bottomup.xml =================================================================== --- trunk/ws/docs/reference/en/modules/bottomup.xml 2008-07-02 04:23:16 UTC (rev 9040) +++ trunk/ws/docs/reference/en/modules/bottomup.xml 2008-07-02 08:56:54 UTC (rev 9041) @@ -0,0 +1,81 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="bottomup" revisionflag="added"> + <title>Creating a Web service from a Java bean using JBoss WS</title> + <para>The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and deploying the Web service to a server.</para> + <para>To create a Web service from a bean using JBoss WS:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><link linkend="webproject">Creating a Dynamic Web project</link>.</para> + <para><link linkend="facet">Add JBossWS facet to web project</link>.</para> + <para>Create a Web Service from a java bean: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis><property>Window > Open Perspective > Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project.</para> + </listitem> + <listitem> + <para>Click <emphasis><property>File > New > Other</property></emphasis>.Select Web Services in order to display the various Web service wizards. Select the Web Service wizard. Click <property>Next</property> button.</para> + </listitem> + <listitem> + <para>In the first Web Service wizard page: select <property>Bottom up Java bean Web service</property> as your Web service type, and select the Java bean from which the service will be created.</para> + <itemizedlist> + <listitem> + <para>Select the stages of Web service development that you want to complete using the slider: </para> + <itemizedlist> + <listitem> + <para>Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating the modules which will contain the generated code, WSDL files, deployment descriptors, and Java files when appropriate.</para>> + </listitem> + <listitem> + <para>Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server.</para>> + </listitem> + <listitem> + <para>Deploy: this will create the deployment code for the service.</para>> + </listitem> + <listitem> + <para>Install: this will install and configure the Web module and EARs on the target server.</para>> + </listitem> + <listitem> + <para>Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated.</para>> + </listitem> + <listitem> + <para>Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs</para>> + </listitem> + </itemizedlist> + </listitem> + <listitem>Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server.</listitem> + <listitem>Select your runtime: ensure the JBoss WS runtime is selected.</listitem> + <listitem>Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to JBoss Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts.</listitem> + <listitem>If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client. The better way is to create a web service client project seperately.</listitem> + </itemizedlist> + <para>Click <property>Next</property> button.</para> + </listitem> + <listitem> + <para>In the JBoss Web Service Code Generation Configuration page, you set values:</para> + <itemizedlist> + <listitem> + <para>Generate WSDL file: select it, you will get a generated WSDL file in your project. But this wsdl's services' address location values are not real address. </para> + </listitem> + <listitem>After the Web service has been created, the following may occur depending on the options you selected: + <para>Update the default web.xml: select it, you may test the web service by Explorer.</para> + </listitem> + </itemizedlist> + <para>Click <property>Next</property> button.</para> + </listitem> + <listitem> + <para>In this page, the project is deployed to the server. you can start server and test the web service. If you want to publish the web service to a UDDI registry, you may click <property>Next</property> button to publish it. If not, you may click <property>Finish</property> button.</para> + </listitem> + </itemizedlist> + <para>After the Web Service has been created, the following may occur depending on the options you selected:</para> + <itemizedlist> + <listitem> + <para> the generated web services codes</para> + </listitem> + <listitem> + <para>If have selected to generate WSDL file, you will get the file in your project's WebContent > wsdl folder.</para> + </listitem> + <listitem> + <para>If have selected to update the default web.xml, you will test the web service in browser.Open the Explorer, input the url for the web service according to web.xml plus <property>?wsdl.</property>, you will get the WSDL file from Explorer. </para> + </listitem> + </itemizedlist> +</chapter> Modified: trunk/ws/docs/reference/en/modules/client.xml =================================================================== --- trunk/ws/docs/reference/en/modules/client.xml 2008-07-02 04:23:16 UTC (rev 9040) +++ trunk/ws/docs/reference/en/modules/client.xml 2008-07-02 08:56:54 UTC (rev 9041) @@ -0,0 +1,40 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<chapter id="client" revisionflag="added"> + <title>Creating a Web service Client from a WSDL file using JBoss WS</title> + <para>To create a Web service Client from a WSDL file using JBoss WS:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><link linkend="webproject">Creating a Dynamic Web project</link>.</para> + <para><link linkend="facet">Add JBossWS facet to web project</link>.</para> + <para>Create a Web Service Client from a WSDL file: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis><property>Window > Open Perspective > Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project.</para> + </listitem> + <listitem> + <para>Click <emphasis><property>File > New > Other</property></emphasis>.Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click <property>Next</property> button.</para> + </listitem> + <listitem> + <para>The first and second Web Service Client wizard page are same to <link linkend="topdown">Web Service from a WSDL document</link>.</para> + <para>The differences are:</para> + <itemizedlist> + <listitem> + <para><property>Client Type:</property> Now only support Java Proxy.</para> + </listitem> + </itemizedlist> + <para>Click <property>Finish</property> button.</para> + </listitem> + </itemizedlist> + <para>After the Web Service Client has been created, the following may occur depending on the options you selected:</para> + <itemizedlist> + <listitem> + <para> the generated web service and client codes</para> + </listitem> + <listitem> + <para>a client sample class.</para> + </listitem> + </itemizedlist> + <para>JBoss WS support Java class test for Web Service. A client sample class will be generated, you may run this client as a java application to call the web service.</para> +</chapter> Modified: trunk/ws/docs/reference/en/modules/preference.xml =================================================================== --- trunk/ws/docs/reference/en/modules/preference.xml 2008-07-02 04:23:16 UTC (rev 9040) +++ trunk/ws/docs/reference/en/modules/preference.xml 2008-07-02 08:56:54 UTC (rev 9041) @@ -1,6 +1,6 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="preference" revisionflag="added"> - <title>JBoss WS and development enviroment</title> + <title>JBoss WS and development environment</title> <section id="overview"> <title>JBoss WS Overview</title> @@ -11,18 +11,34 @@ <section id="jbosswspreference"> <title>Set JBossWS Runtime Location</title> - - <para>Open Window->Preferences->Web Services-> JBossWS Preferences. In this Page , you can set JBossWS Runtime.</para> - <para>Now only support JBoss EAP or JBoss AS as JBossWS Runtime.</para> - <para>After you set JBoss WS Runtime, click 'OK' Button.</para> + <para>Open + <emphasis><property>Window > Preferences > Web Services > JBossWS Preferences</property></emphasis>. In this Page , you can set JBossWS Runtime.</para> + <para>Now JBoss Tools only support JBoss EAP or JBoss AS as JBossWS Runtime.</para> + <para>After set JBoss WS Runtime, click <property>OK</property> button to save the JBoss WS Runtime location.</para> + <figure> + <title></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/"></imagedata> + </imageobject> + </mediaobject> + </figure> </section> <section id="serverruntime"> - <title>Set default Server and Runtime</title> - <para>Open Window->Preferences->Web Services-> Server and Runtime. In this page, you can set default server and runtime.</para> + <para>Open + <emphasis><property>Window > Preferences > Web Services > Server and Runtime</property></emphasis>. In this page, you can set default server and runtime.</para> <para>For ease of use, the better way is to set runtime = JBoss WS.</para> - + <para>After set server and runtime, click <property>Aplly</property> button to save the value.</para> + <figure> + <title></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/"/> + </imageobject> + </mediaobject> + </figure> </section> </chapter> Modified: trunk/ws/docs/reference/en/modules/webproject.xml =================================================================== --- trunk/ws/docs/reference/en/modules/webproject.xml 2008-07-02 04:23:16 UTC (rev 9040) +++ trunk/ws/docs/reference/en/modules/webproject.xml 2008-07-02 08:56:54 UTC (rev 9041) @@ -1,8 +1,17 @@ <?xml version="1.0" encoding="ISO-8859-1"?> <chapter id="webproject" revisionflag="added"> - <title>Creating a Web project</title> + <title>Creating a Dynamic Web project</title> <para>Before create a web service, you must have a Dynamic Web Project</para> - - <para>Create the service Web project by selecting New > Dynamic Web project. Enter the following information: </para> + <para>Create the service Web project by selecting + <emphasis><property>New > Project... > Dynamic Web project</property></emphasis>. Enter the following information: </para> + <itemizedlist> + <listitem> + <para>Project Name: enter a project name</para> + </listitem> + <listitem> + <para>Target runtime: any server depending on you installed. If it is not listed, click New and browse to the location where it is installed. You may choose none of server.In this case, you must choose a JBoss WS runtime when you add a JBoss WS facet to this project.</para> + </listitem> + </itemizedlist> + <para>Click <property>Finish</property> button.</para> </chapter> \ No newline at end of file