Return-Path: Delivered-To: apmail-ws-axis-dev-archive@www.apache.org Received: (qmail 26315 invoked from network); 20 Dec 2006 07:41:42 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 20 Dec 2006 07:41:42 -0000 Received: (qmail 68415 invoked by uid 500); 20 Dec 2006 07:41:49 -0000 Delivered-To: apmail-ws-axis-dev-archive@ws.apache.org Received: (qmail 68299 invoked by uid 500); 20 Dec 2006 07:41:49 -0000 Mailing-List: contact axis-cvs-help@ws.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: List-Id: Delivered-To: mailing list axis-cvs@ws.apache.org Received: (qmail 68288 invoked by uid 500); 20 Dec 2006 07:41:49 -0000 Delivered-To: apmail-ws-axis2-cvs@ws.apache.org Received: (qmail 68285 invoked by uid 99); 20 Dec 2006 07:41:49 -0000 Received: from herse.apache.org (HELO herse.apache.org) (140.211.11.133) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Dec 2006 23:41:49 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 19 Dec 2006 23:41:39 -0800 Received: by eris.apache.org (Postfix, from userid 65534) id 8101E1A981D; Tue, 19 Dec 2006 23:40:50 -0800 (PST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r488944 [2/2] - /webservices/axis2/trunk/java/xdocs/1_1/ Date: Wed, 20 Dec 2006 07:40:49 -0000 To: axis2-cvs@ws.apache.org From: chatra@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20061220074050.8101E1A981D@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Modified: webservices/axis2/trunk/java/xdocs/1_1/userguide-installingtesting.html URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/1_1/userguide-installingtesting.html?view=diff&rev=488944&r1=488943&r2=488944 ============================================================================== --- webservices/axis2/trunk/java/xdocs/1_1/userguide-installingtesting.html (original) +++ webservices/axis2/trunk/java/xdocs/1_1/userguide-installingtesting.html Tue Dec 19 23:40:48 2006 @@ -1,129 +1,129 @@ - - - - Apache Axis2 User's Guide-Installing and Testing Client Code - - - - - - -

Apache Axis2 User's Guide - Installing and Testing Client Code

- -

The best way to make sure that your system is running Axis2 is to install -and test both a service and a client. The process involves the following -steps:

- -

Content

- -

The Short Story:

Install Axis2 into a suitable container such as Apache Tomcat by - copying the axis2.war file to the webapps directory.
Install the service into the Axis2 application by copying the *.aar - file into the Axis2 services directory.
Install the client on the system on which you want to run it and make - sure all of the Axis2 libraries are on the CLASSPATH.
Run the client

- - -

The Long Story:

- -

Start by installing a suitable container, such as Apache Tomcat. Any J2EE server will do. -To install Axis2 on the server, download the Axis2 War distribution from http://ws.apache.org/axis2/download.cgi -and place the axis2.war file in the server's webapps directory. The server -will then expand the distribution into its proper structure, seen in the earlier section.

- -

Axis2 services come bundled as *.aar files, which contain all of the -pieces necessary to define the service, such as the necessary classes and -libraries and the services.xml file that defines the service's behavior. You -can install the service using the Web -administration application, but to make things simple for now, copy the -*.aar file into the Axis2 services directory. For example, to install the -MyService service distributed as one of the Axis2 samples, copy the file -<AXIS2_HOME>/samples/userguide/build/MyService.aar file which is built -using the ant command from <AXIS2_HOME>/samples/userguide, -to the directory <J2EE_HOME>/webapps/axis2-1.1/WEB-INF/services (Note -that if you installed a SNAPSHOT version of Axis2, this location might take a -form such as -<J2EE_HOME>/webapps/axis2-1.1.1-SNAPSHOT/WEB-INF/services)

- -

Your client can come in any number of forms, from a collection of files to -a single *.jar file. The important thing is to ensure that all the -appropriate classes are on the classpath. In addition to the classes that -pertain to the actual client, you must also add the Axis2 jar files into the -CLASSPATH. Normally you will do this by downloading and unpacking the Axis2 -Standard Distribution and adding the *.jar files in the lib directory to -your CLASSPATH, but you also have the option to run your client using the -axis2.bat (or axis2.sh) script, which takes care of it for you. For example, -you can run a client with the command: axis2 -org.apache.axis2.axis2userguide.Client.

- -

See Next Section- Introduction to -Services

- - + + + + Apache Axis2 User's Guide-Installing and Testing Client Code + + + + + + +

Apache Axis2 User's Guide - Installing and Testing Client Code

+ +

The best way to make sure that your system is running Axis2 is to install +and test both a service and a client. The process involves the following +steps:

+ +

Content

+ +

The Short Story:

Install Axis2 into a suitable container such as Apache Tomcat by + copying the axis2.war file to the webapps directory.
Install the service into the Axis2 application by copying the *.aar + file into the Axis2 services directory.
Install the client on the system on which you want to run it and make + sure all of the Axis2 libraries are on the CLASSPATH.
Run the client

+ + +

The Long Story:

+ +

Start by installing a suitable container, such as Apache Tomcat. Any J2EE server will do. +To install Axis2 on the server, download the Axis2 War distribution from http://ws.apache.org/axis2/download.cgi +and place the axis2.war file in the server's webapps directory. The server +will then expand the distribution into its proper structure, seen in the earlier section.

+ +

Axis2 services come bundled as *.aar files, which contain all of the +pieces necessary to define the service, such as the necessary classes and +libraries and the services.xml file that defines the service's behavior. You +can install the service using the Web +administration application, but to make things simple for now, copy the +*.aar file into the Axis2 services directory. For example, to install the +MyService service distributed as one of the Axis2 samples, copy the file +<AXIS2_HOME>/samples/userguide/build/MyService.aar file which is built +using the ant command from <AXIS2_HOME>/samples/userguide, +to the directory <J2EE_HOME>/webapps/axis2-1.1/WEB-INF/services (Note +that if you installed a SNAPSHOT version of Axis2, this location might take a +form such as +<J2EE_HOME>/webapps/axis2-1.1.1-SNAPSHOT/WEB-INF/services)

+ +

Your client can come in any number of forms, from a collection of files to +a single *.jar file. The important thing is to ensure that all the +appropriate classes are on the classpath. In addition to the classes that +pertain to the actual client, you must also add the Axis2 jar files into the +CLASSPATH. Normally you will do this by downloading and unpacking the Axis2 +Standard Distribution and adding the *.jar files in the lib directory to +your CLASSPATH, but you also have the option to run your client using the +axis2.bat (or axis2.sh) script, which takes care of it for you. For example, +you can run a client with the command: axis2 +org.apache.axis2.axis2userguide.Client.

+ +

See Next Section- Introduction to +Services

+ + Modified: webservices/axis2/trunk/java/xdocs/1_1/userguide-introtoservices.html URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/1_1/userguide-introtoservices.html?view=diff&rev=488944&r1=488943&r2=488944 ============================================================================== --- webservices/axis2/trunk/java/xdocs/1_1/userguide-introtoservices.html (original) +++ webservices/axis2/trunk/java/xdocs/1_1/userguide-introtoservices.html Tue Dec 19 23:40:48 2006 @@ -1,164 +1,164 @@ - - - - Apache Axis2 User's Guide- Introduction to Services - - - - - - -

Apache Axis2 User's Guide - Introduction to Services

- -

The term "Web services" can apply to a number of different ways to send -information back and forth, but this guide focuses on the sending and -receiving of SOAP messages. SOAP messages are XML documents that consist of -an "envelope" containing a "payload" (see Code Listing 4):

- -

Content

- -

Code Listing 4: Example SOAP Message

<?xml version='1.0' ?>
-<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
-xmlns:wsa="http://www.w3.org/2005/03/addressing"> 
- <env:Header>
-
-    <wsa:MessageID>
-      http://ws.apache.org/9C21DE32-DB42-1228-C42E-66CB101421AD
-    </wsa:MessageID>
-    <wsa:ReplyTo>
-      <wsa:Address>http://example.com/projects/clientApp</wsa:Address>
-    </wsa:ReplyTo>
-    
-<wsa:To>http://example.com/axis2/publishingService</wsa:To>
-    
-<wsa:Action>http://example.com/axis2/addDocument</wsa:Action>
- 
-</env:Header>
- <env:Body>
-
-  <addDocument>
-   <docTitle>What I Did On My Summer Vacation</doctitle>
-   <docSubtitle>Children's Essays from Accross the World</docSubtitle>
-   <docLocation>contentRepos/summerVac.doc</docLocation>
-  </addDocument>
-
- </env:Body>
-</env:Envelope>

- -

This XML document consists of the outer element, or the SOAP Envelope, and -its contents. The SOAP Envelope is in the SOAP namespace, -http://www.w3.org/2003/05/soap-envelope, prefixed as env:, and contains up to -two children. This envelope is a standard format that pertains to every -single SOAP message sent and received by any SOAP Web service.

- -

The contents of the Envelope consists of two parts, the first being the -SOAP headers, the contents of the env:Header element. These headers, such as -the WS-Addressing elements shown here, provide additional information about -the message and how it should be handled. A SOAP message may carry headers -relating to several aspects of the message, or it may carry no headers at -all. These headers are typically processed by the message handlers.

- -

The third and arguably most important part of the message is the payload, -which consists of the contents of the env:Body element. This is the actual -message intended for the receiver, and is the information that the main -application will ultimately process.

- - -

Message Exchange Patterns

- -

Although all SOAP messages carry the same structure, the ways in which use -them can be combined into a number of different "message exchange patterns", -or MEPs. The two major message exchange patterns are:

In-Out: in this MEP, the client sends a soap message to the server, in - which processes the message and sends a response back. This is probably - the most commonly used MEP, and is useful for tasks such as searching for - information, or submitting information in situations in which - acknowledgment is important.
In-Only: In this MEP, the client sends a message to the server without - the expectation of receiving a response. You may use this MEP for - activities such as pinging a server to wake it up, reporting logging - information for which you need no acknowledgment, and so on.

- -

Within these two MEPs, you also have several variables to consider:

Blocking versus non-blocking: When the client sends a message, the - application may wait to receive a response before moving on, or it may - simply send a message and then move on, specifying a callback action to - be completed when the response is received.
Number of parameters: Ultimately, a message sent from a client to - server is intended to execute a particular action. That action may - require no parameters, or it may require one or more parameters. These - parameters must be encoded as part of the payload of the message.

- -

Taking all of these options into consideration, you can create virtually -any MEP. For example, you can create an Out-Only system by reversing roles -for the In-Only MEP. Axis2 also includes support for less prominent MEPs, -such as Robust-In-Only.

- -

See Next Section - Creating Clients

- - + + + + Apache Axis2 User's Guide- Introduction to Services + + + + + + +

Apache Axis2 User's Guide - Introduction to Services

+ +

The term "Web services" can apply to a number of different ways to send +information back and forth, but this guide focuses on the sending and +receiving of SOAP messages. SOAP messages are XML documents that consist of +an "envelope" containing a "payload" (see Code Listing 4):

+ +

Content

+ +

Code Listing 4: Example SOAP Message

<?xml version='1.0' ?>
+<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
+xmlns:wsa="http://www.w3.org/2005/03/addressing"> 
+ <env:Header>
+
+    <wsa:MessageID>
+      http://ws.apache.org/9C21DE32-DB42-1228-C42E-66CB101421AD
+    </wsa:MessageID>
+    <wsa:ReplyTo>
+      <wsa:Address>http://example.com/projects/clientApp</wsa:Address>
+    </wsa:ReplyTo>
+    
+<wsa:To>http://example.com/axis2/publishingService</wsa:To>
+    
+<wsa:Action>http://example.com/axis2/addDocument</wsa:Action>
+ 
+</env:Header>
+ <env:Body>
+
+  <addDocument>
+   <docTitle>What I Did On My Summer Vacation</doctitle>
+   <docSubtitle>Children's Essays from Accross the World</docSubtitle>
+   <docLocation>contentRepos/summerVac.doc</docLocation>
+  </addDocument>
+
+ </env:Body>
+</env:Envelope>

+ +

This XML document consists of the outer element, or the SOAP Envelope, and +its contents. The SOAP Envelope is in the SOAP namespace, +http://www.w3.org/2003/05/soap-envelope, prefixed as env:, and contains up to +two children. This envelope is a standard format that pertains to every +single SOAP message sent and received by any SOAP Web service.

+ +

The contents of the Envelope consists of two parts, the first being the +SOAP headers, the contents of the env:Header element. These headers, such as +the WS-Addressing elements shown here, provide additional information about +the message and how it should be handled. A SOAP message may carry headers +relating to several aspects of the message, or it may carry no headers at +all. These headers are typically processed by the message handlers.

+ +

The third and arguably most important part of the message is the payload, +which consists of the contents of the env:Body element. This is the actual +message intended for the receiver, and is the information that the main +application will ultimately process.

+ + +

Message Exchange Patterns

+ +

Although all SOAP messages carry the same structure, the ways in which use +them can be combined into a number of different "message exchange patterns", +or MEPs. The two major message exchange patterns are:

In-Out: in this MEP, the client sends a soap message to the server, in + which processes the message and sends a response back. This is probably + the most commonly used MEP, and is useful for tasks such as searching for + information, or submitting information in situations in which + acknowledgment is important.
In-Only: In this MEP, the client sends a message to the server without + the expectation of receiving a response. You may use this MEP for + activities such as pinging a server to wake it up, reporting logging + information for which you need no acknowledgment, and so on.

+ +

Within these two MEPs, you also have several variables to consider:

Blocking versus non-blocking: When the client sends a message, the + application may wait to receive a response before moving on, or it may + simply send a message and then move on, specifying a callback action to + be completed when the response is received.
Number of parameters: Ultimately, a message sent from a client to + server is intended to execute a particular action. That action may + require no parameters, or it may require one or more parameters. These + parameters must be encoded as part of the payload of the message.

+ +

Taking all of these options into consideration, you can create virtually +any MEP. For example, you can create an Out-Only system by reversing roles +for the In-Only MEP. Axis2 also includes support for less prominent MEPs, +such as Robust-In-Only.

+ +

See Next Section - Creating Clients

+ + Modified: webservices/axis2/trunk/java/xdocs/1_1/userguide-samples.html URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/1_1/userguide-samples.html?view=diff&rev=488944&r1=488943&r2=488944 ============================================================================== --- webservices/axis2/trunk/java/xdocs/1_1/userguide-samples.html (original) +++ webservices/axis2/trunk/java/xdocs/1_1/userguide-samples.html Tue Dec 19 23:40:48 2006 @@ -1,184 +1,184 @@ - - - - Apache Axis2 User's Guide- The Samples - - - - - - -

Apache Axis2 User's Guide - The Samples

- -

The Axis2 Standard Distribution provides a number of samples you can use -as a guide for implementing specific features and capabilities. These -services are listed in this section.

- -

Content

- - -

Clients (in samples/userguide/src/clients):

- -

EchoBlockingClient.java: A basic example of the send/receive MEP.

- -

EchoBlockingDualClient.java: Specifies that the return message should be -sent over a different channel than the request message.

- -

EchoBlockingWsaBasedClient.java: Provides an example of using the -capabilities of WS-Addressing action mapping.

- -

EchoNonBlockingClient.java: Demonstrates an asynchronous request and using -Callbacks.

- -

EchoNonBlockingDualClient.java: Similar to above, but uses a separate -listener for the response.

- -

ClientForWebServiceWithModule.java: Simply makes a call to a service with -engaged modules.

- -

ClientSideModuleEngagement.java: Demonstrates the use of modules on the -client side, in addition to the server side.

- -

MailClient.java: Demonstrates the use of the Robust In-Only MEP.

- -

PingClient.java: A simple "fire and forget" client.

- -

RESTClient.java: Demonstrates the ability to request a REST response -rather than a SOAP response. Also demonstrates setting arbitrary properties -on the Options object.

- -

TCPClient.java: Provides an example of using the TCP transport rather than -HTTP.

- - -

Services (in samples/userguide):

- -

groovyService.aar: Demonstrates how to use Groovy classes in the -processing of SOAP messages.

- -

MyService.aar: Provides simple "echo" and "ping" operations.

- -

MyServiceWithModule.aar: Same as above, but demonstrates how to engage a -module.

- -

WsaMappingService.aar: Demonstrates the mapping of WS-Addressing -actions.

- - -

Sample WSDL files (in samples):

- -

Axis2SampleDocLit.wsdl: Demonstrates the use of the Document/Literal WSDL -pattern, rather than RPC.

- -

perf.wsdl: Demonstrates the use of array values as input values.

- - -

Other samples (in samples):

- - -

faulthandling: Demonstrates the use of SOAP faults and -their definition in WSDL, enabling exception processing in the client.

- - -

googleSpellcheck: Demonstrates both synchronous and -non-synchronous use of the Google Web Service in a GUI.

- -

mtom: Demonstrates the use of MTOM and SOAP with -Attachments to send binary files to a service.

- -

saopwithattachments: Demonstrates the capabilities and -power of SOAP with Attachment support and the Attachment API of Axis2.

- -

pojo: Example POJO (Plain Old Java Object) Web service. -It shows how to expose the methods of a Java class as a Web service using -Aixs2

- -

servicelifecycle: Demonstrate usage of service life cycle -and bit of session management. The main idea is to show where and how to use -service life cycle interface and session related methods.

- - -

databinding: Demonstrates how to use WSDL2Java generated -code with Castor.

- -

version: A very simple service that simply outputs the -Axis2 version.

- -

yahoorestearch: Complete example of the use of a REST -service rather than a SOAP service.

- -

See Next Section - For Further Study

- - + + + + Apache Axis2 User's Guide- The Samples + + + + + + +

Apache Axis2 User's Guide - The Samples

+ +

The Axis2 Standard Distribution provides a number of samples you can use +as a guide for implementing specific features and capabilities. These +services are listed in this section.

+ +

Content

+ + +

Clients (in samples/userguide/src/clients):

+ +

EchoBlockingClient.java: A basic example of the send/receive MEP.

+ +

EchoBlockingDualClient.java: Specifies that the return message should be +sent over a different channel than the request message.

+ +

EchoBlockingWsaBasedClient.java: Provides an example of using the +capabilities of WS-Addressing action mapping.

+ +

EchoNonBlockingClient.java: Demonstrates an asynchronous request and using +Callbacks.

+ +

EchoNonBlockingDualClient.java: Similar to above, but uses a separate +listener for the response.

+ +

ClientForWebServiceWithModule.java: Simply makes a call to a service with +engaged modules.

+ +

ClientSideModuleEngagement.java: Demonstrates the use of modules on the +client side, in addition to the server side.

+ +

MailClient.java: Demonstrates the use of the Robust In-Only MEP.

+ +

PingClient.java: A simple "fire and forget" client.

+ +

RESTClient.java: Demonstrates the ability to request a REST response +rather than a SOAP response. Also demonstrates setting arbitrary properties +on the Options object.

+ +

TCPClient.java: Provides an example of using the TCP transport rather than +HTTP.

+ + +

Services (in samples/userguide):

+ +

groovyService.aar: Demonstrates how to use Groovy classes in the +processing of SOAP messages.

+ +

MyService.aar: Provides simple "echo" and "ping" operations.

+ +

MyServiceWithModule.aar: Same as above, but demonstrates how to engage a +module.

+ +

WsaMappingService.aar: Demonstrates the mapping of WS-Addressing +actions.

+ + +

Sample WSDL files (in samples):

+ +

Axis2SampleDocLit.wsdl: Demonstrates the use of the Document/Literal WSDL +pattern, rather than RPC.

+ +

perf.wsdl: Demonstrates the use of array values as input values.

+ + +

Other samples (in samples):

+ + +

faulthandling: Demonstrates the use of SOAP faults and +their definition in WSDL, enabling exception processing in the client.

+ + +

googleSpellcheck: Demonstrates both synchronous and +non-synchronous use of the Google Web Service in a GUI.

+ +

mtom: Demonstrates the use of MTOM and SOAP with +Attachments to send binary files to a service.

+ +

saopwithattachments: Demonstrates the capabilities and +power of SOAP with Attachment support and the Attachment API of Axis2.

+ +

pojo: Example POJO (Plain Old Java Object) Web service. +It shows how to expose the methods of a Java class as a Web service using +Aixs2

+ +

servicelifecycle: Demonstrate usage of service life cycle +and bit of session management. The main idea is to show where and how to use +service life cycle interface and session related methods.

+ + +

databinding: Demonstrates how to use WSDL2Java generated +code with Castor.

+ +

version: A very simple service that simply outputs the +Axis2 version.

+ +

yahoorestearch: Complete example of the use of a REST +service rather than a SOAP service.

+ +

See Next Section - For Further Study

+ + Modified: webservices/axis2/trunk/java/xdocs/1_1/userguide.html URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/java/xdocs/1_1/userguide.html?view=diff&rev=488944&r1=488943&r2=488944 ============================================================================== --- webservices/axis2/trunk/java/xdocs/1_1/userguide.html (original) +++ webservices/axis2/trunk/java/xdocs/1_1/userguide.html Tue Dec 19 23:40:48 2006 @@ -4,7 +4,7 @@ Apache Axis2 User's Guide- Introducing Axis2 + media="all" /> --------------------------------------------------------------------- To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org For additional commands, e-mail: axis-cvs-help@ws.apache.org