You are viewing a plain text version of this content. The canonical link for it is here.
Posted to wsrf-commits@ws.apache.org by jr...@apache.org on 2005/08/01 23:13:14 UTC

svn commit: r226886 - in /webservices/wsrf/trunk/src/site/content/xdocs: dev_guide/home.xml release_notes.xml

Author: jruzzi
Date: Mon Aug  1 14:13:11 2005
New Revision: 226886

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

Modified:
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/home.xml
    webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml

Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/home.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/home.xml?rev=226886&r1=226885&r2=226886&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/home.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/home.xml Mon Aug  1 14:13:11 2005
@@ -11,7 +11,7 @@
 			<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> section.</note>
+			<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> section.</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.
@@ -27,6 +27,8 @@
 			<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 modfify or extend the base class' functionality.</note>
 		</section>
 		<section id="ops">
 			<title>Operations</title>
@@ -40,8 +42,15 @@
         add( createInstance( LVOL1_ID ) );
         add( createInstance( LVOL2_ID ) );        
     }</source>
-			<note>Many of the operations in the <code>AbstractResourceHome</code> may be overridden in your Home
-            		class, if you have a need to modfify or extend the base class' functionality.</note>
+			<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/wsrf/trunk/src/site/content/xdocs/release_notes.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml?rev=226886&r1=226885&r2=226886&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml Mon Aug  1 14:13:11 2005
@@ -2,23 +2,47 @@
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
 <document>
 	<header>
-		<title>WSRF Release Notes</title>
+		<title>Apache WSRF Release Notes</title>
 	</header>
 	<body>
+		<note>If you have any services created prior to this release, it is strongly suggested that you regenerate the services (including XmlBeans-generated types) to a 
+		clean directory and manually port any added code to the newly generated files. This will avoid any problems associated with the changes in this release.</note>
 		<section>
 			<title>Change History</title>
 			<p>Changes since the 1.0 Beta release:</p>
 			<ul>
-				<li>New and improved documentation including a Getting Started section and Developer Guide.</li>
-				<li>Updated Tutorial.</li>
+				<li>Removed the <code>getInstance(..)</code> method from the generated Home classes. The init() method should be used for initializing Resources at startup. 
+				See method call/comment in the generated <code>...Home.java</code> file.</li>
+				<li>Added the generation of an Abstract...Home class which maintains the static Resource map specific to a Home. This was necessary to ensure each Home type 
+				maintains its cache across all instances.</li>
+				<li>Added <code>getNamespaceVersionHolder</code> method to the generated Home class. This returns the previously generated member variable.</li>
+				<li>Removed the<code> ResourceKey</code> interface. The <code>AbstractResourceHome.find(..)</code> method now takes an Object so that simple types 
+				like Strings may easily be used for lookups.</li>
+				<li>Changed the behavior of the<code> AbstractResourceHome.add(..)</code> and <code>AbstractResourceHome.createInstance(..)</code> method to determine 
+				if a Resource's EndpointReference (EPR) has been set, if it is <code>null</code> the EPR is generated and set on the Resource instance. This allows the 
+				implementor the opportunity to set the EPR themselves in the <code>Home.init(..)</code> method or let the <code>createInstance/add(..)</code> methods do it for 
+				them.</li>
+				<li>Added extra parameter to the <code>jndi-config.xml</code> file called <code>baseWebAppUrl</code> which by default is generated with the value of 
+				<code>http://$IP_ADDRESS$:8080/wsrf</code> (or pubscribe or muse). The parameter is used at runtime for building EPR's for a Resource. This URL may be 
+				modified to explicitly set a static IP address or host name, else you may replace <code>$IP_ADDRESS$</code> with <code>$HOST_NAME$</code> in which case 
+				the host name will be determined at runtime.</li>
+				<li>Changed the <code>jndi-config.xml resourceKeyName</code> parameter name to <code>resourceIdentifierReferenceParameterName</code> for better 
+				clarity.</li>
+				<li>Updated the schema for the <code>jndi-config.xml</code> for the metadata elements to make them more consistent.</li>
+				<li>Regenerated all XmlBeans-generated artifacts for the XmlBeans 2.0 release. This was necessary due to changes in their generated artifacts. <strong>Please 
+				regenerate any of your own XmlBeans-generated types</strong>.</li>
+				<li>Add Documentation: Enhanced Javadocs, Installation, Quick Demo, Tutorial, and Developers Guide.</li>
+				<li>Added a <code>ServletContextListener</code> implementation for initializing JNDI at startup. The original method of initializing JNDI was via an extension to 
+				<code>AxisServlet</code> which is now unnecessary.</li>
 			</ul>
-			<p></p>
+			<p/>
 		</section>
 		<section>
 			<title>Known Issues</title>
-			<ul>
-				<li>TODO</li>
-			</ul>
+			<p>There are currently no issues reported with this release. Please submit all issues to the Apache WSRF project in 
+			<a href="http://issues.apache.org/jira/browse/Apollo">Apache JIRA</a>. If you are not sure whether something is a bug, post a question on the WSRF 
+			<a href="contact_info.html">mailing list</a>.
+			</p>
 		</section>
 	</body>
 </document>