ws-wsrf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jru...@apache.org
Subject svn commit: r226449 - in /webservices/wsrf/trunk/src: ./ site/content/xdocs/ site/content/xdocs/dev_guide/
Date Sat, 30 Jul 2005 00:53:06 GMT
Author: jruzzi
Date: Fri Jul 29 17:53:00 2005
New Revision: 226449

URL: http://svn.apache.org/viewcvs?rev=226449&view=rev
Log:
ian edits

Modified:
    webservices/wsrf/trunk/src/ReadMe.txt
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/client.xml
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/debug.xml
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/deploy.xml
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/metadata.xml
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/singleton.xml
    webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/validate.xml
    webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml

Modified: webservices/wsrf/trunk/src/ReadMe.txt
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/ReadMe.txt?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/ReadMe.txt (original)
+++ webservices/wsrf/trunk/src/ReadMe.txt Fri Jul 29 17:53:00 2005
@@ -11,9 +11,6 @@
 /examples/filesystem - used in the documentation Quick Demonstration and 
 Tutorial. It demonstrates creating a WS Resource.
 
-/examples/interop - used for an interoperability session conducted
-by the WSRF OASIS working group.
-
 **************************************************************************
 
 /template

Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/client.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/client.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/client.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/client.xml Fri Jul 29 17:53:00
2005
@@ -8,7 +8,7 @@
 	<body>
 		<section id="intro">
 			<title>Introduction</title>
-			<p>Apache WSRF 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>Apache WSRF 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,23 +17,21 @@
 			<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>
 			<p>To invoke the script:</p>
-			
 			<ol>
 				<li>Make sure your WS Resource is deployed.</li>
 				<li>open a command prompt and change directories to <code>INSTALL_DIR/template/soapclient.xml</code>.</li>
 				<li>Run:
       				<source>ant -f soapclient.xml sendRequest -Durl=http://localhost:8080/wsrf/services/<em>your_service</em>
-Dxml=./requests/QueryResourceProperties_allProps.soap</source>
-				<p>Where <em>your_service</em> represents your WS Resource endpoint
name, and the script name should be the name (including the path) of your .soap file. 
+					<p>Where <em>your_service</em> represents your WS Resource endpoint
name, and the script name should be the name (including the path) of your .soap file. 
       				</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/wsrf/trunk/src/site/content/xdocs/dev_guide/debug.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/debug.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/debug.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/debug.xml Fri Jul 29 17:53:00
2005
@@ -15,17 +15,21 @@
 		</section>
 		<section>
 			<title>Changing Log Levels</title>
-			<p>Log4j uses the following log levels: DEBUG, INFO, WARN, ERROR, and FATAL. By
default, Apache WSRF 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 Apache WSRF Web application.</li>
-				<li>Change the log level associated with the <code>log4j.category.org.apache.ws</code>
package. For example:<source>
-log4j.category.org.apache.ws=DEBUG</source></li>
+				<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>
 				<li>Restart Tomcat.
 				<note>Log messages are displayed in Tomcat's standard output. If you are not using
Tomcat, you may need to configure your Web container to include the output 
-				in its standard output.</note></li>
+				in its standard output.</note>
+				</li>
 			</ol>
 		</section>
 	</body>

Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/deploy.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/deploy.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/deploy.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/deploy.xml Fri Jul 29 17:53:00
2005
@@ -8,14 +8,14 @@
 	<body>
 		<section id="intro">
 			<title>Introduction</title>
-			<p>The quickest way to deploy your WS Resource is to use the generated build scripts.
The scripts compile and delploy your WS 
-			Resource to the Apache WSRF Web application, which is an Apache-Axis Web application.
This section describes how to use the 
-			generated build scripts and also how the script works so 	you can build your own scripts.</p>
+			<p>The quickest way to deploy your WS-Resource is to use the generated build script.
The script compiles and delploys your WS-Resource 
+			 to the Apache WSRF Web application, which is an Apache-Axis Web application. This section
describes how to use the 
+			generated build script and also how the script works so you can build your own script.</p>
 		</section>
 		<section>
 			<title>Using the generated build scripts</title>
-			<p>The Wsdl2Java tool generates an Ant build script that is used to compile and
deploy your WS Resource. The script is located in the 
-			output directory under the subdirectory for you WS Resource (e.g., <code>generated/</code>
+			<p>The Wsdl2Java tool generates an Ant build script that is used to compile and
deploy your WS-Resource. The script is located in the 
+			output directory under the subdirectory for your WS-Resource (e.g., <code>generated/</code>
 				<em>
 					<code>service_name</code>
 				</em>).</p>
@@ -33,7 +33,7 @@
 			<source><![CDATA[
 	ant compile deploy ]]></source>
 			<p>Start Tomcat and verify that the service is deployed by going to 
-			<a href="http://localhost:8080/wsrf/servlet/AxisServlet">http://localhost:8080/wsrf/servlet/AxisServlet</a>
+			<a href="http://localhost:8080/wsrf/services">http://localhost:8080/wsrf/services</a>
 			</p>
 		</section>
 		<section id="steps">
@@ -92,17 +92,16 @@
 					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> 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>{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 
+					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>

Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/metadata.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/metadata.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/metadata.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/metadata.xml Fri Jul 29 17:53:00
2005
@@ -8,11 +8,9 @@
 	<body>
 		<section>
 			<title>Introduction</title>
-			<p>Web services use metadata to describe what other endpoints need to know to interact
with them. In particular, the metadata for a Web service includes the 
-			service's description (WSDL or schema). There are two operations that are not defined
by the WSRF specification that can be used in your services 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.  
+			<p>Web services may have various metadata associated with them (e.g. the WSDL for
the service or a set of Topic Space documents). The 
+			<a href="http://msdn.microsoft.com/library/en-us/dnglobspec/html/ws-metadataexchange.pdf">WS-MEXWS-Metadata
Exchange</a> specification (defined by Microsoft 
+			and other industry contributors) defines operations that can be provided by services to
allow clients to retrieve these metadata documents.
 			</p>
 		</section>
 		<section>
@@ -59,8 +57,8 @@
 		</section>
 		<section>
 			<title>Modify the JNDI Configuration File</title>
-			<p>The JDNI configuration file must be modified to include a metadata resource for
your service as well as configurations that define where your metadata files are located.</p>
-			<p>To update the JDNI configuration file to include metadata information:</p>
+			<p>The JNDI configuration file must be modified to include a metadata resource for
your service as well as configurations that define where your metadata files are located.</p>
+			<p>To update the JNDI configuration file to include metadata information:</p>
 			<ol>
 				<li>Using a text editor, open <code>jndi-config.xml</code> in the <code>WEB-INF/classes</code>
directory.</li>
 				<li>Add the following JNDI resource block to the service, for which you would like
to associate metadata:
@@ -68,11 +66,12 @@
 <service name="myService">
    <resource name="metadata" type="org.apache.ws.util.jndi.tools.MetadataConfigImpl">]]></source>
 					<p>The <code>org.apache.ws.util.jndi.tools.MetadataConfigImpl</code>
object containing the metadata is available via JNDI using a Context lookup of 
-				<code>wsrf/services/{sevice_name}/metadata</code> - i.e. <code>ctx.lookup("wsrf/services/sushi/metadata");</code>
+				<code>wsrf/services/{service_name}/metadata</code> - i.e. <code>ctx.lookup("wsrf/services/sushi/metadata");</code>
 					</p>
 				</li>
-				<li>In the metadata resource block, add a<code> metadataConfig</code>
element that contains metadata configurations. The following examples demonstrate five different

-				methods of configuring where your metadata files are located. The files should be "reachable"
at the configured locations.<source><![CDATA[
+				<li>In the metadata resource block, add a<code> metadataConfig</code>
element that contains metadata configurations. The configuration includes a <code>dialect</code>

+				attribute that defines the type of the data (xsd, wsdl, etc...) and an identifier attribute
that uniquely identifies a particular document and is typically a targetNamespace. The 
+				following examples demonstrate five different methods of configuring where your metadata
files are located. The files should be "reachable" at the configured locations.<source><![CDATA[
 <resource name="metadata" type="org.apache.ws.util.jndi.tools.MetadataConfigImpl">
    <metadataConfig>
       <!-- classpath -->

Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/singleton.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/singleton.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/singleton.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/singleton.xml Fri Jul 29 17:53:00
2005
@@ -8,15 +8,15 @@
 	<body>
 		<section>
 			<title>Introduction</title>
-			<p>You can create a singleton service if only a single instance of a resource is
required. If a service is a singleton, no resource ID is expected in the 
-			WS-Addressing header. To create a singleton service, you must create a single instance
of the resource in the generated home class and modify the deployed 
+			<p>You can create a singleton service if only a single instance of a resource is
required. If a service is a singleton, no resource ID parameter is expected in the 
+			header of requests sent to the service. To create a singleton service, you must create
a single instance of the resource in the generated home class and modify the deployed 
 			jndi-config.xml file.
 			</p>
 		</section>
 		<section>
 			<title>Create a Single Instance</title>
-			<p>Resource instances are created in the service's home class. For a singleton,
set the <code>createInstance</code> method to <code>null</code>. This
ensures 
-			that only a single instance of the resource is created. For example:</p>
+			<p>Resource instances are created in the service's home class. For a singleton,
specify an identifier of <code>null</code> when you call <code>createInstance()</code>.
This 
+			ensures that only a single instance of the resource is created. For example:</p>
 			<source><![CDATA[public void init() throws Exception
     {
         super.init();
@@ -27,7 +27,7 @@
 		</section>
 		<section>
 			<title>Modify the JNDI Configuration File</title>
-			<p>To update the JDNI configuration file for a singleton:</p>
+			<p>To update the JNDII configuration file for a singleton service:</p>
 			<ol>
 				<li>Using a text editor, open <code>jndi-config.xml</code> in the <code>WEB-INF/classes</code>
directory.</li>
 				<li>From the <code><![CDATA[<service name="your_service">]]></code>
block, remove the <code>resourceIdentifierReferenceParameterName</code> parameter.


Modified: webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/validate.xml
URL: http://svn.apache.org/viewcvs/webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/validate.xml?rev=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/validate.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/dev_guide/validate.xml Fri Jul 29 17:53:00
2005
@@ -8,20 +8,22 @@
 	<body>
 		<section id="intro">
 			<title>Introduction</title>
-			<p>All requests sent to the resource invocation framework are validated against
any defined schemas. When validation fails, a fault that contains a detailed description of

-				exactly what is wrong with the XM is returned to the client. Request validation is performed
using XMLBeans, which uses an in-memory 
-				binary schema store. If the utmost performance is required, request validation can be
disabled.
-				</p>
+			<p>All requests sent to the resource invocation framework are validated against
any defined schemas types which have corresponding XMLBean classes located on the 
+			classpath. When validation fails, a fault that contains a detailed description of exactly
what is wrong with the XM is returned to the client. Request validation is performed using

+			XMLBeans, which uses an in-memory binary schema store. If the utmost performance is required,
request validation can be disabled.
+			</p>
 		</section>
 		<section>
 			<title>Disabling Schema Validation</title>
 			<p>Schema validation is enabled by default. This means that all requests are validated.
If you would like to disable this feature, you must set the 
-			<code>validateRequestXml</code> property to <code>false</code>.
The property must be set as a Java property before starting the container that is hosting
Apache WSRF. 
-			For example:</p><source>
+			<code>validateRequestXml</code> system property to <code>false</code>.
The property must be set as a Java property before starting the container that is hosting

+			Apache WSRF. For example:</p>
+			<source>
 	-DvalidateRequestXml=false</source>
-			<p>If you are using Tomcat, you can set this property in the <code>JAVA_OPTS</code>
variable before starting Tomcat. For example:</p><source>
+			<p>If you are using Tomcat, you can set this property in the <code>JAVA_OPTS</code>
variable before starting Tomcat. For example:</p>
+			<source>
 	set JAVA_OPTS=-DvalidateRequestXml=false
-	catalina.bat run</source>	
+	catalina.bat run</source>
 		</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=226449&r1=226448&r2=226449&view=diff
==============================================================================
--- webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml (original)
+++ webservices/wsrf/trunk/src/site/content/xdocs/release_notes.xml Fri Jul 29 17:53:00 2005
@@ -1,19 +1,24 @@
 <?xml version="1.0"?>
-
 <!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-
-<document> 
-  <header> 
-    <title>WSRF Release Notes</title> 
-  </header> 
-  <body> 
-    <section>
-        <title>Change History</title>
-        <p>TODO</p>
-    </section>
-    <section>
-        <title>Known Issues</title>
-        <p>TODO</p>
-    </section>
-  </body>
+<document>
+	<header>
+		<title>WSRF Release Notes</title>
+	</header>
+	<body>
+		<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>
+			</ul>
+			<p></p>
+		</section>
+		<section>
+			<title>Known Issues</title>
+			<ul>
+				<li>TODO</li>
+			</ul>
+		</section>
+	</body>
 </document>



Mime
View raw message