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 2006/11/01 09:26:54 UTC
svn commit: r469816 - in
/webservices/axis2/branches/java/1_1/modules/samples: mtom/README.txt
pojo/README.txt servicelifecycle/README.txt soapwithattachments/README.txt
yahoorestsearch/README.txt
Author: chinthaka
Date: Wed Nov 1 00:26:54 2006
New Revision: 469816
URL: http://svn.apache.org/viewvc?view=rev&rev=469816
Log:
Improving the README file and making sure the line length is 100.
Modified:
webservices/axis2/branches/java/1_1/modules/samples/mtom/README.txt
webservices/axis2/branches/java/1_1/modules/samples/pojo/README.txt
webservices/axis2/branches/java/1_1/modules/samples/servicelifecycle/README.txt
webservices/axis2/branches/java/1_1/modules/samples/soapwithattachments/README.txt
webservices/axis2/branches/java/1_1/modules/samples/yahoorestsearch/README.txt
Modified: webservices/axis2/branches/java/1_1/modules/samples/mtom/README.txt
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/modules/samples/mtom/README.txt?view=diff&rev=469816&r1=469815&r2=469816
==============================================================================
--- webservices/axis2/branches/java/1_1/modules/samples/mtom/README.txt (original)
+++ webservices/axis2/branches/java/1_1/modules/samples/mtom/README.txt Wed Nov 1 00:26:54 2006
@@ -4,21 +4,19 @@
Overview:
---------
-This sample demonstrates the capabilities and power of MTOM support of
-AXIS2. In this sample the user can send a file to the service.
+This sample demonstrates the capabilities and power of MTOM support of AXIS2. In this sample the
+user can send a file to the service.
Running the Sample:
-------------------
-1. Please make sure to set the AXIS2_HOME environment variable to point to the
-AXIS2_DIST.
-1. Use ant generate.service or just ant command in the AXIS2_DIST/sample/mtom/ to build the service.
-2. Generated service gets copied to the AXIS2_DIST/repository/services automatically.
-Run the AXIS2_DIST/bin/axis2server.{sh.bat} to start the standalone axis2 server.
-(Alternatively you can drop the sample to the services directory of a Axis2 server
-running in a servlet container)
-4. Use ant run.client -Dfile "file to be send" -Ddest "destination file name" > to
-build and run the client.
+1. Please make sure to set the AXIS2_HOME environment variable to point to the AXIS2_DIST.
+2. Use ant generate.service or just ant command in the AXIS2_DIST/sample/mtom/ to build the service.
+3. Generated service gets copied to the AXIS2_DIST/repository/services automatically.
-Please contact axis-user list (axis-user@ws.apache.org) if you have any trouble
-running the sample.
+ Run the AXIS2_DIST/bin/axis2server.{sh.bat} to start the standalone axis2 server. (Alternatively
+ you can drop the sample to the services directory of a Axis2 server running in a servlet container)
+4. Use ant run.client -Dfile "file to be send" -Ddest "destination file name" > to build and run the
+ client.
+
+Please contact axis-user list (axis-user@ws.apache.org) if you have any trouble running the sample.
Modified: webservices/axis2/branches/java/1_1/modules/samples/pojo/README.txt
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/modules/samples/pojo/README.txt?view=diff&rev=469816&r1=469815&r2=469816
==============================================================================
--- webservices/axis2/branches/java/1_1/modules/samples/pojo/README.txt (original)
+++ webservices/axis2/branches/java/1_1/modules/samples/pojo/README.txt Wed Nov 1 00:26:54 2006
@@ -1,5 +1,6 @@
-This is an example POJO web service. It shows how to expose the methods of a Java class as a web service using Aixs2.
+This is an example POJO web service. It shows how to expose the methods of a Java class as a web
+service using Aixs2.
To build the sample service you must have ant-1.6.x installed in your system.
@@ -9,21 +10,25 @@
To build the sample service, type:
$ant
-This will build the AddressBookService.aar in the build directory and copy it to the <AXIS2_HOME>/repository/services directory.
+This will build the AddressBookService.aar in the build directory and copy it to the
+<AXIS2_HOME>/repository/services directory.
-You can start the Axis2 server by running either axis2server.bat (on Windows) or axis2server.sh (on Linux)that are located in <AXIS2_HOME>/bin directory.
+You can start the Axis2 server by running either axis2server.bat (on Windows) or axis2server.sh
+(on Linux)that are located in <AXIS2_HOME>/bin directory.
The WSDL for this service should be viewable at:
http://<yourhost>:<yourport>/axis2/services/AddressBookService?wsdl
(e.g. http://localhost:8080/axis2/services/AddressBookService?wsdl)
-src/sample/addressbook/rpcclient/AddressBookRPCClient.java is a Client that uses RPCServiceClient to invoke the methods of this web services just like the method invocations of a Java object.
+src/sample/addressbook/rpcclient/AddressBookRPCClient.java is a Client that uses RPCServiceClient
+to invoke the methods of this web services just like the method invocations of a Java object.
To compile and run, type
$ant rpc.client
-src/sample/addressbook/adbclient/AddressBookADBClient is Client that uses a generated stub with ADB to invoke the methods of this web service.
+src/sample/addressbook/adbclient/AddressBookADBClient is Client that uses a generated stub with ADB
+to invoke the methods of this web service.
To generate the stub, compile and run, type
$ant adb.client -Dwsdl=http://<yourhost>:<yourport>/axis2/services/AdressBookService?wsdl
Modified: webservices/axis2/branches/java/1_1/modules/samples/servicelifecycle/README.txt
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/modules/samples/servicelifecycle/README.txt?view=diff&rev=469816&r1=469815&r2=469816
==============================================================================
--- webservices/axis2/branches/java/1_1/modules/samples/servicelifecycle/README.txt (original)
+++ webservices/axis2/branches/java/1_1/modules/samples/servicelifecycle/README.txt Wed Nov 1 00:26:54 2006
@@ -1,8 +1,9 @@
-The service life cycle sample is to demonstrate usage of service life cycle interface and session related stuff (only demonstrate application scope session services.). The sample consists of two parts;
-Service and
-Client
+The service life cycle sample is to demonstrate usage of service life cycle interface and session
+scoping with a sample on application scope session. The sample consists of two parts;
+ Service and Client
-To show usage of service life cycle and session, have chosen a simple library system. Which has few basic operation like
+To show usage of service life cycle and session, have chosen a simple library system. Which has few
+basic operation like
- register user
- login to system
- view all books
@@ -13,48 +14,64 @@
Why do we need service life cycle class here ?
================================================
-Well, at the deployment time we need to initialize the service , reading stuff from somewhere (??) , so at the runtime service impl class access those data. Forget about the session for a minute , think about the scenario where you want to populate a bean or need to start a DB connection for the service , in such situation having service life cycle class is very useful.
+Well, at the deployment time we need to initialize the service , reading stuff from somewhere (??) ,
+so at the runtime service impl class access those data. Forget about the session for a minute ,
+think about the scenario where you want to populate a bean or need to start a DB connection for the
+service , in such situation having service life cycle class is very useful.
-In this sample you fill learn how to use the service life cycle class for your application. The interface has only two methods
+In this sample you fill learn how to use the service life cycle class for your application. The
+interface has only two methods
-startUp
-shutDown
-Where startUp method will be called when the service is deployed and it will call only once for that particular service , while shutDown method calls when system shutdown.
+Where startUp method will be called when the service is deployed and it will call only once for that
+ particular service , while shutDown method calls when system shutdown.
-So in this sample , the life cycle class will load up the library in side the startUp method. At the very first time the system will load up from services.xml , it has all the available books in the system. And at the time of system shutdown will save the status of the library into a file (library.xml) in the java.io.temp directory. So the next time on wards it will populate library using the above file. So all the changes will be there in the new instance as well.
+So in this sample , the life cycle class will load up the library in side the startUp method. At the
+ very first time the system will load up from services.xml , it has all the available books in the
+ system. And at the time of system shutdown will save the status of the library into a file
+ (library.xml) in the java.io.temp directory. So the next time on wards it will populate library
+ using the above file. So all the changes will be there in the new instance as well.
How to build the service ?
=================================================
-Building the service is just a matter of running ant build file. It will create you the service aar file , or you could just run the copy.to.tomcat goal , it will cope the aar file into tomcat/web-app/axis2/WEB-INF/services directory.
-
-Next , go to http://[url and port to your app server]/axis2 and see whether your service is listed there.
+Building the service is just a matter of running ant build file. It will create you the service aar
+file , or you could just run the copy.to.tomcat goal , it will cope the aar file into
+tomcat/web-app/axis2/WEB-INF/services directory.
+Next , go to http://[url and port to your app server]/axis2 and see whether your service is listed
+there.
Running the client.
=================================================
-WOW , you can invoke complete service using REST API . First try to use library system using REST API.
+WOW , you can invoke complete service using REST API . First try to use library system using REST
+API.
This sample is simple one and will not do complex tasks , so lets try to follow the right way .
-Step 1:- View all the available books in the library , just type the following URL in your favorite browser.
-http://127.0.0.1:8080/axis2/rest/Library/listAvailableBook
+Step 1:- View all the available books in the library , just type the following URL in your favorite
+browser.
+ http://127.0.0.1:8080/axis2/rest/Library/listAvailableBook
You will see all the available books in the system
Step 2 : View all the books in the system
http://127.0.0.1:8080/axis2/rest/Library/listAllBook
-In this case you will get exacatly the same result for both the request , since no one has borrowed the book.
+In this case you will get exacatly the same result for both the request , since no one has borrowed
+the book.
Step 3: Now look at the all the lend books in the system . And you will see empty list;
http://127.0.0.1:8080/axis2/rest/Library/listLendBook
Step 4 : Register a user
-To lend a book or return a book , you need to register first. And do not register twice , if you tries do so you will get an exception.
+To lend a book or return a book , you need to register first. And do not register twice , if you
+tries do so you will get an exception.
-To register you need to give user name and password (have a look at the wsdl , you will see what you need to pass in)
+To register you need to give user name and password (have a look at the wsdl , you will see what you
+ need to pass in)
-So let's create a user called foo with the password 123
+So let's create a user called �foo� with the password �123�
http://127.0.0.1:8080/axis2/rest/Library/register?userName=foo&passWord=123
Then you will get the following response , if everything is gone well.
@@ -62,10 +79,13 @@
<ns:return>true</ns:return>
</ns:registerResponse>
-Step 5 : Login to system , to login you need to pass user name and password. So let's try to login to system.
+Step 5 : Login to system , to login you need to pass user name and password. So let's try to login
+to system.
http://127.0.0.1:8080/axis2/rest/Library/login?userName=foo&passWord=123
-Step 6 : Now we are ready to lend a book , so let's do that. To lend a book you need to pass isbn and userName. So lets try to lend the book with isbn 0-937175-77-3, your request would look like below;
+Step 6 : Now we are ready to lend a book , so let's do that. To lend a book you need to pass isbn
+and userName. So lets try to lend the book with isbn �0-937175-77-3�, your request would look like
+below;
http://127.0.0.1:8080/axis2/rest/Library/lendBook?isbn=0-937175-77-3&userName=foo
@@ -99,9 +119,11 @@
Step 8 : Now let's look at the lend book list again , and you will realize that list is empty.
-Step 9 : Lend few more book and re-start the app server (say tomcat) and see whether all the data are there in the new instance.
+Step 9 : Lend few more book and re-start the app server (say tomcat) and see whether all the data
+are there in the new instance.
Running Java client.
==================================================
-Open up the LibraryServiceClient java class in your favorite IDE and run the main class. And you can comment and un-comment what ever the method you want to invoke.
+Open up the LibraryServiceClient java class in your favorite IDE and run the main class. And you can
+ comment and un-comment what ever the method you want to invoke.
Modified: webservices/axis2/branches/java/1_1/modules/samples/soapwithattachments/README.txt
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/modules/samples/soapwithattachments/README.txt?view=diff&rev=469816&r1=469815&r2=469816
==============================================================================
--- webservices/axis2/branches/java/1_1/modules/samples/soapwithattachments/README.txt (original)
+++ webservices/axis2/branches/java/1_1/modules/samples/soapwithattachments/README.txt Wed Nov 1 00:26:54 2006
@@ -4,22 +4,20 @@
Overview:
---------
-This sample demonstrates the capabilities and power of Soap with Attachment
-support and the Attachmet API of AXIS2. In this sample the user can upload a
-file to the service. The service is written and deployed as a simple POJO and
-it uses the Attachment API to retrieve the received attachment. Client is written
-using Operation Client API of Axis2.
+This sample demonstrates the capabilities and power of Soap with Attachment support and the
+Attachment API of AXIS2. In this sample the user can upload a file to the service. The service is
+written and deployed as a simple POJO and it uses the Attachment API to retrieve the received
+attachment. Client is written using Operation Client API of Axis2.
Running the Sample:
-------------------
1. Use ant generate.service or ant command in the AXIS2_DIST/sample/mtom/ to build the service.
2. Generated service gets copied to the AXIS2_DIST/repository/services automatically.
-Run the AXIS2_DIST/bin/axis2server.{sh.bat} to start the standalone axis2 server.
-(Alternatively you can drop the sample to the services directory of a Axis2 server
+Run the AXIS2_DIST/bin/axis2server.{sh.bat} to start the standalone axis2 server. (Alternatively you
+ can drop the sample to the services directory of a Axis2 server
running in a servlet container)
-4. Use ant run.client -Dfile "file to be send" -Ddest "destination file name" > to
+4. Use ant run.client -Dfile "file to be send" -Ddest "destination file name" > to
build and run the client.
-Please contact axis-user list (axis-user@ws.apache.org) if you have any trouble
-running the sample.
+Please contact axis-user list (axis-user@ws.apache.org) if you have any trouble running the sample.
Modified: webservices/axis2/branches/java/1_1/modules/samples/yahoorestsearch/README.txt
URL: http://svn.apache.org/viewvc/webservices/axis2/branches/java/1_1/modules/samples/yahoorestsearch/README.txt?view=diff&rev=469816&r1=469815&r2=469816
==============================================================================
--- webservices/axis2/branches/java/1_1/modules/samples/yahoorestsearch/README.txt (original)
+++ webservices/axis2/branches/java/1_1/modules/samples/yahoorestsearch/README.txt Wed Nov 1 00:26:54 2006
@@ -7,8 +7,8 @@
Axis2 client API has facilities to invoke REST interfaces. The API to be used is almost the same
as the one we use while invoking with REST.
-Yahoo provides a REST API to call its search service. This sample demonstrates how to call Yahoo search
-service using Axis2 client.
+Yahoo provides a REST API to call its search service. This sample demonstrates how to call Yahoo
+search service using Axis2 client.
Pre-Requisites
==============
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org