Author: jruzzi
Date: Fri Jul 29 17:54:38 2005
New Revision: 226450
URL: http://svn.apache.org/viewcvs?rev=226450&view=rev
Log:
ian edits
Added:
webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml
Modified:
webservices/muse/trunk/src/site/content/xdocs/dev_guide/client.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/debug.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/index.xml
webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml
webservices/muse/trunk/src/site/content/xdocs/site.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=226450&r1=226449&r2=226450&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 Fri Jul
29 17:54:38 2005
@@ -8,7 +8,7 @@
<body>
<section id="intro">
<title>Introduction</title>
- <p>MUSE includes a lightweight SOAP client that is used
to test your services. The client is invoked using an Ant script, which is
located in
+ <p>MUSE includes a lightweight SOAP client that can be
used to test your services. The client is invoked using an Ant script, which is
located in
<code>INSTALL_DIR/template/soapclient.xml</code>.
Request and response messages are viewed in the Ant output. This section
explains how to use the client and
how to build request SOAP messages for the client.</p>
</section>
@@ -17,8 +17,7 @@
<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 number for the
instance you would like to invoke. This has to do with the home's
implementation of <code>getInstance()</code>
- and allows you to decide which instances are valid for
sending requests. </p>
+ 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>
</section>
<section>
<title>Running the Client</title>
@@ -32,7 +31,7 @@
</p>
</li>
</ol>
- <note>You can add an entry to
<code>build.properties</code> for <code>url</code> which will alleviate the need
+ <note>You can add an entry to
<code>build.properties</code> for the <code>url</code> property, which
alleviates the need
to specify it on the command line.</note>
</section>
</body>
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/debug.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/debug.xml?rev=226450&r1=226449&r2=226450&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/debug.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/debug.xml Fri Jul
29 17:54:38 2005
@@ -15,12 +15,14 @@
</section>
<section>
<title>Changing Log Levels</title>
- <p>Log4j uses the following log levels: DEBUG, INFO,
WARN, ERROR, and FATAL. By default, MUSE is configured to emit INFO messages.
To see more
- detailed log messages, you must change the log level.
The following example assumes Tomcat.</p>
+ <p>Log4j uses the following log levels: DEBUG, INFO,
WARN, ERROR, and FATAL. By default, Apache WSRF is configured at the INFO
level, which means messages logged
+ at INFO or higher level (i.e. INFO, WARN, ERROR, and
FATAL) are included in the output. To see more detailed log messages, you must
change the log level.
+ The following example assumes Tomcat.
+ </p>
<p>To change the logging level:</p>
<ol>
<li>Using a text editor, open the
log4j.properties file located in the WEB-INF/classes directory of the deployed
MUSE Web application.</li>
- <li>Change the log level associated with the
<code>log4j.category.org.apache.ws</code> package. For example:<source>
+ <li>Change the log level associated with all
classes below the <code>log4j.category.org.apache.ws</code> package. For
example:<source>
log4j.category.org.apache.ws=DEBUG</source>
</li>
<li>Save the log4j.properties file.</li>
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml?rev=226450&r1=226449&r2=226450&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml
(original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml Fri Jul
29 17:54:38 2005
@@ -92,19 +92,19 @@
alternative, you can use the following
markers which are replaced at runtime:
</p>
<ul>
- <li><code>$IP_ADDRESS$</code> -
An attempt is made to determine the IP address at runtime. (Do not use on
multi-homed systems).</li>
- <li><code>$HOST_NAME$</code> -
An attempt is made to determine the host name at runtime.</li>
+ <li>
+
<code>$IP_ADDRESS$</code> - An attempt is made to determine the IP address at
runtime. (Do not use on multi-homed systems).</li>
+ <li>
+
<code>$HOST_NAME$</code> - An attempt is made to determine the host name at
runtime.</li>
</ul>
- <p>The
<code>resourceIdentifierReferenceParameterName</code> represents the name of
the WS-Addressing-header that is used to
- extract a unique resource identifier to
lookup a specific WS resource instance. This value should be a QName that
includes the local
- reference parameter name in the format
<em>
- <code>{target
namespace}qualified name of a reference parameter</code>
- </em>. If you omit
- this entry, it is assumed that the
service is a <strong>
- <code>SINGLETON</code>
- </strong> service and no
resource id is expected in the
+ <p>The
<code>resourceIdentifierReferenceParameterName</code> parameter represents the
name of the WS-Addressing-header that is used to
+ extract a unique resource identifier to
lookup a specific WS-Resource instance. This value should be a QName that
includes the local
+ reference parameter name in the format
<em><code>{namespaceURI}localPart</code></em>, where namesapaceURI and
localPart are the namespace and URI and local
+ part of the qualified name of the
reference paramater that should contain the resource identifier. If you omit
this entry, it is assumed that the service is a
+ <strong><code>SINGLETON</code></strong>
service and no resource id is expected in the
WS-Addressing headers.
</p>
+
</li>
<li>
<strong>Update the server-config.wsdd
file</strong>
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=226450&r1=226449&r2=226450&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 Fri Jul
29 17:54:38 2005
@@ -24,7 +24,8 @@
</section>
<section>
<title>WSDM Overview</title>
- <p><a href="site:wsdm">WSDM</a> is defined by the OASIS
standards body and is comprised of two separate specifcations:
+ <p>
+ <a href="site:wsdm">WSDM</a> is defined by the
OASIS standards body and is comprised of two separate specifcations:
</p>
<ul>
<li>Management using Web Services (MUWS) - MUWS
defines how to represent and access the manageability interfaces of resources
as Web services. It is the
@@ -35,7 +36,7 @@
<li>Management of WebServices (MOWS)- MOWS
defines the manageability model for managing Web services as a resource and how
to describe and access that
manageability using MUWS.</li>
</ul>
- <p>MUSE is an implementation of both parts of the MUWS
specification since MOWS is a domain specific implementation of MUWS.</p>
+ <p>MUSE is an implementation of both parts of the MUWS
specification.</p>
</section>
<section>
<title>Conceptual Overview</title>
Added: 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=226450&view=auto
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml
(added)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/muws_topics.xml Fri
Jul 29 17:54:38 2005
@@ -0,0 +1,170 @@
+<?xml version="1.0"?>
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN"
+ "http://forrest.apache.org/dtd/document-v20.dtd";>
+<document>
+ <header>
+ <title>MUWS-Specific Topics</title>
+ </header>
+ <body>
+ <section id="intro">
+ <title>Introduction</title>
+ <p>Each resource that is configured to be a
notification producer (implements the WSN <code>NotificationProducer</code>
portType) is associated with a
+ topic set. The resource publishes notifications to a
topic in the topic set. Notification consumers can then subscribe to a topic
and receive notifications
+ from the resource. As the service developer of the
notification producer resource, you are responsible for adding the topics you
want to support to the topic set.
+ </p>
+ <p>
+ This section provides instructions for adding support
to your managed resource for the various topics that are defined by MUWS.
+ The topics can be organized into three types:
+ </p>
+ <ul>
+ <li>Capability topics: Topics for each of the
MUWS defined resource properties that indicate changed property events</li>
+ <li>Advertiser topics: Topics for resource
creation and destruction events</li>
+ <li>Relationship topics: Topics for
relationship created and deleted events</li>
+ </ul>
+ <note>For information on adding custom topics for your
resource, see the <a href="ext:producer">Notification Producer</a> section in
the Apache Pubscribe
+ documentation.</note>
+ <p>Notification topics are added to the
<code>init()</code> method of your service's resource class. If you used the
Wsdl2Java tool, the resource class
+ (<em>
+ <code>service_name</code>
+ </em>
+ <code>Resource.java</code>) is automatically
generated, but will need to modified. Initially, you should model your resource
off of the included FileSystemResource
+ example to ensure that you write a valid
resource class.
+ </p>
+ <p>The resource class is the stateful
instance-representation of your Web service. In addition to notification
topics, the resource class maintains the resource
+ <code>id</code> and the
<code>ResourcePropertySet</code>. The <code>ResourcePropertySet</code> is the
Java representation of the Resource Properties document
+ defined in the types section of your WSDL file.
+ </p>
+ <note>This section does not include instructions for
initializing resource properties and adding them to the
<code>ResourcePropertySet</code>. See the
+ <a href="ext:resource">Resource Class</a> documentation
included with Apache WSRF.
+ </note>
+ <section>
+ <title>ManagementEvent notifications</title>
+ <p> WSDM defines a specific event format
that is different than a standard WSN notification. Whenever you subscribe to a
MUWS related topic, the notifcations
+ are always returned in the WSDM event format.
The term ManagementEvent notification is used since
<code>ManagementEvent</code> is the root element of the
+ notification.
+ </p>
+ <p>A ManagementEvent notification provides a
set of standard fields that provide metadata about the event as well as the
actual notification element (e.g, a resource
+ property changed event for a resource
property). The Metadata includes: report time, event ID, source component,
reporter component, as well as an "any" wild card.
+ It is suggested that your custom topics also
use this event format. Although, it is not required. Apache MUSE provides some
helper classes that can be used to create
+ ManagementEvent-based notifications. The
instructions are discussed below.
+ </p>
+ </section>
+ </section>
+ <section>
+ <title>Adding Capability Topics</title>
+ <p>To add MUWS capability topics to your resource,
modify the <code>init()</code> of your resource class using the following
instructions. The example is taken from the
+ filesystem example and creates topics for the following
MUWS resource properties: <code>Identity</code>,
<code>ManageabilityCharacteristics</code>,
+ <code>OperationalStatus</code>, and
<code>Relationship</code>.</p>
+ <source>
+org.apache.ws.muws.v1_0.topics.ManagementEventTopic identityCapabilityTopic;
+ org.apache.ws.muws.v1_0.topics.ManagementEventTopic
manageabilityCharacteristicsCapabilityTopic;
+ org.apache.ws.muws.v1_0.topics.ManagementEventTopic
operationalStatusCapabilityTopic;
+ org.apache.ws.muws.v1_0.topics.ManagementEventTopic
relationshipsCapabilityTopic;
+ try
+ {
+ org.apache.ws.notification.topics.TopicSpace muwsTopicSpace = new
org.apache.ws.notification.topics.impl.TopicSpaceImpl(
org.apache.ws.muws.v1_0.MuwsConstants.NSURI_MUWS_PART2_TOPICS );
+ getTopicSpaceSet().addTopicSpace( muwsTopicSpace );
+
+ identityCapabilityTopic = new
org.apache.ws.muws.v1_0.topics.impl.XmlBeansManagementEventTopicImpl(
org.apache.ws.muws.v1_0.capability.IdentityCapability.TOPIC_NAME );
+ muwsTopicSpace.addTopic( identityCapabilityTopic );
+ manageabilityCharacteristicsCapabilityTopic = new
org.apache.ws.muws.v1_0.topics.impl.XmlBeansManagementEventTopicImpl(
+
org.apache.ws.muws.v1_0.capability.ManageabilityCharacteristicsCapability.TOPIC_NAME
);
+ muwsTopicSpace.addTopic(
manageabilityCharacteristicsCapabilityTopic );
+ operationalStatusCapabilityTopic = new
org.apache.ws.muws.v1_0.topics.impl.XmlBeansManagementEventTopicImpl(
+
org.apache.ws.muws.v1_0.capability.OperationalStatusCapability.TOPIC_NAME );
+ muwsTopicSpace.addTopic( operationalStatusCapabilityTopic );
+ relationshipsCapabilityTopic = new
org.apache.ws.muws.v1_0.topics.impl.XmlBeansManagementEventTopicImpl(
org.apache.ws.muws.v1_0.capability.RelationshipsCapability.TOPIC_NAME );
+ muwsTopicSpace.addTopic( relationshipsCapabilityTopic );
+ }
+ catch ( Exception e )
+ {
+ throw new RuntimeException( "Failed to add MUWS capability topics
to topic set of " + this.getClass().getName() + " resource with ID " + getID()
+ ".", e );
+ }
+
+ </source>
+ <ul>
+ <li>Create the topic space:
+ </li>
+ <li>For each MIUWS capability that your
resource supports, you should add a topic to the resource's topic set. The
topic should be of the type
+
<code>org.apache.ws.muws.v1_0.topics.ManagementEventTopic</code>.</li>
+ <li>add each capability to the topic space</li>
+ <li>Third add a change listener for each
resource property topic that is associated with a muse capability.</li>
+ </ul>
+ <note> change listner is not required but can be used if you want
management events containing changedproperty events </note>
+ </section>
+ <section>
+ <title>Adding Advertiser Topics</title>
+
+ <p>The
âmuws-events:ManageableResourceCreationâ topic is a specialization of the
1383
+âManageability EndpointCreationâ topic. This topic corresponds to the case
where a resource 1384
+itself is newly created. Note that if a resource is created that is not
manageable (i.e. which does 1385
+not have a manageability endpoint) no notification on this topic will be sent.
If a resource and a 1386
+manageability endpoint for the resource are created then a notification will
be sent to a subscriber 1387
+on this topic.
+
+The âmuws-events:ManageableResourceDestructionâ topic is a specialization
of the 1394
+âManageabilityEndpointDestructionâ topic. This topic corresponds to the
case where a resource 1395
+itself is destroyed at the same time as the manageability endpoint. Note that
if a resource is 1396
+destroyed that is not manageable (i.e. which does not have a manageability
endpoint) no 1397
+notification on this topic will be sent. An associated
muws-p2-xs:DestructionNotification message 1398
+contains the muws-p2-xs:ResourceId that a newly destroyed manageability
endpoint provided for 1399
+the resource before its destruction.
+</p>
+<note>Two additional topics, ManageabilityEndpointCreation and
ManageabilityEndpointDestruction are note implemented by MUSE.</note>
+
+
+ <p>uses a selector to narrow it down to a
specific resource. the selector is returned with the request.</p>
+ </section>
+ <section>
+ <title>Adding Relationhip Topics</title>
+ <p>
+
+
muws-events:ManageableRelationships/muws-events:RelationshipCreated indicates
the 1233
+addition of a new relationship. It is RECOMMENDED that a consumer subscribe to
this 1234
+notification with an appropriate selector against the content of notification
messages in order to 1235
+reduce the volume of received messages. Each notification message contains at
least the 1236
+following information:
+
+muws-events:ManageableRelationships/muws-events:RelationshipDeleted indicates
1241
+removal of an existing relationship. It is RECOMMENDED that a consumer
subscribe to this 1242
+notification with an appropriate selector against the content of notification
messages in order to 1243
+reduce the volume of received messages. Each notification message contains at
least the 1244
+following information:
+
+
+
+
+ </p>
+ </section>
+ <section>
+ <title>Adding Custom Management Events</title>
+
+
+ <p>custom topics can be add
+
+ First, you create the topic space:
+
+ org.apache.ws.notification.topics.TopicSpace
muwsTopicSpace = new org.apache.ws.notification.topics.impl.TopicSpaceImpl(
org.apache.ws.muws.v1_0.MuwsConstants.NSURI_MUWS_PART2_TOPICS );
+ getTopicSpaceSet().addTopicSpace( muwsTopicSpace );
+
+
+ second add each capability to the topic space
+
+
+
+ for example the filesystem resource
+
+
+ managmentevent, Impl, mgmteventTopic (impl?)
+
+ </p>
+
+
+
+
+
+
+
+ </section>
+ </body>
+</document>
Modified: webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml?rev=226450&r1=226449&r2=226450&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml Fri Jul 29
17:54:38 2005
@@ -32,12 +32,12 @@
<note>The WSRF portTypes - from 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. The WSN portTypes - from
WS-BaseNotification - and their associated operations are described in the
Apache Pubscribe
- <a href="ext:pubwsdl">WSDL Documentation</a>. The
instructions include defining notification producers and notification consumers.
+ <a href="ext:pubwsdl">WSDL Documentation</a>. The
instructions include defining notification producers, notification topics, and
notification consumers.
</note>
<section>
<title>MUWS PortTypes</title>
<p>The MUWS specification defines eight
portTypes. However, only the <code>Relationships</code> portType contains an
operation that can be added to the portType of your
- WSDL. The other portTypes are used to organize
and expose resource properties and need to be defined in the
<code>schema</code> section of a WSDL as you would
+ WSDL. The other portTypes are used to organize
and expose resource properties and need to be defined in the <code>type</code>
section of a WSDL as you would
any other resource property. Among these
properties, the ResourceID property is required and must be included in a MUWS
compliant WSDL.
</p>
<table>
Modified: webservices/muse/trunk/src/site/content/xdocs/site.xml
URL:
http://svn.apache.org/viewcvs/webservices/muse/trunk/src/site/content/xdocs/site.xml?rev=226450&r1=226449&r2=226450&view=diff
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/site.xml (original)
+++ webservices/muse/trunk/src/site/content/xdocs/site.xml Fri Jul 29 17:54:38
2005
@@ -71,8 +71,10 @@
<spec href="wsrf/wsrf.html"/>
<metadata href="wsrf/dev_guide/metadata.html"/>
<single href="wsrf/dev_guide/singleton.html"/>
+ <resource href="wsrf/dev_guide/resource.html"/>
<pubscribe href="pubscribe/"/>
<pubwsdl href="pubscribe/dev_guide/wsdl.html"/>
+ <producer href="pubscribe/dev_guide/producer.html"/>
<wsn href="pubscribe/wsn.html"/>
<mirrors href="mirrors.cgi"/>
<axis href="axis/"/>
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
