Author: scamp
Date: Thu Aug 4 14:03:07 2005
New Revision: 227486
URL: http://svn.apache.org/viewcvs?rev=227486&view=rev
Log:
updates to docs
Modified:
webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/relationships.xml
webservices/muse/trunk/src/site/content/xdocs/getting_started.xml
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml
(original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml Thu Aug
4 14:03:07 2005
@@ -16,8 +16,8 @@
<title>SOAP Files</title>
<p>The client reads a <code>.soap</code> file which
contains the SOAP envelope to be sent. Examples of SOAP files are located in
<code>INSTALL_DIR/examples/filesystem/requests/</code>.
Each file is named appropriately based on the operation it contains. Use these
files as models when
- creating your own .soap files. Make sure you modify the
WS-Addressing header for the resource id to match the entry that is in the JNDI
- configuration file and the resource id for the instance
you would like to invoke. The id is used by the invocation framework to lookup
a particular resource instance.</p>
+ creating your own .soap files. Make sure you modify the
WS-Addressing header for the resource identifier to match the entry that is in
the JNDI
+ configuration file and the resource identifier for the
instance you would like to invoke. The id is used by the invocation framework
to lookup a particular resource instance.</p>
</section>
<section>
<title>Running the Client</title>
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml Thu Aug 4
14:03:07 2005
@@ -13,7 +13,7 @@
</p>
<note>If your service is a singleton and only requires
a single resource instance, see the <a href="ext: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
+ <p>If you use the Wsdl2Java tool, the home class is
automatically generated but will need to be 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>
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml Thu Aug
4 14:03:07 2005
@@ -10,7 +10,7 @@
<p>The Developer Guide provides instructions for using
many of the features that are included in Muse. If you are new to this project,
you should start
with the <a href="site:overview">Getting Started</a>
and the <a href="site:tut">Tutorial</a> before reading this guide. They provide
a good starting point for
learning how to use Muse.</p>
- <note>Muse is tightly integrated with <a
href="ext:wsrf">Apache WSRF</a> as its WSRF foundation and <a
href="ext:pubscribe">Apache Pubscribe</a>as its WSN
+ <note>Muse is tightly integrated with <a
href="ext:wsrf">Apache WSRF</a> as its WSRF foundation and <a
href="ext:pubscribe">Apache Pubscribe</a> as its WSN
foundation. While it is not required, it is a good idea
to start with Apache WSRF and Apache Pubscribe to learn more about these
respective foundations.
You should also consult the Apache WSRF and Apache
Pubscribe documentation while completing the instructions in this document. All
of the tasks required in Apache WSRF and
Apache Pubscribe are also required in Muse.
Modified:
webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml
(original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml Thu
Aug 4 14:03:07 2005
@@ -148,9 +148,9 @@
</section>
<section>
<title>Adding Custom Management Events</title>
- <p>Notifications for custom topics (e.g. property
changed events) can be wrapped as a ManagementEvent notification. While this is
not required by the MUWS
+ <p>Notifications for custom topics (e.g. my_foo events)
can be wrapped as a ManagementEvent notification. While this is not required by
the MUWS
specification, it may give WSDM notification consumers
the ability to process your notification, even if they are unaware of the
resource as a managed resource.</p>
- <p>Muse provides several utility classes that can be
used to wrap a notification. </p>
+ <p>Muse provides several utility classes that can be
used to define a ManagementEvent Topic and wrap a notification. </p>
<ol>
<li>Define a ManagementTopic.
@@ -187,14 +187,14 @@
org.oasisOpen.docs.wsdm.x2004.x12.muws.wsdmMuwsPart1.ManagementEventType
managementEvent =
managementEventDocument.getManagementEvent();
- //add your custom XmlBean-generated object to the ManagementEvent
+ //add your custom XmlBean-generated object (i.e.
fooXmlBeanGeneratedObject) to the ManagementEvent
XmlBeanUtils.addChildElement(managementEvent,
fooXmlBeanGeneratedObject);
</source>
</li>
<li>Publishing ManagementNotifications.
- <p>The use of ManagementEventTopic as the Topic for
exposing Notifications provides the ability to publish ManagementEvents. Once
you have built the notification you would like to send, you will need to
publish the event to the ManagementTopic.</p>
+ <p>The use of ManagementEventTopic as the Topic for
exposing Notifications provides the ability to publish ManagementEvents. Once
you have built the ManagementEvent notification you would like to send, you
will need to publish the event to the ManagementTopic.</p>
<source>
//retrieve the Topic from the Resource
ManagementEventTopic fooTopic =
(ManagementEventTopic)getTopicSpaceSet().getTopicSpace("http://foo/topicspace";).getTopic("FooCapability");
Modified:
webservices/muse/trunk/src/site/content/xdocs/dev_guide/relationships.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/relationships.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/relationships.xml
(original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/relationships.xml
Thu Aug 4 14:03:07 2005
@@ -14,7 +14,7 @@
</p>
<p>The examples in this section are taken from the
filesystem example. The example demonstrates a simple relationship where a host
resource contains a relationship
with a filesystem resource. The host resource is
considered the <code>container</code> in the relationship and the filesystem
resource is considered the
- <code>containee</code>. The code to define and setup
the relationship is added to the <code>init()</code> method of
FilesystemResource.java.
+ <code>containee</code>. The code to define and setup
the relationship is added to the <code>init()</code> method of
FilesystemResource.java since the FilesystemResource exposes the Relationship
resource property.
</p>
<note>For simplicity, the example relationship is
defined within the the filesystem resource. However, relationships do not need
to be defined as part of the resource
definition. For example, a resource can be created that
is not a manageable resource, but does provide the implementation of the
relationships for a particular management
Modified: webservices/muse/trunk/src/site/content/xdocs/getting_started.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/getting_started.xml?rev=227486&r1=227485&r2=227486&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/getting_started.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/getting_started.xml Thu Aug
4 14:03:07 2005
@@ -43,7 +43,7 @@
displays. Four services are deployed:
<code>SubscriptionManager</code>, <code>ResourceAdvertiser</code>,
<code>AdminService</code>, and
<code>Version</code>. The <code>AdminService</code> and <code>Version</code>
services are default
Apache-Axis services. The
<code>SubscriptionManager</code> is used to pause, resume, destroy, or update
- subscriptions. Lastly,
<code>ResourceAdvertiser</code> is used to get resource properties and
subscribe to notifications.</li>
+ subscriptions. Lastly,
<code>ResourceAdvertiser</code> is used to subscribe to notifications about
resources which are created and destroyed.</li>
<li>Click on the respective WSDL links to view
and ensure that the WSDL for the services are published.</li>
</ol>
</section>
@@ -118,7 +118,7 @@
ant -f soapclient.xml
-Durl=http://localhost:8080/muse/services/SubscriptionManager
-Dxml=requests/Destroy_Subscription.soap]]></source>
</li>
<li>
- <strong>View Relationship</strong>
+ <strong>View Relationships</strong>
<br/>
<p>In this step, a request is sent to
retrieve all relationships of the type <code>ContainedBy</code>. The filesystem
resource has a <code>ContainedBy</code>
relationship with the host resource.
The response indicates the participants of the relationship and the role each
participant plays in the relationship.</p>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
