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 da...@apache.org on 2008/01/14 07:00:43 UTC
svn commit: r611719 [2/7] - in /webservices/axis2/trunk/c/xdocs: ./ docs/
docs/hello/client/ docs/hello/service/ docs/mod_log/
Modified: webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html
URL: http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html?rev=611719&r1=611718&r2=611719&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html Sun Jan 13 22:00:36 2008
@@ -1,34 +1,19 @@
-<html>
-<head>
- <title>Manual</title>
- <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-</head>
-
-<body lang="en-US" dir="ltr">
-<h2>Preamble</h2>
-
-<p style="margin-bottom: 0in">This document is intended to be a reference
-manual for <a href="http://ws.apache.org/axis2/c">Apache Axis2/C</a>. This
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache Axis2/C - Manual</title><style type="text/css" media="all">
+ @import url("../style/maven-base.css");
+
+ @import url("../style/maven-classic.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="http://www.apache.org/images/asf-logo.gif"></img></a><a href="http://ws.apache.org/axis2/c" id="projectLogo"><img alt="Apache Axis2/C" src="http://ws.apache.org/axis2/images/axis.jpg"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 09 January 2008
+ | Doc for 1.2.0</div><div class="xright"></div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuApache_Axis2_C"><h5>Apache Axis2/C</h5><ul><li class="none"><a href="../index.html">Apache Axis2/C Home</a></li><li class="expanded"><a href="../download.cgi">Download Axis2/C</a><ul><li class="none"><a href="../download.cgi">Releases</a></li></ul></li><li class="expanded"><a href="../docs/index.html">Documentation</a><ul><li class="none"><a href="../docs/installationguide.html">Installation Guide</a></li><li class="none"><a href="../docs/axis2c_manual.html">Axis2/C manual</a></li></ul></li><li class="expanded"><a href="../lists_issues.html">Get Involved</a><ul><li class="none"><a href="../lists_issues.html">Mailing Lists & Issue Tracking</a></li><li class="none"><a href="../svn.html">Checkout Source Code</a></li></ul></li><li class="expanded"><a href="../coding_conventions.html">Developer Guidelines</a><ul><li cla
ss="none"><a href="../coding_conventions.html">Coding Convention</a></li><li class="none"><a href="../versioning.html">Versionning</a></li></ul></li><li class="expanded"><a href="../team-list.html">Project Information</a><ul><li class="none"><a href="../team-list.html">Project Team</a></li><li class="none"><a href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/c/" class="externalLink" title="External Link">Source Code</a></li></ul></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><a name="Preamble"></a><h2>Preamble</h2><p style="margin-bottom: 0in">This document is intended to be a reference
+manual for <a href="http://ws.apache.org/axis2/c" class="externalLink" title="External Link">Apache Axis2/C</a>. This
manual details how Axis2/C can be used to provide and consume Web
-services.</p>
-
-<p style="margin-bottom: 0in">Please send your feedback to the Apache Axis2/C
-developer mailing list (<a
-href="mailto:axis-c-dev@apache.org">axis-c-dev@apache.org</a>). Subscription
-details are available on the <a
-href="http://ws.apache.org/axis2/c/mail-lists.html">Axis2 site</a>.</p>
-
-<p>This document uses the following conventions:</p>
-<ul>
+services.</p><p style="margin-bottom: 0in">Please send your feedback to the Apache Axis2/C
+developer mailing list (<a href="mailto:axis-c-dev@apache.org">axis-c-dev@apache.org</a>). Subscription
+details are available on the <a href="http://ws.apache.org/axis2/c/mail-lists.html" class="externalLink" title="External Link">Axis2 site</a>.</p><p>This document uses the following conventions:</p><ul>
<li>The directory each package is installed in is given with an
"_INSTALL_DIR" suffix to the package name. For example, the path in which
Libxml2 is installed is referred to as LIBXML2_INSTALL_DIR</li>
-</ul>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<h1 class="western"><a name="toc">Axis2/C Manual - Contents</a></h1>
-<ol>
+</ul><p style="margin-bottom: 0in"><br></br>
+</p></div><div class="section"><a name="Axis2_C_Manual_-_Contents"></a><h2>Axis2/C Manual - Contents</h2><ol>
<li><a href="#quick_start">Quick Start Guide</a></li>
<li><a href="#repo_folder">Repository Folder</a></li>
<li><a href="#svc_api">Service API</a></li>
@@ -51,136 +36,89 @@
<li><a href="#appB">Appendix B - services.xml</a></li>
<li><a href="#appC">Appendix C - module.xml</a></li>
<li><a href="#appD">Appendix D - service client options</a></li>
-</ol>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="quick_start"></a>
-
-<h1>1. Quick Start Guide</h1>
-
-<p>This section is aimed to help you get a Web service running in a short
-time using Axis2/C, and consume that service using an Axis2/C client.</p>
-
-<p>First, <a href="http://ws.apache.org/axis2/c/download.cgi">download</a>
+</ol><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="quick_start"></a></p></div><div class="section"><a name="1__Quick_Start_Guide"></a><h2>1. Quick Start Guide</h2><p>This section is aimed to help you get a Web service running in a short
+time using Axis2/C, and consume that service using an Axis2/C client.</p><p>First, <a href="http://ws.apache.org/axis2/c/download.cgi" class="externalLink" title="External Link">download</a>
the latest binary release from Apache Axis2/C. Once you download the correct
binary that suits your platform, all that you require to get it running is to
extract the package to a folder of your choice, and set the AXIS2C_HOME
environment variable to point to this extracted folder. For Linux, you may
have to set the LD_LIBRARY_PATH environment variable to include the lib
folder (e.g. add $AXIS2C_HOME/lib). For MS Windows, you will have to add the
-lib folder to your PATH variable to include the Axis2/C DLLs to your path.</p>
-
-<p>Now you should be able to change the directory to the bin folder of the
+lib folder to your PATH variable to include the Axis2/C DLLs to your path.</p><p>Now you should be able to change the directory to the bin folder of the
extracted folder, and run the simple axis server in one command shell. Then
change the directory to bin/samples in another command shell and run any of
the samples there (you may have to set the environment variables in this new
-shell as well). Please see the <a
-href="http://ws.apache.org/axis2/c/docs/installationguide.html">installation
-guide</a> for more details.</p>
-
-<p>Once you have Axis2/C up and running successfully, you can start writing
+shell as well). Please see the <a href="http://ws.apache.org/axis2/c/docs/installationguide.html" class="externalLink" title="External Link">installation
+guide</a> for more details.</p><p>Once you have Axis2/C up and running successfully, you can start writing
your own services and clients. The following sections explain how to write
-your first service and client with Axis2/C.</p>
-
-<h2 class="western">1.1 Hello Service</h2>
-
-<p>Let's see how you can write your first Web service with Axis2/C and how to
-deploy it.</p>
-
-<p>The first service that we are going to write is named "hello" with a
+your first service and client with Axis2/C.</p><div class="subsection"><a name="1_1_Hello_Service"></a><h3>1.1 Hello Service</h3><p>Let's see how you can write your first Web service with Axis2/C and how to
+deploy it.</p><p>The first service that we are going to write is named "hello" with a
single operation named "greet" in the service. This "greet" operation, when
invoked by the client, will expect the client to send a greeting in the
request, and in turn send a greeting in the response. Following are examples
-of XML payloads exchanged between the client and the service:</p>
-
-<p>Request:</p>
-<pre> <greet>
+of XML payloads exchanged between the client and the service:</p><p>Request:</p>
+ <div class="source"><pre> <greet>
Hello Service!
- <greet></pre>
+ <greet>
-<p>Response:</p>
-<pre> <greetResponse>
+</pre></div>
+ <p>Response:</p>
+ <div class="source"><pre> <greetResponse>
Hello Client!
- <greetResponse></pre>
-<br />
-
-
-<p>The steps to be followed when implementing a service with Axis2/C
-include:</p>
-<ol>
+ <greetResponse>
+</pre></div>
+ <br></br><p>The steps to be followed when implementing a service with Axis2/C
+include:</p><ol>
<li><b>Implement the functions corresponding to the operations of the
- service.</b> <br />
+ service.</b> <br></br>
In our sample, we will have one function that implements the "greet"
- operation. <br />
+ operation. <br></br>
We will name that function <code>axis2_hello_greet</code>.</li>
<li><b>Implement the functions defined by the
- <code>axis2_svc_skeleton</code> interface</b><br />
+ <code>axis2_svc_skeleton</code> interface</b><br></br>
<code>axis2_svc_skeleton</code> interface expects the functions
<code>init</code>, <code>invoke</code>, <code>on_fault</code> and
- <code>free</code> to be implemented by our service.<br />
+ <code>free</code> to be implemented by our service.<br></br>
In our sample, we would implement those and name them as
<code>hello_init</code>, <code>hello_invoke</code>,
- <code>hello_on_fault</code> and <code>hello_free</code> respectively.<br />
+ <code>hello_on_fault</code> and <code>hello_free</code> respectively.<br></br>
</li>
<li><b>Implement the create function, that would create an instance of the
- service skeleton</b><br />
+ service skeleton</b><br></br>
The create function would create an axis2_svc_skeleton and assign the
respective function pointers to map the axis2_svc_skeleton interface to
- our interface implementation methods explained in the above step.<br />
+ our interface implementation methods explained in the above step.<br></br>
</li>
<li><b>Implement axis2_get_instance and axis2_remove_instance
- functions</b><br />
+ functions</b><br></br>
These functions are used to create and destroy service instances by the
- engine, and each service must define these functions.<br />
+ engine, and each service must define these functions.<br></br>
</li>
- <li><b>Write the services.xml file for the service</b><br />
+ <li><b>Write the services.xml file for the service</b><br></br>
The services.xml file acts as the deployment descriptor file for the
service. As the bare minimum, we need to configure the service name,
operations, and the shared library file name containing the service
- implementation in this file.<br />
+ implementation in this file.<br></br>
As previously decided, we will name the service "hello", the operation
"greet" and the shared library libhello.so on Linux and hello.dll on MS
- Windows.<br />
+ Windows.<br></br>
</li>
-</ol>
-
-<h3 class="western">1.1.1 Operation Implementation</h3>
-
-<p>Look for the <code>axis2_hello_greet</code> function in the <a
-href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p>
-
-<p>This function implements the business logic for the greet operation. We
+</ol></div><div class="subsection"><a name="1_1_1_Operation_Implementation"></a><h3>1.1.1 Operation Implementation</h3><p>Look for the <code>axis2_hello_greet</code> function in the <a href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p><p>This function implements the business logic for the greet operation. We
will be calling this function from our implementation of the invoke function.
Basically, this function receives the request payload as an
<code>axiom_node</code>, process it to understand the request logic, and
-prepares the response as an <code>axiom_node</code> and returns that.</p>
-
-<h3 class="western">1.1.2 Skeleton Create Method</h3>
-
-<p>Look for the <code>axis2_hello_create</code> function in the <a
-href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p>
-
-<p>The create function creates and returns a new
+prepares the response as an <code>axiom_node</code> and returns that.</p></div><div class="subsection"><a name="1_1_2_Skeleton_Create_Method"></a><h3>1.1.2 Skeleton Create Method</h3><p>Look for the <code>axis2_hello_create</code> function in the <a href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p><p>The create function creates and returns a new
<code>axis2_svc_skeleton</code> instance. The most important aspect to note
about this function is the function pointer assignments. They are used to map
the interface operations to the corresponding functions of the
implementation. This is done by assigning the ops member of the service
-skeleton to the address of the ops struct variable.</p>
-
-<h3>1.1.3 Invoking Operation Implementation</h3>
-
-<p>The invoke method of the service skeleton is the point of entry for
+skeleton to the address of the ops struct variable.</p></div><div class="subsection"><a name="1_1_3_Invoking_Operation_Implementation"></a><h3>1.1.3 Invoking Operation Implementation</h3><p>The invoke method of the service skeleton is the point of entry for
invoking the operations. Hence in our implementation of the invoke function,
-we have to define how the operations are to be called.</p>
-
-<p>Look for the <code>hello_invoke</code> function in the <a
-href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p>
-
-<p>In our implementation of the <code>hello_invoke</code>, we call the
+we have to define how the operations are to be called.</p><p>Look for the <code>hello_invoke</code> function in the <a href="hello/service/hello_svc.c.html">hello_svc.c</a> source file.</p><p>In our implementation of the <code>hello_invoke</code>, we call the
function implementing the greet operation. As we have only one operation, the
task is simple here. If we had multiple operations, we will have to look into
-the information in the message context to map it to the exact operation. <br />
+the information in the message context to map it to the exact operation. <br></br>
The Axis2/C engine will call the invoke method with an
<code>axiom_node</code>, containing the request payload, and
<code>axis2_msg_ctx</code> instance, containing the message context
@@ -188,284 +126,194 @@
pointers. We can use the message context to extract whatever information we
deem necessary that is related to the incoming message. The Axis2/C engine
expects the invoke method to return a pointer to an <code>axiom_node</code>,
-representing the response payload.</p>
-
-<h3>1.1.4 Full Source</h3>
-
-<p>Here is the complete source code for the service : <a
-href="hello/service/hello_svc.c.html">hello_svc.c</a></p>
-
-<h3>1.1.5 Service Descriptor</h3>
-
-<p>The services.xml file contains details on the service that would be read
+representing the response payload.</p></div><div class="subsection"><a name="1_1_4_Full_Source"></a><h3>1.1.4 Full Source</h3><p>Here is the complete source code for the service : <a href="hello/service/hello_svc.c.html">hello_svc.c</a></p></div><div class="subsection"><a name="1_1_5_Service_Descriptor"></a><h3>1.1.5 Service Descriptor</h3><p>The services.xml file contains details on the service that would be read
by the Axis2/C deployment engine during server start up time. The following
shows the contents for the services.xml file for the hello service.</p>
-<pre><service name="hello">
+ <div class="source"><pre><service name="hello">
<parameter name="ServiceClass" locked="xsd:false">hello</parameter>
<description>
Quick start guide hello service sample.
</description>
<operation name="greet"/>
-</service></pre>
+</service>
-<p>The service configuration shown above specifies that the name of the
-service is hello. <br />
+</pre></div>
+ <p>The service configuration shown above specifies that the name of the
+service is hello. <br></br>
The value of the "ServiceClass", "hello" in this case, will be mapped to the
service implementation by the deployment engine as libhello.so on Linux or
hello.dll on MS Windows. The description element contains a brief description
-of the service. <br />
+of the service. <br></br>
There can be one or more operation elements. For this sample, we only have
-one operation, with the name "greet".<br />
-</p>
-
-<h3>1.1.6 Compiling the Service</h3>
-
-<p>You can compile the service sample as shown below.</p>
-
-<p>On Linux:</p>
-<pre>gcc -shared -olibhello.so -I$AXIS2C_HOME/include/axis2-1.2/ -L$AXIS2C_HOME/lib -laxutil -laxis2_axiom -laxis2_parser -laxis2_engine -lpthread -laxis2_http_sender -laxis2_http_receiver hello_svc.c</pre>
-
-<p>On MS Windows:</p>
-
-<p>to compile,</p>
-<pre>cl.exe /D "WIN32" /D "_WINDOWS" /D "_MBCS" /D "AXIS2_DECLARE_EXPORT" /D "AXIS2_SVR_MULTI_THREADED" /w /nologo /I %AXIS2C_HOME%\include /c hello_svc.c</pre>
-
-<p>to link,</p>
-<pre>link.exe /nologo /LIBPATH:%AXIS2C_HOME%\lib axutil.lib axiom.lib axis2_parser.lib axis2_engine.lib /DLL /OUT:hello.dll *.obj</pre>
-
-<h3>1.1.7 Deploying the Service</h3>
+one operation, with the name "greet".<br></br>
+</p></div><div class="subsection"><a name="1_1_6_Compiling_the_Service"></a><h3>1.1.6 Compiling the Service</h3><p>You can compile the service sample as shown below.</p><p>On Linux:</p>
+ <div class="source"><pre>gcc -shared -olibhello.so -I$AXIS2C_HOME/include/axis2-1.2/ -L$AXIS2C_HOME/lib -laxutil -laxis2_axiom -laxis2_parser -laxis2_engine -lpthread -laxis2_http_sender -laxis2_http_receiver hello_svc.c
+
+</pre></div>
+ <p>On MS Windows:</p><p>to compile,</p>
+ <div class="source"><pre>cl.exe /D "WIN32" /D "_WINDOWS" /D "_MBCS" /D "AXIS2_DECLARE_EXPORT" /D "AXIS2_SVR_MULTI_THREADED" /w /nologo /I %AXIS2C_HOME%\include /c hello_svc.c
+
+</pre></div>
+ <p>to link,</p>
+ <div class="source"><pre>link.exe /nologo /LIBPATH:%AXIS2C_HOME%\lib axutil.lib axiom.lib axis2_parser.lib axis2_engine.lib /DLL /OUT:hello.dll *.obj
-<p>To make the service available to be consumed by the clients, we have to
+</pre></div>
+ </div><div class="subsection"><a name="1_1_7_Deploying_the_Service"></a><h3>1.1.7 Deploying the Service</h3><p>To make the service available to be consumed by the clients, we have to
deploy the service. To deploy the service, you have to create a folder named
'hello' in the AXIS2C_HOME/services folder, and copy the services.xml file
and the shared library file (libhello.so on Linux or hello.dll on MS Windows)
-into that folder.</p>
-
-<p>To verify that your service has been correctly deployed, you can start the
+into that folder.</p><p>To verify that your service has been correctly deployed, you can start the
simple axis server and then browse the list of deployed services using a Web
browser. To start the simple axis server, you can go to the AXIS2C_HOME/bin
folder and run the executable axis2_http_server. The default URL that you can
-test the service list with is <a
-href="http://localhost:9090/axis2/services">http://localhost:9090/axis2/services</a>.
+test the service list with is <a href="http://localhost:9090/axis2/services" class="externalLink" title="External Link">http://localhost:9090/axis2/services</a>.
You should get an entry for the hello service on the page that is
-displayed.</p>
-
-<h2 class="western" style="margin-top: 0in; margin-bottom: 0in">1.2 Hello
-Client</h2>
-
-<p>Now that you know how to write a service with Axis2/C, let's see how to
+displayed.</p></div><div class="subsection"><a name="1_2_Hello_Client"></a><h3>1.2 Hello Client</h3><p>Now that you know how to write a service with Axis2/C, let's see how to
write a client to consume that service. The request payload that the client
will be sending to the service was described in the previous section. The
client has to prepare the payload, send it to the service, and then receive
-and process the response.</p>
-
-<p>The steps to be followed when implementing a client with Axis2/C:</p>
-<ol>
- <li><b>Create the environment to be used by the client.</b> <br />
+and process the response.</p><p>The steps to be followed when implementing a client with Axis2/C:</p><ol>
+ <li><b>Create the environment to be used by the client.</b> <br></br>
Each function in Axis2/C takes a pointer to the environment instance that
encapsulates the memory allocator, error handler, and logging and
threading mechanisms. The <code>axutil_env_create_all</code> method can
- be used to create a default, ready to use environment instance.<br />
+ be used to create a default, ready to use environment instance.<br></br>
</li>
- <li><b>Create an options instance, and set options</b>.<br />
+ <li><b>Create an options instance, and set options</b>.<br></br>
The<code> axis2_options</code> struct can be used to set the client side
options. For example, we can use options to set the endpoint address of
the service to be consumed by the client.</li>
<li><b>Create a service client instance, giving the client repository
- folder as a parameter.</b><br />
+ folder as a parameter.</b><br></br>
The<code> axis2_svc_client</code> struct is meant to be used by the users
to consume Web services. It provides an easy to use API. Service client
create method takes the location of the repository as a parameter. For
the purpose of our sample, you can use the AXIS2C_HOME as the repository.
The concept of <a href="#repo_folder">repository</a> is explained in
- detail in a later section.<br />
+ detail in a later section.<br></br>
</li>
- <li><b>Set options to service client instance</b><br />
+ <li><b>Set options to service client instance</b><br></br>
The options created in an earlier step have to be set on the service
client, indicating the options that are meant to be used by the service
- client.<br />
+ client.<br></br>
</li>
- <li><b>Send the request and receive the response</b><br />
+ <li><b>Send the request and receive the response</b><br></br>
The service client's <code>axis2_svc_client_send_receive</code> method
can be used to invoke the send receive operation on the service client
- instance.<br />
+ instance.<br></br>
The send receive operation takes the request payload as an
<code>axiom_node</code> and returns the response payload as an
<code>axiom_node</code>.</li>
- <li><b>Process the response</b><br />
+ <li><b>Process the response</b><br></br>
Process the response in line with the client business logic.</li>
-</ol>
-
-<h3>1.2.1 Creating and Setting Options</h3>
-<pre> options = axis2_options_create(env);
+</ol></div><div class="subsection"><a name="1_2_1_Creating_and_Setting_Options"></a><h3>1.2.1 Creating and Setting Options</h3>
+ <div class="source"><pre> options = axis2_options_create(env);
address = "http://localhost:9090/axis2/services/hello";
endpoint_ref = axis2_endpoint_ref_create(env, address);
- axis2_options_set_to(options, env, endpoint_ref);</pre>
+ axis2_options_set_to(options, env, endpoint_ref);
-<p>In the above section of code, an <code>axis2_options</code> instance is
+</pre></div>
+ <p>In the above section of code, an <code>axis2_options</code> instance is
created first. Then an endpoint reference instance is created with the
address of the location of the service. Finally, the created endpoint is set
as the "to" address of the options. The "to" address indicates where the
-request should be sent to.</p>
-
-<h3>1.2.2 Using Service Client</h3>
-<pre> svc_client = axis2_svc_client_create(env, client_home);
+request should be sent to.</p></div><div class="subsection"><a name="1_2_2_Using_Service_Client"></a><h3>1.2.2 Using Service Client</h3>
+ <div class="source"><pre> svc_client = axis2_svc_client_create(env, client_home);
axis2_svc_client_set_options(svc_client, env, options);
payload = build_om_request(env);
- ret_node = axis2_svc_client_send_receive(svc_client, env, payload);</pre>
+ ret_node = axis2_svc_client_send_receive(svc_client, env, payload);
-<p>After creating and preparing the options, the next step is to create a
+</pre></div>
+ <p>After creating and preparing the options, the next step is to create a
service client instance and use it to send the request and receive the
response. The code fragment given above shows how options can be set on top
of the service client and how to invoke the send receive operation with a
request payload. Once the response is received, the response payload will be
stored in the <code>ret_node</code>, which is a pointer to an
-<code>axiom_node</code> that can be used to process the response further.</p>
-
-<h3>1.2.3 Full Source</h3>
-
-<p>Here is the complete source code for the client : <a
-href="hello/client/hello.c.html">hello.c</a></p>
-
-<h3>1.2.4 Compiling the Client</h3>
-
-<p>You can compile the client sample as shown below.</p>
+<code>axiom_node</code> that can be used to process the response further.</p></div><div class="subsection"><a name="1_2_3_Full_Source"></a><h3>1.2.3 Full Source</h3><p>Here is the complete source code for the client : <a href="hello/client/hello.c.html">hello.c</a></p></div><div class="subsection"><a name="1_2_4_Compiling_the_Client"></a><h3>1.2.4 Compiling the Client</h3><p>You can compile the client sample as shown below.</p><p>On Linux:</p>
+ <div class="source"><pre>gcc -o hello -I$AXIS2C_HOME/include/axis2-1.2/ -L$AXIS2C_HOME/lib -laxutil -laxis2_axiom -laxis2_parser -laxis2_engine -lpthread -laxis2_http_sender -laxis2_http_receiver hello.c -ldl -Wl,--rpath -Wl,$AXIS2C_HOME/lib
-<p>On Linux:</p>
-<pre>gcc -o hello -I$AXIS2C_HOME/include/axis2-1.2/ -L$AXIS2C_HOME/lib -laxutil -laxis2_axiom -laxis2_parser -laxis2_engine -lpthread -laxis2_http_sender -laxis2_http_receiver hello.c -ldl -Wl,--rpath -Wl,$AXIS2C_HOME/lib</pre>
-
-<p>On MS Windows:</p>
-
-<p>to compile,</p>
-<pre>cl.exe /nologo /D "WIN32" /D "_WINDOWS" /D "_MBCS" /I %AXIS2C_HOME%\include /c hello.c</pre>
-
-<p>to link,</p>
-<pre>link.exe /LIBPATH:%AXIS2C_HOME%\lib axutil.lib axiom.lib axis2_parser.lib axis2_engine.lib /OUT:hello.exe *.obj</pre>
-
-<h3>1.2.5 Running the Client</h3>
-
-<p>To run the client, make sure you start the simple axis server and then run
-the hello executable.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="repo_folder"></a>
-
-<h1>2. Repository Folder</h1>
-
-<p>Repository is a folder where all Axis2/C related configurations as well as
+</pre></div>
+ <p>On MS Windows:</p><p>to compile,</p>
+ <div class="source"><pre>cl.exe /nologo /D "WIN32" /D "_WINDOWS" /D "_MBCS" /I %AXIS2C_HOME%\include /c hello.c
+
+</pre></div>
+ <p>to link,</p>
+ <div class="source"><pre>link.exe /LIBPATH:%AXIS2C_HOME%\lib axutil.lib axiom.lib axis2_parser.lib axis2_engine.lib /OUT:hello.exe *.obj
+
+</pre></div>
+ </div><div class="subsection"><a name="1_2_5_Running_the_Client"></a><h3>1.2.5 Running the Client</h3><p>To run the client, make sure you start the simple axis server and then run
+the hello executable.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="repo_folder"></a></p></div></div><div class="section"><a name="2__Repository_Folder"></a><h2>2. Repository Folder</h2><p>Repository is a folder where all Axis2/C related configurations as well as
services and modules are located. The following shows the folder structure of
-the repository:</p>
-<img src="images/axis2c_repo.gif">
-
-<p>Here the name of the repository folder is axis2c_repo. In your system, you
+the repository:</p><img src="images/axis2c_repo.gif" alt=""></img><p>Here the name of the repository folder is axis2c_repo. In your system, you
can specify any folder name of your choice. There are three sub folders
available in the repository. In addition to that, the axis2.xml configuration
file is also located in the repository. The following table describes the
-purpose of the repository contents.</p>
-
-<table border="1">
- <caption>Axis2/C Repository Contents</caption>
- <tbody>
- <tr>
- <th>Folder/File Name</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><p>lib</p>
- </td>
- <td><p>The lib folder contains the libraries required to run the
+purpose of the repository contents.</p><table class="bodyTable"><caption>Axis2/C Repository Contents</caption><tbody>
+ <tr class="b"><th>Folder/File Name</th><th>Description</th></tr>
+ <tr class="a"><td><p>lib</p>
+ </td><td><p>The lib folder contains the libraries required to run the
Axis2/C engine. While you can afford to have the shared libs of
Axis2/C in a location of your choice, the dynamically loaded shared
libs, parser, transport receiver and transport sender has to be in
- the repository lib folder. <br />
+ the repository lib folder. <br></br>
It is mandatory that the lib folder is there in the repository.</p>
- </td>
- </tr>
- <tr>
- <td><p>modules [optional]</p>
- </td>
- <td><p>The modules folder contains the modules deployed with Axis2/C.
+ </td></tr>
+ <tr class="b"><td><p>modules [optional]</p>
+ </td><td><p>The modules folder contains the modules deployed with Axis2/C.
Each module deployed will have its own sub folder inside the modules
folder. For example, if the addressing module is deployed, then there
will be a sub folder named addressing inside the modules folder of
- the repository.<br />
+ the repository.<br></br>
At deployment, the Axis2/C deployment engine would traverse the
- modules folders to find out what modules are available.<br />
+ modules folders to find out what modules are available.<br></br>
The modules folder is optional. If it is empty or non-existent, that
means that there are no deployed modules.</p>
- </td>
- </tr>
- <tr>
- <td><p>services [optional]</p>
- </td>
- <td><p>The services folder contains the services deployed with Axis2/C.
+ </td></tr>
+ <tr class="a"><td><p>services [optional]</p>
+ </td><td><p>The services folder contains the services deployed with Axis2/C.
Each service deployed will have its own sub folder inside the
- services folder, or live inside one of the sub folders.<br />
+ services folder, or live inside one of the sub folders.<br></br>
At deployment, the Axis2/C deployment engine will traverse the
- services folders to find out what services are available.<br />
+ services folders to find out what services are available.<br></br>
The services folder is optional. If it is empty or non-existent, that
means that there are no deployed services.</p>
- </td>
- </tr>
- <tr>
- <td><p>axis2.xml</p>
- </td>
- <td><p>The axis2.xml file is the configuration file of Axis2/C.<br />
+ </td></tr>
+ <tr class="b"><td><p>axis2.xml</p>
+ </td><td><p>The axis2.xml file is the configuration file of Axis2/C.<br></br>
The configuration file is mandatory and must have the name axis2.xml.
It is safe to consider your Axis2/C repository to be the folder in
which you have the axis2.xml file.</p>
- </td>
- </tr>
- </tbody>
-</table>
-
-<p>Both clients as well as the services written using Axis2/C can use the
+ </td></tr>
+ </tbody></table><p>Both clients as well as the services written using Axis2/C can use the
same repository. However you can use one repository for the server side and
another one for the client side. The services folder is used only when the
repository is used by the server side. When the repository is used by the
-client, the services folder, if present, will not be used.</p>
-
-<p>The Axis2/C binary distribution, when extracted, can be considered as
+client, the services folder, if present, will not be used.</p><p>The Axis2/C binary distribution, when extracted, can be considered as
ready for use as your repository folder. If you are building Axis2/C from the
source distribution, when you build the source, including the samples, the
-installation destination will be ready for use as your repository folder.</p>
-
-<p>The simple axis server (that is axis2_http_server binary), the client
+installation destination will be ready for use as your repository folder.</p><p>The simple axis server (that is axis2_http_server binary), the client
samples, and the HTTPD module (Axis2 Apache2 module) require the repository
-folder to be specified in order to run correctly.</p>
-
-<p></p>
-
-<h2>2.1 Module Folders</h2>
-
-<p>As described earlier, all the modules are placed inside the modules folder
+folder to be specified in order to run correctly.</p><p></p><div class="subsection"><a name="2_1_Module_Folders"></a><h3>2.1 Module Folders</h3><p>As described earlier, all the modules are placed inside the modules folder
of the repository, and each module will have its own sub folder within the
-modules folder.<br />
+modules folder.<br></br>
The folder in which a module is placed must have the same name as the module
name. For example, the addressing module will be placed in a sub folder named
-addressing.<br />
-</p>
-
-<p>Inside the folder corresponding to a module, the shared library
+addressing.<br></br>
+</p><p>Inside the folder corresponding to a module, the shared library
implementing the module and the module configuration file, module.xml, is
placed. It is a must that these two files are present inside each folder
representing a module. The module.xml file will be processed by the
deployment engine to find out module specific information such as the module
name, set of handlers, the flows into which those handlers are to be added,
-etc.</p>
-
-<h2>2.2 Service Folders</h2>
-
-<p>All the services are placed inside the services folder of the repository,
+etc.</p></div><div class="subsection"><a name="2_2_Service_Folders"></a><h3>2.2 Service Folders</h3><p>All the services are placed inside the services folder of the repository,
and each service will be in one of the sub folders within the services
folder. Axis2/C has a concept called service groups, where there can be one
or more services inside a service group. A single stand alone service is
assigned a service group with the same name as that of the service by the
Axis2/C engine for the purpose of easy handling. Therefore the sub folders in
-the services folder correspond to the service groups.</p>
-
-<p>A service, if deployed as a stand alone service, will reside inside a
+the services folder correspond to the service groups.</p><p>A service, if deployed as a stand alone service, will reside inside a
folder with the same name as that of the service. For example, the echo
service will be placed in a sub folder named echo. The shared library
implementing the service and the service configuration file, the
@@ -473,319 +321,187 @@
Given the fact that the engine treats the folders to represent service groups
and not a single service, the configuration file is called services.xml.
However, you can always place a single service inside a single folder, which
-is the most common use case.</p>
-
-<p>Each sub folder within the services folder should have at least one shared
+is the most common use case.</p><p>Each sub folder within the services folder should have at least one shared
lib implementing a service and a services.xml file. If it is a real service
group, there will be multiple shared libs, yet there is only one services.xml
file configuring all those services. The services.xml file is processed by
the deployment engine to find out the service group and the service specific
information such as the service group name, service name, the set of
-operations for each service, etc.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="svc_api"></a>
-
-<h1>3. Service API</h1>
-
-<p>We have already seen how to write a service in the Quick Start Guide
+operations for each service, etc.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="svc_api"></a></p></div></div><div class="section"><a name="3__Service_API"></a><h2>3. Service API</h2><p>We have already seen how to write a service in the Quick Start Guide
section of this manual. This section covers the service API of Axis2/C in
-more detail.</p>
-
-<p><code>axis2_svc_skeleton</code> is an interface. Axis2/C does not provide
+more detail.</p><p><code>axis2_svc_skeleton</code> is an interface. Axis2/C does not provide
any concrete implementation of this interface. It is the responsibility of
the service implementer to implement this interface. To implement the
interface, you should implement the functions adhering to the function
pointer signatures of the members of the <code>axis2_svc_skeleton_ops</code>
struct. Then, a create function should be written to create an
<code>axis2_svc_skeleton</code> instance, and assign the implementing
-functions to the members of the ops member of service skeleton.</p>
-
-<p>The following table details the signatures of the function pointer members
-of the <code>axis2_svc_skeleton</code> struct implemented by a service.</p>
-
-<table border="1">
- <caption></caption>
- <tbody>
- <tr>
- <th>Function Signature</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><pre>int (AXIS2_CALL *
+functions to the members of the ops member of service skeleton.</p><p>The following table details the signatures of the function pointer members
+of the <code>axis2_svc_skeleton</code> struct implemented by a service.</p><table class="bodyTable"><caption></caption><tbody>
+ <tr class="a"><th>Function Signature</th><th>Description</th></tr>
+ <tr class="b"><td><pre>int (AXIS2_CALL *
init)(axis2_svc_skeleton_t *svc_skeleton,
const axutil_env_t *env);</pre>
- </td>
- <td>Initializes the service skeleton object instance. The Axis2/C
+ </td><td>Initializes the service skeleton object instance. The Axis2/C
engine initializes a service skeleton instance once per deployed
- service, during the first request made to the service.</td>
- </tr>
- <tr>
- <td width="410"><pre>axiom_node_t *(AXIS2_CALL*
+ service, during the first request made to the service.</td></tr>
+ <tr class="a"><td width="410"><pre>axiom_node_t *(AXIS2_CALL*
invoke )( axis2_svc_skeleton_t *svc_skeli,
const axutil_env_t *env,
axiom_node_t *node,
axis2_msg_ctx_t *msg_ctx);</pre>
- </td>
- <td>Invokes the service implementation. You have to implement the logic
+ </td><td>Invokes the service implementation. You have to implement the logic
to call the correct functions in this method based on the name of the
- operation being invoked.</td>
- </tr>
- <tr>
- <td><pre>axiom_node_t *(AXIS2_CALL*
+ operation being invoked.</td></tr>
+ <tr class="b"><td><pre>axiom_node_t *(AXIS2_CALL*
on_fault)(
axis2_svc_skeleton_t *svc_skeli,
const axutil_env_t *env,
axiom_node_t *node);</pre>
- </td>
- <td>This method is called by the engine if a fault is detected.</td>
- </tr>
- <tr>
- <td><pre>axis2_status_t (AXIS2_CALL *
+ </td><td>This method is called by the engine if a fault is detected.</td></tr>
+ <tr class="a"><td><pre>axis2_status_t (AXIS2_CALL *
free )( axis2_svc_skeleton_t *svc_skeli,
const axutil_env_t *env);</pre>
- </td>
- <td>Frees the service implementation instance.</td>
- </tr>
- </tbody>
-</table>
-<br />
-
-
-<p>There are two more methods that a service should implement. Once a service
+ </td><td>Frees the service implementation instance.</td></tr>
+ </tbody></table><br></br><p>There are two more methods that a service should implement. Once a service
is deployed, the message receiver of the Axis2/C engine has to create a
service instance at run time for the purpose of invoking it. For this, it
looks for a method named <code>axis2_create_instance</code> and calls it on
the service shared library. The engine also looks for a function named
<code>axis2_remove_instance</code> in the shared library for clean up
-purposes.</p>
-
-<table border="1">
- <caption></caption>
- <tbody>
- <tr>
- <th>Function Signature</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><pre>AXIS2_EXPORT int
+purposes.</p><table class="bodyTable"><caption></caption><tbody>
+ <tr class="b"><th>Function Signature</th><th>Description</th></tr>
+ <tr class="a"><td><pre>AXIS2_EXPORT int
axis2_get_instance(
axis2_svc_skeleton_t ** inst,
const axutil_env_t * env);</pre>
- </td>
- <td>Creates an instance of the service. You have to implement the logic
- of creating the service object, allocating memory etc. in this method.</td>
- </tr>
- <tr>
- <td width="410"><pre>AXIS2_EXPORT int
+ </td><td>Creates an instance of the service. You have to implement the logic
+ of creating the service object, allocating memory etc. in this method.</td></tr>
+ <tr class="b"><td width="410"><pre>AXIS2_EXPORT int
axis2_remove_instance(
axis2_svc_skeleton_t * inst,
const axutil_env_t * env);</pre>
- </td>
- <td>Removes the instance of the service. Do any cleaning-up and
- deallocations here.</td>
- </tr>
- </tbody>
-</table>
-<br />
-
-<p>Note that service object instantiation happens once per service. When the
+ </td><td>Removes the instance of the service. Do any cleaning-up and
+ deallocations here.</td></tr>
+ </tbody></table><br></br><p>Note that service object instantiation happens once per service. When the
first request is received by the service, a service skeleton instance is
created and initialized. The same object instance will be re-used by the
-subsequent requests.</p>
-
-<p>You can find an example on how to implement the service skeleton interface
+subsequent requests.</p><p>You can find an example on how to implement the service skeleton interface
in the <a href="hello/service/hello_svc.c.html">hello_svc.c</a> source file,
which is the example used in the <a href="#quick_start">Quick Start
Guide</a>. More advanced samples can be found in the samples folder of the
-Axis2/C distribution.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="client_api"></a>
-
-<h1>4. Client API</h1>
-
-<p>The primary client API to be used with Axis2/C is
+Axis2/C distribution.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="client_api"></a></p></div><div class="section"><a name="4__Client_API"></a><h2>4. Client API</h2><p>The primary client API to be used with Axis2/C is
<code>axis2_svc_client</code>, the service client API. This is meant to be an
easy to use API for consuming services. If you want to do more complex tasks,
such as invoking a client inside a module, or wrap the client API with
another interface, you may need to use <code>axis2_op_client</code>, the
operation client API. For most of the use cases, the service client API is
-sufficient.</p>
-
-<p>The behavior of the service client can be fine tuned with the options
+sufficient.</p><p>The behavior of the service client can be fine tuned with the options
passed to the service client. You can set the options by creating an
<code>axis2_options</code> instance. The bare minimum that you need to set is
the endpoint URI to which the request is to be sent. An example of this was
-given in the <a href="#quick_start">Quick Start Guide section</a>.</p>
-
-<p>The service client interface serves as the primary client interface for
+given in the <a href="#quick_start">Quick Start Guide section</a>.</p><p>The service client interface serves as the primary client interface for
consuming services. You can set the options to be used by the service client
and then invoke an operation on a given service. There are several ways of
invoking a service operation. The method of invoking an operation depends on
-3 things. They are,</p>
-<ol>
+3 things. They are,</p><ol>
<li>The Message Exchange Pattern (MEP)</li>
<li>Synchronous/Asynchronous behavior (Blocking/Non-Blocking)</li>
<li>Two-way or one-way transport</li>
-</ol>
-
-<p>Many service operation invocation scenarios can be obtained by combining
+</ol><p>Many service operation invocation scenarios can be obtained by combining
the above three factors. The service client interface provides the necessary
-API calls to achieve this.</p>
-
-<p>Deciding the Message Exchange Pattern (MEP)</p>
-
-<p>There are 2 message exchange patterns.</p>
-<ol>
+API calls to achieve this.</p><p>Deciding the Message Exchange Pattern (MEP)</p><p>There are 2 message exchange patterns.</p><ol>
<li>Out-Only</li>
<li>Out-In</li>
-</ol>
-
-<p>In the Out-Only MEP, the client doesn't expect a reply from the server.
-The service client provides two methods of using the Out-Only MEP.</p>
-
-<p></p>
-
-<table border="1">
- <caption></caption>
- <tbody>
- <tr>
- <th>Function Signature</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><pre>AXIS2_EXTERN void AXIS2_CALL
+</ol><p>In the Out-Only MEP, the client doesn't expect a reply from the server.
+The service client provides two methods of using the Out-Only MEP.</p><p></p><table class="bodyTable"><caption></caption><tbody>
+ <tr class="a"><th>Function Signature</th><th>Description</th></tr>
+ <tr class="b"><td><pre>AXIS2_EXTERN void AXIS2_CALL
axis2_svc_client_fire_and_forget(
axis2_svc_client_t * svc_client,
const axutil_env_t * env,
const axiom_node_t * payload);</pre>
- </td>
- <td>Sends a message and forgets about it. This method is used to interact
+ </td><td>Sends a message and forgets about it. This method is used to interact
with a service operation whose MEP is In-Only. There is no way of getting
an error from the service using this method. However, you may still get
- client-side errors, such as host unknown.</td>
- </tr>
- <tr>
- <td width="410"><pre>AXIS2_EXTERN axis2_status_t AXIS2_CALL
+ client-side errors, such as host unknown.</td></tr>
+ <tr class="a"><td width="410"><pre>AXIS2_EXTERN axis2_status_t AXIS2_CALL
axis2_svc_client_send_robust(
axis2_svc_client_t * svc_client,
const axutil_env_t * env,
const axiom_node_t * payload);</pre>
- </td>
- <td>This method too is used to interact with a service operation whose MEP
+ </td><td>This method too is used to interact with a service operation whose MEP
is In-Only. However, unlike <code>axis2_svc_client_fire_and_forget</code>,
this function reports an error back to the caller if a fault triggers on
- the server side.<br />When using Out-In MEP, the client expects a reply
+ the server side.<br></br>When using Out-In MEP, the client expects a reply
from the server. <code>axis2_svc_client_send_receive</code> and <code>
axis2_svc_client_send_receive_non_blocking</code>functions support this
- MEP</td>
- </tr>
- <tr>
- <td><pre> AXIS2_EXTERN axiom_node_t *AXIS2_CALL
+ MEP</td></tr>
+ <tr class="b"><td><pre> AXIS2_EXTERN axiom_node_t *AXIS2_CALL
axis2_svc_client_send_receive(
axis2_svc_client_t * svc_client,
const axutil_env_t * env,
const axiom_node_t * payload);</pre>
- </td>
- <td>This method is used to interact with a service operation whose MEP is
- In-Out. It sends an XML request and receives an XML response.<br />Returns
+ </td><td>This method is used to interact with a service operation whose MEP is
+ In-Out. It sends an XML request and receives an XML response.<br></br>Returns
a pointer to the AXIOM node representing the XML response. This method
- blocks the client until the response arrives.</td>
- </tr>
- <tr>
- <td><pre>AXIS2_EXTERN void AXIS2_CALL
+ blocks the client until the response arrives.</td></tr>
+ <tr class="a"><td><pre>AXIS2_EXTERN void AXIS2_CALL
axis2_svc_client_send_receive_non_blocking(
axis2_svc_client_t * svc_client,
const axutil_env_t * env,
const axiom_node_t * payload,
axis2_callback_t * callback);</pre>
- </td>
- <td>This method too, is used to interact with a service operation whose MEP
+ </td><td>This method too, is used to interact with a service operation whose MEP
is In-Out. It sends an XML request and receives an XML response, but the
- client does not block for the response.<br />In this method, the client
+ client does not block for the response.<br></br>In this method, the client
does not block for the response, but instead it expects the user to set a
- call back to capture the response.</td>
- </tr>
- </tbody>
-</table>
-<br />
-
-<p>Please have a look at the <code>axis2_svc_client.h</code> header file for
+ call back to capture the response.</td></tr>
+ </tbody></table><br></br><p>Please have a look at the <code>axis2_svc_client.h</code> header file for
more information on the above mentioned functions, as well as their synonyms
-that accept an operation's qualified name.</p>
-
-<h2>4.1 Synchronous vs. Asynchronous Behavior (Blocking/Non-Blocking)</h2>
-
-<p>This will determine whether the client would block for the response
+that accept an operation's qualified name.</p><div class="subsection"><a name="4_1_Synchronous_vs__Asynchronous_Behavior__Blocking_Non-Blocking_"></a><h3>4.1 Synchronous vs. Asynchronous Behavior (Blocking/Non-Blocking)</h3><p>This will determine whether the client would block for the response
(synchronous) or return immediately expecting the response to be handled by a
callback (asynchronous, in other words non-blocking) in an Out-In MEP
-scenario.<br />
+scenario.<br></br>
<code>axis2_svc_client_send_receive</code> operates in synchronous mode,
whereas <code>axis2_svc_client_send_receive_non_blocking</code> operates in
-asynchronous mode.<br />
-</p>
-
-<h2>4.2 Two-Way or One-Way Transport</h2>
-
-<p>If the transport is two-way, then only one channel is used, which means
+asynchronous mode.<br></br>
+</p></div><div class="subsection"><a name="4_2_Two-Way_or_One-Way_Transport"></a><h3>4.2 Two-Way or One-Way Transport</h3><p>If the transport is two-way, then only one channel is used, which means
the request is sent and the response is received on the same channel. If the
transport is one-way, then the request is sent on one channel and the
-response is received on a separate channel.<br />
+response is received on a separate channel.<br></br>
If we want to use a separate channel for the response, a separate listener
has to be started to receive the response, This can be done by setting the
separate listener option to True using the
<code>axis2_options_set_use_separate_listener</code> function above the
-options.</p>
-
-<p>Please have a look at the <code>echo_blocking_dual</code> sample to see
-how to set the separate channel option.</p>
-
-<p>Please see <a href="#appD">Appendix D</a> for further details on setting
-options.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="rest"></a>
-
-<h1>5. REST</h1>
-
-<p>Axis2/C comes with plain old XML (POX) like REST support. A given service
+options.</p><p>Please have a look at the <code>echo_blocking_dual</code> sample to see
+how to set the separate channel option.</p><p>Please see <a href="#appD">Appendix D</a> for further details on setting
+options.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="rest"></a></p></div></div><div class="section"><a name="5__REST"></a><h2>5. REST</h2><p>Axis2/C comes with plain old XML (POX) like REST support. A given service
can be exposed both as a SOAP service as well as a REST service. If you want
to consume Web services using REST style calls, you can use either the HTTP
-POST method or the HTTP GET method.</p>
-
-<p>The following example code fragment shows how to enable a REST style
+POST method or the HTTP GET method.</p><p>The following example code fragment shows how to enable a REST style
invocation.</p>
-<pre>axis2_options_set_enable_rest(options, env, AXIS2_TRUE);</pre>
-
-<p>You can use the same code that you use with a SOAP call, and do REST style
-invocation by just enabling REST using the option setting shown above.</p>
+ <div class="source"><pre>axis2_options_set_enable_rest(options, env, AXIS2_TRUE);
-<p>The default HTTP method used with REST is HTTP POST. If you need to change
+</pre></div>
+ <p>You can use the same code that you use with a SOAP call, and do REST style
+invocation by just enabling REST using the option setting shown above.</p><p>The default HTTP method used with REST is HTTP POST. If you need to change
it to the HTTP GET method, the following needs to be done.</p>
-<pre>axis2_options_set_http_method(options, env, AXIS2_HTTP_GET);</pre>
+ <div class="source"><pre>axis2_options_set_http_method(options, env, AXIS2_HTTP_GET);
-<p>Please have a look at the <code>echo_rest</code> sample for a complete
-source code on how to use REST.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="mtom"></a>
-
-<h1>6. MTOM</h1>
-
-<p>Axis2/C allows you to send and receive binary data with SOAP messages
+</pre></div>
+ <p>Please have a look at the <code>echo_rest</code> sample for a complete
+source code on how to use REST.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="mtom"></a></p></div><div class="section"><a name="6__MTOM"></a><h2>6. MTOM</h2><p>Axis2/C allows you to send and receive binary data with SOAP messages
using MTOM/XOP conventions. When sending and receiving attachments, you have
to use the service client (<code>axis2_svc_client</code>) API to perform the
send and receive operations, and provide or consume binary data in relation
-to the AXIOM payloads.</p>
-
-<p>In order to send a binary attachment, you need to build the AXIOM payload
+to the AXIOM payloads.</p><p>In order to send a binary attachment, you need to build the AXIOM payload
and attach the data handler with binary content to the payload.</p>
-<pre><soapenv:Body>
+ <div class="source"><pre><soapenv:Body>
<ns1:mtomSample xmlns:ns1="http://ws.apache.org/axis2/c/samples/mtom">
<ns1:fileName>test.jpg</ns1:fileName>
<ns1:image>
@@ -793,39 +509,28 @@
href="cid:1.f399248e-8b39-1db1-3124-0015c53de2e5@apache.org"></xop:Include>
</ns1:image>
</ns1:mtomSample>
-</soapenv:Body></pre>
+</soapenv:Body>
-<p>In the above sample payload shown, we place our image file as text within
+</pre></div>
+ <p>In the above sample payload shown, we place our image file as text within
an image element</p>
-<pre>image_om_ele = axiom_element_create(env, mtom_om_node, "image", ns1, &image_om_node);
+ <div class="source"><pre>image_om_ele = axiom_element_create(env, mtom_om_node, "image", ns1, &image_om_node);
data_handler = axiom_data_handler_create(env, image_name, "image/jpeg");
-data_text = axiom_text_create_with_data_handler(env, image_om_node, data_handler, &data_om_node);</pre>
+data_text = axiom_text_create_with_data_handler(env, image_om_node, data_handler, &data_om_node);
-<p>When sending attachments, you can configure the client either to send the
-attachment in the optimized format or non-optimized format.</p>
-
-<p>To do this, set the option <code>axis2_options_set_enable_mtom(options,
+</pre></div>
+ <p>When sending attachments, you can configure the client either to send the
+attachment in the optimized format or non-optimized format.</p><p>To do this, set the option <code>axis2_options_set_enable_mtom(options,
env, AXIS2_TRUE);</code>or the setting
-<code><enableMtom>true</enableMtom> </code>in axis2.xml</p>
-
-<p>If enableMTOM is set to True, the attachment is sent as it is, out of the
+<code><enableMtom>true</enableMtom> </code>in axis2.xml</p><p>If enableMTOM is set to True, the attachment is sent as it is, out of the
SOAP body, using MIME headers. Also the payload will have an XOP:Include
element, referring to the MIME part that contains the binary attachment.
Sending the attachment as it is, in pure binary format, is called binary
optimized format. In the case of binary non-optimized format, where
enableMTOM is False, the attachment content is sent in the payload itself, as
-a base64 encoded string.</p>
-
-<p>Please have a look at the <code>mtom</code> sample for a complete example
-on how to use MTOM.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="engaging_module"></a>
-
-<h1>7. Engaging a Module</h1>
-
-<p>A module is a set of handlers that helps to extend the message processing
+a base64 encoded string.</p><p>Please have a look at the <code>mtom</code> sample for a complete example
+on how to use MTOM.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="engaging_module"></a></p></div><div class="section"><a name="7__Engaging_a_Module"></a><h2>7. Engaging a Module</h2><p>A module is a set of handlers that helps to extend the message processing
behavior of the Axis2/C engine. Modules have the concepts of being Available
and Engaged associated with them. Available means modules are deployed in the
system but not activated. They will be activated only after being engaged.
@@ -842,26 +547,17 @@
engage that module. Engaging a module means correctly adding the handlers of
a particular module to one or more phases. Once the module is engaged, the
handlers and the operations defined in the module are added to the entity
-that engaged them.</p>
-
-<p>Before engaging a module, the following steps have to be followed.</p>
-<ol>
+that engaged them.</p><p>Before engaging a module, the following steps have to be followed.</p><ol>
<li>Write the module.xml file</li>
<li>Package the module libraries and the module.xml into a folder which has
the same name as the module</li>
<li>Deploy the folder in AXIS2C_INSTALL_DIR/modules</li>
<li>Add the module specific phases in the axis2.xml file</li>
-</ol>
-
-<p>The following is an example of engaging a sample module called the logging
-module with Axis2/C:</p>
-
-<h2>7.1 Writing the module.xml File</h2>
-
-<p>In the module.xml file, the handlers of the module and the phases to which
+</ol><p>The following is an example of engaging a sample module called the logging
+module with Axis2/C:</p><div class="subsection"><a name="7_1_Writing_the_module_xml_File"></a><h3>7.1 Writing the module.xml File</h3><p>In the module.xml file, the handlers of the module and the phases to which
they are to be added have to be specified. Below is the module.xml file of
the sample logging module.</p>
-<pre> <module name="logging" class="axis2_mod_log">
+ <div class="source"><pre> <module name="logging" class="axis2_mod_log">
<inflow>
<handler name="LoggingInHandler" class="axis2_mod_log">
<order phase="PreDispatch"/>
@@ -877,47 +573,37 @@
<order phase="MessageOut"/>
</handler>
</Outfaultflow>
- </module></pre>
+ </module>
-<p>In the above shown module configuration file, the name of the module is
+</pre></div>
+ <p>In the above shown module configuration file, the name of the module is
logging. There are two handlers in this module, the LoggingInHandler and the
LoggingOutHandler. The LoggingInHandler is placed into the PreDispatch phase
of the in flow. The LoggingOutHandler is placed into the MessageOut phase of
-both the out flow and the fault out flow.</p>
-
-<h2>7.2 Packaging and Deploying the Module</h2>
-
-<p>The above module.xml file should be copied to a folder named "logging"
+both the out flow and the fault out flow.</p></div><div class="subsection"><a name="7_2_Packaging_and_Deploying_the_Module"></a><h3>7.2 Packaging and Deploying the Module</h3><p>The above module.xml file should be copied to a folder named "logging"
(because the module name is "logging") inside the AXIS2C_INSTALL_DIR/modules
folder. The module libraries containing the handler implementation should
also be copied to the same folder. According to the module.xml file shown
above, the name of the shared library file should be libaxis2_mod_log.so on
-Linux and axis2_mod_log.dll on MS Windows.</p>
-
-<h2>7.3 Adding Module Specific Phases to the axis2.xml File</h2>
-
-<p>Module specific phases have to be added after the system predefined
+Linux and axis2_mod_log.dll on MS Windows.</p></div><div class="subsection"><a name="7_3_Adding_Module_Specific_Phases_to_the_axis2_xml_File"></a><h3>7.3 Adding Module Specific Phases to the axis2.xml File</h3><p>Module specific phases have to be added after the system predefined
phases. The following example shows where to add the module specific phases.
Look for the <code>phaseOrder</code> elements in the axis2.xml file. Note the
comment lines:</p>
-<pre> <!-- User defined phases could be added here --></pre>
+ <div class="source"><pre> <!-- User defined phases could be added here --></pre></div>
+ <p>
You can add user defined phases after the above comment line into any of the
flows. The <code>type</code> attribute of the <code>phaseOrder</code> element
indicates the flow.
-<p>For the logging module example, user defined phases are not required. All
+</p><p>For the logging module example, user defined phases are not required. All
the module specific handlers are added to system predefined phases as
-specified in the module.xml file.</p>
-
-<h2>7.4 Engaging a Module to a Services</h2>
-
-<p>The following is an example of engaging the logging module to the echo
+specified in the module.xml file.</p></div><div class="subsection"><a name="7_4_Engaging_a_Module_to_a_Services"></a><h3>7.4 Engaging a Module to a Services</h3><p>The following is an example of engaging the logging module to the echo
service. This can be done by simply adding <code><module ref
="logging"/></code> in the services.xml file of the echo service. This
informs the Axis2/C engine that the module "logging" should be engaged for
this service. The handlers inside the module will be executed in their
respective phases as described by the module.xml.</p>
-<pre> <service name="echo">
+ <div class="source"><pre> <service name="echo">
<module ref ="logging"/>
<parameter name="ServiceClass" locked="xsd:false">echo</parameter>
<description>
@@ -929,220 +615,148 @@
http://ws.apache.org/axis2/c/samples/echoString
</parameter>
</operation>
- </service></pre>
+ </service>
-<p>One important thing to note here is that because the logging module's
+</pre></div>
+ <p>One important thing to note here is that because the logging module's
handlers are placed into the global phases, even though the logging module is
engaged only to the echo service, the module will be engaged globally. This
is a feature of the Axis2 architecture, not a bug. When invoked, the handlers
in a module can check whether the module has been engaged to a particular
-service, and act accordingly.</p>
-
-<h3>7.4.1 Engaging a Module Globally</h3>
-
-<p>If we want to engage a module for every service deployed in the Axis2/C
+service, and act accordingly.</p></div><div class="subsection"><a name="7_4_1_Engaging_a_Module_Globally"></a><h3>7.4.1 Engaging a Module Globally</h3><p>If we want to engage a module for every service deployed in the Axis2/C
system, we can add the <code><module ref ="logging"/></code> entry in
the axis2.xml file. This will inform the Axis2/C engine to invoke the
handlers associated with the module for every message coming in or going out
-for all the services deployed.</p>
-
-<h2>7.5 Engaging a Module on the Client Side</h2>
-
-<p>On the client side, if <code><module ref ="logging"/></code> is
+for all the services deployed.</p></div><div class="subsection"><a name="7_5_Engaging_a_Module_on_the_Client_Side"></a><h3>7.5 Engaging a Module on the Client Side</h3><p>On the client side, if <code><module ref ="logging"/></code> is
added in the axis2.xml, the handlers specific to the logging module will be
invoked for every request the client sends and every response the client
receives. If only a particular client wants to engage the module, it can be
done by engaging the module programmatically. This can be done by adding the
following line in the client code after setting the options.</p>
-<pre>axis2_svc_client_engage_module(svc_client, env, "module-name");</pre>
+ <div class="source"><pre>axis2_svc_client_engage_module(svc_client, env, "module-name");
-<p>Remember to replace "module-name" with the name of the module you want to
+</pre></div>
+ <p>Remember to replace "module-name" with the name of the module you want to
engage. For example to engage the logging module you can use:</p>
-<pre>axis2_svc_client_engage_module(svc_client, env, "logging");</pre>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="ws_addressing"></a>
+ <div class="source"><pre>axis2_svc_client_engage_module(svc_client, env, "logging");
-<h1>8. WS-Addressing</h1>
-
-<p><a href="http://www.w3.org/2002/ws/addr/">WS-Addressing</a> provides
+</pre></div>
+ <p style="margin-bottom: 0in"><br></br>
+</p><p><a name="ws_addressing"></a></p></div></div><div class="section"><a name="8__WS-Addressing"></a><h2>8. WS-Addressing</h2><p><a href="http://www.w3.org/2002/ws/addr/" class="externalLink" title="External Link">WS-Addressing</a> provides
mechanisms to address Web services and messages. With Axis2/C, you can use
-both WS-Addressing <a href="http://www.w3.org/TR/ws-addr-core/">version
-1.0</a> as well as the <a
-href="http://www.w3.org/Submission/ws-addressing/">submission version</a>.</p>
-
-<p>WS-Addressing is implemented as a module in Axis2/C. Hence as explained in
+both WS-Addressing <a href="http://www.w3.org/TR/ws-addr-core/" class="externalLink" title="External Link">version
+1.0</a> as well as the <a href="http://www.w3.org/Submission/ws-addressing/" class="externalLink" title="External Link">submission version</a>.</p><p>WS-Addressing is implemented as a module in Axis2/C. Hence as explained in
the previous section, the addressing module can be engaged both on the client
-side as well as on the server side.</p>
-
-<p>The WS-Addressing module can be globally engaged by adding the
-<code><module ref="addressing"/></code> line to the axis2.xml file.</p>
-
-<p>The WS-Addressing module can also be programmatically engaged using the
-following line of code with the service client API <br />
+side as well as on the server side.</p><p>The WS-Addressing module can be globally engaged by adding the
+<code><module ref="addressing"/></code> line to the axis2.xml file.</p><p>The WS-Addressing module can also be programmatically engaged using the
+following line of code with the service client API <br></br>
</p>
-<pre>axis2_svc_client_engage_module(svc_client, env, AXIS2_MODULE_ADDRESSING);</pre>
+ <div class="source"><pre>axis2_svc_client_engage_module(svc_client, env, AXIS2_MODULE_ADDRESSING);
-<p>WS-Addressing related options can be set using the
+</pre></div>
+ <p>WS-Addressing related options can be set using the
<code>axis2_options</code> struct instance on the client side. If the
addressing module is engaged, there are no options to be set on the server
side. The server will employ WS-Addressing if the incoming requests have
-WS-Addressing headers.</p>
-
-<p>There is a mandatory requirement for using WS-Addressing on the client
+WS-Addressing headers.</p><p>There is a mandatory requirement for using WS-Addressing on the client
side with Axis2/C. That is to set a WS-Addressing action that represents the
operation to be invoked. Example:</p>
-<pre>axis2_options_set_action(options,env,"http://ws.apache.org/axis2/c/samples/echoString")</pre>
+ <div class="source"><pre>axis2_options_set_action(options,env,"http://ws.apache.org/axis2/c/samples/echoString")
-<p>In addition to the action, which is mandatory, there are other
+</pre></div>
+ <p>In addition to the action, which is mandatory, there are other
WS-Addressing related headers that can be sent in a message. Axis2/C supports
to set those headers as options at the client level. The following functions
are used to set them.</p>
-<pre>axis2_options_set_reply_to(options, env, reply_to)</pre>
+ <div class="source"><pre>axis2_options_set_reply_to(options, env, reply_to)
-<p>Sets the <code>wsa:ReplyTo</code> header. The ReplyTo header contains the
+</pre></div>
+ <p>Sets the <code>wsa:ReplyTo</code> header. The ReplyTo header contains the
endpoint to send reply messages. The ReplyTo header is required when the
response comes in a separate channel (when using a dual channel).</p>
-<pre>axis2_options_set_fault_to(options, env, fault_to)</pre>
+ <div class="source"><pre>axis2_options_set_fault_to(options, env, fault_to)
-<p>Sets the <code>wsa:FaultTo</code> header. This contains the endpoint to
+</pre></div>
+ <p>Sets the <code>wsa:FaultTo</code> header. This contains the endpoint to
direct fault messages.</p>
-<pre>axis2_options_set_from(options, env, from)</pre>
+ <div class="source"><pre>axis2_options_set_from(options, env, from)
-<p>Sometimes the receiving endpoint requires to know the original sender of
+</pre></div>
+ <p>Sometimes the receiving endpoint requires to know the original sender of
the message. The <code>wsa:From</code> header is used in such cases. The
above function sets the From header.</p>
-<pre>axis2_options_set_relates_to(options, env, relates_to)</pre>
+ <div class="source"><pre>axis2_options_set_relates_to(options, env, relates_to)
-<p>Sets the <code>wsa:RelatesTo</code> header. This header contains a unique
+</pre></div>
+ <p>Sets the <code>wsa:RelatesTo</code> header. This header contains a unique
ID which is the message ID of a previously exchanged message. It helps to
-identify a previous message that relates to the current message.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="writing_module"></a>
-
-<h1>9. Writing a Module</h1>
-
-<p>A module is an extension point in the Axis2/C engine. Modules are
+identify a previous message that relates to the current message.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="writing_module"></a></p></div><div class="section"><a name="9__Writing_a_Module"></a><h2>9. Writing a Module</h2><p>A module is an extension point in the Axis2/C engine. Modules are
primarily used to WS-* specifications. In other words, quality of service
aspects such as security and reliable messaging can be implemented as modules
-and deployed with the Axis2/C engine. <br />
+and deployed with the Axis2/C engine. <br></br>
A SOAP message can contain any number of header blocks. These header blocks
provide various processing information. In Axis2/C, these various header
blocks are processed by modules. Some times modules may add header blocks to
-a SOAP message.</p>
-
-<p>Normally a module is a collection of handlers. So writing a module mainly
+a SOAP message.</p><p>Normally a module is a collection of handlers. So writing a module mainly
consists of writing handlers. There are two interfaces that are important
when writing a module. They are <code>axis2_module</code> and
-<code>axis2_handler<code>.</code></code></p>
-
-<p>Every module should have three basic functions that are defined as
+<code>axis2_handler<code>.</code></code></p><p>Every module should have three basic functions that are defined as
function pointer members of the <code>axis2_module_ops</code> struct. This
-struct is defined in the <code>axis2_module.h</code> header file.</p>
-
-<table border="1">
- <caption></caption>
- <tbody>
- <tr>
- <th>Function Signature</th>
- <th>Description</th>
- </tr>
- <tr>
- <td><pre>axis2_status_t (AXIS2_CALL *
+struct is defined in the <code>axis2_module.h</code> header file.</p><table class="bodyTable"><caption></caption><tbody>
+ <tr class="b"><th>Function Signature</th><th>Description</th></tr>
+ <tr class="a"><td><pre>axis2_status_t (AXIS2_CALL *
init)(axis2_module_t *module, const
axutil_env_t *env,
axis2_conf_ctx_t *conf_ctx,
axis2_module_desc_t *module_desc);</pre>
- </td>
- <td>This function takes care of the module initialization.</td>
- </tr>
- <tr>
- <td width="410"><pre>axis2_status_t (AXIS2_CALL *
+ </td><td>This function takes care of the module initialization.</td></tr>
+ <tr class="b"><td width="410"><pre>axis2_status_t (AXIS2_CALL *
shutdown)(axis2_module_t *module,
const axutil_env_t *env );</pre>
- </td>
- <td>Shuts down and cleans up the module.</td>
- </tr>
- <tr>
- <td><pre>axis2_status_t (AXIS2_CALL *
+ </td><td>Shuts down and cleans up the module.</td></tr>
+ <tr class="a"><td><pre>axis2_status_t (AXIS2_CALL *
fill_handler_create_func_map)(axis2_module_t *module,
const axutil_env_t *env );</pre>
- </td>
- <td>This function fills the hash map of the handler create functions for
- the module.</td>
- </tr>
- </tbody>
-</table>
-
-<p>The module developer has to implement functions with the above signatures
+ </td><td>This function fills the hash map of the handler create functions for
+ the module.</td></tr>
+ </tbody></table><p>The module developer has to implement functions with the above signatures
and assign them to the members of an <code>axis2_module_ops</code> struct
instance. Then that struct instance has to be assigned to the ops member of
-an <code>axis2_module</code> struct instance.</p>
-
-<p><a href="mod_log/mod_log.c.html">mod_log.c</a> has the source for the
+an <code>axis2_module</code> struct instance.</p><p><a href="mod_log/mod_log.c.html">mod_log.c</a> has the source for the
logging module. Please have a look at the <code>axis2_mod_log_create</code>
function in it to see how an <code>axis2_module</code> instance is allocated
-and how the ops are initialized.</p>
-
-<p>The<code> axis2_mod_log_fill_handler_create_func_map</code> function adds
+and how the ops are initialized.</p><p>The<code> axis2_mod_log_fill_handler_create_func_map</code> function adds
the handler create functions to the module's hash map, which stores the
-handler create functions. In the <a
-href="mod_log/mod_log.c.html">mod_log.c</a> example, the logging module adds
+handler create functions. In the <a href="mod_log/mod_log.c.html">mod_log.c</a> example, the logging module adds
two handlers. The in handler and the out handler that deals with logging
-along with the in-flow and out-flow respectively.</p>
-
-<h2>9.1 Writing Handlers</h2>
-
-<p>A handler is the smallest unit of execution in the Axis2/C engine's
+along with the in-flow and out-flow respectively.</p><div class="subsection"><a name="9_1_Writing_Handlers"></a><h3>9.1 Writing Handlers</h3><p>A handler is the smallest unit of execution in the Axis2/C engine's
execution flow. The engine can have two flows, the in-flow and the out-flow.
A flow is a collection of phases, and a phase in turn is a collection of
handlers. A handler is invoked when the phase within which it lives is
invoked. Axis2/C defines an interface called <code>axis2_handler</code>,
-which is to be implemented by all the handlers.</p>
-
-<p><a href="mod_log/log_in_handler.c.html">log_in_handler.c</a> contains the
+which is to be implemented by all the handlers.</p><p><a href="mod_log/log_in_handler.c.html">log_in_handler.c</a> contains the
source code of the in-handler of the logging module. Please have a look at
the <code>axutil_log_in_handler_create</code> function to see how an
<code>axis2_handler</code> instance is created and how the invoke function
implementation, <code>axis2_log_in_handler_invoke</code> is assigned to the
<code>axis2_handler</code> invoke function pointer. The invoke is called to
do the actual work assigned to the handler. The phase that owns the handler
-is responsible for calling the invoke function of the handler.</p>
-
-<p><a href="mod_log/log_out_handler.c.html">log_out_handler.c</a> contains
+is responsible for calling the invoke function of the handler.</p><p><a href="mod_log/log_out_handler.c.html">log_out_handler.c</a> contains
the source code of the out handler of the logging module. The implementation
is similar to the in handler, except that it is placed along the out-flow
-when deployed.</p>
-
-<h2>9.2 Writing the module.xml File</h2>
-
-<p>After writing the module, the module.xml file should be written. The
+when deployed.</p></div><div class="subsection"><a name="9_2_Writing_the_module_xml_File"></a><h3>9.2 Writing the module.xml File</h3><p>After writing the module, the module.xml file should be written. The
module.xml file contains all the configuration details for a particular
module. Please see the sample <a href="mod_log/module.xml">module.xml</a>
-file for the logging module.</p>
-
-<p>Please see the <a href="#engaging_module">Engaging a Module</a> section
-for more details on how to package and deploy the module.</p>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="simple_axis_server"></a>
-
-<h1>10. Simple Axis2 HTTP Server</h1>
-
-<p>Simple Axis2 HTTP Server is the inbuilt HTTP server of Axis2/C.<br />
-</p>
-
-<h2>10.1 Linux Based Systems</h2>
-
-<p>Synopsis :</p>
-<pre> axis2_http_server [-p PORT] [-t TIMEOUT] [-r REPO_PATH] [-l LOG_LEVEL] [-f LOG_FILE] [-s LOG_FILE_SIZE]</pre>
-
-<p>You can use the following options with simple axis HTTP server.</p>
-<pre> -p PORT port number to use, default port is 9090
+file for the logging module.</p><p>Please see the <a href="#engaging_module">Engaging a Module</a> section
+for more details on how to package and deploy the module.</p><p style="margin-bottom: 0in"><br></br>
+</p><p><a name="simple_axis_server"></a></p></div></div><div class="section"><a name="10__Simple_Axis2_HTTP__Server"></a><h2>10. Simple Axis2 HTTP Server</h2><p>Simple Axis2 HTTP Server is the inbuilt HTTP server of Axis2/C.<br></br>
+</p><div class="subsection"><a name="10_1_Linux_Based_Systems"></a><h3>10.1 Linux Based Systems</h3><p>Synopsis :</p>
+ <div class="source"><pre> axis2_http_server [-p PORT] [-t TIMEOUT] [-r REPO_PATH] [-l LOG_LEVEL] [-f LOG_FILE] [-s LOG_FILE_SIZE]
+
+</pre></div>
+ <p>You can use the following options with simple axis HTTP server.</p>
+ <div class="source"><pre> -p PORT port number to use, default port is 9090
-r REPO_PATH repository path, default is ../
-t TIMEOUT socket read timeout, default is 30 seconds
-l LOG_LEVEL log level, available log levels:
@@ -1152,18 +766,19 @@
-f LOG_FILE log file, default is $AXIS2C_HOME/logs/axis2.log
or axis2.log in current folder if AXIS2C_HOME not set
-s LOG_FILE_SIZE Maximum log file size in mega bytes, default maximum size is 1MB.
- -h display the help screen.</pre>
-
-<p>Example :</p>
-<pre> axis2_http_server -l 3 -p 8080 -r $AXIS2C_HOME -f /dev/stderr</pre>
-
-<h2>10.2 MS Windows Based Systems</h2>
-
-<p>Synopsis :</p>
-<pre> axis2_http_server.exe [-p PORT] [-t TIMEOUT] [-r REPO_PATH] [-l LOG_LEVEL] [-f LOG_FILE] [-s LOG_FILE_SIZE]</pre>
+ -h display the help screen.
-<p>You can use the following options with simple axis HTTP server.</p>
-<pre> -p PORT port number to use, default port is 9090
+</pre></div>
+ <p>Example :</p>
+ <div class="source"><pre> axis2_http_server -l 3 -p 8080 -r $AXIS2C_HOME -f /dev/stderr
+
+</pre></div>
+ </div><div class="subsection"><a name="10_2_MS_Windows_Based_Systems"></a><h3>10.2 MS Windows Based Systems</h3><p>Synopsis :</p>
+ <div class="source"><pre> axis2_http_server.exe [-p PORT] [-t TIMEOUT] [-r REPO_PATH] [-l LOG_LEVEL] [-f LOG_FILE] [-s LOG_FILE_SIZE]
+
+</pre></div>
+ <p>You can use the following options with simple axis HTTP server.</p>
+ <div class="source"><pre> -p PORT port number to use, default port is 9090
-r REPO_PATH repository path, default is ../
-t TIMEOUT socket read timeout, default is 30 seconds
-l LOG_LEVEL log level, available log levels:
@@ -1173,70 +788,62 @@
-f LOG_FILE log file, default is %AXIS2C_HOME%\logs\axis2.log
or axis2.log in current folder if AXIS2C_HOME not set
-s LOG_FILE_SIZE Maximum log file size in mega bytes, default maximum size is 1MB.
- -h display the help screen.</pre>
+ -h display the help screen.
-<p>Example :</p>
-<pre> axis2_http_server.exe -l 3 -p 8080 -r %AXIS2C_HOME% -f C:\logs\error.log</pre>
-
-<p style="margin-bottom: 0in"><br />
-</p>
-<a name="mod_axis2"></a>
-
-<h1>11. Deploying with Apache HTTP Server Version 2.x</h1>
-
-<h2>11.1 Linux Platform</h2>
-
-<p>To build Axis2/C with the Apache HTTP server module, also called
+</pre></div>
+ <p>Example :</p>
+ <div class="source"><pre> axis2_http_server.exe -l 3 -p 8080 -r %AXIS2C_HOME% -f C:\logs\error.log
+
+</pre></div>
+ <p style="margin-bottom: 0in"><br></br>
+</p><p><a name="mod_axis2"></a></p></div></div><div class="section"><a name="11__Deploying_with_Apache_HTTP_Server_Version_2_x"></a><h2>11. Deploying with Apache HTTP Server Version 2.x</h2><div class="subsection"><a name="11_1_Linux_Platform"></a><h3>11.1 Linux Platform</h3><p>To build Axis2/C with the Apache HTTP server module, also called
mod_axis2, you need to provide the following configuration options on the
Linux platform:</p>
-<pre>./configure --with-apache2=[path to Apache2 include directory] [other configure options]</pre>
+ <div class="source"><pre>./configure --with-apache2=[path to Apache2 include directory] [other configure options]
-<p><font color="#666666">NOTE: Some Apache2 distributions, specially
+</pre></div>
+ <p><font color="#666666">NOTE: Some Apache2 distributions, specially
development versions, install APR (Apache Portable Run-time) include files in
a separate location. In that case, to build mod_axis2, use:</font></p>
-<pre>./configure --with-apache2=[path to Apache2 include directory] --with-apr=[path to APR include directory]
- [other configure options]</pre>
+ <div class="source"><pre>./configure --with-apache2=[path to Apache2 include directory] --with-apr=[path to APR include directory]
+ [other configure options]
-<p>Then build the source tree as usual using:</p>
-<pre> make
- make install</pre>
+</pre></div>
+ <p>Then build the source tree as usual using:</p>
+ <div class="source"><pre> make
+ make install
-<p>This will install mod_axis2.so into your AXIS2C_INSTALL_DIR/lib folder.</p>
-
-<h2>11.2 MS Windows Platform</h2>
-
-<p>On the MS Windows platform, you have to provide the Apache2 install
+</pre></div>
+ <p>This will install mod_axis2.so into your AXIS2C_INSTALL_DIR/lib folder.</p></div><div class="subsection"><a name="11_2_MS_Windows_Platform"></a><h3>11.2 MS Windows Platform</h3><p>On the MS Windows platform, you have to provide the Apache2 install
location in the configure.in file with the setting APACHE_BIN_DIR.
Example:</p>
-<pre>APACHE_BIN_DIR = "C:\Program Files\Apache Software Foundation\Apache2.2"</pre>
+ <div class="source"><pre>APACHE_BIN_DIR = "C:\Program Files\Apache Software Foundation\Apache2.2"
-<p>Based on the Apache HTTP server version you are using, you also need to
+</pre></div>
+ <p>Based on the Apache HTTP server version you are using, you also need to
set the setting APACHE_VERSION_IS_2_0_59 in the configure.in file. If you are
using Apache version 2.0.59, this setting should be set to 1, if the version
is above that, the setting should be 0. Example:</p>
-<pre>APACHE_VERSION_IS_2_0_59 = 0</pre>
+ <div class="source"><pre>APACHE_VERSION_IS_2_0_59 = 0
-<p>To build the source, you have to run the command</p>
-<pre>nmake axis2_apache_module</pre>
+</pre></div>
+ <p>To build the source, you have to run the command</p>
+ <div class="source"><pre>nmake axis2_apache_module</pre></div>
+ <p>
This will build mod_axis2.dll and copy it to AXIS2C_INSTALL_DIR\lib directory.
-<h2>11.3 Deploying mod_axis2</h2>
-
-<p><font color="#666666">NOTE: To execute some of the commands given below,
-you might require super user privileges on your machine.</font></p>
-
-<p>Copy the mod_axis2 shared library <font
-color="#4169E1">(libmod_axis2.so.0.0.0 on Linux and mod_axis2.dll on MS
-Windows)</font> to the Apache2 modules directory as mod_axis2.so</p>
-
-<p>On Linux</p>
-<pre> cp $AXIS2C_HOME/lib/libmod_axis2.so.0.0.0 /usr/lib/apache2/modules/mod_axis2.so</pre>
-<p>On MS Windows</p>
-<pre> copy /Y "%AXIS2C_HOME%\lib\mod_axis2.dll" C:\Apache2\modules\</pre>
+</p></div><div class="subsection"><a name="11_3_Deploying_mod_axis2"></a><h3>11.3 Deploying mod_axis2</h3><p><font color="#666666">NOTE: To execute some of the commands given below,
+you might require super user privileges on your machine.</font></p><p>Copy the mod_axis2 shared library <font color="#4169E1">(libmod_axis2.so.0.0.0 on Linux and mod_axis2.dll on MS
+Windows)</font> to the Apache2 modules directory as mod_axis2.so</p><p>On Linux</p>
+ <div class="source"><pre> cp $AXIS2C_HOME/lib/libmod_axis2.so.0.0.0 /usr/lib/apache2/modules/mod_axis2.so
+</pre></div>
+ <p>On MS Windows</p>
+ <div class="source"><pre> copy /Y "%AXIS2C_HOME%\lib\mod_axis2.dll" C:\Apache2\modules\
-<p>Edit the Apache2's configuration file (generally httpd.conf) and add the
+</pre></div>
+ <p>Edit the Apache2's configuration file (generally httpd.conf) and add the
following directives at the end of the file.</p>
-<pre>LoadModule axis2_module MOD_AXIS2_INSTALL_DIR
+ <div class="source"><pre>LoadModule axis2_module MOD_AXIS2_INSTALL_DIR
Axis2RepoPath AXIS2C_INSTALL_DIR
Axis2LogFile PATH_TO_LOG_FILE
Axis2LogLevel LOG_LEVEL
@@ -1244,27 +851,27 @@
Axis2MaxLogFileSize SIZE_IN_MB
<Location /axis2>
SetHandler axis2_module
-</Location></pre>
+</Location>
-<p>Please note that you have to fine tune the above settings to mach your
-system.<br />
-<br />
+</pre></div>
+ <p>Please note that you have to fine tune the above settings to mach your
+system.<br></br>
+<br></br>
MOD_AXIS2_INSTALL_DIR has to be replaced with the full path to mod_axis2.so,
-for example, /usr/lib/apache2/modules/mod_axis2.so <br />
-<br />
+for example, /usr/lib/apache2/modules/mod_axis2.so <br></br>
+<br></br>
AXIS2C_INSTALL_DIR has to be replaced with the full path to Axis2/C
repository, for example, /usr/local/axis2. Note that repository path should
have read access to the daemon user account under which the Apache2 HTTPD
-process is run.<br />
-<br />
+process is run.<br></br>
+<br></br>
PATH_TO_LOG_FILE has to be replaced with the full path to where you wish to
have the Axis2/C log file, for example, /tmp/axis2.log. Note that the log
file path should have write access to the daemon user account under which the
-Apache2 HTTPD process is run.<br />
-<br />
+Apache2 HTTPD process is run.<br></br>
+<br></br>
LOG_LEVEL has to be replaced with one of the following values: crit, error,
-warn, info, debug, trace. These log levels have the following meanings:</p>
-<ul>
+warn, info, debug, trace. These log levels have the following meanings:</p><ul>
<li>crit - log critical errors</li>
<li>error - log errors and above</li>
<li>warn - log warnings and above</li>
@@ -1272,37 +879,32 @@
<li>debug - log debug information and above, this is the default log level
used</li>
<li>trace - log trace messages and above</li>
-</ul>
-<p>SIZE_IN_MB must be replaced by the size of the particular resource in MB, rounded to
-the nearest whole value.<br />
-<br />PREFIX has to be replaced with the prefix to be used with the
-service endpoints. This is optional and defaults to "services".
-As an example, if you have "web_services" as the prefix, then all the
-services hosted would have the endpoint prefix of : <br/>
-http://localhost/axis2/web_services <br/>
-If you wish, you can also change the location as well by replacing "/axis2" in
+</ul><p>SIZE_IN_MB must be replaced by the size of the particular resource in MB, rounded to
+the nearest whole value.<br></br>
+<br></br>PREFIX has to be replaced with the prefix to be used with the
+service endpoints. This is optional and defaults to "services".
[... 2553 lines stripped ...]
---------------------------------------------------------------------
To unsubscribe, e-mail: axis-cvs-unsubscribe@ws.apache.org
For additional commands, e-mail: axis-cvs-help@ws.apache.org
Fwd: svn commit: r611719 [2/7] - in /webservices/axis2/trunk/c/xdocs: ./ docs/ docs/hello/client/ docs/hello/service/ docs/mod_log/
Posted by Dinesh Premalal <xy...@gmail.com>.
Hi Damitha,
I think , this commit has messed the generated site for the release
1.2.1 .
---------- Forwarded message ----------
From: <da...@apache.org>
Date: Jan 14, 2008 11:30 AM
Subject: svn commit: r611719 [2/7] - in /webservices/axis2/trunk/c/xdocs: ./
docs/ docs/hello/client/ docs/hello/service/ docs/mod_log/
To: axis2-cvs@ws.apache.org
Modified: webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html
URL:
http://svn.apache.org/viewvc/webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html?rev=611719&r1=611718&r2=611719&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html (original)
+++ webservices/axis2/trunk/c/xdocs/docs/axis2c_manual.html Sun Jan 13
22:00:36 2008
@@ -1,34 +1,19 @@
-<html>
-<head>
- <title>Manual</title>
- <meta http-equiv="content-type" content="text/html; charset=UTF-8">
-</head>
-
-<body lang="en-US" dir="ltr">
-<h2>Preamble</h2>
-
-<p style="margin-bottom: 0in">This document is intended to be a reference
-manual for <a href="http://ws.apache.org/axis2/c">Apache Axis2/C</a>. This
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "
http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Apache
Axis2/C - Manual</title><style type="text/css" media="all">
+ @import url("../style/maven-base.css");
+
+ @import
url("../style/maven-classic.css");</style><link
rel="stylesheet" href="../style/print.css" type="text/css"
media="print"></link><meta http-equiv="Content-Type" content="text/html;
charset=ISO-8859-1"></meta></head><body class="composite"><div
id="banner"><a href="http://www.apache.org/" id="organizationLogo"><img
alt="Apache Software Foundation" src="
http://www.apache.org/images/asf-logo.gif"></img></a><a href="
http://ws.apache.org/axis2/c" id="projectLogo"><img alt="Apache Axis2/C"
src="http://ws.apache.org/axis2/images/axis.jpg"></img></a><div
class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 09 January 2008
+ | Doc for 1.2.0</div><div class="xright"></div><div
class="clear"><hr></hr></div></div><div id="leftColumn"><div
id="navcolumn"><div id="menuApache_Axis2_C"><h5>Apache Axis2/C</h5><ul><li
class="none"><a href="../index.html">Apache Axis2/C Home</a></li><li
We are not suppose to add maven generated codes to the site manually. Those
codes added by 'maven' software. Now after generating codes for
1.2.1release it is look like hell :( . I'm going to remove that code
segment from
all html files, otherwise it will be a big headache for the later releases.
Did I miss something here ?
thanks,
Dinesh
--
http://nethu.org/