You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ch...@apache.org on 2007/07/03 08:36:00 UTC

svn commit: r552690 - in /webservices/axis2/trunk/java/xdocs/@axis2_version_dir@: installationguide.html quickstartguide.html

Author: chatra
Date: Mon Jul  2 23:35:59 2007
New Revision: 552690

URL: http://svn.apache.org/viewvc?view=rev&rev=552690
Log:
added information on the setenv.sh file in the bin dir. Resolved JIRA issuehttps://issues.apache.org/jira/browse/AXIS2-1886

Modified:
    webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/installationguide.html
    webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/quickstartguide.html

Modified: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/installationguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/installationguide.html?view=diff&rev=552690&r1=552689&r2=552690
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/installationguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/installationguide.html Mon Jul  2 23:35:59 2007
@@ -1,21 +1,21 @@
 <!--
-  ~ Licensed to the Apache Software Foundation (ASF) under one
-  ~ or more contributor license agreements. See the NOTICE file
-  ~ distributed with this work for additional information
-  ~ regarding copyright ownership. The ASF licenses this file
-  ~ to you under the Apache License, Version 2.0 (the
-  ~ "License"); you may not use this file except in compliance
-  ~ with the License. You may obtain a copy of the License at
-  ~
-  ~ http://www.apache.org/licenses/LICENSE-2.0
-  ~
-  ~ Unless required by applicable law or agreed to in writing,
-  ~ software distributed under the License is distributed on an
-  ~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-  ~ KIND, either express or implied. See the License for the
-  ~ specific language governing permissions and limitations
-  ~ under the License.
-  -->
+~ Licensed to the Apache Software Foundation (ASF) under one
+~ or more contributor license agreements. See the NOTICE file
+~ distributed with this work for additional information
+~ regarding copyright ownership. The ASF licenses this file
+~ to you under the Apache License, Version 2.0 (the
+~ "License"); you may not use this file except in compliance
+~ with the License. You may obtain a copy of the License at
+~
+~ http://www.apache.org/licenses/LICENSE-2.0
+~
+~ Unless required by applicable law or agreed to in writing,
+~ software distributed under the License is distributed on an
+~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~ KIND, either express or implied. See the License for the
+~ specific language governing permissions and limitations
+~ under the License.
+-->
 <html>
 <head>
   <meta http-equiv="content-type" content="">
@@ -41,14 +41,14 @@
 <ul>
   <li><a href="#Download_Axis2">Axis2 Distributions</a></li>
   <li><a href="#requirements">System Requirements</a></li>
-  <li><a href="#standalone">Installing Axis2 as a Standalone Server using
-    the Standard Binary Distribution</a>
+  <li><a href="#standalone">Installing Axis2 as a Standalone Server using the
+    Standard Binary Distribution</a>
     <ul>
       <li><a href="#standalone1">Installing the Apache Axis2 Binary
         Distribution</a></li>
       <li><a href="#standalone2">Starting up Axis2 Standalone Server</a></li>
-      <li><a href="#standalone3">Building the Axis2 WAR File Using the Standard Binary
-        Distribution</a></li>
+      <li><a href="#standalone3">Building the Axis2 WAR File Using the
+        Standard Binary Distribution</a></li>
       <li><a href="#standalone4">Getting Familiar with Convenient Axis2
         Scripts</a></li>
     </ul>
@@ -81,7 +81,8 @@
 
 <p><a
 href="http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi">Download</a>
-distribution packages of the Apache Axis2 @axis2_version@ version (latest).</p>
+distribution packages of the Apache Axis2 @axis2_version@ version
+(latest).</p>
 
 <p></p>
 
@@ -210,11 +211,13 @@
 the JDK release.</p>
 
 <p>Download and unpack the <a
-href="http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi">Axis2 Standard
-Binary Distribution</a> into a convenient location so that the distribution
-resides in its own directory. Set an environment variable AXIS2_HOME to the
-pathname of the extracted directory of Axis2 (Eg: /opt/axis2-@axis2_version@).</p>
-<a name="standalone2"></a>
+href="http://ws.apache.org/axis2/download/@axis2_version_dir@/download.cgi">Axis2
+Standard Binary Distribution</a> into a convenient location so that the
+distribution resides in its own directory. Set an environment variable
+AXIS2_HOME to the pathname of the extracted directory of Axis2 (Eg:
+/opt/axis2-@axis2_version@). Linux users can alternatively run the setenv.sh
+file available in the AXIS2_HOME/bin directory to set the AXIS2_HOME
+environment variable to the Axis2 classpath.</p>
 
 <h3>2. Starting up Axis2 Standalone Server</h3>
 
@@ -268,6 +271,7 @@
         location(AXIS2_HOME/conf/axis2.xml) for you. With this you can be
         relieved from setting all the above Axis2 specific parameters.<br>
 
+
         <p><em>Usage : axis2.{sh.bat}  [-options] class [args...]</em></p>
       </td>
     </tr>
@@ -291,8 +295,8 @@
       <td>wsdl2java.{bat|sh}</td>
       <td>This script generates Java code according to a given WSDL file to
         handle Web service invocations (client-side stubs). This script also
-        has the ability to generate web service skeletons according to the given
-        WSDL.<br>
+        has the ability to generate web service skeletons according to the
+        given WSDL.<br>
 
 
         <p><em>Usage:  wsdl2java.{sh|bat} [OPTION]... -uri &lt;Location of
@@ -350,8 +354,8 @@
     If the validation fails then the WAR has failed to install properly or
     some essential jars are missing. In such a situation, refer to the
     documentation of the particular servlet container to find the problem.
-    The following page shows a successful validation. Note the statement
-    that indicates the core Axis2 libraries are present.</li>
+    The following page shows a successful validation. Note the statement that
+    indicates the core Axis2 libraries are present.</li>
 </ol>
 
 <p align="center"><img src="images/happyaxis.jpg"></p>
@@ -364,9 +368,10 @@
 <h2>Uploading Services</h2>
 <ol>
   <p>The Axis2 Web application also provides an interface to upload services.
-  Once a service archive file is created according to the service specification as
-  described in the <a name="adv-userguide.html" target="_blank">Advanced
-  User's Guide</a>, that .aar file can be uploaded using the upload page.</p>
+  Once a service archive file is created according to the service
+  specification as described in the <a name="adv-userguide.html"
+  target="_blank">Advanced User's Guide</a>, that .aar file can be uploaded
+  using the upload page.</p>
 
   <p align="center"><strong><img src="images/clip_image010.jpg"
   alt=""></strong></p>

Modified: webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/quickstartguide.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/%40axis2_version_dir%40/quickstartguide.html?view=diff&rev=552690&r1=552689&r2=552690
==============================================================================
--- webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/quickstartguide.html (original)
+++ webservices/axis2/trunk/java/xdocs/@axis2_version_dir@/quickstartguide.html Mon Jul  2 23:35:59 2007
@@ -115,13 +115,18 @@
 housekeeping. First off, you'll need to get your environment ready for
 working with Axis2. Fortunately, it involves just a few simple steps:</p>
 <ol>
-  <li>Download and install Java. (Minimum version is JDK1.4)</li>
+  <li>Download and install Java (Minimum version is JDK1.4). Set the
+    JAVA_HOME environment variable to the pathname of the directory into
+    which you installed the JDK release.</li>
   <li>Download Axis2 and extract it to a target directory.</li>
   <li>Copy the axis2.war file to the webapps directory of your servlet
   engine.</li>
   <li>Set the AXIS2_HOME environment variable to point to the target
     directory in step. Note that all of the scripts and build files Axis2
-    generates depend on this value, so don't skip this step!</li>
+    generates depend on this value, so don't skip this step! Linux users can
+    alternatively run the setenv.sh file in the AXIS2_HOME/bin directory to
+    set the AXIS2_HOME environment variable to the pathname of the extracted
+    directory of Axis2.</li>
 </ol>
 
 <p>In most cases, we're also going to need a WSDL file for our service.
@@ -196,16 +201,16 @@
          - pojo
            - StockQuoteService.class</pre>
 
-<p>Here, the name of the service is StockQuoteService, which 
-is specified in the services.xml file and corresponds to the top-level
-folder of this service. Compiled Java classes are placed underneath
-this in their proper place based on the package name. The lib directory
-holds any service-specific JAR files needed for the service to run (none in 
-this case) besides those already stored with the Axis2 WAR file and the
-servlet container's common JAR directories.  Finally, the META-INF directory
-contains any additional information about the service that Axis2 needs
-to execute it properly. The services.xml file defines the service itself and
-links the Java class to it (See Code Listing 3).</p>
+<p>Here, the name of the service is StockQuoteService, which is specified in
+the services.xml file and corresponds to the top-level folder of this
+service. Compiled Java classes are placed underneath this in their proper
+place based on the package name. The lib directory holds any service-specific
+JAR files needed for the service to run (none in this case) besides those
+already stored with the Axis2 WAR file and the servlet container's common JAR
+directories. Finally, the META-INF directory contains any additional
+information about the service that Axis2 needs to execute it properly. The
+services.xml file defines the service itself and links the Java class to it
+(See Code Listing 3).</p>
 
 <p><b>Code Listing 3: The Service Definition File</b></p>
 <pre>&lt;service name="StockQuoteService" scope="application"&gt;
@@ -232,16 +237,18 @@
 intend to include for this application.</p>
 
 <p>You can deploy a service by simply taking this hierarchy of files and
-copying it to the webapps/axis2/WEB-INF/services directory of your servlet engine. 
-(Note the Axis2 WAR file must be installed first in the servlet engine.)
-This is known as the "exploded" format. You can also compress your documents into an *.aar
-file, similar to a *.jar file, and place the *.aar file directly in the
-servlet engine's webapps/axis2/WEB-INF/services directory.</p>
+copying it to the webapps/axis2/WEB-INF/services directory of your servlet
+engine. (Note the Axis2 WAR file must be installed first in the servlet
+engine.) This is known as the "exploded" format. You can also compress your
+documents into an *.aar file, similar to a *.jar file, and place the *.aar
+file directly in the servlet engine's webapps/axis2/WEB-INF/services
+directory.</p>
 
 <p>Now that you understand what we're trying to accomplish, we're almost
 ready to start building.</p>
 
-<p>First, <a href="../download/@axis2_version_dir@/download.html#std-bin">download</a> and
+<p>First, <a
+href="../download/@axis2_version_dir@/download.html#std-bin">download</a> and
 unzip the appropriate version of Axis2 Standard Binary Distribution. Make
 sure that you set the value of the AXIS2_HOME variable to match the location
 into which you extracted the contents of this release.</p>
@@ -424,10 +431,11 @@
 that is based on the StAX API (Streaming API for XML). Methods that act as
 services must take as their argument an OMElement, which represents an XML
 element that happens, in this case, to be the payload of the incoming SOAP
-message. Method getPrice(OMElement), for example, extracts the contents of the first child of the
-payload element, which corresponds to the stock symbol, and uses this to look up
-the current price of the stock. Unless this is an "in only" service, these methods must return an
-OMElement, because that becomes the payload of the return SOAP message.</p>
+message. Method getPrice(OMElement), for example, extracts the contents of
+the first child of the payload element, which corresponds to the stock
+symbol, and uses this to look up the current price of the stock. Unless this
+is an "in only" service, these methods must return an OMElement, because that
+becomes the payload of the return SOAP message.</p>
 
 <p>Now build the project by typing ant generate.service in the
 Axis2_HOME/samples/quickstartaxiom directory.</p>
@@ -891,11 +899,9 @@
 Axis2_HOME/samples/quickstartadb directory.</p>
 
 <p>You should get the following as output:</p>
-<pre>
-42
+<pre>42
 price updated
-42.35
-</pre>
+42.35</pre>
 <a name="clientxmlbeans"></a>
 
 <h3>Generating a Client using XMLBeans</h3>
@@ -988,11 +994,9 @@
 Axis2_HOME/samples/quickstartxmlbeans directory.</p>
 
 <p>You should get the following as output:</p>
-<pre>
-42
+<pre>42
 price updated
-42.32
-</pre>
+42.32</pre>
 <a name="clientjibx"></a>
 
 <h3>Generating a Client using JiBX</h3>
@@ -1063,11 +1067,9 @@
 the Axis2_HOME/samples/quickstartjibx directory.</p>
 
 <p>You should get the following as output:</p>
-<pre>
-42
+<pre>42
 price updated
-42.35
-</pre>
+42.35</pre>
 
 <p>For more information on using JiBX with Axis2, see the <a
 href="jibx/jibx-codegen-integration.html">JiBX code generation
@@ -1076,11 +1078,11 @@
 
 <h2>Summary</h2>
 
-<p>Axis2 provides a slick and robust way to get web services up and running in no
-time. This guide presented five methods of creating a service deployable on
-Axis2, and four methods of creating a client to communicate with the
-services. You now have the flexibility to create Web services using a variety
-of different technologies.</p>
+<p>Axis2 provides a slick and robust way to get web services up and running
+in no time. This guide presented five methods of creating a service
+deployable on Axis2, and four methods of creating a client to communicate
+with the services. You now have the flexibility to create Web services using
+a variety of different technologies.</p>
 <a name="furtherstudy"></a>
 
 <h2>For Further Study</h2>



---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org