Author: jruzzi
Date: Fri Jun 17 14:32:32 2005
New Revision: 191212
URL: http://svn.apache.org/viewcvs?rev=191212&view=rev
Log:
new directory for dev guide
Added:
incubator/apollo/trunk/src/site/content/xdocs/dev_guide/
incubator/apollo/trunk/src/site/content/xdocs/dev_guide/index.xml
incubator/apollo/trunk/src/site/content/xdocs/dev_guide/wsrf_wsdl.xml
Added: incubator/apollo/trunk/src/site/content/xdocs/dev_guide/index.xml
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/site/content/xdocs/dev_guide/index.xml?rev=191212&view=auto
==============================================================================
--- incubator/apollo/trunk/src/site/content/xdocs/dev_guide/index.xml (added)
+++ incubator/apollo/trunk/src/site/content/xdocs/dev_guide/index.xml Fri Jun
17 14:32:32 2005
@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>WSRF Developer Guide</title>
+ </header>
+ <body>
+ <section>
+ <title>WSRF Developer Guide</title>
+ <p>TODO
+ </p>
+ </section>
+ </body>
+</document>
Added: incubator/apollo/trunk/src/site/content/xdocs/dev_guide/wsrf_wsdl.xml
URL:
http://svn.apache.org/viewcvs/incubator/apollo/trunk/src/site/content/xdocs/dev_guide/wsrf_wsdl.xml?rev=191212&view=auto
==============================================================================
--- incubator/apollo/trunk/src/site/content/xdocs/dev_guide/wsrf_wsdl.xml
(added)
+++ incubator/apollo/trunk/src/site/content/xdocs/dev_guide/wsrf_wsdl.xml Fri
Jun 17 14:32:32 2005
@@ -0,0 +1,128 @@
+<?xml version="1.0"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>Composing a WSRF WSDL</title>
+ </header>
+ <body>
+ <section>
+ <title>Using the WSRF WSDL Template</title>
+ <p>Resources are exposed as WSRF WS-Resources using the
Web Services Description Language (WSDL). The WSDL must conform to
+ the conventions as described in the WSRF
specifications. To expedite the WSDL creation process, a
+ <a href="../tutorial/_TEMPLATE_.wsdl">WSRF WSDL
template</a> is provided that provides instructions as
well as many common and required sections.
+ </p>
+ <p>To use the template:</p>
+ <ol>
+ <li>Using a text or XML editor, open
INSTALL_DIR/docs/tutorial/_TEMPLATE_.wsdl.</li>
+ <li>Save the file with a new name (e.g.,
<em>nameOfYourService</em>.wsdl</li>
+ </ol>
+ <p>To use the template, first make a of the template
file. For example, on a Windows system,
+ run a command like:
+ </p>
+ <source>copy _TEMPLATE_.wsdl </source>
+ <warning>Do not modify the original template
file.</warning>
+ </section>
+ <section>
+ <title>Defining the WSRF PortType</title>
+ <p>A WSRF WSDL should contain only one portType, which
is an aggregation of custom
+ resource-specific operations and operations from the
following
+ specification-defined portTypes:
+ </p>
+ <section>
+ <title>WS-ResourceProperties (WSRF-RP)
PortTypes</title>
+ <table>
+ <tr>
+ <th>PortType</th>
+ <th>Operations</th>
+ <th>Properties</th>
+ </tr>
+ <tr>
+ <td>GetResourceProperty</td>
+ <td>GetResourceProperty</td>
+ <td/>
+ </tr>
+ <tr>
+
<td>GetMultipleResourceProperties</td>
+
<td>GetMultipleResourceProperties</td>
+ <td/>
+ </tr>
+ <tr>
+ <td>SetResourceProperties</td>
+ <td>SetResourceProperties</td>
+ <td/>
+ </tr>
+ <tr>
+ <td>QueryResourceProperties</td>
+ <td>QueryResourceProperties</td>
+ <td/>
+ </tr>
+ </table>
+ <note>The GetResourceProperty portType is
REQUIRED. The WS-Resource specification states that
+ all WS-Resources MUST implement this portType.</note>
+ </section>
+ <section>
+ <title>WS-ResourceLifetime (WSRF-RL)
PortTypes</title>
+ <table>
+ <tr>
+ <th>PortType</th>
+ <th>Operations</th>
+ <th>Properties</th>
+ </tr>
+ <tr>
+
<td>ImmediateResourceTermination</td>
+ <td>Destroy</td>
+ <td/>
+ </tr>
+ <tr>
+
<td>ScheduledResourceTermination</td>
+ <td>SetTerminationTime</td>
+ <td>CurrentTime,
+ <br/>TerminationTime
+ </td>
+ </tr>
+ </table>
+ <note>In addition to operations, the
ScheduledResourceTermination portType also includes two properties.
+ This means that if a WS-Resource implements
this portType, it must expose these properties.</note>
+ </section>
+ <p>The PortType element must have a
+
{http://docs.oasis-open.org/wsrf/2004/11/wsrf-WS-ResourceProperties-1.2-draft-05.xsd}ResourceProperties
+ attribute whose value is the QName of the resource
properties document element defined
+ in the types/schema section of the WSDL file.
+ </p>
+ <p>If you've copied the WSDL template file as described
above, your WSDL file
+ already contains a WSRF portType. You simply have to
uncomment the blocks
+ corresponding to whichever optional portTypes you want
your WS-Resource to support. You should also
+ add any custom operations you want your WS-Resource to
expose. The following
+ section describes how to add custom operations.
+ </p>
+ </section>
+ <section>
+ <title>Adding Custom Operations</title>
+ <p>You may optionally add custom operations to the WSRF
portType. To do so,
+ you will have to define message types, messages, and
operations, as you would
+ for any WSDL. It is recommended that, when defining
your custom operations,
+ you adhere to the rules defined by
+ <a
href="http://www.ws-i.org/Profiles/BasicProfile-1.0-2004-04-16.html#description";>section
5 of the WS-I Basic Profile</a>.
+ This will ensure maximum interoperability for your
WS-Resource.
+ </p>
+ </section>
+ <section>
+ <title>Defining Resource Properties</title>
+ <p>Resource properties are defined in the types/schema
section of the WSDL file. In addition to defining
+ custom resource-specific properties, you may also need
to add properties that are required by certain
+ specification-defined portTypes. For example, the
WSRF-RL ScheduledResourceTermination portType requires
+ two properties (see above). Chapter 4 of the
+ <a
href="http://docs.oasis-open.org/wsrf/2004/11/wsrf-WS-ResourceProperties-1.2-draft-05.pdf";>WSRF-RP
specification</a>
+ explains how to define resource properties.
+ </p>
+ <p>If you have copied the WSDL template file as
described above, your WSDL file
+ already contains a resource properties document
definition. If your WS-Resource
+ implements the WSRF-RL ScheduledResourceTermination
portType, simply
+ uncomment the xsd element references, which correspond
to the two ScheduledResourceTermination
+ properties. If would like your WS-Resource to allow
resource properties with arbitrary names
+ (not generally recommended), simply uncomment the xsd
<code>any</code> element.
+ </p>
+ </section>
+ </body>
+</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
