Changeset 3941

Timestamp:

23/05/08 12:18:48 (13 years ago)

Author:

cbyrom

Message:

Update the readme doc to include new instructions for setting things up.

File:

• TI01-discovery/trunk/ws-Discovery2/readme.txt (modified) (2 diffs)

TI01-discovery/trunk/ws-Discovery2/readme.txt

@@ -2 +2 @@
 ------------
 
-Server Side:
-Instructions for building & deploying Axis2 web service archive (DiscoveryService.aar)
+NB, completing the build here assumes you have both apache axis2 and ant installed.  The AXIS2_HOME environment variable
+should be set to point to the top level directory of the axis2 install.
 
-1. Run WSDL2Java to generate skeleton code and XMLBeans for data binding
-(In srcgen directory)
-%AXIS2_HOME%\bin\wsdl2java -ss -sd -d xmlbeans -uri ..\wsdl\Discovery.wsdl -o . -p ndg.services.discovery
+The build file, \srcgen\buildDiscovery.xml, now includes targets to run the WSDL2Java code generation.  Running the build
+with no parameters, e.g.:
 
-2. Build server side code (DiscoveryService.aar)
-(In srcgen directory)
-ant -buildfile buildDiscovery.xml jar.server
-(output in build/lib)
+ant -f buildClient.xml
 
-3. Optionally build javadoc documentation
-ant -buildfile buildDiscovery.xml javadoc
+will now build both the server and client archives and make the necessary changes to the files outlined below.  NB, to get
+the DiscoveryService.wsdl file to be generated properly, you will likely have to temporarily rename the jsr file, as mentioned
+below.
 
-4. Deploy the service
- - Copy DiscoveryService.aar to <tomcat>/webapps/axis/WEB-INF/services
- - Reload axis2 context within tomcat manager app, or restart tomcat
-
+Original, detailed instructions, are as follows (but you shouldn't have to use them!):
 
 Client Side:
-Instructions for building client (DiscoveryService.aar)
+---------------
+Instructions for building client (DiscoveryService-test-client.jar)
 
 Do all the following in directory "srcgen"
@@ -41 +36 @@
 ant -buildfile buildClient.xml run.client
 
-Code to edit for testing is in ..\src\ndg\services\discovery\MyDiscoveryServiceClient.java
+Server Side:
+---------------
+Instructions for building & deploying Axis2 web service archive (DiscoveryService.aar)
+
+1. Run WSDL2Java to generate skeleton code and XMLBeans for data binding
+(In srcgen directory)
+%AXIS2_HOME%\bin\wsdl2java -ss -sd -d xmlbeans -uri ..\wsdl\Discovery.wsdl -o . -p ndg.services.discovery
+
+NB, when running this command, you may get an error along the lines of:
+
+Exception in thread "main" java.lang.NoSuchMethodError: javax.xml.stream.XMLOutputFactory.newInstance(Ljava/lang/String;Ljava/lang/ClassLoader;)Ljavax/xml/stream/XMLOutputFactory;
+        at org.apache.axiom.om.util.StAXUtils.getXMLOutputFactory(StAXUtils.java:97)
+
+- this occurs due to a mismatch in libraries between the versions of java and axis being used.  A
+quick fix can be to temporarily hide jre/lib/ext/jsr173_1.0_api.jar.  NB, without this change, the
+generated DiscoveryService.wsdl file is likely to be empty.
+
+2. Build server side code (DiscoveryService.aar)
+(In srcgen directory)
+ant -buildfile buildDiscovery.xml jar.server
+(output in build/lib)
+
+3. Optionally build javadoc documentation
+ant -buildfile buildDiscovery.xml javadoc
+
+4. Deploy the service
+ - Copy DiscoveryService.aar to <tomcat>/webapps/axis/WEB-INF/services (NB, for this step you need to have axis2
+ installed in your tomcat server - just drop an axis2.war file into the webapps directory when the server is running)
+ - Reload axis2 context within tomcat manager app, or restart tomcat
+
+
+
+Code to edit for testing is in ..\src\ndg\services\discovery\DiscoveryServiceClient.java
 
 Tested with Sun Java SDK 1.5.08 (problems with 1.6.03)