Author: irooskov(a)redhat.com Date: 2011-07-31 17:48:45 -0400 (Sun, 31 Jul 2011) New Revision: 33387 Removed: trunk/ws/docs/restful_reference/en-US/topdown.xml Modified: trunk/ws/docs/restful_reference/en-US/JBoss_RESTful_Web_Services_User_Guide.xml Log: updated for TOOLSDOC-150 Modified: trunk/ws/docs/restful_reference/en-US/JBoss_RESTful_Web_Services_User_Guide.xml =================================================================== --- trunk/ws/docs/restful_reference/en-US/JBoss_RESTful_Web_Services_User_Guide.xml 2011-07-31 15:54:45 UTC (rev 33386) +++ trunk/ws/docs/restful_reference/en-US/JBoss_RESTful_Web_Services_User_Guide.xml 2011-07-31 21:48:45 UTC (rev 33387) @@ -5,7 +5,6 @@ <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="topdown.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" /> Deleted: trunk/ws/docs/restful_reference/en-US/topdown.xml =================================================================== --- trunk/ws/docs/restful_reference/en-US/topdown.xml 2011-07-31 15:54:45 UTC (rev 33386) +++ trunk/ws/docs/restful_reference/en-US/topdown.xml 2011-07-31 21:48:45 UTC (rev 33387) @@ -1,590 +0,0 @@ -<?xml version="1.0" encoding="ISO-8859-1"?> -<chapter id="create_ws_topdown"> -<?dbhtml filename="topdown.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Tools</keyword> - - <keyword>Web Service</keyword> - - <keyword>JBossWS Web Service runtime</keyword> - </keywordset> - </chapterinfo> - <title>Creating a Web Service using JBossWS runtime</title> - <para> - In this chapter we provide you with the necessary steps to create a Web Service using JBossWS runtime. First you need to create a Dynamic Web project: - </para> - - <section id="createproject"> - <title>Creating a Dynamic Web project</title> - <para> - Before creating a web service, you should have a Dynamic Web Project created: - </para> - - <figure> - <title>Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - Create a 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 your installation. If it is not listed, click <property>New</property> button and browse to the location where it is installed to. You may set <emphasis> <property>Target Runtime</property> </emphasis> to <emphasis> <property>None</property></emphasis>, in this case, you should read the section <xref linkend="addfacet"/>. - </para> - - <figure> - <title>Dynamic Web Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_2.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para> - Configuration: You may <xref linkend="addfacet"/> by clicking the <property>Modify...</property> button. The opened page is like <property>Figure 2.4</property>. - </para> - </listitem> - - <listitem> - <para> - Configure Web Module values: - </para> - - <figure> - <title>Web Module Settings Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_3.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - - <para> - If you added the JBoss Web Service facet to the project, now the <property>Finish</property> button is unavailable. You must click <property>Next</property> button to set more information about the JBoss Web Service facet. The page is like <property>Figure 2.5</property>. Then click on the <property>Finish</property> button. - </para> - - <para> - If you didn't add the JBoss Web Service facet to the project, click on the <property>Finish</property> button. Next you will need to add JBoss Web Service facet to the project. - </para> - </section> - - <section id="addfacet"> - <title>Configure JBoss Web Service facet settings</title> - <para> - If you have already created a new Dynamic Web project and not set the JBoss Web Service facet to the project, the next step is to add JBoss Web Service facet to the project. Right-click on the project, select its <emphasis><property>Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis> in the tree-view on the left-side of the project properties dialog. Tick on the check box for JBoss Web Services. You will see what like this: - </para> - - <figure id="figure_addfacet_0"> - <title>Choose JBoss Web Service Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_facet_0.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property>Further configuration required...</property></emphasis> . You must click the link to set more information about JBoss Web Service facet. - </para> - - <para> - Click on the <emphasis><property>Further configuration required...</property></emphasis> link. In the opened window - </para> - - <figure id="figure_addfacet"> - <title>Configure JBoss Web Service Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_facet.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - Server Supplied JBossWS Runtime: If you have already set a JBoss runtime to the project's target runtime, you may choose <emphasis> <property>Server Supplied JBossWS Runtime</property> </emphasis> and then click <emphasis> <property>Ok</property> </emphasis> to finish the configuration of JBoss Web Service facet. - </para> - - <para> - If the project has no <emphasis> <property>Target Runtime</property> </emphasis> settings, you should check the second radio button and specify a JBossWS runtime from the list. You also can create a new JBossWS runtime, click on the <emphasis> <property>New...</property> </emphasis> button will bring you to another dialog to configure new JBossWS runtime. - </para> - - <figure id="figure_addfacet1"> - <title>Configure JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_newruntime.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - See how to configure a new JBossWS runtime in the <xref linkend="preference"/> section. - </para> - - <para> - After setting the information about JBoss Web Service facet, for saving the result, you should click the <property>Apply</property> or <property>OK</property> button at the bottom-right of the right-side of the project properties dialog. - </para> - </section> - <!-- - <section id="topdownwebservice"> - <title>Creating a Web Service from a WSDL document using JBossWS runtime</title> - <para> - In this chapter we provide you with the necessary steps to create a Web Service from a WSDL document using JBossWS runtime. - </para> - - <para> - At first, please make sure that you have already created a dynamic Web project with JBoss Web Service facet installed. - </para> - - <para> - See how to make it in the <xref linkend="createproject"/> section and in the <xref - linkend="addfacet"/> section. - </para> - - <note> - <para> - To use the - <guilabel> - Simple Web Service - </guilabel> - wizard to create this Web Service, replace the - <guilabel> - Class - </guilabel> - and - <guilabel> - Applicaiton Class - </guilabel> - fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. - </para> - </note> - - <para> - To create a Web Service using JBossWS runtime select<emphasis> <property>File > New > Other > Web Services > Web Service</property> </emphasis> to run Web Service creation wizard. - </para> - - <para> - Let&apos;s get through the wizard step-by-step: - </para> - - <figure id="figure_create_ws_topdown"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - First, please select <property>Top down Java bean Web Service</property> from the Web Service type list, and select a WSDL document from workspace, click on the Server name link on the page will bring you to another dialog. Here you can specify the server to a JBoss Server and Web Service runtime to JBossWS runtime: - </para> - - <figure id="figure_create_ws_topdown_setserver"> - <title>Select Server and Web Service runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1_1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - Click on the <emphasis> <property>Finish</property> </emphasis> button to see the next wizard view opened: - </para> - - <figure id="figure_create_ws_topdown1"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - Click on the <emphasis> <property>Next</property> </emphasis> button to proceed: - </para> - - <figure id="figure_create_ws_topdown_codegen"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation2.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para> - <emphasis> <property>WSDL Service</property> </emphasis> : display the services in your WSDL file, you can select one to generate Web Service. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Source Folder</property> </emphasis> : display the source codes folder in your web project, you can select one to generate java codes. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Package name</property> </emphasis> : input a package name. You can click the Brown button to choose one. If you don't input a package name, system will generate one for you. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>JAX-WS specificaiton</property> </emphasis> : display the supported JAX-WS version, include, 2.0, 2.1, 2.2 - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Catalog file</property> </emphasis> : specify a catalog file. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Binding files</property> </emphasis> : specify some binding files that are used by your WSDL file - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Enable binding extension support (Only available for JBossWS 3.0 or later)</property> </emphasis> : select it if you need the binding extension support. Only work based on JBossWS 3.0 or later. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Generate default Web Service implementation classes</property> </emphasis> : select it if you want to generate empty implementation classes for the selected WSDL Service. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Update the default Web.xml</property> </emphasis> : update the Web.xml file with your Web Service servlets configured. - </para> - </listitem> - <listitem> - <para> - <emphasis> <property>Additional Options</property> </emphasis> : the senior options for the generating process. Only for the senior user. - </para> - </listitem> - </itemizedlist> - <para> - Click on the <emphasis> <property>Next</property> </emphasis> or on the <emphasis> <property>Finish</property> </emphasis> button to generate code. - </para> - - <para> - Once the Web Service code is generated, you can view the implementation class and add business logic to each method. - </para> - - <figure id="figure_impl_code"> - <title>The generated implementation Java code</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - View the Web.xml file: - </para> - - <figure id="figure_webxml"> - <title>Web.xml</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_webxml.png"/> - </imageobject> - </mediaobject> - </figure> - - <para> - In the next chapter you will find out how to create a Web service from a Java bean. - </para> - </section> - --> - <!-- - <section id="bottomupws"> - <title>Creating a Web service from a Java bean using JBossWS runtime</title> - <para> - The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and then deploying it to the server. - </para> - - <para> - To create a Web service from a bean using JBoss WS: - </para> - - <para> - Setup <xref linkend="preference"/>. - </para> - - <para> - Create <xref linkend="createproject"/>. - </para> - - <note> - <para> - To use the - <guilabel> - Simple Web Service - </guilabel> - wizard to create this Web Service, replace the - <guilabel> - Class - </guilabel> - and - <guilabel> - Applicaiton Class - </guilabel> - fields with your specific classes, within the instructions in <xref linkend="simple_web_service" />. - </para> - </note> - - <para> - <xref linkend="addfacet"/> - </para> - - <para> - Create a Web Service from a java bean: - </para> - - <itemizedlist> - <listitem> - <para> - Switch to the Java EE perspective <menuchoice><guimenuitem>Window</guimenuitem><guimenuitem>Open Perspective</guimenuitem><guimenuitem>Java EE</guimenuitem></menuchoice>. - </para> - </listitem> - - <listitem> - <para> - In the Project Explorer view, select the bean that you created or imported into the source folder of your Web project. - </para> - - <figure> - <title>Select the Bean Created</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para> - Click <menuchoice><guimenuitem>File</guimenuitem><guimenuitem>New</guimenuitem><guimenuitem>Other</guimenuitem></menuchoice>. Select Web Services in order to display various Web service wizards. Select the Web Service wizard. Click on the <property>Next</property> button. - </para> - - <figure> - <title>New Web Service</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_1.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para> - On 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> - - <figure> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_2.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para> - Select the stages of Web service development that you want to complete using the slider: - </para> - - <itemizedlist> - <listitem> - <para> - Develop: this will develop the WSDL definition and implementation of the Web service. This includes such tasks as creating modules that will contain generated code, WSDL files, deployment descriptors, and Java files when appropriate. - </para> - </listitem> - - <listitem> - <para> - Assemble: this ensures the project that will host the Web service or client gets associated to an EAR when required by the target application server. - </para> - </listitem> - - <listitem> - <para> - Deploy: this will create the deployment code for the service. - </para> - </listitem> - - <listitem> - <para> - Install: this will install and configure the Web module and EARs on the target server. - </para> - </listitem> - - <listitem> - <para> - Start: this will start the server once the service has been installed on it. The server-config.wsdd file will be generated. - </para> - </listitem> - - <listitem> - <para> - Test: this will provide various options for testing the service, such as using the Web Service Explorer or sample JSPs. - </para> - </listitem> - </itemizedlist> - </listitem> - - <listitem> - <para> - Select your server: the default server is displayed. If you want to deploy your service to a different server click the link to specify a different server. - </para> - </listitem> - - <listitem> - <para> - Select your runtime: ensure the JBoss WS runtime is selected. - </para> - </listitem> - - <listitem> - <para> - Select the service project: the project selected in your workspace is displayed. To select a different project click on the project link. If you are deploying to JBoss Application Server you will also be asked to select the EAR associated with the project. Ensure that the project selected as the Client Web Project is different from the Service Web Project, or the service will be overwritten by the client's generated artifacts. - </para> - </listitem> - - <listitem> - <para> - If you want to create a client, select the type of proxy to be generated and repeat the above steps for the client. The better way is to create a web service client project separately. - </para> - </listitem> - </itemizedlist> - - <para> - Click on the <property>Next</property> button. - </para> - </listitem> - - <listitem> - <para> - On the JBoss Web Service Code Generation Configuration page, set the following values: - </para> - - <figure> - <title>Set Web Service values for Code Generation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_3.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para> - Generate WSDL file: select it, you will get a generated WSDL file in your project. But this wsdl's service address location values are not a real address. - </para> - </listitem> - - <listitem> - <para> - After the Web service has been created, the following option can become available depending on the options you selected: Update the default web.xml file. If selected, you may test the web service by Explorer. - </para> - </listitem> - </itemizedlist> - - <para> - Click on the <property>Next</property> button. - </para> - </listitem> - - <listitem> - <para> - On this page, the project is deployed to the server. You can start the server and test the web service. If you want to publish the web service to a UDDI registry, you may click the <property>Next</property> button to publish it. If not, you may click the <property>Finish</property> button. - </para> - - <figure> - <title>Start a Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_4.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - - <para> - After the Web Service has been created, the following options may become available depending on the options selected: - </para> - - <itemizedlist> - <listitem> - <para> - the generated web services code - </para> - </listitem> - - <listitem> - <para> - If you selected to generate a WSDL file, you will get the file in your project's wsdl folder. - </para> - - <figure> - <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_6.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - - <listitem> - <para> - If you selected to update the default web.xml, you will test the web service in the browser. Open the Explorer, input the url for the web service according to web.xml plus <property>?wsdl</property>, you will get the WSDL file from Explorer. - </para> - - <figure> - <title>The Updated web.xml file</title> - <mediaobject> - <imageobject> - <imagedata scale="80" fileref="images/topdown/jbossws_bottomup_5.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - - <para> - In the next chapter you will be able to create a Web Service Client from a WSDL document using JBoss WS. - </para> -</section> --> -</chapter>