[jbosstools-commits] JBoss Tools SVN: r19343 - branches/jbosstools-3.1.0.RC1/ws/docs/reference/en.

Author: ochikvina Date: 2009-12-16 10:20:58 -0500 (Wed, 16 Dec 2009) New Revision: 19343 Modified: branches/jbosstools-3.1.0.RC1/ws/docs/reference/en/master_output.xml Log: https://jira.jboss.org/jira/browse/JBDS-989 - updating master_output.xml; Modified: branches/jbosstools-3.1.0.RC1/ws/docs/reference/en/master_output.xml =================================================================== --- branches/jbosstools-3.1.0.RC1/ws/docs/reference/en/master_output.xml 2009-12-16 15:20:35 UTC (rev 19342) +++ branches/jbosstools-3.1.0.RC1/ws/docs/reference/en/master_output.xml 2009-12-16 15:20:58 UTC (rev 19343) @@ -7,683 +7,698 @@ <!ENTITY preference SYSTEM "modules/preference.xml"> <!ENTITY webproject SYSTEM "modules/webproject.xml"> <!ENTITY client SYSTEM "modules/client.xml"> -]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> - - <bookinfo> - <title>JBoss WS User Guide</title> - - <corpauthor diffmk:change="added"> - <inlinemediaobject diffmk:change="added"> - <imageobject diffmk:change="added" role="fo"> - <imagedata diffmk:change="added" fileref="images/jbosstools_logo.png" format="PNG"></imagedata> - </imageobject> - <imageobject diffmk:change="added" role="html"> - <imagedata diffmk:change="added"></imagedata> - </imageobject> - </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; - <pubdate>July 2008</pubdate> - <copyright> - <year>2008</year> - <year>2009</year> - <holder><diffmk:wrapper diffmk:change="changed">JBoss by Red Hat</diffmk:wrapper></holder> - </copyright> - <releaseinfo><diffmk:wrapper diffmk:change="changed"> - Version: 1.1.0.M2 - </diffmk:wrapper></releaseinfo> -<abstract> - <title></title> - <para> - <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_gui... version</ulink> - </para> -</abstract> - - - </bookinfo> - - <toc></toc> - -<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/overview.xml"> - <title>JBossWS Runtime Overview</title> - - <para>JBossWS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para> - <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para> - -<section diffmk:change="added"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Features of JBossWS</diffmk:wrapper></title> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">For a start, we propose you to look through the table of main features of JBossWS Runtime:</diffmk:wrapper></para> - - <table diffmk:change="added"> - - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Key Functionality for JBossWS</diffmk:wrapper></title> - <tgroup cols="2" diffmk:change="added"> - - <colspec align="left" colnum="1" colwidth="2*" diffmk:change="added"></colspec> - <colspec colnum="2" colwidth="4*" diffmk:change="added"></colspec> - - - <thead diffmk:change="added"> - <row diffmk:change="added"> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Feature</diffmk:wrapper></entry> - <entry diffmk:change="added"><diffmk:wrapper diffmk:change="added">Benefit</diffmk:wrapper></entry> - - </row> - </thead> - - <tbody diffmk:change="added"> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JAX-RPC and JAX-WS support</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBossWS implements both the JAX-WS and JAX-RPC specifications.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">EJB 2.1, EJB3 and JSE endpoints</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBossWS supports EJB 2.1, EJB3 and JSE as Web Service Endpoints.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">WS-Security 1.0 for XML Encryption/Signature of the SOAP message</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">WS-Security standardizes authorization, encryption, and digital signature processing of web services.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss AS</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">JBoss Application Server 5 (JavaEE 5 compliant) web service stack.</diffmk:wrapper></para></entry> - - </row> - - <row diffmk:change="added"> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Support for MTOM/XOP and SwA-Ref</diffmk:wrapper></para></entry> - <entry diffmk:change="added"><para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Message Transmission Optimization Mechanism (MTOM) and XML-binary Optimized Packaging (XOP) more efficiently serialize XML Infosets that have certain types of content.</diffmk:wrapper></para></entry> - - </row> - - </tbody> - - </tgroup> - </table> - - -</section> - - - -</chapter> - -<chapter id="create_ws_topdown" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/topdown.xml"> - <?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 float="0"> - <title>Dynamic Web Project</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Create a Web project by selecting <emphasis> - <property moreinfo="none">New &gt; Project... &gt; Dynamic Web project</property></emphasis>. Enter the following information: </para> - <itemizedlist> - <listitem> - <para>Project Name: enter a project name</para> - </listitem> - <listitem> - <para><diffmk:wrapper diffmk:change="added">Target runtime: any server depending on your installation. If it is not listed, - click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">New</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button and browse to the location where it is installed to. You may set </diffmk:wrapper><emphasis> - <property moreinfo="none">Target Runtime</property> - </emphasis> to <emphasis> - <property moreinfo="none">None</property></emphasis>, in this case, you should add <link linkend="addfacet">JBoss Web Service - facet to the project</link>.</para> - <figure float="0"> - <title>Dynamic Web Project Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para><diffmk:wrapper diffmk:change="added">Configuration: You may add </diffmk:wrapper><link diffmk:change="added" linkend="addfacet"><diffmk:wrapper diffmk:change="added">JBoss Web Service - facet to the project</diffmk:wrapper></link><diffmk:wrapper diffmk:change="added"> by clicking </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Modify...</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button. The opened page is like </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Figure 2.4</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">.</diffmk:wrapper></para> - </listitem> - <listitem diffmk:change="added"> - <para diffmk:change="added">Configure Web Module values:</para> - <figure float="0"> - <title>Web Module Settings Configuration</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_webproject_3.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para><diffmk:wrapper diffmk:change="added">If you added the JBoss Web Service facet to the project, now the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button is disable. You must click </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Next</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button to set more information about the JBoss Web Service facet. The page is like </diffmk:wrapper><property moreinfo="none"><diffmk:wrapper diffmk:change="added">Figure 2.5</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added">. Then click on the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Finish</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">If you didn't add the JBoss Web Service facet to the project, click on the </diffmk:wrapper><property diffmk:change="added" moreinfo="none">Finish</property><diffmk:wrapper diffmk:change="changed"> button. Next you will need to add JBoss Web Service facet to the project.</diffmk:wrapper></para> - </section> - - <section id="addfacet"> - <title>Configure JBoss Web Service facet settings</title> - <para><diffmk:wrapper diffmk:change="changed">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 </diffmk:wrapper><emphasis><property moreinfo="none">Properties</property></emphasis> and then find <emphasis>Project Facets</emphasis><diffmk:wrapper diffmk:change="added"> 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: </diffmk:wrapper></para> - <figure diffmk:change="added" float="0" id="figure_addfacet_0"> - <title diffmk:change="added"><diffmk:wrapper diffmk:change="added">Choose JBoss Web Service Facet</diffmk:wrapper></title> - <mediaobject diffmk:change="added"> - <imageobject diffmk:change="added"> - <imagedata diffmk:change="added" fileref="images/topdown/jbossws_facet_0.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">At the bottom-left of the right-side of the project properties dialog, there is a error link: </diffmk:wrapper><emphasis diffmk:change="added"><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Further configuration required...</diffmk:wrapper></property></emphasis><diffmk:wrapper diffmk:change="added"> . You must click the link to set more information about JBoss Web Service facet.</diffmk:wrapper></para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">Click on the </diffmk:wrapper><emphasis><property moreinfo="none">Further configuration required...</property></emphasis> link. In the opened window</para> - <figure float="0" id="figure_addfacet"> - <title>Configure JBoss Web Service Facet</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_facet.png"></imagedata> - </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 moreinfo="none">Server Supplied JBossWS Runtime</property> - </emphasis> and then click <emphasis> - <property moreinfo="none">Ok</property> - </emphasis> to finish the configuration of JBoss Web Service facet. </para> - <para>If the project has no <emphasis> - <property moreinfo="none">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 moreinfo="none">New...</property> - </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para> - <figure float="0" id="figure_addfacet1"> - <title>Configure JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_newruntime.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>See how to configure a new JBossWS runtime <link linkend="preference">here</link>.</para> - <para diffmk:change="added"><diffmk:wrapper diffmk:change="added">After setting the information about JBoss Web Service facet, for saving the result, you should click the </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">Apply</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> or </diffmk:wrapper><property diffmk:change="added" moreinfo="none"><diffmk:wrapper diffmk:change="added">OK</diffmk:wrapper></property><diffmk:wrapper diffmk:change="added"> button at the bottom-right of the right-side of the project properties dialog.</diffmk:wrapper></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 <link linkend="createproject">here</link> and <link linkend="addfacet">here</link>.</para> - - <para>To create a Web Service using JBossWS runtime select<emphasis> - <property moreinfo="none">File &gt; New &gt; Other &gt; Web Services &gt; Web Service</property> - </emphasis> to run Web Service creation wizard. </para> - <para>Let's get through the wizard step-by-step:</para> - <figure float="0" id="figure_create_ws_topdown"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>First, please select <property moreinfo="none">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 float="0" 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"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property moreinfo="none">Finish</property> - </emphasis> button to see the next wizard view opened:</para> - - <figure float="0" id="figure_create_ws_topdown1"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> button to proceed:</para> - <figure float="0" id="figure_create_ws_topdown_codegen"> - <title>New Web Service Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_creation2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>On this page, the default package name comes from the namespace of the WSDL document, - you also can change it to any valid package name you want. JAX-WS specification should be - set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can - specify a catalog file and binding files if you have them. If you want the wizard to - generate empty implementation classes for the Web Service, check the <emphasis> - <property moreinfo="none">Generate default Web Service implementation classes</property> - </emphasis> check box. If you want to update the default Web.xml file with the Web Service - servlets configured, check the <emphasis> - <property moreinfo="none">Update the default Web.xml</property> - </emphasis> check box. Click on the <emphasis> - <property moreinfo="none">Next</property> - </emphasis> or on the <emphasis> - <property moreinfo="none">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 float="0" id="figure_impl_code"> - <title>The generated implementation Java code</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>View the Web.xml file:</para> - <figure float="0" id="figure_webxml"> - <title>Web.xml</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_ws_webxml.png"></imagedata> - </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" role="updated"> - <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 <link linkend="preference">JBoss WS and development environment</link>.</para> - <para>Create <link linkend="createproject">a Dynamic Web project</link>.</para> - <para>Add <link linkend="addfacet">JBossWS Facet</link> to Web project.</para> - <para>Create a Web Service from a java bean: </para> - <itemizedlist> - <listitem> - <para>Switch to the Java EE perspective <emphasis> - <property moreinfo="none">Window &gt; Open Perspective &gt; 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> - <figure float="0"> - <title>Select the Bean Created</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>Click <emphasis> - <property moreinfo="none">File &gt; New &gt; Other</property></emphasis>. Select Web Services in order to display various Web service wizards. - Select the Web Service wizard. Click on the <property moreinfo="none">Next</property> button.</para> - <figure float="0"> - <title>New Web Service</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>On the first Web Service wizard page: select <property moreinfo="none">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 float="0"> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_2.png"></imagedata> - </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 moreinfo="none">Next</property> button.</para> - </listitem> - <listitem> - <para>On the JBoss Web Service Code Generation Configuration page, set the following - values:</para> - <figure float="0"> - <title>Set Web Service values for Code Generation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_3.png"></imagedata> - </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 services' 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.xm - file. If selected, you may test the web service by Explorer.</para> - </listitem> - </itemizedlist> - <para>Click on the <property moreinfo="none">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 moreinfo="none">Next</property> button to publish it. If not, you may click - the <property moreinfo="none">Finish</property> button.</para> - <figure float="0"> - <title>Start a Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_4.png"></imagedata> - </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 float="0"> - <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_6.png" scale="80"></imagedata> - </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 moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> - <figure float="0"> - <title>The Updated web.xml file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/topdown/jbossws_bottomup_5.png" scale="80"></imagedata> - </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> - - -<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/client.xml"> - <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> - <para>To create a Web Service Client from a WSDL Document using JBoss WS you need to fulfil the following steps:</para> - <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> - <para><link linkend="createproject">Create a Dynamic Web project</link>.</para> - <para><link linkend="addfacet">Add JBossWS Facet to Web project</link>.</para> - <para>Then you can create a Web Service Client from a WSDL document: </para> - <itemizedlist> - <listitem> - <para>Switch to the Java EE perspective <emphasis><property moreinfo="none">Window &gt; Open Perspective &gt; Java EE</property></emphasis>.</para> - </listitem> - <listitem> - <para>Click <emphasis><property moreinfo="none">File &gt; New &gt; Other</property></emphasis>. Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click on the <property moreinfo="none">Next</property> button.</para> - <figure float="0"> - <title>New Web Service Client</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>The first and the second Web Service Client wizard pages are the same as for <link linkend="topdownwebservice">Web Service from a WSDL document</link>.</para> - <figure float="0"> - <title>Set Web Service Common values</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <figure float="0"> - <title>Set Web Service values related to WSDL file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>The only difference is:</para> - <itemizedlist> - <listitem> - <para><property moreinfo="none">Client Type:</property> Support of Java Proxy only.</para> - </listitem> - </itemizedlist> - <para>Click on the <property moreinfo="none">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> - <figure float="0"> - <title>Client Sample Class</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/client/jbossws_client_3.png" scale="80"></imagedata> - </imageobject> - </mediaobject> - </figure> - </listitem> - </itemizedlist> - <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> -</chapter> - - -<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/trunk/ws/docs/reference/en/modules/preference.xml"> - <title>JBoss WS and development environment</title> - - <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> - <section id="jbosswspreference"> - - - <title>JBossWS Preferences</title> - - <para>In this section you will know how JBossWS preferences can be modified during the - development process.</para> - - <para>JBossWS preferences can be set on the JBossWS preference page. Click on - <emphasis><property moreinfo="none">Window &gt; Preferences &gt; JBoss Tools &gt; Web &gt; JBossWS - Preferences</property>.</emphasis></para> - - <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to - <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that - are not needed.</para> - - <figure float="0"> - <title>JBossWS Preferences Page</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>Clicking on <emphasis> - <property moreinfo="none">Add</property> - </emphasis> or <emphasis> - <property moreinfo="none">Edit</property> - </emphasis> button will open the form where you can configure a new JBossWS runtime and - change the path to JBossWS runtime home folder, modify the name and version of the - existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the - changes.</para> - - <figure float="0"> - <title>Edit JBossWS Runtime</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/Jbossws_preference_new.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - - - - <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> - - <figure float="0"> - <title>Classpath Container: Java Source Attachment</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_container1.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> - <para>To change JavaDoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para> - - <figure float="0"> - <title>Classpath Container: Javadoc Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_container2.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> - - - - - - - </section> - <section id="serverruntime"> - <title>Default Server and Runtime</title> - <para>Open <emphasis> - <property moreinfo="none">Window &gt; Preferences &gt; Web Services &gt; Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para> - <para>For ease of use, the better way is to set runtime to JBoss WS.</para> - <para>After server and runtime are specified, click on the <property moreinfo="none">Apply</property> button - to save the values.</para> - <figure float="0"> - <title></title> - <mediaobject> - <imageobject> - <imagedata fileref="images/preference/jbossws_server_runtime.png"></imagedata> - </imageobject> - </mediaobject> - </figure> - - <para>On the whole, this guide covers the fundamental concepts of work with tooling for - <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using - JBossWS Runtime and adjust JBossWS and development environment as well.</para> - - <para>If the information on JBossWS tools in this guide isn't enough for you, ask - questions on our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&...;. Your comments and suggestions are also welcome.</para> - </section> -</chapter> - -</book> +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>JBoss WS User Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </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; + <pubdate>July 2008</pubdate> + <copyright> + <year>2008</year> + <year>2009</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> + Version: 1.1.0.CR1 + </diffmk:wrapper></releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/ws_ref_gui... version</ulink> + </para> +</abstract> + + + </bookinfo> + + <toc></toc> + +<chapter id="overview" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/overview.xml"> + <title>JBossWS Runtime Overview</title> + + <para>JBossWS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para> + <para>JBossWS integrates with most current JBoss Application Server releases as well as earlier ones, that did implement the J2EE 1.4 specifications. Even though JAX-RPC, the web service specification for J2EE 1.4, is still supported JBossWS does put a clear focus on JAX-WS.</para> + +<section> + <title>Key Features of JBossWS</title> + <para>For a start, we propose you to look through the table of main features of JBossWS Runtime:</para> + + <table> + + <title>Key Functionality for JBossWS</title> + <tgroup cols="2"> + + <colspec align="left" colnum="1" colwidth="2*"></colspec> + <colspec colnum="2" colwidth="4*"></colspec> + + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + + <tbody> + + <row> + <entry><para>JAX-RPC and JAX-WS support</para></entry> + <entry><para>JBossWS implements both the JAX-WS and JAX-RPC specifications.</para></entry> + + </row> + + <row> + <entry><para>EJB 2.1, EJB3 and JSE endpoints</para></entry> + <entry><para>JBossWS supports EJB 2.1, EJB3 and JSE as Web Service Endpoints.</para></entry> + + </row> + + <row> + <entry><para>WS-Security 1.0 for XML Encryption/Signature of the SOAP message</para></entry> + <entry><para>WS-Security standardizes authorization, encryption, and digital signature processing of web services.</para></entry> + + </row> + + <row> + <entry><para>JBoss AS</para></entry> + <entry><para>JBoss Application Server 5 (JavaEE 5 compliant) web service stack.</para></entry> + + </row> + + <row> + <entry><para>Support for MTOM/XOP and SwA-Ref</para></entry> + <entry><para>Message Transmission Optimization Mechanism (MTOM) and XML-binary Optimized Packaging (XOP) more efficiently serialize XML Infosets that have certain types of content.</para></entry> + + </row> + + </tbody> + + </tgroup> + </table> + + +</section> +<section> + <title>Other relevant resources on the topic</title> + + <para>You can find some extra information on:</para> + <itemizedlist> + <listitem> + <para> + <ulink url="http://www.jboss.org/community/wiki/JBossWS-FAQ#Tools">... Tools Wiki FAQ.</ulink> + </para> + </listitem> + </itemizedlist> + + + </section> + + + + +</chapter> + +<chapter id="create_ws_topdown" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/topdown.xml"> + <?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 float="0"> + <title>Dynamic Web Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Create a Web project by selecting <emphasis> + <property moreinfo="none">New &gt; Project... &gt; 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 moreinfo="none">New</property> button and browse to the location where it is installed to. You may set <emphasis> + <property moreinfo="none">Target Runtime</property> + </emphasis> to <emphasis> + <property moreinfo="none">None</property></emphasis>, in this case, you should add <link linkend="addfacet">JBoss Web Service + facet to the project</link>.</para> + <figure float="0"> + <title>Dynamic Web Project Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Configuration: You may add <link linkend="addfacet">JBoss Web Service + facet to the project</link> by clicking <property moreinfo="none">Modify...</property> button. The opened page is like <property moreinfo="none">Figure 2.4</property>.</para> + </listitem> + <listitem> + <para>Configure Web Module values:</para> + <figure float="0"> + <title>Web Module Settings Configuration</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_webproject_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>If you added the JBoss Web Service facet to the project, now the <property moreinfo="none">Finish</property> button is disable. You must click <property moreinfo="none">Next</property> button to set more information about the JBoss Web Service facet. The page is like <property moreinfo="none">Figure 2.5</property>. Then click on the <property moreinfo="none">Finish</property> button.</para> + <para>If you didn't add the JBoss Web Service facet to the project, click on the <property moreinfo="none">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 moreinfo="none">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 float="0" id="figure_addfacet_0"> + <title>Choose JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet_0.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>At the bottom-left of the right-side of the project properties dialog, there is a error link: <emphasis><property moreinfo="none">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 moreinfo="none">Further configuration required...</property></emphasis> link. In the opened window</para> + <figure float="0" id="figure_addfacet"> + <title>Configure JBoss Web Service Facet</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_facet.png"></imagedata> + </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 moreinfo="none">Server Supplied JBossWS Runtime</property> + </emphasis> and then click <emphasis> + <property moreinfo="none">Ok</property> + </emphasis> to finish the configuration of JBoss Web Service facet. </para> + <para>If the project has no <emphasis> + <property moreinfo="none">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 moreinfo="none">New...</property> + </emphasis> button will bring you to another dialog to configure new JBossWS runtime.</para> + <figure float="0" id="figure_addfacet1"> + <title>Configure JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_newruntime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>See how to configure a new JBossWS runtime <link linkend="preference">here</link>.</para> + <para>After setting the information about JBoss Web Service facet, for saving the result, you should click the <property moreinfo="none">Apply</property> or <property moreinfo="none">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 <link linkend="createproject">here</link> and <link linkend="addfacet">here</link>.</para> + + <para>To create a Web Service using JBossWS runtime select<emphasis> + <property moreinfo="none">File &gt; New &gt; Other &gt; Web Services &gt; Web Service</property> + </emphasis> to run Web Service creation wizard. </para> + <para>Let's get through the wizard step-by-step:</para> + <figure float="0" id="figure_create_ws_topdown"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>First, please select <property moreinfo="none">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 float="0" 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"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to see the next wizard view opened:</para> + + <figure float="0" id="figure_create_ws_topdown1"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Click on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button to proceed:</para> + <figure float="0" id="figure_create_ws_topdown_codegen"> + <title>New Web Service Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_creation2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>On this page, the default package name comes from the namespace of the WSDL document, + you also can change it to any valid package name you want. JAX-WS specification should be + set to 2.0 if your JBossWS runtime in JBoss Server is JBossWS native runtime. You can + specify a catalog file and binding files if you have them. If you want the wizard to + generate empty implementation classes for the Web Service, check the <emphasis> + <property moreinfo="none">Generate default Web Service implementation classes</property> + </emphasis> check box. If you want to update the default Web.xml file with the Web Service + servlets configured, check the <emphasis> + <property moreinfo="none">Update the default Web.xml</property> + </emphasis> check box. Click on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> or on the <emphasis> + <property moreinfo="none">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 float="0" id="figure_impl_code"> + <title>The generated implementation Java code</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_Impl_code_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>View the Web.xml file:</para> + <figure float="0" id="figure_webxml"> + <title>Web.xml</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_ws_webxml.png"></imagedata> + </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 <link linkend="preference">JBoss WS and development environment</link>.</para> + <para>Create <link linkend="createproject">a Dynamic Web project</link>.</para> + <para>Add <link linkend="addfacet">JBossWS Facet</link> to Web project.</para> + <para>Create a Web Service from a java bean: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis> + <property moreinfo="none">Window &gt; Open Perspective &gt; 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> + <figure float="0"> + <title>Select the Bean Created</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>Click <emphasis> + <property moreinfo="none">File &gt; New &gt; Other</property></emphasis>. Select Web Services in order to display various Web service wizards. + Select the Web Service wizard. Click on the <property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>On the first Web Service wizard page: select <property moreinfo="none">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 float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_2.png"></imagedata> + </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 moreinfo="none">Next</property> button.</para> + </listitem> + <listitem> + <para>On the JBoss Web Service Code Generation Configuration page, set the following + values:</para> + <figure float="0"> + <title>Set Web Service values for Code Generation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_3.png"></imagedata> + </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 services' 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.xm + file. If selected, you may test the web service by Explorer.</para> + </listitem> + </itemizedlist> + <para>Click on the <property moreinfo="none">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 moreinfo="none">Next</property> button to publish it. If not, you may click + the <property moreinfo="none">Finish</property> button.</para> + <figure float="0"> + <title>Start a Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_4.png"></imagedata> + </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 float="0"> + <title>The Generated HelloWorldService.wsdl File in the wsdl Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_6.png" scale="80"></imagedata> + </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 moreinfo="none">?wsdl.</property>, you will get the WSDL file from Explorer. </para> + <figure float="0"> + <title>The Updated web.xml file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/topdown/jbossws_bottomup_5.png" scale="80"></imagedata> + </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> + + +<chapter id="client" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/client.xml"> + <title>Creating a Web Service Client from a WSDL Document using JBoss WS</title> + <para>To create a Web Service Client from a WSDL Document using JBoss WS you need to fulfil the following steps:</para> + <para>Setup <link linkend="preference">JBoss WS and development environment</link>.</para> + <para><link linkend="createproject">Create a Dynamic Web project</link>.</para> + <para><link linkend="addfacet">Add JBossWS Facet to Web project</link>.</para> + <para>Then you can create a Web Service Client from a WSDL document: </para> + <itemizedlist> + <listitem> + <para>Switch to the Java EE perspective <emphasis><property moreinfo="none">Window &gt; Open Perspective &gt; Java EE</property></emphasis>.</para> + </listitem> + <listitem> + <para>Click <emphasis><property moreinfo="none">File &gt; New &gt; Other</property></emphasis>. Select Web Services in order to display the various Web service wizards. Select the Web Service Client wizard. Click on the <property moreinfo="none">Next</property> button.</para> + <figure float="0"> + <title>New Web Service Client</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>The first and the second Web Service Client wizard pages are the same as for <link linkend="topdownwebservice">Web Service from a WSDL document</link>.</para> + <figure float="0"> + <title>Set Web Service Common values</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <figure float="0"> + <title>Set Web Service values related to WSDL file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The only difference is:</para> + <itemizedlist> + <listitem> + <para><property moreinfo="none">Client Type:</property> Support of Java Proxy only.</para> + </listitem> + </itemizedlist> + <para>Click on the <property moreinfo="none">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> + <figure float="0"> + <title>Client Sample Class</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/client/jbossws_client_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + </itemizedlist> + <para>JBoss WS use a Java class to test Web Service. A client sample class will be generated, you may run this client as a java application to call a web service.</para> +</chapter> + + +<chapter id="preference" revisionflag="added" xml:base="file:///home/ochikvina/WORK/for_compare/jbosstools-3.1.0.CR1/ws/docs/reference/en/modules/preference.xml"> + <title>JBoss WS and development environment</title> + + <para>In this chapter you will learn how to change JBossWS preferences and how to set default server and runtime.</para> + <section id="jbosswspreference"> + + + <title>JBossWS Preferences</title> + + <para>In this section you will know how JBossWS preferences can be modified during the + development process.</para> + + <para>JBossWS preferences can be set on the JBossWS preference page. Click on + <emphasis><property moreinfo="none">Window &gt; Preferences &gt; JBoss Tools &gt; Web &gt; JBossWS + Preferences</property>.</emphasis></para> + + <para>On this page you can manage the JBossWS Runtime. Use the appropriate buttons to + <property moreinfo="none">Add</property> more runtimes or to <property moreinfo="none">Remove</property> those that + are not needed.</para> + + <figure float="0"> + <title>JBossWS Preferences Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on <emphasis> + <property moreinfo="none">Add</property> + </emphasis> or <emphasis> + <property moreinfo="none">Edit</property> + </emphasis> button will open the form where you can configure a new JBossWS runtime and + change the path to JBossWS runtime home folder, modify the name and version of the + existing JBossWS runtime settings. Press <property moreinfo="none">Finish</property> to apply the + changes.</para> + + <figure float="0"> + <title>Edit JBossWS Runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/Jbossws_preference_new.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + + + <para>WS container allows Source and JavaDoc locations to be set via the Properties dialog on each contained .jar: right-click on any .jar file in the Project Explorer view, select <emphasis><property moreinfo="none">Properties</property></emphasis>. Choose <emphasis><property moreinfo="none">Java Source Attachment</property></emphasis> and select location (folder, JAR or zip) containing new source for the chosen .jar using one of the suggested options (workspace, external folder or file) or enter the path manually:</para> + + <figure float="0"> + <title>Classpath Container: Java Source Attachment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_container1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + <para>To change JavaDoc Location choose <emphasis><property moreinfo="none">Javadoc Location</property></emphasis> and specify URL to the documentation generated by Javadoc. The Javadoc location will contain a file called <emphasis><property moreinfo="none">package-list</property></emphasis>:</para> + + <figure float="0"> + <title>Classpath Container: Javadoc Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_container2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Click on <emphasis><property moreinfo="none">Apply</property></emphasis> and then on <emphasis><property moreinfo="none">Ok</property></emphasis>.</para> + + + + + + + </section> + <section id="serverruntime"> + <title>Default Server and Runtime</title> + <para>Open <emphasis> + <property moreinfo="none">Window &gt; Preferences &gt; Web Services &gt; Server and Runtime</property></emphasis>. On this page, you can specify a default server and runtime.</para> + <para>For ease of use, the better way is to set runtime to JBoss WS.</para> + <para>After server and runtime are specified, click on the <property moreinfo="none">Apply</property> button + to save the values.</para> + <figure float="0"> + <title>Specifing a default server and runtime</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/preference/jbossws_server_runtime.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the whole, this guide covers the fundamental concepts of work with tooling for + <property moreinfo="none">JBossWS</property>. It describes how to easily create a Web Service and a Web Service Client using + JBossWS Runtime and adjust JBossWS and development environment as well.</para> + + <para>If the information on JBossWS tools in this guide isn't enough for you, ask + questions on our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&...;. Your comments and suggestions are also welcome.</para> + </section> +</chapter> + +</book>