You are viewing a plain text version of this content. The canonical link for it is here.
Posted to axis-cvs@ws.apache.org by sa...@apache.org on 2006/03/09 05:59:38 UTC

svn commit: r384432 - in /webservices/axis2/trunk/c/xdocs: M0_5/architecture_notes.html index.html navigation.xml

Author: sahan
Date: Wed Mar  8 20:59:36 2006
New Revision: 384432

URL: http://svn.apache.org/viewcvs?rev=384432&view=rev
Log:
Changes to some docs

Modified:
    webservices/axis2/trunk/c/xdocs/M0_5/architecture_notes.html
    webservices/axis2/trunk/c/xdocs/index.html
    webservices/axis2/trunk/c/xdocs/navigation.xml

Modified: webservices/axis2/trunk/c/xdocs/M0_5/architecture_notes.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/xdocs/M0_5/architecture_notes.html?rev=384432&r1=384431&r2=384432&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/M0_5/architecture_notes.html (original)
+++ webservices/axis2/trunk/c/xdocs/M0_5/architecture_notes.html Wed Mar  8 20:59:36 2006
@@ -1,207 +1,169 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
-<html>
-<head>
-  <meta content="text/html; charset=ISO-8859-1"
- http-equiv="content-type">
-  <title>Architecture_notes.html</title>
-</head>
-<body>
-<h1>C Specific Architectural Notes on Axis2/C</h1>
-
-<p>Send your feedback to: <a
-href="mailto:axis-c-dev@ws.apache.org">axis-c-dev@ws.apache.org</a> (Prefix
-the subject with [Axis2]). To subscribe to developer or user mailing lists
-see <a href="../mail-lists.html">here</a></p>
-
-<h2>Content</h2>
-<ul>
-  <li><a href="#Introduction">Introduction</a></li>
-  <li><a
- href="#Axis2_Environment">Axis2
-Environment</a></li>
-  <li><a href="#Dynamic_Loading">Dynamic Loading</a></li>
-  <li><a href="#Transport_Abstraction">Transport Abstraction</a></li>
-  <li><a href="#Stream_Abstraction">Stream Abstraction</a></li>
-  <li><a href="#Threading_Model">Threading Model</a></li>
-  <li><a href="#Parser_Abstraction">Parser Abstraction</a></li>
-</ul>
-<a name="Introduction"></a>
-<h2>Introduction</h2>
-<p>One of the main design goals of Axis2/C is the re-useability of the
-library
-and the ability to plug into different platforms. There are many
-features
-that allow Axis2/C to be pluggable in to different platforms as well as
-to enable the extension of the functionality of the Axis2/C.</p>
-<a name="Axis2_Environment"></a>
-<h2>Axis2 Environment</h2>
-<p>Axis2/C defines an environment to hold platform specific entities
-such as
-the allocating mechanism, the logging mechanism, etc. This environment
-is
-initialized
-at the point of starting Axis2/C and will last for the lifetime of
-Axis2/C
-library. Different sub environments can also be created to suit the
-particular
-scenarios (eg: the thread specific environment). The Axis2 Environment
-holds
-following entities in order to abstract the platform.</p>
-<h4>Axis2 Allocator</h4>
-<p>Allocator is the wrapper for memory management mechanisms. It
-defines the
-following primitives.</p>
-<ol>
-  <li><code>malloc</code>
-- method to allocate a memory block of given size</li>
-  <li><code> realloc</code>
-- method to change the size of the memory block</li>
-  <li><code> free</code>
-- method to free a memory block</li>
-</ol>
-<h4>Axis2 Error</h4>
-<p>Axis2 Error defines error reporting mechanisms for Axis2 library.
-All of
-the Axis2 internal functions use the <code>axis2_error</code> in the
-environment to report errors.
-</p>
-<h4>Axis2 Log</h4>
-<p>Axis2 Log defines the common logging mechanisms required for the
-Axis2
-library. All of the internal Axis2/C code uses the functions defined in
-the
-<code>axis2_log</code> available in the environment.</p>
-<h4>Axis2 Thread Pool</h4>
-<p>Axis2 Thread Pool defines the thread management functions. It hides
-the
-complex thread pooling functions as well as the platform specific
-implementations of threads. Axis2 internal library uses this
-interface
-to manipulate threads and they deal with a common thread type which is
-defined
-as
-<code>axis2_thread.</code></p>
-<p>Axis2 Environment is the starting point for the platform abstraction
-of
-Axis2/C. It can be used to plug platform specific memory management,
-error
-reporting, logging and thread pooling mechanisms to Axis2 core
-functions.</p>
-<a name="Dynamic_Loading"></a>
-<h2>Dynamic Loading</h2>
-<p>Axis2 is a modular program where the user can add functionality by
-selecting a set of modules. The modules can either be compiled at the
-source
-tree of
-Axis2 or separately. These modules should be compiled as
-Dynamic
-Shared Objects (DSOs) that exist separately. Services are also loaded
-dynamically by reading the axis2.xml. This dynamic loading is mandatory
-in
-order to provide hot deployment / update as well as to facilitate the
-runtime
-selection of transports.</p>
-<p>The DSO support for loading individual Axis2 components is based on
-the
-component named <code>class_loader</code> which must be statically
-compiled with
-Axis2
-core components (in the <code>util</code> package). But the
-disadvantage of this
-approach
-is that the <code>class_loader</code> completely depends on the DSO
-functionality of
-the
-underlying operating system, which limits the portability.</p>
-<a name="Transport_Abstraction"></a>
-<h2>Transport Abstraction</h2>
-<p>One of the key advantages of Axis2 is that the Axis2 engine and the
-other
-SOAP processing is independent from the transport aspect. Users can
-develop
-their own transports and the interface is defined in
-<code>axis2_transport_sender.h</code> and
-<code>axis2_transport_receiver.h</code>.</p>
-<p>Currently Axis2/C supports HTTP transport. The transport receiver is
-a
-Simple HTTP server provided by Axis2 or the Axis2 Apache2 module. The
-transport sender uses sockets to connect and send the SOAP Message.</p>
-<p>Inside the HTTP transport,&nbsp; the receivers and clients are
-abstracted so
-that the user can easily plug in their own senders and receivers (eg:
-A
-<code>libcurl</code> based client can be implemented instead of the
-simple http
-client
-available in the axis2 distribution)</p>
-<a name="Stream_Abstraction"></a>
-<h2>Stream Abstraction</h2>
-<p>Stream is a representation of a sequence of bytes. Since Axis2
-heavily
-uses
-streaming mechanisms to read / write xml, an implementation independent
-stream
-abstraction is required in order to integrate Axis2 in other
-environments
-seamlessly. The core components of Axis2 deal with this abstracted
-stream
-and does not worry about the implementation specific details. The
-creating
-point of the stream (eg: the transport receiver) knows what type of
-stream
-should
-be created (eg: socket, file, etc) and creates the appropriate
-stream.
-Thereafter, rest of the components are independent from the
-implementation
-details of the stream.</p>
-<p>Also the stream serves as a main point in internationalization
-support. It
-can convert the the internal byte representation to a different type of
-encodings specified by the user. This can be achieved by plugging an
-encoding
-engine to the stream.</p>
-<a name="Threading_Model"></a>
-<h2>Threading Model</h2>
-<p>Axis2 core functions, such as hot deployment / update, asynchronous
-invocation, concurrent request processing in simple axis2 server,
-etc&nbsp;
-heavily depends on threads. At the same time these threads should be
-platform
-independent inside the Axis2 core components. Another important
-requirement
-in threading model is the ability to pool the threads. This thread
-pooling
-mechanism should be Axis2 independent and Axis2 core components
-should
-be able to deal with the thread pooling mechanisms via a uniform
-interface.</p>
-<p>So the above two aspects lead to two main requirements in the
-threading
-model:</p>
-<ol>
-  <li>Ability to define a platform independent threading mechanism.</li>
-  <li>Ability to define an implementation independent thread pool.</li>
-</ol>
-<p>These two requirements are implemented in current Axis2 using a
-platform
-independent thread type <code>axis2_thread</code> and an
-implementation
-independent thread pool <code>axis2_thread_pool.</code></p>
-<a name="Parser_Abstraction"></a>
-<h2>Parser Abstraction</h2>
-<p>Axis2 architecture depends on the XML pull model. But in C there is
-no
-such API (such as StAX API). Therefore XML pull API, which is specific
-to
-Axis2 is defined in as <code>axis2_xml_reader</code> and
-<code>axis2_xml_writer.</code> Any implementation of this API can be
-plugged
-into the Axis2 core as long as they follow the API strictly. If an
-external XML parser needs to be plugged into Axis2, a wrapper that maps
-the
-reading/writing functions to the Axis2 XML reader/writer API should be
-written.</p>
-
-</body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+  <meta content="text/html; charset=iso-8859-1" http-equiv="content-type">
+  <title>Architecture_notes.html</title>
+</head>
+
+<body>
+<h1>C Specific Architectural Notes on Axis2/C</h1>
+
+<p>Send your feedback to: <a
+href="mailto:axis-c-dev@ws.apache.org">axis-c-dev@ws.apache.org</a> (Prefix
+the subject with [Axis2]). To subscribe to developer or user mailing lists
+see <a href="../mail-lists.html">here</a></p>
+
+<h2>Content</h2>
+<ul>
+  <li><a href="#Introduction">Introduction</a></li>
+  <li><a href="#Axis2_Environment">Axis2 Environment</a></li>
+  <li><a href="#Dynamic_Loading">Dynamic Loading</a></li>
+  <li><a href="#Transport_Abstraction">Transport Abstraction</a></li>
+  <li><a href="#Stream_Abstraction">Stream Abstraction</a></li>
+  <li><a href="#Threading_Model">Threading Model</a></li>
+  <li><a href="#Parser_Abstraction">Parser Abstraction</a></li>
+</ul>
+<a name="Introduction"></a>
+
+<h2>Introduction</h2>
+
+<p>One of the main design goals of Axis2/C is the re-useability of the
+library and the ability to plug into different platforms. There are many
+features that allow Axis2/C to be pluggable in to different platforms as well
+as to enable the extension of the functionality of the Axis2/C.</p>
+<a name="Axis2_Environment"></a>
+
+<h2>Axis2 Environment</h2>
+
+<p>Axis2/C defines an environment to hold platform specific entities such as
+the allocating mechanism, the logging mechanism, etc. This environment is
+initialized at the point of starting Axis2/C and will last for the lifetime
+of Axis2/C library. Different sub environments can also be created to suit
+the particular scenarios (eg: the thread specific environment). The Axis2
+Environment holds following entities in order to abstract the platform.</p>
+
+<h4>Axis2 Allocator</h4>
+
+<p>Allocator is the wrapper for memory management mechanisms. It defines the
+following primitives.</p>
+<ol>
+  <li><code>malloc</code> - method to allocate a memory block of given
+  size</li>
+  <li><code>realloc</code> - method to change the size of the memory
+  block</li>
+  <li><code>free</code> - method to free a memory block</li>
+</ol>
+
+<h4>Axis2 Error</h4>
+
+<p>Axis2 Error defines error reporting mechanisms for Axis2 library. All of
+the Axis2 internal functions use the <code>axis2_error</code> in the
+environment to report errors.</p>
+
+<h4>Axis2 Log</h4>
+
+<p>Axis2 Log defines the common logging mechanisms required for the Axis2
+library. All of the internal Axis2/C code uses the functions defined in the
+<code>axis2_log</code> available in the environment.</p>
+
+<h4>Axis2 Thread Pool</h4>
+
+<p>Axis2 Thread Pool defines the thread management functions. It hides the
+complex thread pooling functions as well as the platform specific
+implementations of threads. Axis2 internal library uses this interface to
+manipulate threads and they deal with a common thread type which is defined
+as <code>axis2_thread.</code></p>
+
+<p>Axis2 Environment is the starting point for the platform abstraction of
+Axis2/C. It can be used to plug platform specific memory management, error
+reporting, logging and thread pooling mechanisms to Axis2 core functions.</p>
+<a name="Dynamic_Loading"></a>
+
+<h2>Dynamic Loading</h2>
+
+<p>Axis2 is a modular program where the user can add functionality by
+selecting a set of modules. The modules can either be compiled at the source
+tree of Axis2 or separately. These modules should be compiled as Dynamic
+Shared Objects (DSOs) that exist separately. Services are also loaded
+dynamically by reading the contents of the services folder . This dynamic
+loading is mandatory in order to provide hot deployment / update as well as
+to facilitate the runtime selection of transports.</p>
+
+<p>The DSO support for loading individual Axis2 components is based on the
+component named <code>class_loader</code> which must be statically compiled
+with Axis2 core components (in the <code>util</code> package). But the
+disadvantage of this approach is that the <code>class_loader</code>
+completely depends on the DSO functionality of the underlying operating
+system, which limits the portability.</p>
+<a name="Transport_Abstraction"></a>
+
+<h2>Transport Abstraction</h2>
+
+<p>One of the key advantages of Axis2 is that the Axis2 engine and the other
+SOAP processing is independent from the transport aspect. Users can develop
+their own transports and the interface is defined in
+<code>axis2_transport_sender.h</code> and
+<code>axis2_transport_receiver.h</code>.</p>
+
+<p>Currently Axis2/C supports HTTP transport. The transport receiver is a
+Simple HTTP server provided by Axis2 or the Axis2 Apache2 module. The
+transport sender uses sockets to connect and send the SOAP Message.</p>
+
+<p>Inside the HTTP transport,  the receivers and clients are abstracted so
+that the user can easily plug in their own senders and receivers (eg: A
+<code>libcurl</code> based client can be implemented instead of the simple
+http client available in the axis2 distribution)</p>
+<a name="Stream_Abstraction"></a>
+
+<h2>Stream Abstraction</h2>
+
+<p>Stream is a representation of a sequence of bytes. Since Axis2 heavily
+uses streaming mechanisms to read / write xml, an implementation independent
+stream abstraction is required in order to integrate Axis2 in other
+environments seamlessly. The core components of Axis2 deal with this
+abstracted stream and does not worry about the implementation specific
+details. The creating point of the stream (eg: the transport receiver) knows
+what type of stream should be created (eg: socket, file, etc) and creates the
+appropriate stream. Thereafter, rest of the components are independent from
+the implementation details of the stream.</p>
+
+<p>Also the stream serves as a main point in internationalization support. It
+can convert the the internal byte representation to a different type of
+encodings specified by the user. This can be achieved by plugging an encoding
+engine to the stream.</p>
+<a name="Threading_Model"></a>
+
+<h2>Threading Model</h2>
+
+<p>Axis2 core functions, such as hot deployment / update, asynchronous
+invocation, concurrent request processing in simple axis2 server, etc 
+heavily depends on threads. At the same time these threads should be platform
+independent inside the Axis2 core components. Another important requirement
+in threading model is the ability to pool the threads. This thread pooling
+mechanism should be Axis2 independent and Axis2 core components should be
+able to deal with the thread pooling mechanisms via a uniform interface.</p>
+
+<p>So the above two aspects lead to two main requirements in the threading
+model:</p>
+<ol>
+  <li>Ability to define a platform independent threading mechanism.</li>
+  <li>Ability to define an implementation independent thread pool.</li>
+</ol>
+
+<p>These two requirements are implemented in current Axis2 using a platform
+independent thread type <code>axis2_thread</code> and an implementation
+independent thread pool <code>axis2_thread_pool.</code></p>
+<a name="Parser_Abstraction"></a>
+
+<h2>Parser Abstraction</h2>
+
+<p>Axis2 architecture depends on the XML pull model. But in C there is no
+such API (such as StAX API). Therefore XML pull API, which is specific to
+Axis2 is defined in as <code>axis2_xml_reader</code> and
+<code>axis2_xml_writer.</code> Any implementation of this API can be plugged
+into the Axis2 core as long as they follow the API strictly. If an external
+XML parser needs to be plugged into Axis2, a wrapper that maps the
+reading/writing functions to the Axis2 XML reader/writer API should be
+written.</p>
+</body>
+</html>

Modified: webservices/axis2/trunk/c/xdocs/index.html
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/xdocs/index.html?rev=384432&r1=384431&r2=384432&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/index.html (original)
+++ webservices/axis2/trunk/c/xdocs/index.html Wed Mar  8 20:59:36 2006
@@ -1,80 +1,78 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
-       "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html>
-<head>
-  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
-  <title>Welcome to Apache Axis2-C home page</title>
-  <meta name="generator" content="amaya 9.2.1, see http://www.w3.org/Amaya/"
-  />
-</head>
-
-<body xml:lang="en">
-<h1>Welcome to Apache Axis2/C</h1>
-
-Axis2/C is an effort to implement <a href="http://ws.apache.org/axis2/0_93/Axis2ArchitectureGuide.html" target="_blank">Axis2 architecture</a>, designed language independently 
-from the day one, in C. It supports both Windows and Unix platforms. 
-
-<h2>Background and Motivation</h2>
-
-<p>While Axis 2 Java is moving closer to 1.0, this implementation provides another 
-  language option to consume and provide web services. Performance being its forte, 
-  Axis2/C is looking at broadening its horizan by providing extensions to popular 
-  open source scripting languages and web browsers. The initial efforts are focused 
-  on developing extensions for PHP language and Mozilla Firefox web browser.</p>
-
-<h2>Latest Release</h2>
-
-<p><b>Milestone Release 0.5 - (9th March 2006) (<a href="http://www.apache.org/dyn/closer.cgi/ws/axis2/c/M0.5/" >Download M-0.5</a>)</b></p>
-
-<h4>Key Features</h4>
-<ol type="1">
-  <li>AXIOM, an XML object model working on StAX (Streaming API for XML)
-    parsing optimized for SOAP 1.1/1.2 Messages.</li>
-  <li>Support for One-Way Messaging (In-Only) and Request Response Messaging
-    (In-Out)</li>
-  <li>Module Architecture, mechanism to extend the SOAP Processing Model</li>
-  <li>Directory based deployment model</li>
-  <li>WS-Addressing, both the submission (2004/08) and final (2005/08)
-    versions</li>
-  <li>Improved and user friendly Client API</li>
-  <li>Transports supports: HTTP
-    <ul>
-      <li>Axis2/C server</li>
-      <li>Apache integration module</li>
-    </ul>
-  </li>
-  <li>Raw XML providers</li>
-  <li>Numerous bug fixes since last release</li>
-</ol>
-
-<h4>Major Changes Since the Last Release</h4>
-<ol type="1">
-  <li>Improving code quality by fixing memory leaks and reviewing the
-  code.</li>
-  <li>Apache2 integration.</li>
-  <li>More samples and tests(Including Plugfest testing code to interoperate
-    with Microsoft services)</li>
-  <li>Initial documentations(User Guide, Developer Guide, Installation
-  Guide)</li>
-</ol>
-
-<h4>What's Still To Do?</h4>
-
-<p>See list of what we think needs to be done, and consider helping out if
-you're interested &amp; able!</p>
-<ol type="1">
-  <li>Management Interface for Axis2/C</li>
-  <li>Implementation of other Transports.</li>
-  <li>Code generation and Dynamic Invocation</li>
-  <li>Firefox Extension</li>
-  <li>PHP Extension</li>
-  <li>Hot Deployment of Services</li>
-  <li>Completion of interop tests</li>
-  <li>Support for MTOM/ MIME/ SwA</li>
-  <li>Axis Data Binding - ADB (Framework and Schema Compiler)</li>
-  <li>REST (REpresentational State Transfer) Support</li>
-</ol>
-
-</body>
-</html>
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+       "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+  <title>Welcome to Apache Axis2-C home page</title>
+  <meta name="generator" content="amaya 9.4, see http://www.w3.org/Amaya/" />
+</head>
+
+<body xml:lang="en">
+<h1>Welcome to Apache Axis2/C</h1>
+
+<p>Axis2/C is an effort to implement <a
+href="http://ws.apache.org/axis2/0_93/Axis2ArchitectureGuide.html">Axis2
+architecture</a>, in C. Axis2/C can be used to provide and consume Web
+Services.</p>
+
+<h2>Background and Motivation</h2>
+
+<p>While Axis 2 Java is moving closer to 1.0, this implementation provides
+another language option to consume and provide web services. Performance
+being its forte, Axis2/C is looking at broadening its horizan by providing
+extensions to popular open source scripting languages and web browsers. </p>
+
+<h2>Latest Release</h2>
+
+<p><b>Milestone Release 0.5 - (9th March 2006) (<a
+href="http://www.apache.org/dyn/closer.cgi/ws/axis2/c/M0.5/">Download
+M-0.5</a>)</b></p>
+
+<h4>Key Features</h4>
+<ol type="1">
+  <li>AXIOM, an XML object model working on StAX (Streaming API for XML)
+    parsing optimized for SOAP 1.1/1.2 Messages.</li>
+  <li>Support for Request Response Messaging (In-Out)</li>
+  <li>Module Architecture, mechanism to extend the SOAP Processing Model</li>
+  <li>Directory based deployment model</li>
+  <li>WS-Addressing, both the submission (2004/08) and final (2005/08)
+    versions</li>
+  <li>Improved and user friendly Client API</li>
+  <li>Transports supports: HTTP
+    <ul>
+      <li>Axis2/C server</li>
+      <li>Apache integration module</li>
+    </ul>
+  </li>
+  <li>Raw XML providers</li>
+  <li>Numerous bug fixes since last release</li>
+</ol>
+
+<h4>Major Changes Since the Last Release</h4>
+<ol type="1">
+  <li>Improving code quality by fixing memory leaks and reviewing the
+  code.</li>
+  <li>Apache2 integration.</li>
+  <li>More samples and tests(Including Plugfest testing code to interoperate
+    with Microsoft services)</li>
+  <li>Initial documentations(User Guide, Developer Guide, Installation
+  Guide)</li>
+</ol>
+
+<h4>What's Still To Do?</h4>
+
+<p>See list of what we think needs to be done, and consider helping out if
+you're interested &amp; able!</p>
+<ol type="1">
+  <li>Management Interface for Axis2/C</li>
+  <li>Implementation of other Transports.</li>
+  <li>Code generation and Dynamic Invocation</li>
+  <li>Hot Deployment of Services</li>
+  <li>Completion of interop tests</li>
+  <li>Support for MTOM/ MIME/ SwA</li>
+  <li>Axis Data Binding - ADB (Framework and Schema Compiler)</li>
+  <li>REST (REpresentational State Transfer) Support</li>
+</ol>
+</body>
+</html>

Modified: webservices/axis2/trunk/c/xdocs/navigation.xml
URL: http://svn.apache.org/viewcvs/webservices/axis2/trunk/c/xdocs/navigation.xml?rev=384432&r1=384431&r2=384432&view=diff
==============================================================================
--- webservices/axis2/trunk/c/xdocs/navigation.xml (original)
+++ webservices/axis2/trunk/c/xdocs/navigation.xml Wed Mar  8 20:59:36 2006
@@ -10,7 +10,7 @@
           href="http://svn.apache.org/viewcvs.cgi/webservices/axis2/trunk/c/"/>
       </item>
       <item name="Documentation">
-        <item name="Milestone M0.5" href="M0_5/index.html"/>
+        <item name="Milestone 0.5" href="M0_5/index.html"/>
       </item>
       <item name="Get Involved">
         <item name="Mailing Lists" href="mail-lists.html"/>