You are viewing a plain text version of this content. The canonical link for it is here.
Posted to muse-commits@ws.apache.org by sc...@apache.org on 2006/06/06 18:22:21 UTC
svn commit: r412162 - in
/webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide:
consumer.xml home.xml subscription.xml wsdl.xml
Author: scamp
Date: Tue Jun 6 09:22:21 2006
New Revision: 412162
URL: http://svn.apache.org/viewvc?rev=412162&view=rev
Log: (empty)
Modified:
webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/consumer.xml
webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/home.xml
webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/subscription.xml
webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/wsdl.xml
Modified: webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/consumer.xml
URL: http://svn.apache.org/viewvc/webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/consumer.xml?rev=412162&r1=412161&r2=412162&view=diff
==============================================================================
--- webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/consumer.xml (original)
+++ webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/consumer.xml Tue Jun 6 09:22:21 2006
@@ -2,34 +2,34 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
- <header>
- <title>Notification Consumer</title>
- </header>
- <body>
- <section id="intro">
- <title>Introduction</title>
- <p>This section provides instructions for creating a notification consumer resource. A service that acts as a notification consumer (implements the WSN
- <code>NotificationConsumer</code> portType) can receive SOAP notification messages sent by a notification producer. The consumer
- only receives messages for notifications to which it is subscribed.
- </p>
- <p>The Wsdl2Java tool generates the same artifacts for a notification consumer as it does for a notification producer. In particular, the service, resource, and home class are
- generated but need to be modified specifically for your consumer. The topics in this section describe how to modify these classes. An example notification consumer that works together
- with the filesystem example is provided in the <code>INSTALL_DIR/examples/consumer</code> and discussed below. Initially, you should model your consumer based on the example to
- ensure that you write a valid consumer.
- </p>
- <note>A consumer WSDL must implement the <code>Notify</code> operation from the <code>NotificationConsumer</code> portType. If you use the
- <code>INSTALL_DIR/template/_TEMPLATE_.wsdl</code> to create the WSDL, this operation is included and only needs to be uncommented. A WSDL is included in the consumer
- example. To use this example, run the Wsdl2Java tool on the WSDL.
- </note>
- </section>
- <section>
- <title>Modify the Service Class</title>
- <p>An abstract method <code>Notify</code> is generated in the abstractService class an needs to be implemented in your service class. The implementation of the method is dependant
- on whatever features you want to include for your consumer. In the consumer example, a property is used to retrieve the last notification message. In
- this case, the <code>notify</code> method will allow a JSP page to retrieve and display the current notification message. Notice that the service class is also used to
- setup and initialize the <code>LASTMESSAGE</code> resource property. Therefore, the the resource class will not need to perform these operations. The method is implemented as
- follows:</p>
- <source>
+ <header>
+ <title>Notification Consumer</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>This section provides instructions for creating a notification consumer resource. A service that acts as a notification consumer (implements the WSN
+ <code>NotificationConsumer</code> portType) can receive SOAP notification messages sent by a notification producer. The consumer
+ only receives messages for notifications to which it is subscribed.
+ </p>
+ <p>The Wsdl2Java tool generates the same artifacts for a notification consumer as it does for a notification producer. In particular, the service, resource, and home class are
+ generated but need to be modified specifically for your consumer. The topics in this section describe how to modify these classes. An example notification consumer that works together
+ with the filesystem example is provided in the <code>INSTALL_DIR/examples/consumer</code> and discussed below. Initially, you should model your consumer based on the example to
+ ensure that you write a valid consumer.
+ </p>
+ <note>A consumer WSDL must implement the <code>Notify</code> operation from the <code>NotificationConsumer</code> portType. If you use the
+ <code>INSTALL_DIR/template/_TEMPLATE_.wsdl</code> to create the WSDL, this operation is included and only needs to be uncommented. A WSDL is included in the consumer
+ example. To use this example, run the Wsdl2Java tool on the WSDL.
+ </note>
+ </section>
+ <section>
+ <title>Modify the Service Class</title>
+ <p>An abstract method <code>Notify</code> is generated in the abstractService class an needs to be implemented in your service class. The implementation of the method is dependant
+ on whatever features you want to include for your consumer. In the consumer example, a property is used to retrieve the last notification message. In
+ this case, the <code>notify</code> method will allow a JSP page to retrieve and display the current notification message. Notice that the service class is also used to
+ setup and initialize the <code>LASTMESSAGE</code> resource property. Therefore, the the resource class will not need to perform these operations. The method is implemented as
+ follows:</p>
+ <source>
public void notify(org.oasisOpen.docs.wsn.x2004.x06.wsnWSBaseNotification12Draft01.NotifyDocument notifyDocument)
{
//get the property set
@@ -50,60 +50,60 @@
//add the LastMessageDocument to the resource property
resourceProperty.add(lastMessageDocument);
}</source>
- </section>
- <section>
- <title>Modify the Resource Class</title>
- <p>The resource class is used to setup and initialize any resource properties. For the consumer example, the resource class is not used to setup and initialize the
- <code>LASTMESSAGE</code> resource property, but instead the service class is used to perform these operations. If you choose to use the resource class, you should
- update the <code>init()</code> method to add your properties to the <code>ResourcePropertySet</code>. The following sample code
- is required for the consumer example. Below the consumer example code is an example of setting up and initializing resource properties in the resource class.
- </p>
- <source>
+ </section>
+ <section>
+ <title>Modify the Resource Class</title>
+ <p>The resource class is used to setup and initialize any resource properties. For the consumer example, the resource class is not used to setup and initialize the
+ <code>LASTMESSAGE</code> resource property, but instead the service class is used to perform these operations. If you choose to use the resource class, you should
+ update the <code>init()</code> method to add your properties to the <code>ResourcePropertySet</code>. The following sample code
+ is required for the consumer example. Below the consumer example code is an example of setting up and initializing resource properties in the resource class.
+ </p>
+ <source>
public void init()
{
super.init();
}
- </source>
- <p>Generic example of setting and initialing resource properties.</p>
- <source>
+ </source>
+ <p>Generic example of setting and initialing resource properties.</p>
+ <source>
public void init()
{
super.init();
/**
- * The ResourcePropertySet which contains all the defined ResourceProperties
- */
- org.apache.ws.resource.properties.ResourcePropertySet resourcePropertySet = getResourcePropertySet();
- org.apache.ws.resource.properties.ResourceProperty resourceProperty = null;
+ * The ResourcePropertySet which contains all the defined ResourceProperties
+ */
+ org.apache.ws.resource.properties.ResourcePropertySet resourcePropertySet = getResourcePropertySet();
+ org.apache.ws.resource.properties.ResourceProperty resourceProperty = null;
- try{
- // init the {http://ws.apache.org/resource/example/NotifConsumer}YourResourceProperty Property
- resourceProperty = resourcePropertySet.get(ConsumerPortPropertyQNames.YourResourceProperty);
-
- }
- catch (Exception e)
- {
- throw new javax.xml.rpc.JAXRPCException("There was a problem in initializing your resource properties. Please check your init() method. Cause: " + e.getLocalizedMessage());
- }
-} </source>
- </section>
- <section>
- <title>Modify the Home Class</title>
- <p>The home class 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. For the consumer example the <code>init()</code> method is modified to get an instance of the consumer resource. The resource is a singleton
- and therfore only requires a single instance. For more information on creating a singleton, see the <a href="site:w_single">Creating a Singleton Service</a> in the Apache WSRF
- documentation.
- </p>
- <source>
+ try{
+ // init the {http://ws.apache.org/resource/example/NotifConsumer}YourResourceProperty Property
+ resourceProperty = resourcePropertySet.get(ConsumerPortPropertyQNames.YourResourceProperty);
+
+ }
+ catch (Exception e)
+ {
+ throw new javax.xml.rpc.JAXRPCException("There was a problem in initializing your resource properties. Please check your init() method. Cause: " + e.getLocalizedMessage());
+ }
+} </source>
+ </section>
+ <section>
+ <title>Modify the Home Class</title>
+ <p>The home class 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. For the consumer example the <code>init()</code> method is modified to get an instance of the consumer resource. The resource is a singleton
+ and therfore only requires a single instance. For more information on creating a singleton, see the <a href="site:single">Creating a Singleton Service</a> in the Apache WSRF
+ documentation.
+ </p>
+ <source>
public void init() throws Exception
{
super.init();
add( createInstance( null ) );
}</source>
- <note>At runtime, a client for the consumer must use the EPR to access the consumer resource. The EPR is returned by the notification producer when you subscribe to a
- notification topic.
- </note>
- </section>
- </body>
+ <note>At runtime, a client for the consumer must use the EPR to access the consumer resource. The EPR is returned by the notification producer when you subscribe to a
+ notification topic.
+ </note>
+ </section>
+ </body>
</document>
Modified: webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/home.xml
URL: http://svn.apache.org/viewvc/webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/home.xml?rev=412162&r1=412161&r2=412162&view=diff
==============================================================================
--- webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/home.xml (original)
+++ webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/home.xml Tue Jun 6 09:22:21 2006
@@ -2,54 +2,54 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
- <header>
- <title>Writing a Home class</title>
- </header>
- <body>
- <section id="intro">
- <title>Introduction</title>
- <p>The home class 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>
- <note>If your service is a singleton and only requires a single resource instance, see the <a href="site:w_single">Creating a Singleton Service</a> in the Apache WSRF
- documentation.</note>
- <p>If you use the Wsdl2Java tool, the home class is automatically generated but will need to modified to create instances of your resource. This section will
- describe how to write a home class for your resource. Initially, you should model your resource off of the included <code>FilesystemHome</code> example
- to ensure that you write a valid home class for your resource.</p>
- </section>
- <section id="class-declaration">
- <title>Class Declaration</title>
- <p>The generated home class extends <code>AbstractResourceHome</code>. Extending <code>AbstractResourceHome</code>
- provides services for caching instances and looking them up. It also ensures
- that the correct interfaces are implemented so that Apache WSRF can interact with your home.
- </p>
- <p>The <code>FileSystemHome</code> class extends <code>AbstractResourceHome</code> and implements <code>Serializable</code>:</p>
- <source>public class FileSystemHome
+ <header>
+ <title>Writing a Home class</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>The home class 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>
+ <note>If your service is a singleton and only requires a single resource instance, see the <a href="site:single">Creating a Singleton Service</a> in the Apache WSRF
+ documentation.</note>
+ <p>If you use the Wsdl2Java tool, the home class is automatically generated but will need to modified to create instances of your resource. This section will
+ describe how to write a home class for your resource. Initially, you should model your resource off of the included <code>FilesystemHome</code> example
+ to ensure that you write a valid home class for your resource.</p>
+ </section>
+ <section id="class-declaration">
+ <title>Class Declaration</title>
+ <p>The generated home class extends <code>AbstractResourceHome</code>. Extending <code>AbstractResourceHome</code>
+ provides services for caching instances and looking them up. It also ensures
+ that the correct interfaces are implemented so that Apache WSRF can interact with your home.
+ </p>
+ <p>The <code>FileSystemHome</code> class extends <code>AbstractResourceHome</code> and implements <code>Serializable</code>:</p>
+ <source>public class FileSystemHome
extends AbstractResourceHome
implements Serializable</source>
<note>Many of the operations in the <code>AbstractResourceHome</code> may be overridden in your Home
- class, if you have a need to extend its functionality.</note>
- </section>
- <section id="ops">
- <title>Operations</title>
- <p>If you extend <code>AbstractResourceHome</code>, the only required operation you will need to implement is:</p>
- <source>public void init()</source>
- <p>The <code>init()</code> operation can be used to initialize any instances at startup. In the FileSystem example, the <code>init()</code> method is used:</p>
- <source>public void init() throws Exception
+ class, if you have a need to extend its functionality.</note>
+ </section>
+ <section id="ops">
+ <title>Operations</title>
+ <p>If you extend <code>AbstractResourceHome</code>, the only required operation you will need to implement is:</p>
+ <source>public void init()</source>
+ <p>The <code>init()</code> operation can be used to initialize any instances at startup. In the FileSystem example, the <code>init()</code> method is used:</p>
+ <source>public void init() throws Exception
{
super.init();
add( createInstance( LVOL1_ID ) );
add( createInstance( LVOL2_ID ) );
- }</source>
- <p>The <code>createInstance()</code> method:</p>
- <ul>
- <li>Creates an instance of the resource.</li>
- <li>Sets an endpoint reference on the resource.</li>
- <li>Calls <code>init()</code> on the resource.</li>
- </ul>
- <note>If you choose to not use the <code>createInstance()</code> method (e.g. if you have a non-empty constructor), then you must manually set the EPR then call
- the <code>init()</code> method on the resource. The generated home class contains a utility method from the <code>AbstractResourceHome</code> that can be used
- to build an EPR.</note>
- </section>
- </body>
+ }</source>
+ <p>The <code>createInstance()</code> method:</p>
+ <ul>
+ <li>Creates an instance of the resource.</li>
+ <li>Sets an endpoint reference on the resource.</li>
+ <li>Calls <code>init()</code> on the resource.</li>
+ </ul>
+ <note>If you choose to not use the <code>createInstance()</code> method (e.g. if you have a non-empty constructor), then you must manually set the EPR then call
+ the <code>init()</code> method on the resource. The generated home class contains a utility method from the <code>AbstractResourceHome</code> that can be used
+ to build an EPR.</note>
+ </section>
+ </body>
</document>
Modified: webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/subscription.xml
URL: http://svn.apache.org/viewvc/webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/subscription.xml?rev=412162&r1=412161&r2=412162&view=diff
==============================================================================
--- webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/subscription.xml (original)
+++ webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/subscription.xml Tue Jun 6 09:22:21 2006
@@ -2,36 +2,36 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
- <header>
- <title>Using the Subscription Manager</title>
- </header>
- <body>
- <section>
- <title>Introduction</title>
- <p>The WS-BaseNotification specification includes a portType called <code>SubscriptionManager</code>. The portType includes two operations
- (<code>PauseSubscription</code> and <code> ResumeSubscription</code>) and a set of resource properties: <code>ConsumerReference</code>,
- <code>TopicExpression</code>, <code>UseNotify</code>, <code>Precondition</code>, <code>Selector</code>, <code>SubscriptionPolicy</code>, and
- <code>CreationTime</code>. Pubscribe implements this portType and its required resource properties by default. Therefore, it does not have to be defined in a WSRF/WSN WSDL.
- This insures that all the resource properties are initialized without having to directly interact with the subscription manager.
- </p>
- <note>In Pubscribe, a notification producer uses the subscription manager to create a subscription whenever a <code>Subscribe</code> message is received for a topic.</note>
- </section>
- <section>
- <title>Subscription Manager Messages</title>
- <p>Messages to pause or resume a subscription are sent to the <code>SubscriptionManager</code> service. This service is deployed by default when you deploy the Pubscribe Web
- application. The <code>SubscriptionManager</code> service can also be used to send <code>Destroy</code>, <code>SetTerminationTime</code>, and
- <code>GetResourceProperty</code> messages. These operations are defined in the WSRF WS-ResourceLifetime and WS-ResourceProperties specifications respectively.
- When you send messages to the subscription manager, the SOAP header must include the ResourceIdentifier obtained from the EPR of the subscription this value
- is returned in the response message when you subscribe to a topic.
- </p>
- <p>The below requests demonstrate the messages to pause, resume, and destroy a subscription and are taken from the filesystem example. In the header, notice the EPR that is entered in
- the <code>wsa:To</code> element and the subscription identifier that is entered in the <code>sub:ResourceIdentifier</code> element.
- </p>
- <section>
- <title>PauseSubscription</title>
- <source><![CDATA[
+ <header>
+ <title>Using the Subscription Manager</title>
+ </header>
+ <body>
+ <section>
+ <title>Introduction</title>
+ <p>The WS-BaseNotification specification includes a portType called <code>SubscriptionManager</code>. The portType includes two operations
+ (<code>PauseSubscription</code> and <code> ResumeSubscription</code>) and a set of resource properties: <code>ConsumerReference</code>,
+ <code>TopicExpression</code>, <code>UseNotify</code>, <code>Precondition</code>, <code>Selector</code>, <code>SubscriptionPolicy</code>, and
+ <code>CreationTime</code>. Pubscribe implements this portType and its required resource properties by default. Therefore, it does not have to be defined in a WSRF/WSN WSDL.
+ This insures that all the resource properties are initialized without having to directly interact with the subscription manager.
+ </p>
+ <note>In Pubscribe, a notification producer uses the subscription manager to create a subscription whenever a <code>Subscribe</code> message is received for a topic.</note>
+ </section>
+ <section>
+ <title>Subscription Manager Messages</title>
+ <p>Messages to pause or resume a subscription are sent to the <code>SubscriptionManager</code> service. This service is deployed by default when you deploy the Pubscribe Web
+ application. The <code>SubscriptionManager</code> service can also be used to send <code>Destroy</code>, <code>SetTerminationTime</code>, and
+ <code>GetResourceProperty</code> messages. These operations are defined in the WSRF WS-ResourceLifetime and WS-ResourceProperties specifications respectively.
+ When you send messages to the subscription manager, the SOAP header must include the ResourceIdentifier obtained from the EPR of the subscription this value
+ is returned in the response message when you subscribe to a topic.
+ </p>
+ <p>The below requests demonstrate the messages to pause, resume, and destroy a subscription and are taken from the filesystem example. In the header, notice the EPR that is entered in
+ the <code>wsa:To</code> element and the subscription identifier that is entered in the <code>sub:ResourceIdentifier</code> element.
+ </p>
+ <section>
+ <title>PauseSubscription</title>
+ <source><![CDATA[
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"
- xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
+ xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
xmlns:sub="http://ws.apache.org/notification/base/service/SubscriptionManager">
<Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
@@ -45,12 +45,12 @@
</Body>
</Envelope>]]></source>
- </section>
- <section>
- <title>ResumeSubscription</title>
- <source><![CDATA[
+ </section>
+ <section>
+ <title>ResumeSubscription</title>
+ <source><![CDATA[
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"
- xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
+ xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
xmlns:sub="http://ws.apache.org/notification/base/service/SubscriptionManager">
<Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
@@ -64,15 +64,15 @@
</Body>
</Envelope>]]></source>
- </section>
- <section>
- <title>Destroy</title>
- <p>The <code>SubscriptionManager</code> also includes the Destroy operation. This operation is defined in the WS-ResourceLifetime specifcation. The Destroy operation can be
- used to destroy a subscription. Like pause and resume, you must provide the EPR and the subscription's <code>ResourceIdentifier</code>.</p>
- <source><![CDATA[
+ </section>
+ <section>
+ <title>Destroy</title>
+ <p>The <code>SubscriptionManager</code> also includes the Destroy operation. This operation is defined in the WS-ResourceLifetime specifcation. The Destroy operation can be
+ used to destroy a subscription. Like pause and resume, you must provide the EPR and the subscription's <code>ResourceIdentifier</code>.</p>
+ <source><![CDATA[
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"
- xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
- xmlns:wsrlw="http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceLifetime-1.2-draft-01.xsd"
+ xmlns:wsnt="http://docs.oasis-open.org/wsn/2004/06/wsn-WS-BaseNotification-1.2-draft-01.xsd"
+ xmlns:wsrlw="http://docs.oasis-open.org/wsrf/2004/06/wsrf-WS-ResourceLifetime-1.2-draft-01.xsd"
xmlns:sub="http://ws.apache.org/notification/base/service/SubscriptionManager">
<Header xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/03/addressing">
@@ -86,14 +86,14 @@
</Body>
</Envelope>]]></source>
- </section>
- <section>
- <title>Getting the Subscription Manager's WSDL</title>
- <p>The subscription manager publishes its WSDL as metadata using Pubscribe's implementation of the WS-Metadata Exchange specification. The following examples
- demonstrate SOAP requests that can be used to retrieve the WSDL. For instructions on providing metadata about your service, see the
- <a href="site:w_metadata">Adding Service Metadata</a> section of the Apache
- WSRF documentation. </p>
- <source><![CDATA[
+ </section>
+ <section>
+ <title>Getting the Subscription Manager's WSDL</title>
+ <p>The subscription manager publishes its WSDL as metadata using Pubscribe's implementation of the WS-Metadata Exchange specification. The following examples
+ demonstrate SOAP requests that can be used to retrieve the WSDL. For instructions on providing metadata about your service, see the
+ <a href="site:metadata">Adding Service Metadata</a> section of the Apache
+ WSRF documentation. </p>
+ <source><![CDATA[
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"
xmlns:sub="http://ws.apache.org/notification/base/service/SubscriptionManager">
@@ -109,7 +109,7 @@
</Body>
</Envelope>]]></source>
- <source><![CDATA[
+ <source><![CDATA[
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:wsx="http://schemas.xmlsoap.org/ws/2004/09/mex"
xmlns:sub="http://ws.apache.org/notification/base/service/SubscriptionManager">
@@ -125,7 +125,7 @@
</Body>
</Envelope>]]></source>
- </section>
- </section>
- </body>
+ </section>
+ </section>
+ </body>
</document>
Modified: webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/wsdl.xml
URL: http://svn.apache.org/viewvc/webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/wsdl.xml?rev=412162&r1=412161&r2=412162&view=diff
==============================================================================
--- webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/wsdl.xml (original)
+++ webservices/muse/branches/1.0/src/site/content/xdocs/pubscribe/dev_guide/wsdl.xml Tue Jun 6 09:22:21 2006
@@ -2,83 +2,83 @@
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
"http://forrest.apache.org/dtd/document-v20.dtd">
<document>
- <header>
- <title>Composing a WSRF/WSN WSDL</title>
- </header>
- <body>
- <section>
- <title>Using the WSRF/WSN WSDL Template</title>
- <p>Resources and notifications are exposed as WS-Resources using the Web Services Description Language (WSDL). The WSDL must
- conform to the conventions as described in the <a href="ext:spec">WSRF</a> and <a href="site:wsn">WSN</a> Specifications. To make it
- easier to write a WSRF/WSN WSDL, Pubscribe provides a template WSDL that can be used as a starting point. The template saves a good deal of time
- and is less error-prone than writing a WSRF/WSN-compliant WSDL from scratch.
- </p>
- <p>To use the template:</p>
- <ol>
- <li>Using a text or XML editor, open <code>INSTALL_DIR/template/_TEMPLATE_.wsdl</code>.</li>
- <li>Save the file with a new name (e.g., <em>nameOfYourService</em>.wsdl).</li>
- <li>Modify your WSDL based on the instructions in the template and the information below.</li>
- </ol>
- <warning>Do not modify the original template file.</warning>
- </section>
- <section>
- <title>Defining the WSRF/WSN PortType</title>
- <p>A WSRF/WSN WSDL should contain only one portType. The portType aggregates operations from WSRF and WSN specification-defined portTypes
- and custom resource-specific operations. If you copied the WSDL template file as described above, your WSDL file
- already contains a WSRF/WSN-compliant portType. You simply have to rename the portType (<code>MyPortType</code>) and the binding (MySoapHttpBinding) and uncomment the
- blocks corresponding to whichever optional portTypes you want your WS-Resource to support.
- </p>
- <note>The WSRF portTypes - WS-ResourceProperties (WSRF-RP) and WS-ResourceLifetime (WSRF-RL)- and their associated operations are described in the Apache WSRF
- <a href="ext:wsrfwsdl">WSDL Documentation</a>. The instructions include defining the resource properties document, custom properties, and custom
- operations.</note>
- <section>
- <title>WS-BaseNotification PortTypes</title>
- <p>The WS-BaseNotification specification defines three portTypes:</p>
- <ul>
- <li>NotificationProducer - This portType allows a resource to advertise notification topics and allows clients to subscribe to these topics. To implement this portType,
- uncomment the three NotificationProducer property references (<code>wsnt:Topic</code>, <code>wsnt:FixedTopicSet</code>, and
- <code>wsnt:TopicExpressionDialects</code>) within the types/schema section of the WSDL. Then, uncomment the two NotificationProducer
- operations (<code>Subscribe</code> and <code>GetCurrentMessage</code>) within both the portType and binding sections. See <a href="site:producer">Notification
- Producer</a>.</li>
- <li>NotificationConsumer - This portType allows a resource to receive notification messages from a notification producer. To implement this portType, uncomment the
- <code>Notify</code> operation. See <a href="site:consumer">Notification Consumer</a>.</li>
- <li>SubscriptionManager - This portType defines message exchanges to manipulate (pause and resume) Subscription resources. An implementation of this portType is
- included in Pubscribe as a separate service and therefore does not have to be included in the WSRF/WSN WSDL for a resource. For more information on the Subscription
- Manager service, see <a href="site:subscript">Using the Subscription Manager</a>.</li>
- </ul>
- <note>Typically, a resource will be either be a Consumer or a Producer. However, you can implement both in a single resource.</note>
- <table>
- <tr>
- <th>PortType</th>
- <th>Operations</th>
- <th>Properties</th>
- </tr>
- <tr>
- <td>NotificationProducer</td>
- <td>Subscribe, GetCurrentMessage</td>
- <td>Topic, FixedTopicSet, TopicExpressionDialects</td>
- </tr>
- <tr>
- <td>NotificationConsumer</td>
- <td>Notify</td>
- <td/>
- </tr>
- </table>
- <note>In addition to operations, the <code>NotificationProducer</code> portType also includes three properties. If a
- WS-Resource implements this portType, it must also expose these properties.</note>
- <p>The PortType element must have a
- <code>{http://docs.oasis-open.org/wsrf/2004/11/wsrf-WS-ResourceProperties-1.2-draft-05.xsd}ResourceProperties</code>
- attribute whose value is the <code>QName</code> of the resource properties document element defined in the types/schema section of the WSDL file.
- </p>
- </section>
- <section>
- <title>Metadata Operations</title>
- <p>The template contains two operations that are not defined by the WSRF or WSN specification that can be used in your service to retrieve metadata
- about your services. The operations and messages are defined in the
- <a href="http://msdn.microsoft.com/library/en-us/dnglobspec/html/ws-metadataexchange.pdf">WS-Metadata Exchange</a> specification defined by Microsoft and other industry
- contributors. For instructions on providing metadata about your service, see the <a href="site:w_metadata">Adding Service Metadata</a> section of the Apache
- WSRF documentation.</p>
- </section>
- </section>
- </body>
+ <header>
+ <title>Composing a WSRF/WSN WSDL</title>
+ </header>
+ <body>
+ <section>
+ <title>Using the WSRF/WSN WSDL Template</title>
+ <p>Resources and notifications are exposed as WS-Resources using the Web Services Description Language (WSDL). The WSDL must
+ conform to the conventions as described in the <a href="ext:spec">WSRF</a> and <a href="site:wsn">WSN</a> Specifications. To make it
+ easier to write a WSRF/WSN WSDL, Pubscribe provides a template WSDL that can be used as a starting point. The template saves a good deal of time
+ and is less error-prone than writing a WSRF/WSN-compliant WSDL from scratch.
+ </p>
+ <p>To use the template:</p>
+ <ol>
+ <li>Using a text or XML editor, open <code>INSTALL_DIR/template/_TEMPLATE_.wsdl</code>.</li>
+ <li>Save the file with a new name (e.g., <em>nameOfYourService</em>.wsdl).</li>
+ <li>Modify your WSDL based on the instructions in the template and the information below.</li>
+ </ol>
+ <warning>Do not modify the original template file.</warning>
+ </section>
+ <section>
+ <title>Defining the WSRF/WSN PortType</title>
+ <p>A WSRF/WSN WSDL should contain only one portType. The portType aggregates operations from WSRF and WSN specification-defined portTypes
+ and custom resource-specific operations. If you copied the WSDL template file as described above, your WSDL file
+ already contains a WSRF/WSN-compliant portType. You simply have to rename the portType (<code>MyPortType</code>) and the binding (MySoapHttpBinding) and uncomment the
+ blocks corresponding to whichever optional portTypes you want your WS-Resource to support.
+ </p>
+ <note>The WSRF portTypes - WS-ResourceProperties (WSRF-RP) and WS-ResourceLifetime (WSRF-RL)- and their associated operations are described in the Apache WSRF
+ <a href="ext:wsrfwsdl">WSDL Documentation</a>. The instructions include defining the resource properties document, custom properties, and custom
+ operations.</note>
+ <section>
+ <title>WS-BaseNotification PortTypes</title>
+ <p>The WS-BaseNotification specification defines three portTypes:</p>
+ <ul>
+ <li>NotificationProducer - This portType allows a resource to advertise notification topics and allows clients to subscribe to these topics. To implement this portType,
+ uncomment the three NotificationProducer property references (<code>wsnt:Topic</code>, <code>wsnt:FixedTopicSet</code>, and
+ <code>wsnt:TopicExpressionDialects</code>) within the types/schema section of the WSDL. Then, uncomment the two NotificationProducer
+ operations (<code>Subscribe</code> and <code>GetCurrentMessage</code>) within both the portType and binding sections. See <a href="site:producer">Notification
+ Producer</a>.</li>
+ <li>NotificationConsumer - This portType allows a resource to receive notification messages from a notification producer. To implement this portType, uncomment the
+ <code>Notify</code> operation. See <a href="site:consumer">Notification Consumer</a>.</li>
+ <li>SubscriptionManager - This portType defines message exchanges to manipulate (pause and resume) Subscription resources. An implementation of this portType is
+ included in Pubscribe as a separate service and therefore does not have to be included in the WSRF/WSN WSDL for a resource. For more information on the Subscription
+ Manager service, see <a href="site:subscript">Using the Subscription Manager</a>.</li>
+ </ul>
+ <note>Typically, a resource will be either be a Consumer or a Producer. However, you can implement both in a single resource.</note>
+ <table>
+ <tr>
+ <th>PortType</th>
+ <th>Operations</th>
+ <th>Properties</th>
+ </tr>
+ <tr>
+ <td>NotificationProducer</td>
+ <td>Subscribe, GetCurrentMessage</td>
+ <td>Topic, FixedTopicSet, TopicExpressionDialects</td>
+ </tr>
+ <tr>
+ <td>NotificationConsumer</td>
+ <td>Notify</td>
+ <td/>
+ </tr>
+ </table>
+ <note>In addition to operations, the <code>NotificationProducer</code> portType also includes three properties. If a
+ WS-Resource implements this portType, it must also expose these properties.</note>
+ <p>The PortType element must have a
+ <code>{http://docs.oasis-open.org/wsrf/2004/11/wsrf-WS-ResourceProperties-1.2-draft-05.xsd}ResourceProperties</code>
+ attribute whose value is the <code>QName</code> of the resource properties document element defined in the types/schema section of the WSDL file.
+ </p>
+ </section>
+ <section>
+ <title>Metadata Operations</title>
+ <p>The template contains two operations that are not defined by the WSRF or WSN specification that can be used in your service to retrieve metadata
+ about your services. The operations and messages are defined in the
+ <a href="http://msdn.microsoft.com/library/en-us/dnglobspec/html/ws-metadataexchange.pdf">WS-Metadata Exchange</a> specification defined by Microsoft and other industry
+ contributors. For instructions on providing metadata about your service, see the <a href="site:metadata">Adding Service Metadata</a> section of the Apache
+ WSRF documentation.</p>
+ </section>
+ </section>
+ </body>
</document>
---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org