You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wsrf-dev@ws.apache.org by ip...@apache.org on 2005/06/21 00:08:06 UTC
svn commit: r191574 [2/3] - in /incubator/apollo/site: ./ dev_guide/ images/
manual/ tutorial/ tutorial/images/ tutorial/requests/
tutorial/src/example/filesystem/callback/
Modified: incubator/apollo/site/tutorial/home.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/home.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/home.html (original)
+++ incubator/apollo/site/tutorial/home.html Mon Jun 20 15:08:04 2005
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
-</div>
+<a title="" href="../tutorial/index.html">Overview</a>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
-</div>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Documentation</div>
-<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
+<a title="" href="../tutorial/service.html">Write Service Class</a>
</div>
<div class="menuitem">
-<a title="" href="../tutorial/index.html">Tutorial</a>
+<a title="" href="../tutorial/resource.html">Write Resource Class</a>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
+<div class="menupage">
+<div class="menupagetitle">Write Home Class</div>
</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
</div>
<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<a title="" href="../tutorial/test.html">Test</a>
</div>
-<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit"></div>
@@ -176,43 +170,38 @@
</li>
</ul>
</div>
-
-
+
<a name="N1000C"></a><a name="intro"></a>
<h2 class="boxed">Introduction</h2>
<div class="section">
<p>This section will describe how to write a home for your resource class.
- The home is used to lookup the resource instance. It can act as a factory
- for creating instances upon request, or build all instances. It is meant
- to be the entry point for locating a resource instance.</p>
+ The home is used to lookup the resource instance. It can act as a factory
+ for creating instances upon request, or build all instances. It is meant
+ to be the entry point for locating a resource instance.
+ </p>
</div>
-
-
+
<a name="N10016"></a><a name="class-declaration"></a>
<h2 class="boxed">Class Declaration</h2>
<div class="section">
-<p>When declaring your "home" you
- <strong>should</strong> extend AbstractResourceHome. Extending AbstractResourceHome
- will provide services for caching instances and looking them up. It will also ensure
- that the correct interfaces are implemented so that Apollo can interact with your home.
- </p>
-<p>The FileSystemHome extends AbstractResourceHome and implements Serializable:</p>
+<p>When declaring your "home" you <strong>should</strong> extend <span class="codefrag">AbstractResourceHome</span>. Extending <span class="codefrag">AbstractResourceHome</span> will provide services for caching instances and looking them up. It will also ensure
+ that the correct interfaces are implemented so that Apache WSRF can interact with your home.
+ </p>
+<p>The <span class="codefrag">FileSystemHome</span> class extends <span class="codefrag">AbstractResourceHome</span> and implements <span class="codefrag">Serializable</span>:</p>
<pre class="code">public class FileSystemHome
extends AbstractResourceHome
implements Serializable</pre>
</div>
-
-
-<a name="N1002A"></a><a name="ops"></a>
+
+<a name="N10039"></a><a name="ops"></a>
<h2 class="boxed">Operations</h2>
<div class="section">
-<p>If you extend AbstractResourceHome, the only required operation you will need to implement is:
- </p>
+<p>If you extend <span class="codefrag">AbstractResourceHome</span>, the only required operation you will need to implement is:</p>
<pre class="code">public Resource getInstance( ResourceContext resourceContext )</pre>
-<p>The getInstance(...) operation provides the ability for you to intercept the request for
- retrieving an instance. In the FileSystem example, we use the operation to determine
- if the requested resource instance is a valid filesystems (i.e. one that is being managed
- via WSRF); if it is not, we throw an exception.</p>
+<p>The <span class="codefrag">getInstance(...)</span> operation provides the ability for you to intercept the request for
+ retrieving an instance. In the FileSystem example, we use the operation to determine
+ if the requested resource instance is a valid filesystems (i.e. one that is being managed
+ via WSRF); if it is not, we throw an exception.</p>
<pre class="code">public Resource getInstance( ResourceContext resourceContext )
throws ResourceException,
ResourceContextException,
@@ -250,17 +239,20 @@
}
return resource;
}</pre>
-<p>Notice the method makes calls to find(...) and createInstance(...). These operations are
- provided by the AbstractResourceHome superclass. They provide functions like caching and
- instantiating instances.</p>
+<p>Notice the method makes calls to <span class="codefrag">find(...) </span>and <span class="codefrag">createInstance(...)</span>. These operations are
+ provided by the <span class="codefrag">AbstractResourceHome</span> superclass. They provide functions like caching and
+ instantiating instances.</p>
<div class="frame note">
<div class="label">Note</div>
-<div class="content">Many of the operations in the AbstractResourceHome may be overridden in your Home
- class, if you have a need to extend its functionality.</div>
+<div class="content">Many of the operations in the <span class="codefrag">AbstractResourceHome</span> may be overridden in your Home
+ class, if you have a need to extend its functionality.</div>
</div>
+<p>
+<img alt="go to the previous step" src="images/back.gif"><a href="../tutorial/callback.html">Back</a> <img alt="go to the next step" src="images/next.gif"><a href="../tutorial/webapp.html">Next</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
Added: incubator/apollo/site/tutorial/images/back.gif
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/images/back.gif?rev=191574&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/apollo/site/tutorial/images/back.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Added: incubator/apollo/site/tutorial/images/next.gif
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/images/next.gif?rev=191574&view=auto
==============================================================================
Binary file - no diff available.
Propchange: incubator/apollo/site/tutorial/images/next.gif
------------------------------------------------------------------------------
svn:mime-type = application/octet-stream
Modified: incubator/apollo/site/tutorial/index.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/index.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/index.html (original)
+++ incubator/apollo/site/tutorial/index.html Mon Jun 20 15:08:04 2005
@@ -5,7 +5,7 @@
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.6">
<meta name="Forrest-skin-name" content="pelt">
-<title>Apollo Tutorial</title>
+<title>Apache WSRF Tutorial</title>
<link type="text/css" href="../skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
-</div>
-<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
+<div class="menupage">
+<div class="menupagetitle">Overview</div>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
-</div>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-<div onclick="SwitchMenu('menu_selected_1.3', '../skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Documentation</div>
-<div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
-</div>
-<div class="menupage">
-<div class="menupagetitle">Tutorial</div>
+<a title="" href="../tutorial/service.html">Write Service Class</a>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
+<a title="" href="../tutorial/resource.html">Write Resource Class</a>
</div>
+<div class="menuitem">
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/home.html">Write Home Class</a>
</div>
<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
</div>
<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit">
@@ -164,70 +158,57 @@
+-->
<div id="content">
<div id="skinconf-txtlink"></div>
-<h1>Apollo Tutorial</h1>
-
-
+<h1>Apache WSRF Tutorial</h1>
+
<a name="N1000C"></a><a name="Creating+and+Deploying+a+WSRF+Web+Service"></a>
<h2 class="boxed">Creating and Deploying a WSRF Web Service</h2>
<div class="section">
-<p>
- This tutorial will walk you through using Apollo to create and deploy a WSRF Web service
- that represents a Unix filesystem. The process is broken down into the following steps:
- </p>
+<p>This tutorial provides a step-by-step approach to using Apache WSRF to create and deploy a WSRF-compliant Web service
+ that represents a UNIX file system. If you want to see a completed version of the UNIX file system Web service, see the <a href="../getting_started.html#qd">Quick Demonstration</a>.</p>
+<p>The process consists of the following steps:</p>
<ol>
-
+
<li>
-
<a href="wsdl.html">Write the WSDL for the service.</a>
-
</li>
-
+
<li>
-
-<a href="wsdl2java.html">Run Apollo's Wsdl2Java tool on the WSDL.</a>
-
+<a href="wsdl2java.html">Run Apache WSRF Wsdl2Java tool on the WSDL.</a>
</li>
-
+
<li>
-
<a href="service.html">Create the service class and add business logic to it.</a>
-
</li>
-
+
<li>
-
-<a href="resource.html">Create the resource class which will maintain state for a resource instance.</a>
-
+<a href="resource.html">Create the resource class which maintains state for a resource instance.</a>
</li>
-
+
<li>
-
<a href="callback.html">Create backend callback objects for all non-static resource properties.</a>
-
</li>
-
+
<li>
-
<a href="home.html">Create the home class and add instance lookup logic to it.</a>
-
</li>
-
+
<li>
-
-<a href="webapp.html">Deploy the service to the Apollo webapp.</a>
-
-</li>
-
+<a href="webapp.html">Deploy the service to the Apache WSRF web application.</a>
+</li>
+
<li>
-
<a href="test.html">Start Tomcat and send some test requests to the service.</a>
-
</li>
-
+
</ol>
+<p>
+
+<img alt="go to the next step" src="images/next.gif">
+ <a href="../tutorial/wsdl.html">Next</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
Modified: incubator/apollo/site/tutorial/requests/SetResourceProperties_updateMountPointProp.soap
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/requests/SetResourceProperties_updateMountPointProp.soap?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/requests/SetResourceProperties_updateMountPointProp.soap (original)
+++ incubator/apollo/site/tutorial/requests/SetResourceProperties_updateMountPointProp.soap Mon Jun 20 15:08:04 2005
@@ -11,7 +11,7 @@
<wsrp:SetResourceProperties xmlns:wsrp="http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceProperties-1.2-draft-01.xsd"
xmlns:fs="http://ws.apache.org/resource/example/filesystem">
<wsrp:Update>
- <fs:MountPointDirectory>/var/tmp/apollo</fs:MountPointDirectory>
+ <fs:MountPointDirectory>/var/tmp/wsrf</fs:MountPointDirectory>
</wsrp:Update>
</wsrp:SetResourceProperties>
</Body>
Modified: incubator/apollo/site/tutorial/resource.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/resource.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/resource.html (original)
+++ incubator/apollo/site/tutorial/resource.html Mon Jun 20 15:08:04 2005
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
-</div>
+<a title="" href="../tutorial/index.html">Overview</a>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
-</div>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Documentation</div>
-<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
+<a title="" href="../tutorial/service.html">Write Service Class</a>
</div>
-<div class="menuitem">
-<a title="" href="../tutorial/index.html">Tutorial</a>
+<div class="menupage">
+<div class="menupagetitle">Write Resource Class</div>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
-</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/home.html">Write Home Class</a>
</div>
<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
</div>
<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
+<a title="" href="../tutorial/test.html">Test</a>
+</div>
</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit"></div>
@@ -179,77 +173,81 @@
</li>
</ul>
</div>
-
-
+
<a name="N1000C"></a><a name="intro"></a>
<h2 class="boxed">Introduction</h2>
<div class="section">
-<p>
- The resource class is the stateful instance-representation of your of your Web service.
- The resource maintains the resource id and the ResourcePropertySet. The resource id is
- the unique identifier for an instance of your Web service. It allows you to have multiple
- resource instances, each with their own state, fronted by the same Web service.
- The stateful properties are represented by the ResourcePropertySet. The ResourcePropertySet
- is the Java representation of the Resource Properties document defined in the schema section
- of your WSDL file.
- </p>
+<p>The resource class is the stateful instance-representation of your of your Web service.
+ The resource maintains the resource id and the ResourcePropertySet. The resource id is
+ the unique identifier for an instance of your Web service. It allows you to have multiple
+ resource instances, each with their own state, fronted by the same Web service.
+ The stateful properties are represented by the ResourcePropertySet. The ResourcePropertySet
+ is the Java representation of the Resource Properties document defined in the schema section
+ of your WSDL file.
+ </p>
<p>When a request is made for a Web service, it is expected to contain a WS-Addressing
- header which contains the resource id. When Apollo receives the request it
- will use the resource id to look up the corresponding resource instance to
- service the request.</p>
+ header which contains the resource id. When Apache WSRF receives the request it
+ will use the resource id to look up the corresponding resource instance to
+ service the request.
+ </p>
<p>This section will discuss how to write a resource class.
- Initially, you should model your resource off of the included FileSystemResource example.
- This will ensure you will write a valid resource class.</p>
+ Initially, you should model your resource off of the included <span class="codefrag">FileSystemResource</span> example.
+ This will ensure you will write a valid resource class.</p>
</div>
-
-
-<a name="N1001C"></a><a name="class-declaration"></a>
+
+<a name="N1001F"></a><a name="class-declaration"></a>
<h2 class="boxed">Class Declaration</h2>
<div class="section">
-<p>When declaring your Resource class you MUST implement org.apache.ws.resource.Resource which
- provides the necessary operations for dealing with the ResourcePropertySet and the
- resource's id. When defining a singleton service</p>
+<p>When declaring your Resource class you MUST implement <span class="codefrag">org.apache.ws.resource.Resource</span> which
+ provides the necessary operations for dealing with the ResourcePropertySet and the
+ resource's id. When defining a singleton service
+ </p>
<div class="frame note">
<div class="label">Note</div>
<div class="content">The resource id is a custom WS-Addressing header element which you will define in your configuration
- information for your service.</div>
+ information for your service.</div>
</div>
-<p>Optionally, you may also implement PersistentResource, for providing hooks for persistence,
- and ScheduledResourceTerminationResource, for adding the ability to schedule when the resource
- should be terminated.</p>
-<p>The FileSystemResource's class declaration is as follows:</p>
+<p>Optionally, you may also implement <span class="codefrag">PersistentResource</span>, for providing hooks for persistence,
+ and <span class="codefrag">ScheduledResourceTerminationResource</span>, for adding the ability to schedule when the resource
+ should be terminated.
+ </p>
+<p>The <span class="codefrag">FileSystemResource</span> class declaration is as follows:</p>
<pre class="code">public class FileSystemResource extends
AbstractFileSystemResource</pre>
-<p>Notice that we've extended a base abstract class. This allows us to focus solely on the init() operation for registering callback objects and initializing the values of our ResourceProperties.</p>
-<p>The AbstractFileSystemResource class implements Resource, PropertiesResource, ScheduledResourceTerminationResource. We've "abstracted" the non-user specific code to the abstract class so that the user can focus on their initialization.</p>
+<p>Notice that we've extended a base abstract class. This allows us to focus solely on the <span class="codefrag">init()</span> operation for registering callback objects and initializing the values of our ResourceProperties.
+ </p>
+<p>The <span class="codefrag">AbstractFileSystemResource</span> class implements <span class="codefrag">Resource</span>, <span class="codefrag">PropertiesResource</span>, and <span class="codefrag"> ScheduledResourceTerminationResource</span>. We've "abstracted" the non-user specific code to the abstract class so that the user can focus on their initialization.
+ </p>
</div>
-
-
-<a name="N10039"></a><a name="vars"></a>
+
+<a name="N10057"></a><a name="vars"></a>
<h2 class="boxed">Instance Variables</h2>
<div class="section">
-<p> The instance variables of AbstractFileSystemResource should include the resource id and the
- ResourcePropertySet. The ResourcePropertySet is the object representation of the resource
- properties document associated with this resource instance.</p>
+<p>The instance variables of <span class="codefrag">AbstractFileSystemResource</span> should include the resource id and the
+ ResourcePropertySet. The ResourcePropertySet is the object representation of the resource
+ properties document associated with this resource instance.</p>
<div class="frame note">
<div class="label">Note</div>
<div class="content">Since it is not a requirement to have resource properties in your service,
- there is a PropertiesResource interface to denote that properties are being exposed.</div>
+ there is a PropertiesResource interface to denote that properties are being exposed.</div>
</div>
</div>
-
-
-<a name="N10046"></a><a name="methods"></a>
+
+<a name="N10067"></a><a name="methods"></a>
<h2 class="boxed">Methods</h2>
<div class="section">
<p>The methods are defined by the interfaces you implement and are mainly setters and
- getters for the ResourcePropertySet and the resource id. There are also operations
- which allow you to initialize your resource or destroy your resource (init(..) and
- destroy()). The operations allow you to do setup, initializing your resource properties,
- adding callback objects, and cleanup in your resource class.</p>
+ getters for the ResourcePropertySet and the resource id. There are also operations
+ which allow you to initialize your resource or destroy your resource (<span class="codefrag">init(..) </span>and
+ <span class="codefrag">destroy()</span>). The operations allow you to do setup, initializing your resource properties,
+ adding callback objects, and cleanup in your resource class.
+ </p>
+<p>
+<img alt="go to the previous step" src="images/back.gif"><a href="../tutorial/service.html">Back</a> <img alt="go to the next step" src="images/next.gif"><a href="../tutorial/callback.html">Next</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
Modified: incubator/apollo/site/tutorial/service.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/service.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/service.html (original)
+++ incubator/apollo/site/tutorial/service.html Mon Jun 20 15:08:04 2005
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
-</div>
+<a title="" href="../tutorial/index.html">Overview</a>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-</div>
-<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Documentation</div>
-<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
-<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
+<div class="menupage">
+<div class="menupagetitle">Write Service Class</div>
</div>
<div class="menuitem">
-<a title="" href="../tutorial/index.html">Tutorial</a>
+<a title="" href="../tutorial/resource.html">Write Resource Class</a>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
-</div>
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/home.html">Write Home Class</a>
</div>
<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
</div>
<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
+<a title="" href="../tutorial/test.html">Test</a>
</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit"></div>
@@ -172,7 +166,7 @@
<a href="#classes">What classes will need to be written?</a>
<ul class="minitoc">
<li>
-<a href="#abstract">The AbstractService class.</a>
+<a href="#abstract">The AbstractService class</a>
<ul class="minitoc">
<li>
<a href="#class-declaration">Class Declaration</a>
@@ -195,106 +189,92 @@
</li>
</ul>
</div>
-
-
+
<a name="N1000C"></a><a name="intro"></a>
<h2 class="boxed">Introduction</h2>
<div class="section">
-<p>
- The service class is the representation of your WSDL file as a Web service.
- The public methods in the service class correspond to the SOAP operations
- exposed by your Web service.
- </p>
+<p>The service class is the representation of your WSDL file as a Web service.
+ The public methods in the service class correspond to the SOAP operations
+ exposed by your Web service.
+ </p>
<p>This section will discuss how to write a service class.
- Initially, you should model your service off of the included FileSystemService example.
- This will ensure you will write a valid service.</p>
+ Initially, you should model your service off of the included FileSystemService example.
+ This will ensure you will write a valid service.</p>
</div>
-
-
+
<a name="N10019"></a><a name="classes"></a>
<h2 class="boxed">What classes will need to be written?</h2>
<div class="section">
-<p>The provided example "FileSystem" includes a FileSystemService class.
- The FileSystemService extends AbstractFileSystemService, which contains
- any code which should not need to be altered. The abstract class mainly
- consists of the specification operations (i.e. getMultipleResourceProperties),
- while the service class which extends this class contains the "custom" operations.
- In the case of FileSystemService, these operations are "mount" and "unmount".</p>
-<p>
- We recommend this structure for writing your service class, however you may write
- the service however you like. Our description will describe the use of the abstract
- class to separate the functionality.
- </p>
-<a name="N10025"></a><a name="abstract"></a>
-<h3 class="boxed">The AbstractService class.</h3>
+<p>The provided example FileSystem includes a <span class="codefrag">FileSystemService</span> class.
+ The FileSystemService extends <span class="codefrag">AbstractFileSystemService</span>, which contains
+ any code which should not need to be altered. The abstract class mainly
+ consists of the specification operations (i.e. <span class="codefrag">getMultipleResourceProperties</span>),
+ while the service class which extends this class contains the "custom" operations.
+ In the case of <span class="codefrag">FileSystemService</span>, these operations are <span class="codefrag">mount</span> and <span class="codefrag">unmount</span>.
+ </p>
+<p> We recommend this structure for writing your service class, however you may write
+ the service however you like. Our description will describe the use of the abstract
+ class to separate the functionality.
+ </p>
+<a name="N10037"></a><a name="abstract"></a>
+<h3 class="boxed">The AbstractService class</h3>
<p>The abstract class is the superclass for your service and will contain most of the
- specification-specific operations and utility operations. Our description of writing
- the class will be based on the example.filesystem.AbstractFileSystemService class.</p>
+ specification-specific operations and utility operations. Our description of writing
+ the class will be based on the <span class="codefrag">example.filesystem.AbstractFileSystemService</span> class.</p>
<p>We will describe the class in sections:</p>
<ol>
-
+
<li>
-
<a href="#class-declaration">Class Declaration</a>
-
</li>
-
+
<li>
-
<a href="#wsrfservice">WsrfService Interface</a>
-
</li>
-
+
<li>
-
<a href="#classvars">Class Variable</a>
-
</li>
-
+
<li>
-
<a href="#ops">Operations</a>
-
</li>
-
+
</ol>
-<a name="N10050"></a><a name="class-declaration"></a>
+<a name="N1005D"></a><a name="class-declaration"></a>
<h4>Class Declaration</h4>
<p>When declaring your abstract class, you must implement
- <span class="codefrag">org.apache.ws.resource.handler.WsrfService</span>. This interface provides
- methods for initialization, obtaining the ResourceContext and getting the
- SoapMethodNameMap used for mapping incoming request QName's to method name
- for a given object. It basically ensures that Apollo can interact with your
- service class.
- </p>
-<p>The AbstractFileSystemService's class declaration is as follows:</p>
+ <span class="codefrag">org.apache.ws.resource.handler.WsrfService</span>. This interface provides
+ methods for initialization, obtaining the ResourceContext and getting the
+ SoapMethodNameMap used for mapping incoming request QName's to method name
+ for a given object. It basically ensures that Apache WSRF can interact with your
+ service class.
+ </p>
+<p>The <span class="codefrag">AbstractFileSystemService</span> class declaration is as follows:</p>
<pre class="code">
-
-<strong> abstract class AbstractFileSystemService
- implements WsrfService,
- GetResourcePropertyPortType,
- GetMultipleResourcePropertiesPortType,
- SetResourcePropertiesPortType,
- QueryResourcePropertiesPortType,
- ImmediateResourceTerminationPortType,
- ScheduledResourceTerminationPortType</strong>
-
+<strong> abstract class AbstractFileSystemService implements WsrfService,
+ GetResourcePropertyPortType,
+ GetMultipleResourcePropertiesPortType,
+ SetResourcePropertiesPortType,
+ QueryResourcePropertiesPortType,
+ ImmediateResourceTerminationPortType,
+ ScheduledResourceTerminationPortType</strong>
+
</pre>
-<p>You should notice that the class implements WsrfService (described above) and various *PortType
- inerfaces. Each PortType interface is a Java representation of a specification's WSDL portType
- declaration. By implementing the PortType interface corresponding to the specification's/portTypes
- you are interested in, you will ensure you get the correct method signature for the method call. </p>
-<p>The packages:
- <strong>org.apache.ws.resource.properties.porttype</strong> and
- <strong>org.apache.ws.resource.lifetime.porttype</strong> contain the interfaces for the
- specifications. You should refer to these packages when selecting the operations you'd like
- to support.
- </p>
-<a name="N10073"></a><a name="wsrfservice"></a>
+<p>You should notice that the class implements <span class="codefrag">WsrfService</span> (described above) and various *PortType
+ inerfaces. Each PortType interface is a Java representation of a specification's WSDL portType
+ declaration. By implementing the PortType interface corresponding to the specification's/portTypes
+ you are interested in, you will ensure you get the correct method signature for the method call. </p>
+<p>The packages:<strong><span class="codefrag">org.apache.ws.resource.properties.porttype</span></strong> and
+ <strong><span class="codefrag">org.apache.ws.resource.lifetime.porttype</span></strong> contain the interfaces for the
+ specifications. You should refer to these packages when selecting the operations you'd like
+ to support.
+ </p>
+<a name="N10087"></a><a name="wsrfservice"></a>
<h4>WsrfService Interface</h4>
-<p>All Apollo services must implement the WsrfService interface. The interface provides operation
- "hooks" which will allow Apollo to interact with your service. There are currenty three operations defined
- by the interface:</p>
+<p>All Apache WSRF services must implement the <span class="codefrag">WsrfService</span> interface. The interface provides operation
+ "hooks" which will allow Apache WSRF to interact with your service. There are currenty three operations defined
+ by the interface:</p>
<pre class="code"> /**
* Returns the SoapMethodNameMap for the Service, to determine
* which method to invoke for an incoming request.
@@ -314,46 +294,46 @@
* Initialization method.
*/
public void init( );</pre>
-<p>The getMethodNameMap() returns a SoapMethodNameMap implementation which contains mappings of WSDL operation QNames to Java method names. If you have custom operations you will need to create an instance of ServiceSoapMethodName and add mappings for you operations.</p>
-<p>The getResourceContext() operation returns the ResourceContext associated with this service. This method may be left abstract in this class and later implemented in the Service extension of your abstract class.</p>
-<p>The init() method is provided to give you an opportunity to initialize members for your Service (e.g. ServiceSoapMethodName )</p>
-<a name="N1008A"></a><a name="classvars"></a>
+<p>The <span class="codefrag">getMethodNameMap()</span> returns a SoapMethodNameMap implementation which contains mappings of WSDL operation QNames to Java method names. If you have custom operations you will need to create an instance of <span class="codefrag">ServiceSoapMethodName</span> and add mappings for your operations.
+ </p>
+<p>The <span class="codefrag">getResourceContext()</span> operation returns the ResourceContext associated with this service. This method may be left abstract in this class and later implemented in the Service extension of your abstract class.
+ </p>
+<p>The<span class="codefrag"> init()</span> method is provided to give you an opportunity to initialize members for your Service (e.g. <span class="codefrag">ServiceSoapMethodName </span>)</p>
+<a name="N100B0"></a><a name="classvars"></a>
<h4>Class Variables</h4>
<p>The class variables which should be defined are:</p>
<ol>
-
+
+<li>
+<strong><span class="codefrag">TARGET_NSURI</span></strong> - The target namespace of your sevice's WSDL file.</li>
+
<li>
-
-<strong>TARGET_NSURI</strong> - The target namespace of your sevice's WSDL file.
- </li>
-
-<li>
-
-<strong>TARGET_NSPREFIX</strong> - The target prefix to be associated with your service's namespace.
- </li>
-
+<strong><span class="codefrag">TARGET_NSPREFIX</span></strong> - The target prefix to be associated with your service's namespace.</li>
+
</ol>
-<p> In the AbstractFileSystem we have:</p>
+<p> In the <span class="codefrag">AbstractFileSystem</span> we have:</p>
<pre class="code">public static final String TARGET_NSURI = "http://ws.apache.org/resource/example/filesystem";
public static final String TARGET_NSPREFIX = "fs";</pre>
-<p>Notice the fields are "public static final" since they should not change and are easily accessible.
- </p>
-<a name="N100AD"></a><a name="ops"></a>
+<p>Notice the fields are <span class="codefrag">public static final</span> since they should not change and are easily accessible.</p>
+<a name="N100D9"></a><a name="ops"></a>
<h4>Operations</h4>
-<p>The operations which are defined in the abstract class should be operations which typically should not need to be touched. The specification operations are a prime example. Upon looking at the AbstractFileSystem class, we see the operations defined for methods like: getMultipleResourceProperties(..). The body of these methods are similar in that they hand the invocation off to a Provider class:</p>
+<p>The operations which are defined in the abstract class should be operations which typically should not need to be touched. The specification operations are a prime example. Upon looking at the <span class="codefrag">AbstractFileSystem</span> class, we see the operations defined for methods like: <span class="codefrag">getMultipleResourceProperties(..)</span>. The body of these methods are similar in that they hand the invocation off to a Provider class:
+ </p>
<pre class="code">public GetMultipleResourcePropertiesResponseDocument getMultipleResourceProperties( GetMultipleResourcePropertiesDocument requestDoc )
{
return new GetMultipleResourcePropertiesProvider( getResourceContext( ) ).getMultipleResourceProperties( requestDoc );
}</pre>
-<p>Notice the GetMultipleResourcePropertiesProvider class being used. Providers are used to handle the specification method calls. It provides a way to encapsulate the functionalty needed to handle a method call for a specific specification. Each specification operation will have an equivalent *Provider class to handle a particular class.</p>
+<p>Notice the <span class="codefrag">GetMultipleResourcePropertiesProvider</span> class being used. Providers are used to handle the specification method calls. It provides a way to encapsulate the functionalty needed to handle a method call for a specific specification. Each specification operation will have an equivalent *Provider class to handle a particular class.</p>
<p>The packages:
- <strong>org.apache.ws.resource.properties.porttype.impl</strong> and
- <strong>org.apache.ws.resource.lifetime.porttype.impl</strong> contain the Providers for the methods of the specifications. You should refer to these packages when implementing the specification operations.
- </p>
-<a name="N100C8"></a><a name="service"></a>
+ <strong><span class="codefrag">org.apache.ws.resource.properties.porttype.impl</span></strong> and
+ <strong><span class="codefrag">org.apache.ws.resource.lifetime.porttype.impl</span></strong> contain the Providers for the methods of the specifications. You should refer to these packages when implementing the specification operations.
+ </p>
+<a name="N100FF"></a><a name="service"></a>
<h3 class="boxed">The Service class.</h3>
-<p>The service class is the extension of the abstract class we previously outlined. Because of the extension you will need to implement the required method getResourceContext(). The ResourceContext should be passed in the constructor to the class and be maintained as a class variable. The ResourceContext will be passed, upon construction, to the Service via the Home class. </p>
-<p>The Service class should contain any custom operations as were defined in the WSDL for the service. The safest way to handle the parameters and return type of the methods is to simply use XmlObject:</p>
+<p>The service class is the extension of the abstract class we previously outlined. Because of the extension you will need to implement the required method <span class="codefrag">getResourceContext()</span>. The ResourceContext should be passed in the constructor to the class and be maintained as a class variable. The ResourceContext will be passed, upon construction, to the Service via the Home class.
+ </p>
+<p>The Service class should contain any custom operations as were defined in the WSDL for the service. The safest way to handle the parameters and return type of the methods is to simply use <span class="codefrag">XmlObject</span>:
+ </p>
<pre class="code"> public XmlObject mount( XmlObject requestDoc )
{
try
@@ -365,14 +345,17 @@
throw new JAXRPCException( xe );
}
}
- </pre>
+ </pre>
<p>XmlBeans will generate strongly-typed objects for the types defined in the schema section of
- your WSDL document, and these types may be used, however if you are unsure which type will get
- passed to your operation, you can be sure it will implement the XmlObject interface, since
- all XmlBeans implement this interface.</p>
+ your WSDL document, and these types may be used, however if you are unsure which type will get
+ passed to your operation, you can be sure it will implement the <span class="codefrag">XmlObject</span> interface, since
+ all XmlBeans implement this interface.</p>
+<p>
+<img alt="go to the previous step" src="images/back.gif"><a href="../tutorial/wsdl2java.html">Back</a> <img alt="go to the next step" src="images/next.gif"><a href="../tutorial/resource.html">Next</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
Modified: incubator/apollo/site/tutorial/soapclient.xml
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/soapclient.xml?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/soapclient.xml (original)
+++ incubator/apollo/site/tutorial/soapclient.xml Mon Jun 20 15:08:04 2005
@@ -19,13 +19,13 @@
<fail unless="wsrf.webapp.dir" message="webapp dir ../../webapps/wsrf does not exist." />
<echo>Using webapp dir: ${wsrf.webapp.dir}</echo>
- <path id="apollo.classpath.id">
+ <path id="wsrf.classpath.id">
<pathelement location="${wsrf.webapp.dir}/WEB-INF/classes" />
<fileset dir="${wsrf.webapp.dir}/WEB-INF/lib" includes="*.jar" />
<pathelement location="${activation.jar}" />
<pathelement location="${mail.jar}" />
</path>
- <property name="apollo.classpath" refid="apollo.classpath.id" />
+ <property name="wsrf.classpath" refid="wsrf.classpath.id" />
</target>
@@ -47,7 +47,7 @@
<concat><path><pathelement location="${xml}" /></path></concat>
<echo />
<echo>========================== RESPONSE ============================</echo>
- <taskdef name="soapClient" classname="org.apache.ws.util.soap.SoapClientTask" classpath="${apollo.classpath}" />
+ <taskdef name="soapClient" classname="org.apache.ws.util.soap.SoapClientTask" classpath="${wsrf.classpath}" />
<soapClient serviceURL="${url}" requestFile="${xml}" soapAction="${action}" />
</target>
Modified: incubator/apollo/site/tutorial/src/example/filesystem/callback/BackupFrequencyCallback.java
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/src/example/filesystem/callback/BackupFrequencyCallback.java?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/src/example/filesystem/callback/BackupFrequencyCallback.java (original)
+++ incubator/apollo/site/tutorial/src/example/filesystem/callback/BackupFrequencyCallback.java Mon Jun 20 15:08:04 2005
@@ -24,12 +24,12 @@
public void deleteProperty(QName propQName) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call delete for a prop whose minOccurs != 0
+ return; // no need to implement - WSRF will never call delete for a prop whose minOccurs != 0
}
public void insertProperty(Object[] prop) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call insert for a prop whose minOccurs == its maxOccurs
+ return; // no need to implement - WSRF will never call insert for a prop whose minOccurs == its maxOccurs
}
public void updateProperty(Object[] prop) throws CallbackFailedException
Modified: incubator/apollo/site/tutorial/src/example/filesystem/callback/CommentCallback.java
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/src/example/filesystem/callback/CommentCallback.java?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/src/example/filesystem/callback/CommentCallback.java (original)
+++ incubator/apollo/site/tutorial/src/example/filesystem/callback/CommentCallback.java Mon Jun 20 15:08:04 2005
@@ -22,12 +22,12 @@
public void deleteProperty( QName propQName ) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call delete for a prop whose minOccurs != 0
+ return; // no need to implement - WSRF will never call delete for a prop whose minOccurs != 0
}
public void insertProperty( Object[] propElems ) throws CallbackFailedException
{
- // Comment prop has cardinality of 1, so passed array will always have exactly one element
+ // Comment prop has cardinality of 1, so passed array will always have exactly one element
XmlString xString = (XmlString) propElems[0];
m_fileSystem.setComment( xString.getStringValue() );
}
Modified: incubator/apollo/site/tutorial/src/example/filesystem/callback/FsckPassNumberCallback.java
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/src/example/filesystem/callback/FsckPassNumberCallback.java?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/src/example/filesystem/callback/FsckPassNumberCallback.java (original)
+++ incubator/apollo/site/tutorial/src/example/filesystem/callback/FsckPassNumberCallback.java Mon Jun 20 15:08:04 2005
@@ -25,12 +25,12 @@
public void deleteProperty(QName propQName) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call delete for a prop whose minOccurs != 0
+ return; // no need to implement - WSRF will never call delete for a prop whose minOccurs != 0
}
public void insertProperty(Object[] propElems) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call insert for a prop whose minOccurs == its maxOccurs
+ return; // no need to implement - WSRF will never call insert for a prop whose minOccurs == its maxOccurs
}
public void updateProperty(Object[] propElems) throws CallbackFailedException
Modified: incubator/apollo/site/tutorial/src/example/filesystem/callback/OptionsCallback.java
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/src/example/filesystem/callback/OptionsCallback.java?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/src/example/filesystem/callback/OptionsCallback.java (original)
+++ incubator/apollo/site/tutorial/src/example/filesystem/callback/OptionsCallback.java Mon Jun 20 15:08:04 2005
@@ -53,7 +53,7 @@
*/
public void deleteProperty( QName propQName ) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call delete for a prop whose minOccurs != 0
+ return; // no need to implement - WSRF will never call delete for a prop whose minOccurs != 0
}
/**
@@ -63,7 +63,7 @@
*/
public void insertProperty( Object[] prop ) throws CallbackFailedException
{
- return; // no need to implement - Apollo will never call insert for a prop whose minOccurs == its maxOccurs
+ return; // no need to implement - WSRF will never call insert for a prop whose minOccurs == its maxOccurs
}
/**
Modified: incubator/apollo/site/tutorial/test.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/test.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/test.html (original)
+++ incubator/apollo/site/tutorial/test.html Mon Jun 20 15:08:04 2005
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
-</div>
+<a title="" href="../tutorial/index.html">Overview</a>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
-</div>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Documentation</div>
-<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
+<a title="" href="../tutorial/service.html">Write Service Class</a>
</div>
<div class="menuitem">
-<a title="" href="../tutorial/index.html">Tutorial</a>
+<a title="" href="../tutorial/resource.html">Write Resource Class</a>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
-</div>
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/home.html">Write Home Class</a>
</div>
<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<a title="" href="../tutorial/webapp.html">Deploy Service</a>
</div>
-<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
+<div class="menupage">
+<div class="menupagetitle">Test</div>
</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit"></div>
@@ -179,72 +173,71 @@
</li>
</ul>
</div>
-
-
+
<a name="N1000C"></a><a name="intro"></a>
<h2 class="boxed">Introduction</h2>
<div class="section">
<p>This section will describe how to test your service running in the Tomcat servlet container.</p>
</div>
-
-
+
<a name="N10016"></a><a name="start"></a>
<h2 class="boxed">Starting Tomcat</h2>
<div class="section">
-<p>Tomcat can be started by utilizing the scripts under the TOMCAT_HOME/bin directory.
- The script most typically used is "startup.bat" (Windows) or "startup.sh" (Unix).</p>
-<p>Once Tomcat is started you can navigate to:
- <a class="external" href="http://localhost:8080/wsrf">http://localhost:8080/wsrf/services</a> to view
- the list of deployed Web services.
- </p>
+<p>Tomcat can be started by utilizing the scripts under the <span class="codefrag">TOMCAT_HOME/bin</span> directory.
+ The script most typically used is <span class="codefrag">startup.bat </span>(Windows) or <span class="codefrag">startup.sh</span> (Unix).
+ </p>
+<p>Once Tomcat is started you can navigate to: <a class="external" href="http://localhost:8080/wsrf">http://localhost:8080/wsrf/services</a> to view
+ the list of deployed Web services.
+ </p>
<div class="frame note">
<div class="label">Note</div>
<div class="content">Please refer to the Tomcat and Axis documentation for more details.</div>
</div>
</div>
-
-<a name="N1002A"></a><a name="testing"></a>
+
+<a name="N10033"></a><a name="testing"></a>
<h2 class="boxed">Testing the FileSystem Service</h2>
<div class="section">
<p>The provided example FileSystem includes some scripts for sending requests to the service.
- The scripts can be leveraged in order to test your own services.</p>
+ The scripts can be leveraged in order to test your own services.</p>
<p>In order to test the FileSystem service you will need to change to the tutorial
- directory under docs. The Ant build script contains a target for sending a SOAP
- request. The name of the target is "sendRequest" and in order to invoke it you
- must specify a request XML file. The request XML files are located in the requests
- subdirectory. You can invoke the call by doing the following:</p>
-<p>
-
-<strong>>ant sendRequest -Dxml=./requests/QueryResourceProperties_allProps.soap</strong>
-
+ directory under docs. The Ant build script contains a target for sending a SOAP
+ request. The name of the target is "sendRequest" and in order to invoke it you
+ must specify a request XML file. The request XML files are located in the requests
+ subdirectory. You can invoke the call by doing the following:</p>
+<p>
+<strong><span class="codefrag">>ant sendRequest -Dxml=./requests/QueryResourceProperties_allProps.soap</span></strong>
+
</p>
</div>
-
-
-<a name="N1003D"></a><a name="your-own"></a>
+
+<a name="N10047"></a><a name="your-own"></a>
<h2 class="boxed">Using the Provided Scripts to Invoke Your Service</h2>
<div class="section">
<p>Invoking your service will entail selecting the appropriate .soap file to use.
- Each file is named appropriately based on the operation it contains. You will
- need to make a copy of the file and modify the WS-Addressing header for
- the resource id to match the entry you put in the JNDI config and the resource
- id number for the instance you would like to invoke. Remember this has to do
- with the home's implementation of getInstance() and allows you to "decide" which
- instances are valid for sending requests to. Once done, in order to invoke your
- service with your modified scripts, you will need to call:</p>
+ Each file is named appropriately based on the operation it contains. You will
+ need to make a copy of the file and modify the WS-Addressing header for
+ the resource id to match the entry you put in the JNDI config and the resource
+ id number for the instance you would like to invoke. Remember this has to do
+ with the home's implementation of <span class="codefrag">getInstance()</span> and allows you to "decide" which
+ instances are valid for sending requests to. Once done, in order to invoke your
+ service with your modified scripts, you will need to call:
+ </p>
<p>
-
-<strong>>ant -f soapclient.xml sendRequest -Durl=http://localhost:8080/wsrf/services/your_service -Dxml=./requests/QueryResourceProperties_allProps.soap</strong>
- where "your_service" represents your service endpoint name, and the script name should be the name of your modified script.
- </p>
+<strong><span class="codefrag">>ant -f soapclient.xml sendRequest -Durl=http://localhost:8080/wsrf/services/your_service - Dxml=./requests/QueryResourceProperties_allProps.soap</span></strong>
+ where "your_service" represents your service endpoint name, and the script name should be the name of your modified script.
+ </p>
<div class="frame note">
<div class="label">Note</div>
-<div class="content">You may also add an entry to build.properties for "url" which will alleviate the need
- to specify it on the command line.</div>
+<div class="content">You may also add an entry to <span class="codefrag">build.properties</span> for <span class="codefrag">url</span> which will alleviate the need
+ to specify it on the command line.</div>
</div>
+<p>
+<img alt="go to the previous step" src="images/back.gif"><a href="../tutorial/webapp.html">Back</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
Modified: incubator/apollo/site/tutorial/webapp.html
URL: http://svn.apache.org/viewcvs/incubator/apollo/site/tutorial/webapp.html?rev=191574&r1=191573&r2=191574&view=diff
==============================================================================
--- incubator/apollo/site/tutorial/webapp.html (original)
+++ incubator/apollo/site/tutorial/webapp.html Mon Jun 20 15:08:04 2005
@@ -5,7 +5,7 @@
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.6">
<meta name="Forrest-skin-name" content="pelt">
-<title>Deploy the service to the Apollo webapp</title>
+<title>Deploy the service to the Apache WSRF webapp</title>
<link type="text/css" href="../skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
@@ -39,7 +39,7 @@
|start Project Logo
+-->
<div class="projectlogoA1">
-<a href="http://incubator.apache.org/apollo/"><img class="logoImage" alt="Apollo" src="../images/apollo-logo.jpg"></a>
+<a href="http://ws.apache.org/ws-fx/wsrf/"><img class="logoImage" alt="WSRF" src="../images/wsrf-logo.gif"></a>
</div>
<!--+
|end Project Logo
@@ -49,10 +49,10 @@
+-->
<ul id="tabs">
<li>
-<a class="base-not-selected" href="../index.html">Overview</a>
+<a class="base-not-selected" href="../index.html">Project Info</a>
</li>
<li class="current">
-<a class="base-selected" href="../tutorial/index.html">Tutorial</a>
+<a class="base-selected" href="../getting_started.html">Documentation</a>
</li>
<li>
<a class="base-not-selected" href="../apidocs/index.html">API Docs</a>
@@ -90,61 +90,55 @@
|start Menu
+-->
<div id="menu">
-<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Project Info</div>
+<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">Getting Started</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../index.html">Overview</a>
+<a title="" href="../getting_started.html">Introduction</a>
</div>
<div class="menuitem">
-<a title="" href="../version_control.html">Version Control</a>
+<a title="" href="../getting_started.html#install">Installation</a>
</div>
<div class="menuitem">
-<a title="" href="../issue_tracking.html">Issue Tracking</a>
+<a title="" href="../getting_started.html#qd">Quick Demo</a>
</div>
-<div class="menuitem">
-<a title="" href="../contact_info.html">Contact Info</a>
</div>
+<div onclick="SwitchMenu('menu_selected_1.2', '../skin/')" id="menu_selected_1.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Tutorial</div>
+<div id="menu_selected_1.2" class="selectedmenuitemgroup" style="display: block;">
<div class="menuitem">
-<a title="" href="../release_notes.html">Release Notes</a>
-</div>
+<a title="" href="../tutorial/index.html">Overview</a>
</div>
-<div onclick="SwitchMenu('menu_1.2', '../skin/')" id="menu_1.2Title" class="menutitle">Downloads</div>
-<div id="menu_1.2" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../release.html">Releases</a>
-</div>
+<a title="" href="../tutorial/wsdl.html">View WSDL</a>
</div>
-<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Documentation</div>
-<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="../getting_started.html">Getting Started</a>
+<a title="" href="../tutorial/wsdl2java.html">Generate Java</a>
</div>
<div class="menuitem">
-<a title="" href="../wsrf.html">WSRF</a>
+<a title="" href="../tutorial/service.html">Write Service Class</a>
</div>
<div class="menuitem">
-<a title="" href="../tutorial/index.html">Tutorial</a>
+<a title="" href="../tutorial/resource.html">Write Resource Class</a>
</div>
<div class="menuitem">
-<a title="" href="../apidocs/index.html">API Docs</a>
-</div>
+<a title="" href="../tutorial/callback.html">Write Callback Objects</a>
</div>
-<div onclick="SwitchMenu('menu_1.4', '../skin/')" id="menu_1.4Title" class="menutitle">Related Projects</div>
-<div id="menu_1.4" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://ws.apache.org/axis/">Axis</a>
+<a title="" href="../tutorial/home.html">Write Home Class</a>
</div>
-<div class="menuitem">
-<a title="" href="http://ws.apache.org/ws-fx/addressing/">Addressing</a>
+<div class="menupage">
+<div class="menupagetitle">Deploy Service</div>
</div>
<div class="menuitem">
-<a title="" href="http://xmlbeans.apache.org/">XMLBeans</a>
+<a title="" href="../tutorial/test.html">Test</a>
</div>
+</div>
+<div onclick="SwitchMenu('menu_1.3', '../skin/')" id="menu_1.3Title" class="menutitle">Developer Guide</div>
+<div id="menu_1.3" class="menuitemgroup">
<div class="menuitem">
-<a title="" href="http://maven.apache.org/">Maven</a>
+<a title="" href="../dev_guide/index.html">Overview</a>
</div>
<div class="menuitem">
-<a title="" href="http://incubator.apache.org/">Incubator</a>
+<a title="" href="../dev_guide/wsrf_wsdl.html">Composing a WSRF WSDL</a>
</div>
</div>
<div id="credit"></div>
@@ -162,7 +156,7 @@
+-->
<div id="content">
<div id="skinconf-txtlink"></div>
-<h1>Deploy the service to the Apollo webapp</h1>
+<h1>Deploy the service to the Apache WSRF webapp</h1>
<div id="minitoc-area">
<ul class="minitoc">
<li>
@@ -176,47 +170,48 @@
</li>
</ul>
</div>
-
-
+
<a name="N1000C"></a><a name="intro"></a>
<h2 class="boxed">Introduction</h2>
<div class="section">
<p>Once you've written and compiled the required classes, you will need to deploy
- your service to the webapp. The distribution contains a "webapps" directory which
- contains a "wsrf" webapp. An Ant script is provided for deploying the FileSystem
- example. We will discuss how the script works so you will be able to build your
- own scripts.</p>
-</div>
-
-
-<a name="N10016"></a><a name="steps"></a>
+ your service to the webapp. The distribution contains a <span class="codefrag">webapps</span> directory which
+ contains a <span class="codefrag">wsrf</span> webapp. An Ant script is provided for deploying the FileSystem
+ example. We will discuss how the script works so you will be able to build your
+ own scripts.</p>
+</div>
+
+<a name="N1001C"></a><a name="steps"></a>
<h2 class="boxed">How to manually deploy your service</h2>
<div class="section">
<p>In this section we will describe how to manually deploy your service. We will describe each step in the process.</p>
<ol>
-
+
<li>
-
+
<strong>Copy your WSDL file.</strong>
-
-<p>You will need to copy your WSDL file to an appropriate location in the webapp. We recommend you put it in the wsrf/WEB-INF/classes/wsdl directory. This will allow Axis to reference it from the classpath and avoids the need to hard-code a location on your filesystem. We will use this location when registering the service in the server-config.wsdd file.</p>
-
+
+<p>You will need to copy your WSDL file to an appropriate location in the webapp. We recommend you put it in the
+ <span class="codefrag">wsrf/WEB-INF/classes/wsdl</span> directory. This will allow Axis to reference it from the classpath and avoids the need to hard-code a location on your files ystem. We will use this location when registering the service in the
+ <span class="codefrag">server-config.wsdd</span> file.
+ </p>
+
</li>
-
+
<li>
-
+
<strong>Copy your classes.</strong>
-
-<p>You will need to copy any .class files, generated by Wsdl2Java or hand written, to the wsrf/WEB-INF/classes/ directory so that your service can be created by Axis and Apollo.</p>
-
+
+<p>You will need to copy any .class files, generated by Wsdl2Java or hand written, to the <span class="codefrag">wsrf/WEB-INF/classes/</span> directory so that your service can be created by Axis and Apache WSRF.</p>
+
</li>
-
+
<li>
-
+
<strong>Update the jndi-config.xml file.</strong>
-
-<p>The jndi-config.xml contains information about yoru service, resource, home and resource key. This information is necessary for Apollo to create your home and handle requests for your service. It will setup the in-memory JNDI context for your classes. Here is the entry for the FileSystem:</p>
-
+
+<p>The jndi-config.xml contains information about yoru service, resource, home and resource key. This information is necessary for Apache WSRF to create your home and handle requests for your service. It will setup the in-memory JNDI context for your classes. Here is the entry for the FileSystem:</p>
+
<pre class="code"> <service name="filesystem">
<resource name="home" type="example.filesystem.FileSystemHome">
<resourceParams>
@@ -239,24 +234,27 @@
</resourceParams>
</resource>
</service></pre>
-
-<p>The "name" attribute is a unique name in the config file to denote your service in JNDI. The resource "name" attribute is used for locating your home instance, and is named "home". Notice the serviceClassName points to the clasname for the service class. The same is said for the resourceClassName. The wsdlTargetNamespace is the target namespace from your WSDL.</p>
-
-<p>The resourceKeyName represents the WS-Addressing-header name to be used for your resource id. This can be anything you like and is configurable here. If you omit this entry, it is assumed that the service is a
- <strong>SINGLETON</strong> service and no resource id is expected in the WS-Addressing headers.
- </p>
-
+
+<p>The<span class="codefrag"> name</span> attribute is a unique name in the config file to denote your service in JNDI. The resource "name" attribute is used for locating your home instance, and is named <span class="codefrag">home</span>. Notice <span class="codefrag">serviceClassName</span> points to the clasname for the service class. The same is said for the <span class="codefrag">resourceClassName</span>. The <span class="codefrag">wsdlTargetNamespace </span> is the target namespace from your WSDL.</p>
+
+<p>The <span class="codefrag">resourceKeyName</span> represents the WS-Addressing-header name to be used for your resource id. This can be anything you like and is configurable here. If you omit this entry, it is assumed that the service is a
+ <strong>
+ <span class="codefrag">SINGLETON</span>
+ </strong> service and no resource id is expected in the WS-Addressing headers.
+ </p>
+
</li>
-
+
<li>
-
+
<strong>Update the server-config.wsdd file</strong>
-
-<p>The server-config.wsdd file is the configuration file for the Axis SOAP engine,
- which is bundled with Apollo. This file is located in the wsrf/WEB-INF/ directory.
- The file contains a deployment entry for each Web service. An example is the
- FileSystem service:</p>
-
+
+<p>The <span class="codefrag">server-config.wsdd</span> file is the configuration file for the Axis SOAP engine,
+ which is bundled with Apache WSRF. This file is located in the <span class="codefrag">wsrf/WEB-INF/</span> directory.
+ The file contains a deployment entry for each Web service. An example is the
+ FileSystem service:
+ </p>
+
<pre class="code"> <service name="filesystem" provider="java:WSRF" style="document" use="literal">
<wsdlFile>/wsdl/FileSystem.wsdl</wsdlFile>
<requestFlow>
@@ -266,59 +264,73 @@
</handler>
</requestFlow>
</service></pre>
-
-<p>The service "name" attribute is the endpoint name and should be the same as the port's "name" attribute from your WSDL file.
- This will ensure people consuming your WSDL will be able to invoke your service.</p>
-
-<p>Notice that we've made an entry for wsdlFile which points to the /wsdl/FileSystem.wsdl.
- This translates to the wsdl directory under the WEB-INF/classes directory.</p>
-
-<p>The last part is the requestFlow. This xml fragment is necessary to ensure the
- requests are routed through the WS-Addressing handler. This is static and should
- always be present. We did not define it globally in case there were other services
- defined which will not use WS-Addressing.</p>
-
+
+<p>The service <span class="codefrag">name</span> attribute is the endpoint name and should be the same as the port's <span class="codefrag">name</span> attribute from your WSDL file. This will ensure people consuming your WSDL will be able to invoke your service.
+ </p>
+
+<p>Notice that we've made an entry for <span class="codefrag">wsdlFile</span> which points to the <span class="codefrag">/wsdl/FileSystem.wsdl</span>.
+ This translates to the wsdl directory under the <span class="codefrag">WEB-INF/classes</span> directory.
+ </p>
+
+<p>The last part is the <span class="codefrag">requestFlow</span>. This xml fragment is necessary to ensure the
+ requests are routed through the WS-Addressing handler. This is static and should
+ always be present. We did not define it globally in case there were other services
+ defined which will not use WS-Addressing.
+ </p>
+
</li>
-
+
</ol>
</div>
-
-
-<a name="N10061"></a><a name="filesys"></a>
+
+<a name="N1009D"></a><a name="filesys"></a>
<h2 class="boxed">Deploying the FileSystem Example</h2>
<div class="section">
<p>To deploy the FileSystem example we will need to generate XmlBean code from the WSDL,
- compile all classes and deploy it to the webapp. An Ant script is provided for handling
- all of these steps.</p>
-<p>You should make sure to copy the Apollo webapp from the included webapps directory to your Tomcat installation/webapps directory, and that the environment
- variable CATALINA_HOME is set and pointing to your Tomcat installation.</p>
-<p>You will need to change your directory to the docs/tutorial directory. You will then
- need to run the command:</p>
+ compile all classes and deploy it to the webapp. An Ant script is provided for handling
+ all of these steps.
+ </p>
+<p>You should make sure to copy the Apache WSRF webapp from the included webapps directory to your <span class="codefrag">TOMCAT_HOME/webapps </span> directory, and that the environment variable <span class="codefrag">CATALINA_HOME</span> is set and pointing to your Tomcat installation.
+ </p>
+<p>You will need to change your directory to the <span class="codefrag">docs/tutorial</span> directory. You will then
+ need to run the command:
+ </p>
<p>
-
-<strong>>ant generate</strong>
-
+
+<strong>
+ <span class="codefrag">>ant generate</span>
+ </strong>
+
+</p>
+<p>You will now need to change your directory to the <span class="codefrag">docs/tutorial/generated/filesystem</span> directory. You will need
+ to replace the <span class="codefrag">FilesystemResource.init()</span> and<span class="codefrag"> FilesystemHome.getInstance(..)</span> (generated under src) methods with the contents of the files in the directory <span class="codefrag">docs/tutorial/generated/filesystem/method_impls</span>
+
</p>
-<p>You will now need to change your directory to the docs/tutorial/generated/filesystem directory. You will need
- to replace the FilesystemResource.init() and FilesystemHome.getInstance(..) (generated under src) methods with the contents
- of the files in the directory docs/tutorial/generated/filesystem/method_impls</p>
<p>You will then need to run the command:</p>
<p>
-
-<strong>>ant compile deploy</strong>
-
+
+<strong>
+ <span class="codefrag">>ant compile deploy</span>
+ </strong>
+
</p>
<p>This will compile and deploy the code. You can now start Tomcat.</p>
<div class="frame note">
<div class="label">Note</div>
-<div class="content">This step assumes you have installed Apache Ant. If not, you can get it
- <a class="external" href="http://ant.apache.org/">here</a>
-
+<div class="content">This step assumes you have installed Apache Ant. If not, you can get it <a class="external" href="http://ant.apache.org/">here</a>
+
</div>
</div>
+<p>
+
+<img alt="go to the previous step" src="images/back.gif">
+ <a href="../tutorial/home.html">Back</a>
+ <img alt="go to the next step" src="images/next.gif">
+ <a href="../tutorial/test.html">Next</a>
+
+</p>
</div>
-
-
+
</div>
<!--+
|end content
---------------------------------------------------------------------
To unsubscribe, e-mail: apollo-dev-unsubscribe@ws.apache.org
For additional commands, e-mail: apollo-dev-help@ws.apache.org