You are viewing a plain text version of this content. The canonical link for it is here.
Posted to muse-commits@ws.apache.org by da...@apache.org on 2007/02/20 18:47:18 UTC
svn commit: r509682 - in /webservices/muse/site/docs/2.2.0/tutorial:
01-install-muse.html 03-wsdl2java.html 08-test-client.html
Author: danj
Date: Tue Feb 20 09:47:17 2007
New Revision: 509682
URL: http://svn.apache.org/viewvc?view=rev&rev=509682
Log:
Minor cleanup and consistency fixes. I also added JavaDoc links to the sample code in part 8 of the tutorial.
Modified:
webservices/muse/site/docs/2.2.0/tutorial/01-install-muse.html
webservices/muse/site/docs/2.2.0/tutorial/03-wsdl2java.html
webservices/muse/site/docs/2.2.0/tutorial/08-test-client.html
Modified: webservices/muse/site/docs/2.2.0/tutorial/01-install-muse.html
URL: http://svn.apache.org/viewvc/webservices/muse/site/docs/2.2.0/tutorial/01-install-muse.html?view=diff&rev=509682&r1=509681&r2=509682
==============================================================================
--- webservices/muse/site/docs/2.2.0/tutorial/01-install-muse.html (original)
+++ webservices/muse/site/docs/2.2.0/tutorial/01-install-muse.html Tue Feb 20 09:47:17 2007
@@ -124,7 +124,8 @@
<h2 class="boxed">Get the Latest Release</h2>
<div class="section">
<p>Go to the <a href="../../../download.html">download page</a> and download the binary distribution.
- Unzip the package into a directory on your machine.</p>
+ Unzip the package into a directory on your machine. For the sake of convenience, you should add
+ the distribution's <b>/bin</b> directory to your system's search path.</p>
</p>
</div>
@@ -170,17 +171,16 @@
</div>
<p>Here is an explanation of the contents of each directory:
<ul>
- <li><b>/bin</b> - contains scripts for executing <a href="../manual/tools/wsdl2java.html">wsdl2java</a> and <a href="../manual/tools/wsdlmerge.html">wsdlmerge</a>. There are batch scripts (<em>.bat</em> extension) for Windows machines and shell scripts (<em>.sh</em> extension, uses standard <em>/bin/sh</em>). For convenience, this would be the directory that you would add to your system's executable search path.<br/></li><br/>
+ <li><b>/bin</b> - contains scripts for executing <a href="../manual/tools/wsdl2java.html">wsdl2java</a>
+ and <a href="../manual/tools/wsdlmerge.html">wsdlmerge</a>. There are Windows batch scripts (<em>.bat</em>
+ extension) and Unix shell scripts (<em>.sh</em> extension, for <em>/bin/sh</em>).
+ <br/></li><br/>
<li><b>/docs</b> - contains the documentation you are currently reading.<br/></li><br/>
<li><b>/lib</b> - contains libraries and template project directories for code generation.
- <br/><br/>
- More specifically, all of the command line tools use
- the JARs under <b>/common</b> when they are invoked. The <a href="../manual/tools/wsdl2java.html">wsdl2java</a> tool uses the
- files in <b>/axis2</b> and <b>/eclipse-osgi</b> to create projects for Apache Axis2 (J2EE) and Eclipse Equinox (OSGi) projects.
- The Mini SOAP Engine is part of the Muse project itself.<br/></li><br/>
+ <br/><br/>
<ul>
<li><b>/axis2</b> - an expanded template WAR from the Apache Axis2 project.<br/></li><br/>
- <li><b>/common</b> - common third-party libraries, including Apache Xerces, Apache Xalan, and WSDL4J.<br/></li><br/>
+ <li><b>/common</b> - third-party libraries used on all platforms, including Apache Xerces, Apache Xalan, and WSDL4J.<br/></li><br/>
<li><b>/eclipse-osgi</b> - components from the Eclipse Equinox project, which provide the minimum OSGi environment needed to host
a Muse-based application.<br/></li><br/>
</ul>
Modified: webservices/muse/site/docs/2.2.0/tutorial/03-wsdl2java.html
URL: http://svn.apache.org/viewvc/webservices/muse/site/docs/2.2.0/tutorial/03-wsdl2java.html?view=diff&rev=509682&r1=509681&r2=509682
==============================================================================
--- webservices/muse/site/docs/2.2.0/tutorial/03-wsdl2java.html (original)
+++ webservices/muse/site/docs/2.2.0/tutorial/03-wsdl2java.html Tue Feb 20 09:47:17 2007
@@ -129,17 +129,6 @@
<p>Once the WSDL that describes your endpoint is complete, you can use the command-line <a href="../manual/tools/wsdl2java.html">wsdl2java</a> tool
to generate all of the code needed to either implement and deploy and endpoint or create a proxy to an endpoint.
</p>
-<div class="frame note">
-<div class="label">Note</div>
-<div class="content">
-The first time you run <em>wsdl2java</em>, it will download
-<a href="http://ws.apache.org/axis2/download/1_1/download.cgi" class="external">Apache Axis2 1.1.</a>
-and <a href="http://download.eclipse.org/eclipse/equinox/" class="external">Eclipse Equinox (OSGi)</a>. This download is
-almost 20 MB, so you can expect a delay of a few seconds to almost one minute depending on your connection speed.
-Once these components have been downloaded, <em>wsdl2java</em> will continue as normal and you won't have to
-download them again.
-</div>
-</div>
<p>Below are examples for generating endpoints for OSGi and Axis2 J2EE environments. For much more information, including options on customizing the deployment descriptors and creating endpoints with multiple resource-types see <a href="../manual/tools/wsdl2java.html">the wsdl2java reference</a> documentation.</p>
</div>
Modified: webservices/muse/site/docs/2.2.0/tutorial/08-test-client.html
URL: http://svn.apache.org/viewvc/webservices/muse/site/docs/2.2.0/tutorial/08-test-client.html?view=diff&rev=509682&r1=509681&r2=509682
==============================================================================
--- webservices/muse/site/docs/2.2.0/tutorial/08-test-client.html (original)
+++ webservices/muse/site/docs/2.2.0/tutorial/08-test-client.html Tue Feb 20 09:47:17 2007
@@ -109,8 +109,8 @@
<div id="content">
<div id="skinconf-txtlink"></div>
<h2>Apache Muse - Testing Your Application</h2>
- <p>When communicating with a resource, you must create a client to that resource as described <a href="03-wsdl2java.html#Section4">earlier</a>.
- After adding the generated client jar to your compilation classpath, you can create a client for the sample resource like so:
+ <p>When communicating with a resource, you can create a client for that resource, as described <a href="03-wsdl2java.html#Section4">earlier</a>.
+ After adding the generated client to your classpath, you can create a test application for the sample resource like so:
<code>
<pre>
public static void main(String[] args) {
@@ -119,62 +119,75 @@
URI producerURI = URI.create("http://...");
URI consumerURI = URI.create("http://...");
- EndpointReference epr = new EndpointReference(producerURI);
+ <a href="../javadoc/org/apache/muse/ws/addressing/EndpointReference.html">EndpointReference</a> epr = new EndpointReference(producerURI);
MyServiceProxy proxy = new MyServiceProxy(epr);
<b>// optional, but useful</b>
- proxy.setTrace(true);
+ proxy.<a href="../javadoc/org/apache/muse/core/AbstractResourceClient.html#setTrace(boolean)">setTrace</a>(true);
<b>// get the ServerName property</b>
String serverName = proxy.getServerName();
<b>// invoke the WSN Subscribe operation</b>
- EndpointReference consumer = new EndpointReference(consumerURI);
- proxy.subscribe(consumer, null, null);
+ <a href="../javadoc/org/apache/muse/ws/addressing/EndpointReference.html">EndpointReference</a> consumer = new EndpointReference(consumerURI);
+ proxy.<a href="../javadoc/org/apache/muse/ws/notification/remote/NotificationProducerClient.html#subscribe(org.apache.muse.ws.addressing.EndpointReference,%20org.apache.muse.ws.notification.Filter,%20java.util.Date)">subscribe</a>(consumer, null, null);
- } catch (Exception e) {
- e.printStackTrace();
+ }
+
+ catch (<a href="../javadoc/org/apache/muse/ws/addressing/soap/SoapFault.html">SoapFault</a> fault) {
+ fault.printStackTrace();
}
}
</pre>
</code>
- In the above code you should replace "http://..." with the URI to your deployed resource. For resources created using
- the <em>wsdl2java</em> tooling, a default resource is created when the endpoint is deployed. The URI to this resource is as follows.
+ In the above code you should replace <b>"http://..."</b> literals with the URI for your resource types. For resources created using
+ the <em>wsdl2java</em> tooling, a default resource instance is created when the endpoint is deployed. The URIs are defined as follows:
</p>
<p>
- For J2EE applications (Axis2 or Mini):
+ For J2EE applications:
<blockquote>
<ul>
- <li>Hostname: <code>http://localhost:PORT</code> where PORT is replaced with your J2EE container port.</li>
- <li>WAR path: this is the name of the WAR file that you deployed.</li>
- <li>Resource path: <code>services/NAME</code> where NAME is the name of the generated service. This is the value specified
- in muse.xml's <context-path/> element.</li>
+ <li>Host: <code>http://<b>host</b>:<b>port</b></code> where <b>host</b> is your IP address, host name, or
+ <i>localhost</i>, and <b>port</b> is your J2EE container's port number.</li>
+ <li>J2EE context path: The context path for the WAR (this is usually the name of the .war file).</li>
+ <li>Resource context path: <code>services/<b>name</b></code> where <b>name</b> is the name of the
+ generated service. This value is also specified in muse.xml's <context-path/> element.</li>
</ul>
</blockquote>
- For example, if the PORT is 8080, the name of the WAR file is myWar.war and the name of the service is MyService. The URI would be:
+ For example, if the port number is 8080, the name of the WAR file is my-resources.war, and the name of
+ the service is MyResource, then a valid URI would be:
<blockquote>
- <code>http://localhost:8080/myWar/services/MyService</code>
+ <code>http://localhost:8080/my-resources/services/MyResource</code>
</blockquote>
</p>
<p>
- For OSGi:
+ For OSGi applications:
<blockquote>
<ul>
- <li>Hostname: <code>http://localhost:PORT</code> where PORT is replaced with your OSGi HTTP service port.</li>
- <li>Bundle path: this is the name of the bundle.</li>
- <li>Resource path: <code>NAME</code> where NAME is the name of the generated service. This is the value specified
- in muse.xml's <context-path/> element.</li>
+ <li>Host: <code>http://<b>host</b>:<b>port</b></code> where <b>host</b> is your IP address, host name, or
+ <li>Bundle context path: this is the name of the OSGi bundle.</li>
+ <li>Resource context path: <code>services/<b>name</b></code> where <b>name</b> is the name of the
+ generated service. This value is also specified in muse.xml's <context-path/> element.</li>
</ul>
</blockquote>
- For example, if the PORT is 80, the name of the WAR file is myBundle and the name of the service is MyService. The URI would be:
+ For example, if the port number is 80, the name of the bundle file is my-resources.jar, and the name of the
+ service is MyResource, then a valid URI would be:
<blockquote>
- <code>http://localhost:80/myBundle/MyService</code>
+ <code>http://localhost:80/my-resources/MyResource</code>
</blockquote>
</p>
- <p>Finally, the <em>setTrace()</em> call will print all of the outgoing and incoming messages to standard output. This is extremely useful
- when developing your endpoints. This operation is available on all generated clients, but the other methods will be specific to your
- endpoint.</p>
+
+ <p>The <a href="../javadoc/org/apache/muse/core/AbstractResourceClient.html#setTrace(boolean)">setTrace()</a>
+ call that is shown above will cause the client to print all of the outgoing
+ and incoming messages to standard output. This is extremely useful when
+ developing your endpoints.</p>
+
+ <p>Finally, the <a href="../javadoc/org/apache/muse/ws/addressing/EndpointReference.html#addParameter(javax.xml.namespace.QName,%20java.lang.Object)">EndpointReference.addParameter()</a>
+ method can be used in
+ the code above to target resources whose EPRs that have one or more WS-A
+ reference parameters.
+ </p>
<p>
<br/>
<a href="07-deploy-application-axis2.html"><strong><</strong> Back (Axis2)</a>
---------------------------------------------------------------------
To unsubscribe, e-mail: muse-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: muse-commits-help@ws.apache.org