Author: jruzzi
Date: Thu Jul 28 10:01:53 2005
New Revision: 225824

URL: http://svn.apache.org/viewcvs?rev=225824&view=rev
Log:
updated content

Added:
    webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml
Modified:
    webservices/muse/trunk/src/site/content/xdocs/dev_guide/deploy.xml
    webservices/muse/trunk/src/site/content/xdocs/dev_guide/wsdl.xml

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=225824&r1=225823&r2=225824&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 Thu Jul 
28 10:01:53 2005
@@ -3,7 +3,7 @@
           "http://forrest.apache.org/dtd/document-v20.dtd";>

 <document>

        <header>

-               <title>Deploy the service to the MUSE Web Application</title>

+               <title>Deploy the Service to the MUSE Web Application</title>

        </header>

        <body>

                <section id="intro">

@@ -62,6 +62,10 @@
       <resource name="home" type="example.filesystem.FileSystemHome">

          <resourceParams>

             <parameter>

+               <name>baseWebappUrl</name>

+               <value>http://$IP_ADDRESS$:8080/muse</value>

+            </parameter>

+            <parameter>

                <name>serviceClassName</name>

                <value>example.filesystem.FileSystemService</value>

             </parameter>

@@ -84,6 +88,13 @@
                                        instance, and is named 
<code>home</code>.  Notice <code>serviceClassName</code> points to the clasname 
for the service class. The same is said for the 

                                        <code>resourceClassName</code>.  The 
<code>wsdlTargetNamespace </code> is the target namespace from your WSDL.

                                        </p>

+                                       <p>The <code>baseWebappUrl</code> 
parameter is used to define the URL of your Web application. You can include a 
static host, or as an 

+                                       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>

+                                       </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>


Added: 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=225824&view=auto
==============================================================================
--- webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml (added)
+++ webservices/muse/trunk/src/site/content/xdocs/dev_guide/home.xml Thu Jul 28 
10:01:53 2005
@@ -0,0 +1,48 @@
+<?xml version="1.0"?>

+<!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="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 

+                       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>When declaring your home you <strong>should</strong> 
extend <code>AbstractResourceHome</code>.  Extending 
<code>AbstractResourceHome</code> 

+                       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 <code>FileSystemHome</code> class extends 
<code>AbstractResourceHome</code> and implements <code>Serializable</code>:</p>

+                       <source>public class FileSystemHome

+        extends AbstractResourceHome

+        implements Serializable</source>

+               </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();

+        FilesystemResource lvol1Resource = (FilesystemResource) 
createInstance( LVOL1_ID );

+        add( lvol1Resource );

+        FilesystemResource lvol2Resource = (FilesystemResource) 
createInstance( LVOL1_ID );

+        add( lvol2Resource );

+    }</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>

+       </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=225824&r1=225823&r2=225824&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 Thu Jul 28 
10:01:53 2005
@@ -89,11 +89,13 @@
                                </table>

                        </section>

                        <section>

-                               <title>WS-MetadataExchange PortType</title>

+                               <title>Metadata Operations</title>

+                               <p>The template contains two operations that 
are not defined by the WSRF, WSN or WSDM 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="ext:metadata">Adding Service 
Metadata</a> section of the Apache 

+                               WSRF documentation.</p>

                        </section>

-                       <p>Apache MUWS also includes implementations for two 
operations that are defined in the WS Metadata Exchange Specification. This 
specification is not part of MUWS. See the 

-                               Including Metadata section for more information 
on how to implement metadata for your resources. 

-                               </p>

                </section>

        </body>

 </document>




---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to