Gitiles
Code Review Sign In
git.eclipse.org / webservices / webtools.webservices.axis2 / refs/tags/R3_6_1 / . / docs / org.eclipse.jst.ws.axis2.ui.doc.user / topics / taxis2bu.html
blob: a0f8c7b26bf88c1d5e6b9f56c9b0a8ccb0325b6b [file] [log] [blame]
kprice6decb032008-04-01 19:05:41 +0000[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html lang="en-us" xml:lang="en-us">
3<head>
4<meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
5<meta name="copyright" content="Copyright (c) 2000, 2008 IBM Corporation and others. All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: IBM Corporation - initial API and implementation" />
6<meta name="DC.rights.owner" content="(C) Copyright 2000, 2008" />
7<meta content="public" name="security" />
8<meta content="index,follow" name="Robots" />
9<meta http-equiv="PICS-Label" content='(PICS-1.1 "http://www.icra.org/ratingsv02.html" l gen true r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true r (n 0 s 0 v 0 l 0) "http://www.classify.org/safesurf/" l gen true r (SS~~000 1))' />
10<meta content="task" name="DC.Type" />
11<meta name="DC.Title" content="Creating a Web service from a Java bean using the Apache Axis2 runtime environment" />
12<meta name="abstract" content="The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and deploying the Web service to a server. Once your Web service is deployed, the wizard assists you in generating the client proxy and sample application to test the Web service. When you have completed testing, you can publish your Web service to a UDDI Business Registry using the Export wizard." />
13<meta name="description" content="The Web Service wizard assists you in creating a new Web service, configuring it for deployment, and deploying the Web service to a server. Once your Web service is deployed, the wizard assists you in generating the client proxy and sample application to test the Web service. When you have completed testing, you can publish your Web service to a UDDI Business Registry using the Export wizard." />
14<meta content="Axis2 runtime environment, Web services, Java beans, Axis2 runtime environment, creating a Web service" name="DC.subject" />
15<meta content="Axis2 runtime environment, Web services, Java beans, Axis2 runtime environment, creating a Web service" name="keywords" />
16<meta scheme="URI" name="DC.Relation" content="../topics/caxis2tover.html" />
17<meta scheme="URI" name="DC.Relation" content="../../org.eclipse.jst.ws.doc.user/concepts/cwsinwsa.html" />
18<meta scheme="URI" name="DC.Relation" content="../../org.eclipse.jst.ws.doc.user/concepts/cws.html" />
19<meta scheme="URI" name="DC.Relation" content="../../org.eclipse.jst.ws.doc.user/tasks/toverws.html" />
20<meta scheme="URI" name="DC.Relation" content="../../org.eclipse.jst.ws.consumption.ui.doc.user/tasks/tuddiexp.html" />
21<meta content="XHTML" name="DC.Format" />
22<meta content="twsbeana" name="DC.Identifier" />
23<meta content="en-us" name="DC.Language" />
24<link href="../../org.eclipse.wst.doc.user/common.css" type="text/css" rel="stylesheet" />
25<title>Creating a Web service from a Java bean using the Apache Axis2
26runtime environment</title>
27</head>
28<body id="twsbeana"><a name="twsbeana"><!-- --></a>
29
30
31<h1 class="topictitle1">Creating a Web service from a Java bean using the Apache Axis2 runtime
32environment</h1>
33
34
35
36
37<div><p>The Web Service wizard assists you in creating a new Web service,
38configuring it for deployment, and deploying the Web service to a server.
39Once your Web service is deployed, the wizard assists you in generating the
40client proxy and sample application to test the Web service. When you have
41completed testing, you can publish your Web service to a UDDI Business Registry
42using the Export wizard.</p>
43
44<div class="p"><div class="p">Prerequisites:<ol>
45<li id="twsbeana__installaxis2link"><a name="twsbeana__installaxis2link"><!-- --></a>You must have installed the Apache Axis2 runtime
46environment as described in: <a href="caxis2tover.html" title="This runtime environment is for users who prefer to develop for&#10;the open Apache Axis platform. Both Axis1 and Axis2 are supported by the Web&#10;services tools.">Creating Web services with the Apache Axis2 runtime environments</a></li>
47
48<li id="twsbeana__createtomcatlink"><a name="twsbeana__createtomcatlink"><!-- --></a>If you are using the Apache Jakarta Tomcat servlet
49container as your server, you must install it, configure an instance of it,
kpriceb68e6af2008-05-15 22:17:35 +0000[diff] [blame]50and create a Web project targeted to it as described in: <a href="../../org.eclipse.jst.ws.axis.ui.doc.user/topics/ttomcatserv.html">Creating an Apache Tomcat server and Web project</a></li>
kprice6decb032008-04-01 19:05:41 +0000[diff] [blame]51
52<li>Create or import a bean into the Java™ source folder of the Web project. To
53import, select the <strong>Java Resources: src</strong> folder, and from
54the file menu select <span class="menucascade"><span class="uicontrol">Import</span> &gt; <span class="uicontrol">General</span>
55 &gt; <span class="uicontrol">File System</span></span> and browse to where your
56package is.</li>
57
58</ol>
59</div>
60</div>
61
62<div class="section">To create a Web service from a bean using the Apache Axis2 runtime
63environment:</div>
64
65<ol>
kprice5454e8e2008-04-23 23:32:43 +0000[diff] [blame]66<li class="stepexpand"><span>Switch to the Java EE perspective (<span class="uicontrol">Window &gt; Open Perspective
67&gt; Java EE</span>).</span></li>
kprice6decb032008-04-01 19:05:41 +0000[diff] [blame]68
69<li class="stepexpand"><span>In the Project Explorer view, select the bean that you created
70or imported into the source folder of your Web project.</span></li>
71
72<li class="stepexpand"><span>Click <span class="uicontrol">File &gt; New &gt; Other</span>.</span> Select<span class="uicontrol">Web
73Services</span> in order to display the various Web service wizards.
74Select the <span class="uicontrol">Web Service</span> wizard. Click <span class="uicontrol">Next</span>.
75</li>
76
77<li class="stepexpand"><span>Web Services page: select <span class="uicontrol">Bottom up Java bean Web service</span> as
78your Web service type, and select the Java bean from which the service will be
79created.</span>
80<a name="twsbeana__createstep4ul"><!-- --></a><ol type="a" id="twsbeana__createstep4ul">
81<li class="substepexpand"><span>Select the stages of Web services development that you want
82to complete using the slider:</span> <ul>
83<li>Develop: this will develop the WSDL definition and implementation of the
84Web service. This includes such tasks as creating the modules which will contain
85the generated code, WSDL files, deployment descriptors, and Java files
86when appropriate.</li>
87
88<li>Assemble: this ensures the project that will host the Web service or client
89gets associated to an EAR when required by the target application server.</li>
90
91<li>Deploy: this will create the deployment code for the service.</li>
92
93<li>Install: this will install and configure the Web module and EARs on the
94target server.</li>
95
96<li>Start: this will start the server once the service has been installed
97on it. The server-config.wsdd file will be generated.</li>
98
99<li>Test: this will provide various options for testing the service, such
100as using the Web Service Explorer or sample JSPs.</li>
101
102</ul>
103</li>
104
105<li class="substepexpand"><span>Select your server: the default server is displayed. If you
106want to deploy your service to a different server click the link to specify
107a different server.</span></li>
108
109<li class="substepexpand"><span>Select your runtime: ensure the Apache Axis2 runtime is selected.</span>
110</li>
111
112<li class="substepexpand"><span>Select the service project: the project selected in your workspace
113is displayed. To select a different project click on the project link. If
114you are deploying to WebSphere<sup>®</sup> Application Server you will also be asked
115to select the EAR associated with the project.</span> Ensure that the
116project selected as the Client Web Project is different from the Service Web
117Project, or the service will be overwritten by the client's generated artifacts.
118</li>
119
120<li class="substepexpand"><span>If you want to create a client, select the type of proxy to
121be generated and repeat the above steps for the client.</span></li>
122
123<li class="substepexpand"><span>Publish the Web service: this will launch the Web Services Explorer
124to publish your Web service to a UDDI registry.</span></li>
125
126<li class="substepexpand"><span>Monitor the Web service: this will send the Web service traffic
127through the TCP/IP Monitor, which allows you to watch the SOAP traffic generated
128by the Web service and to test this traffic for WS-I compliance. Alternately
129you can manually set up a TCP/IP monitor as described in <a href="../../org.eclipse.wst.wsi.ui.doc.user/tasks/tmonitor.html">Using the TCP/IP Monitor to test Web services</a></span></li>
130
131</ol>
132
133</li>
134
135<li class="stepexpand"><span>Axis2 Web Service Java Bean Configuration page: If you have
136a custom services.xml file you can point to it on this page, or you can have
137the wizard create a default services.xml file for you.</span></li>
138
139<li class="stepexpand"><span>Web Service Test page: If you selected to test the Web service,
140select the test facility for the generated Web service.</span> This will
141open the Web service in the Web Services Explorer. Select the operation you
142want to test, enter the required information, and click<span class="uicontrol">Go</span>.
143The result will display in the Status pane. Click <span class="uicontrol">Next</span>.
144</li>
145
146<li class="stepexpand" id="twsbeana__axis2clientpagelink"><a name="twsbeana__axis2clientpagelink"><!-- --></a><span>Axis2 Client Web service configuration
147page: Use this page to select the following options: </span>
148<ol type="a">
149<li><span>Service Name: accept the default.</span></li>
150
151<li><span>Port Name: accept the default.</span></li>
152
153<li><span>Databinding Name: only the Axis2 Databinding Framework (ADB)
154is supported at this time.</span></li>
155
156<li><span>Custom package name: You can change the package name in this
157field.</span></li>
158
159<li><span>Client mode: You can choose if the client is synchronous, asynchronous,
160or both.</span></li>
161
162<li><span>Generate test case to test the service: If you select this,
163the Axis2 emitter will generate JUnit testcases matching the WSDL provided
164to the client. These JUnit testcases will be generated to a newly added source
165directory to the client project called <span class="uicontrol">test</span>. </span>
166</li>
167
168<li><span>Generate all types for all elements referred by schemas</span>
169</li>
170
171<li><span>Namespace to package mapping: Use this table to review or edit
172the mappings between packages and namespaces.</span></li>
173
174</ol>
175
176</li>
177
178<li class="stepexpand"><span>Web Service Client Test page: Use this page to select the following
179options: </span>
180<ol type="a">
181<li><span>Select your test facility. You can test the generated proxy
182in the Web Service Explorer, or the Universal Test Client.</span></li>
183
184<li><span>Select <span class="uicontrol">Run test on server</span> to start the
185server for you automatically.</span></li>
186
187</ol>
188
189</li>
190
191<li class="stepexpand"><span>Web Service Publication page: Select whether or not you want to
192publish this Web service to a UDDI registry. Click <span class="uicontrol">Finish</span>.</span>
193</li>
194
195</ol>
196
197<div class="section" id="twsbeana__axiswscreateresult"><a name="twsbeana__axiswscreateresult"><!-- --></a><div class="p">After the Web service has been created,
198the following may occur depending on the options you selected: <ul>
199<li>If you have selected to test the Web service using the Web Services Explorer,
200the Explorer will open. Select the operation you want to test, enter the required
201information, and click <strong>Go</strong>. The result will display in the Status pane.</li>
202
203<li>If you have selected to publish the Web service, the Web Services Explorer
204is launched displaying the page required to publish your Web service. Follow
205the instructions in <var class="varname">Publishing the Web service</var> to complete
206this task.</li>
207
208</ul>
209</div>
210</div>
211
212<div class="section"><p> <span class="uicontrol">Important:</span> If your methods contain types,
213not supported by the sample, such as arrays, indexed properties, and collections,
214the methods will be omitted from the sample and you will receive a warning
215message.</p>
216</div>
217
218</div>
219
kpriceb68e6af2008-05-15 22:17:35 +0000[diff] [blame]220<div>
221<div class="familylinks">
222<div class="parentlink"><strong>Parent topic:</strong> <a href="../topics/caxis2tover.html" title="This runtime environment is for users who prefer to develop for the open Apache Axis platform. Both Axis1 and Axis2 are supported by the Web services tools.">Creating Web services with the Apache Axis2 runtime environments</a></div>
kprice6decb032008-04-01 19:05:41 +0000[diff] [blame]223</div>
224
225<div class="linklist"><strong>Related Concepts</strong><br />
226
227<div><a href="../../org.eclipse.jst.ws.doc.user/concepts/cwsinwsa.html"> Tools for Web services development</a></div>
228<div><a href="../../org.eclipse.jst.ws.doc.user/concepts/cws.html">Web services development</a></div></div>
229
230<div class="linklist"><strong>Related Tasks</strong><br />
231
232<div><a href="../../org.eclipse.jst.ws.doc.user/tasks/toverws.html"> Developing Web services</a></div>
233<div><a href="../../org.eclipse.jst.ws.consumption.ui.doc.user/tasks/tuddiexp.html"> Using the Web Services Explorer</a></div></div>
234</div>
235
236</body>
237</html>