You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by aj...@apache.org on 2006/09/14 18:26:20 UTC

svn commit: r443394 - in /incubator/tuscany/site/site-publish: cpp_sca_overview.html cpp_sdo_overview.html

Author: ajborley
Date: Thu Sep 14 09:26:18 2006
New Revision: 443394

URL: http://svn.apache.org/viewvc?view=rev&rev=443394
Log:
Added initial versions. Mostly based on the GettingStarted.html documents for SDO and SCA C++

Modified:
    incubator/tuscany/site/site-publish/cpp_sca_overview.html
    incubator/tuscany/site/site-publish/cpp_sdo_overview.html

Modified: incubator/tuscany/site/site-publish/cpp_sca_overview.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/site-publish/cpp_sca_overview.html?view=diff&rev=443394&r1=443393&r2=443394
==============================================================================
--- incubator/tuscany/site/site-publish/cpp_sca_overview.html (original)
+++ incubator/tuscany/site/site-publish/cpp_sca_overview.html Thu Sep 14 09:26:18 2006
@@ -281,7 +281,441 @@
 			<td background="images/WhiteL.png" width="15"></td>
 			<td width="100%">
 				<div id="content">
-                                            <p>(TBD) Desciption of SCA C++ system and how to use it</p>
+                                            <H2>The Tuscany SCA C++ Project</H2>
+                                            <P>This page provides a high-level overview of the C++ SCA (Service
+           Component Architecture) subproject of the Apache Tuscany incubator project.</P>
+                    				</div>
+			</td>
+			<td background="images/WhiteR.png" width="14"></td>
+		</tr>
+		
+		<tr>
+			<td background="images/WhiteBL.png" width="15" height="14"></td>
+			<td background="images/WhiteB.png" ></td>
+			<td background="images/WhiteBR.png" width="14"></td>
+		</tr>
+		
+	</table>
+	            	                	<table class="content" border="0" width="90%" cellspacing="0" cellpadding="0" align="center">
+		<tr class="title" height="17" background="images/TitleC.png">
+			<td align="left">
+				<img src="images/TitleL.png" width="15" height="17" alt=""></td>
+			<td align="center" height="17" id="title" background="images/TitleC.png">
+				     <a href="#">SCA C++ Overview</a>
+			</td>
+			<td align="right">
+				<img src="images/TitleR.png" width="14" height="17" alt=""></td>
+		</tr>
+		<tr>
+			<td background="images/WhiteL.png" width="15"></td>
+			<td width="100%">
+				<div id="content">
+                                            <p>
+            Tuscany SCA C++ is an implementation of the 
+            <a href="http://www.osoa.org/download/attachments/28/SCA_ClientAndImplementationModel_Cpp_V09.pdf?version=1">Service Component Architecture specification for C++ developers</a>.
+            To try it out, we recommend using the SCA C++ Milestone release 1 available from our 
+            <A HREF="http://incubator.apache.org/tuscany/downloads.html" target="_blank">downloads page</A>.
+            Alternatively, if you would like to work with the latest (possibly unstable) SCA C++ code, follow the 
+            <a href="cpp-projects.html">general instructions</a> for downloading and building SCA C++ from the Tuscany SVN repository.
+          </p>
+                                            <h3>SCA C++ Documents</h3>
+                                            <table>
+              <tr>
+                  <td>
+                      <a href="http://www.osoa.org/download/attachments/28/SCA_ClientAndImplementationModel_Cpp_V09.pdf?version=1">SCA specification for C++ developers V0.9</a>
+                  </td>
+                  <td>
+                      The Service Component Architecture specification for C++ describes the SCA Client 
+                      and Implementation Model for the C++ programming anguage.
+                  </td>
+              </tr>
+              <tr>
+                  <td><a href="http://www.osoa.org/download/attachments/28/SCA_White_Paper1_09.pdf?version=1">SCA White Paper</a></td>
+                  <td>A white paper that explains the SCA programming model</td>
+              </tr>
+          </table>
+                    				</div>
+			</td>
+			<td background="images/WhiteR.png" width="14"></td>
+		</tr>
+		
+		<tr>
+			<td background="images/WhiteBL.png" width="15" height="14"></td>
+			<td background="images/WhiteB.png" ></td>
+			<td background="images/WhiteBR.png" width="14"></td>
+		</tr>
+		
+	</table>
+	            	                	<table class="content" border="0" width="90%" cellspacing="0" cellpadding="0" align="center">
+		<tr class="title" height="17" background="images/TitleC.png">
+			<td align="left">
+				<img src="images/TitleL.png" width="15" height="17" alt=""></td>
+			<td align="center" height="17" id="title" background="images/TitleC.png">
+				     <a href="#">Getting Started with the SCA C++ Milestone release 1</a>
+			</td>
+			<td align="right">
+				<img src="images/TitleR.png" width="14" height="17" alt=""></td>
+		</tr>
+		<tr>
+			<td background="images/WhiteL.png" width="15"></td>
+			<td width="100%">
+				<div id="content">
+                                            <P>If you haven't already done so, the first
+         step is to download the SCA C++ Milestone release 1 of Apache Tuscany from our
+         <A HREF="http://incubator.apache.org/tuscany/downloads.html" target="_blank">downloads page</A>.<BR />
+         </P>
+                                            <DIV CLASS="section"> 
+         <H3>Contents</H3> 
+         <OL>
+            <LI><A HREF="#requirements">System Requirements</A></LI>
+            <LI><A HREF="#install">Installing Tuscany SCA..</A>
+                <UL>
+                    <LI><A HREF="#linuxbin">..from the binary release on Linux</A></LI>
+                    <LI><A HREF="#linuxsrc">..from the source release on Linux</A></LI>
+                    <LI><A HREF="#winbin">..from the binary release on Windows</A></LI>
+                    <LI><A HREF="#winsrc">..from the source release on Windows</A></LI>
+                </UL></LI>
+            <LI><A HREF="#samples">Samples</A>
+              <UL>
+                 <LI><A HREF="#linuxbld">Building the samples on Linux</A></LI>
+                 <LI><A HREF="#linuxrun">Running the samples on Linux:</A></LI>
+                    <UL>
+                       <LI><A HREF="#linuxcalcbasic">Calculator with basic client</A></LI>
+                       <LI><A HREF="#linuxcalcws">Calculator with Web Service client</A></LI>
+                    </UL>
+                 <LI><A HREF="#winbld">Building the samples on Windows</A></LI>
+                 <LI><A HREF="#winrun">Running the samples on Windows:</A></LI>
+                    <UL>
+                       <LI><A HREF="#wincalcbasic">Calculator with basic client</A></LI>
+                       <LI><A HREF="#wincalcws">Calculator with Web Service client</A></LI>
+                    </UL>
+              </UL>
+            </LI>
+            <LI><A HREF="#userguide">User Guide Documents</A></LI>
+            <LI><A HREF="#help">Getting Help</A></LI>
+         </OL>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="requirements"><H3>System Requirements</H3></A>
+
+         <P>In order to run Tuscany SCA there are some
+         minimum requirements:</P> 
+         <TABLE CLASS="bodyTable">
+
+            <TBODY>
+            <TR CLASS="a">
+               <TD><B>Software</B></TD>
+               <TD><B>Download Link</B></TD>
+            </TR>
+            <TR CLASS="b">
+               <TD>Operating systems: 
+                  <UL>
+
+                     <LI>Windows XP SP2</LI> 
+                     <LI>Linux</LI> 
+                  </UL>
+               </TD>
+               <TD> 
+               </TD>
+            </TR>
+            <TR CLASS="a">
+               <TD>Axis2C Release 0.92</TD>
+
+               <TD> 
+                  <A HREF="http://ws.apache.org/axis2/c/download.cgi" TARGET="_blank">http://ws.apache.org/axis2/c/download.cgi</A><BR />
+                  Please download and follow the installation instructions. Ensure you can run the Axis2C samples                  
+               </TD>
+            </TR>
+            <TR CLASS="b">
+               <TD>Tuscany SDO for C++ Milestone Release 1</TD>
+
+               <TD> 
+                  <A HREF="http://incubator.apache.org/tuscany/download.html" TARGET="_blank">http://incubator.apache.org/tuscany/download.html</A><BR />
+                  Please download and follow the installation instructions
+               </TD>
+            </TR>
+            <TR CLASS="a">
+               <TD>Java SDK 1.4 or later</TD>
+
+               <TD> 
+                  <A HREF="http://java.sun.com/javase/downloads/index.jsp" TARGET="_blank">http://java.sun.com/javase/downloads/index.jsp</A><BR />
+                  This is required for building and running the SCAGEN code generation tool, which is used
+                  when developing Tuscany SCA C++ components
+               </TD>
+            </TR>
+            <TR CLASS="b">
+               <TD>Apache Ant 1.6 or later</TD>
+
+               <TD> 
+                  <A HREF="http://ant.apache.org" TARGET="_blank">http://ant.apache.org</A><BR />
+                  This is required for building the SCAGEN code generation tool, which is used
+                  when developing Tuscany SCA C++ components
+               </TD>
+            </TR>
+            </TBODY>
+         </TABLE>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="install"><H3>Installing Tuscany SCA for C++</H3></A>
+         <A NAME="linuxbin"><H3>Getting Tuscany SCA for C++ working with the binary release on Linux</H3></A>
+          <OL>
+              <LI>Extract the binary tar package to a folder</LI>
+              <LI>Set the TUSCANY_SCACPP environment variable to point to the directory that was just extracted</LI>
+              <LI>Add the *install_dir*/lib directory to the LD_LIBRARY_PATH environment variable</LI>
+          </OL>
+         <A NAME="linuxsrc"><H3>Getting Tuscany SCA for C++ working with the source release on Linux</H3></A>
+          <OL>
+              <LI>Extract the source tar package to a folder &lt;tuscany_sca&gt;</LI>
+              <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL></LI>
+              <LI>Build the source with the following command sequence:
+                  <UL>
+                      <LI>./configure</LI>
+                      <LI>make</LI>
+                      <LI>make install</LI>
+                  </UL>
+	              NOTE: If you don't provide a --prefix configure option, it will by default install into
+                  /usr/local/tuscany/sca</LI>
+              </OL>
+           
+         <A NAME="winbin"><H3>Getting Tuscany SCA for C++ working with the binary release on Windows</H3></A>
+          <OL>
+              <LI>Unzip the supplied zip file to a folder</LI>
+              <LI>Set the TUSCANY_SCACPP environment variable to point to the directory that was just unzipped</LI>
+              <LI>Add the *install_dir*\bin directory to the PATH environment variable</LI>
+          </OL>
+        <A NAME="winsrc"><H3>Getting Tuscany SCA for C++ working with the source release on Windows</H3></A>
+           <OL>   
+              <LI>Unzip the supplied source zip file</LI>
+              <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL></LI>
+              <LI>You must have set up the environment for Microsoft Visual C++ tools. The build command 
+                  will call vcvars32 to set the environment. Ensure the directory containing this is on your path.
+                  This will be where you installed the compiler.</LI>
+              <LI>Build the source:
+                  <UL>
+                      <LI>cd &lt;to where you unzipped the source&gt;</LI>
+                      <LI>build</LI>                      
+                  </UL>
+	              This will build all the projects and put the required output into the 'deploy' directory<BR /><BR />
+                  Alternatively, open the workspace tuscany_sca.dsw in Visual Studio 6 - you can build projects individually
+                  or build the samples to rebuild all the projects</LI>
+              <LI>Set the TUSCANY_SCACPP environment variable to point to the 'deploy' directory that was just created</LI>
+          </OL>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="samples"><H3>Samples</H3></A>
+          <P>Tuscany SCA C++ includes a simple technology sample that demonstrates some of the functionality of
+         the Tuscany SCA C++ runtime. This page describes what is needed to install and run the sample.
+         </P>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="linuxbld"><H3>Building the samples on Linux</H3></A>
+         <P>If using the binary distribution the samples are built and installed in
+            &lt;tuscany_sca_install_dir&gt;/samples - go directly to <A HREF="#linuxrun">Running the samples on Linux</A>.</P>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt; </LI>                                    
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt; </LI>                                     
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL></LI>
+             <LI>Build the source with the following command sequence:
+                  <UL>
+                      <LI>cd &lt;tuscany_sca_install_dir&gt;/samples</LI>
+                      <LI>./configure</LI>
+                      <LI>make</LI>
+                      <LI>make install</LI>
+                  </UL>
+	              NOTE: If you don't provide a --prefix configure option, it will by default install into
+                  /usr/local/tuscany/sca/samples/Calculator</LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="linuxrun"><H3>Running the samples on Linux</H3></A>
+         <A NAME="linuxcalcbasic"><H3>Calculator with basic client</H3></A>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL>
+             </LI>
+             <LI>Run the sample with the following commands:
+                <UL>
+                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/Calculator/deploy/bin</LI>
+                   <LI>./runclient.sh</LI>
+                </UL>
+             </LI>
+         </OL>                                                  
+         <A NAME="linuxcalcws"><H3>Calculator with Web Service client</H3></A>
+         <OL>
+             <LI>Deploy the Calculator as an Axis2C service:                                 
+                <OL>
+                  <LI>Create a new service folder in axis2:<BR />                                      
+                      &lt;AXIS2C_HOME&gt;/services/Calculator</LI>
+                  <LI>Copy the &lt;TUSCANY_SCACPP&gt;/samples/Calculator/CalculatorComposite/services.xml                                       
+                      to &lt;AXIS2C_HOME&gt;/services/Calculator/services.xml</LI>
+                  <LI>Edit the &lt;AXIS2C_HOME&gt;/services/Calculator/services.xml file to set the TuscanySystemRoot parameter to<BR />
+                      &lt;parameter name="TuscanySystemRoot" locked="xsd:false"&gt;&lt;tuscany_sca_install_dir&gt;/samples/Calculator/deploy&lt;/parameter&gt;<BR />
+                      replacing &lt;tuscany_sca_install_dir&gt; with the install path of Tuscany SCA</LI>                                      
+                  <LI>Copy the &lt;TUSCANY_SCACPP&gt;/lib/libtuscany_sca_ws_service.so library into &lt;AXIS2C_HOME&gt;/services/Calculator</LI>
+                </OL>
+             </LI>
+             <LI>Start the Axis2C simple http server:
+                <OL>
+                   <LI>cd &lt;AXIS2C_HOME&gt;/bin</LI>
+                   <LI>The following environment variables are required:                                 
+                      <UL>
+                        <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
+                        <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                        <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                      </UL>
+                   </LI>
+                   <LI>Add &lt;TUSCANY_SCACPP&gt;/lib, &lt;TUSCANY_SDOCPP&gt;/lib and &lt;AXIS2C_HOME&gt;/lib 
+                       to the LD_LIBRARY_PATH environment variable
+                   </LI>
+                   <LI>./axis2_http_server</LI>
+                </OL>
+             </LI>
+             <LI>Run the client:
+                <OL>
+                   <LI>The following environment variable is required:                                 
+                      <UL>
+                        <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                      </UL>
+                   </LI>
+                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/Calculator/deploy/bin</LI>
+                   <LI>./runwsclient.sh</LI>
+                </OL>
+             </LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section">
+         <A NAME="winbld"><H3>Building the samples on Windows</H3></A>
+         <P>If using the binary distribution the samples are built and installed in
+            &lt;tuscany_sca_install_dir&gt;/samples - go directly to <A HREF="#winrun">Running the samples on Windows</A>.</P>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL>
+             </LI>
+             <LI>You must have set up the environment for Microsoft Visual C++ tools.
+                 The build command will call vcvars32 to set the environment. Ensure the 
+                 directory containing this is on your path. This will be where you 
+                 installed the compiler.
+             </LI>
+             <LI>Build the source, either via the Visual Studio 6 or 7 projects under 
+                 &lt;tuscany_sca_install_dir&gt;\samples\ides or via the command-line build file
+                 found at &lt;tuscany_sca_install_dir&gt;\samples\ides\devstudio6\projects\Calculator\build.cmd
+                 which will build and deploy the samples.
+             </LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="winrun"><H3>Running the samples on Windows</H3></A>
+         <A NAME="wincalcbasic"><H3>Calculator with basic client</H3></A>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL>
+             </LI>
+             <LI>Run the sample with the following commands:
+                <UL>
+                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/Calculator/deploy/bin</LI>
+                   <LI>runclient add 5 6<BR />
+                       (can also use sub, div, mul).</LI>
+                </UL>
+             </LI>
+         </OL>                                                  
+         <A NAME="wincalcws"><H3>Calculator with Web Service client</H3></A>
+         <OL>
+             <LI>Deploy the Calculator as an Axis2C service:                                 
+                <OL>
+                  <LI>Create a new service folder in axis2:<BR />                                      
+                      &lt;AXIS2C_HOME&gt;/services/Calculator</LI>
+                  <LI>Copy the &lt;TUSCANY_SCACPP&gt;/samples/Calculator/CalculatorComposite/services.xml                                       
+                      to &lt;AXIS2C_HOME&gt;/services/Calculator/services.xml</LI>
+                  <LI>Edit the &lt;AXIS2C_HOME&gt;/services/Calculator/services.xml file to set the TuscanySystemRoot parameter to<BR />
+                      &lt;parameter name="TuscanySystemRoot" locked="xsd:false"&gt;&lt;TUSCANY_SCACPP&gt;/samples/Calculator/deploy&lt;/parameter&gt;<BR />
+                      replacing &lt;TUSCANY_SCACPP&gt; with the install path of Tuscany SCA</LI>                                      
+                  <LI>Copy the &lt;TUSCANY_SCACPP&gt;/lib/tuscany_sca_ws_service.dll (and .pdb if debugging) file(s) 
+                      into &lt;AXIS2C_HOME&gt;/services/Calculator</LI>
+                </OL>
+             </LI>
+             <LI>Start the Axis2C simple http server:
+                <OL>
+                   <LI>cd &lt;AXIS2C_HOME&gt;/bin</LI>
+                   <LI>The following environment variables are required:                                 
+                      <UL>
+                        <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
+                        <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                        <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                      </UL>
+                   </LI>
+                   <LI>Add &lt;TUSCANY_SCACPP&gt;\bin, &lt;TUSCANY_SDOCPP&gt;\bin and &lt;AXIS2C_HOME&gt;/lib 
+                       to the PATH environment variable
+                   </LI>
+                   <LI>axis2_http_server</LI>
+                </OL>
+             </LI>
+             <LI>Run the client:
+                <OL>
+                   <LI>The following environment variable is required:                                 
+                      <UL>
+                        <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                      </UL>
+                   </LI>
+                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/Calculator/deploy/bin</LI>
+                   <LI>runwsclient</LI>
+                </OL>
+             </LI>
+         </OL>                                                  
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="userguide"><H3>User Guide Documents</H3></A>
+         <P>The SCA C++ Milestone release 1 also contains the following two documents to assist in developing with Tuscany SCA C++
+         </P>
+         <TABLE CLASS="bodyTable"> 
+            <TBODY>
+            <TR CLASS="a">
+               <TD STYLE="vertical-align: top; white-space: nowrap;"><EM>Creating and building a Tuscany SCA C++ component</EM>
+               </TD>
+               <TD>A document that describes how to create, build and run a Tuscany SCA C++ component.
+               </TD>
+            </TR>
+            <TR CLASS="a">
+               <TD STYLE="vertical-align: top; white-space: nowrap;"><EM>Enabling Web Service access to your Tuscany SCA C++ component</EM> 
+               </TD>
+               <TD>A document that describes how to expose a Tuscany SCA C++ component as a Web Service via an SCA Web Service Entrypoint.
+               </TD>
+            </TR>
+            </TBODY>
+         </TABLE> 
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="help"><H3>Getting Help</H3></A>
+
+         <P>First place to look is at the Tuscany FAQ at 
+         <A HREF="http://incubator.apache.org/tuscany/faq.html" TARGET="_blank">http://incubator.apache.org/tuscany/faq.html</A> </P>
+
+         <P>Any problem with this release can be reported to the Tuscany 
+         <A HREF="http://incubator.apache.org/tuscany/mail-lists.html" TARGET="_blank">mailing lists</A> or create a JIRA issue at 
+            <A HREF="http://issues.apache.org/jira/browse/Tuscany" TARGET="_blank">http://issues.apache.org/jira/browse/Tuscany</A>.</P>
+      </DIV>
                     				</div>
 			</td>
 			<td background="images/WhiteR.png" width="14"></td>

Modified: incubator/tuscany/site/site-publish/cpp_sdo_overview.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/site/site-publish/cpp_sdo_overview.html?view=diff&rev=443394&r1=443393&r2=443394
==============================================================================
--- incubator/tuscany/site/site-publish/cpp_sdo_overview.html (original)
+++ incubator/tuscany/site/site-publish/cpp_sdo_overview.html Thu Sep 14 09:26:18 2006
@@ -34,7 +34,7 @@
    
             
         
-    <title>Tuscany - Tuscany</title>
+    <title>Tuscany - Tuscany Service Data Objects - C++</title>
 </head>
 
 <body topmargin="0" leftmargin="0" marginwidth="0" marginheight="0">
@@ -281,17 +281,325 @@
 			<td background="images/WhiteL.png" width="15"></td>
 			<td width="100%">
 				<div id="content">
-                                            <p>(TBD) Desciption of SDO C++ system. </p>
-                                            <br />
-                                            <div align="center">
-              <img src="./images/SDO-Cpp.png" alt="Tuscany Overview" usemap="#tuscany_overview" border="0" />
-			 </div>
-                                            <map name="tuscany_overview">
-                <area shape="rect" coords="1,74,108,290" href="das_index.html" target="" />
-                <area shape="rect" coords="111,74,206,287" href="sdo_index.html" target="" />
-                <area shape="rect" coords="208,33,620,335" href="sca_index.html" target="" />
-                <area shape="rect" coords="620,32,859,333" href="tools_index.html" target="" />
-              </map>
+                                            <H2>The Tuscany SDO C++ Project</H2>
+                                            <P>This page provides a high-level overview of the C++ SDO (Service
+         Data Objects) subproject of the Apache Tuscany incubator project.</P>
+                    				</div>
+			</td>
+			<td background="images/WhiteR.png" width="14"></td>
+		</tr>
+		
+		<tr>
+			<td background="images/WhiteBL.png" width="15" height="14"></td>
+			<td background="images/WhiteB.png" ></td>
+			<td background="images/WhiteBR.png" width="14"></td>
+		</tr>
+		
+	</table>
+	            	                	<table class="content" border="0" width="90%" cellspacing="0" cellpadding="0" align="center">
+		<tr class="title" height="17" background="images/TitleC.png">
+			<td align="left">
+				<img src="images/TitleL.png" width="15" height="17" alt=""></td>
+			<td align="center" height="17" id="title" background="images/TitleC.png">
+				     <a href="#">SDO C++ Overview</a>
+			</td>
+			<td align="right">
+				<img src="images/TitleR.png" width="14" height="17" alt=""></td>
+		</tr>
+		<tr>
+			<td background="images/WhiteL.png" width="15"></td>
+			<td width="100%">
+				<div id="content">
+                                            <p>
+              Tuscany SDO C++ is an implementation of the 
+              <a href="http://download.boulder.ibm.com/ibmdl/pub/software/dw/specs/ws-sdo/SDO_Specification_CPP_V2.01.pdf">Service Data Objects 2.0 specification for C++ developers</a>.
+              To try it out, we recommend using the SDO C++ Milestone release 1 available from our 
+              <A HREF="http://incubator.apache.org/tuscany/downloads.html" target="_blank">downloads page</A>.
+              Alternatively, if you would like to work with the latest (possibly unstable) SDO C++ code, follow the 
+              <a href="cpp-projects.html">general instructions</a> for downloading and building SDO C++ from the Tuscany SVN repository.
+            </p>
+                                            <h3>SDO C++ Documents</h3>
+                                            <table>
+                <tr>
+                    <td>
+                        <a href="http://download.boulder.ibm.com/ibmdl/pub/software/dw/specs/ws-sdo/SDO_Specification_CPP_V2.01.pdf"> SDO Specification for C++ V2.01</a>
+                    </td>
+                    <td>
+                        The Service Data Objects specification for C++ Describes the data programming interfaces of SDO in the C++ language.
+                    </td>
+                </tr>
+                <tr>
+                    <td><a href="http://download.boulder.ibm.com/ibmdl/pub/software/dw/specs/ws-sdo/Next-Gen-Data-Programming-Whitepaper.pdf">SDO White Paper</a></td>
+                    <td>A white paper that explains the SDO programming model</td>
+                </tr>
+            </table>
+                    				</div>
+			</td>
+			<td background="images/WhiteR.png" width="14"></td>
+		</tr>
+		
+		<tr>
+			<td background="images/WhiteBL.png" width="15" height="14"></td>
+			<td background="images/WhiteB.png" ></td>
+			<td background="images/WhiteBR.png" width="14"></td>
+		</tr>
+		
+	</table>
+	            	                	<table class="content" border="0" width="90%" cellspacing="0" cellpadding="0" align="center">
+		<tr class="title" height="17" background="images/TitleC.png">
+			<td align="left">
+				<img src="images/TitleL.png" width="15" height="17" alt=""></td>
+			<td align="center" height="17" id="title" background="images/TitleC.png">
+				     <a href="#">Getting Started with the SDO C++ Milestone release 1</a>
+			</td>
+			<td align="right">
+				<img src="images/TitleR.png" width="14" height="17" alt=""></td>
+		</tr>
+		<tr>
+			<td background="images/WhiteL.png" width="15"></td>
+			<td width="100%">
+				<div id="content">
+                                            <DIV CLASS="section"> 
+ 
+         <P>If you haven't already done so, the first step is to download the SDO C++ Milestone release 1 of Apache Tuscany from our
+         <A HREF="http://incubator.apache.org/tuscany/downloads.html" target="_blank">downloads page</A>.<BR />
+         </P>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <H3>Contents</H3> 
+         <OL>
+            <LI><A HREF="#requirements">System Requirements</A></LI>
+            <LI><A HREF="#install">Installing Tuscany SDO..</A>
+                <UL>
+                    <LI><A HREF="#linuxbin">..from the binary release on Linux</A></LI>
+                    <LI><A HREF="#linuxsrc">..from the source release on Linux</A></LI>
+                    <LI><A HREF="#winbin">..from the binary release on Windows</A></LI>
+                    <LI><A HREF="#winsrc">..from the source release on Windows</A></LI>
+                </UL></LI>
+            <LI><A HREF="#samples">Samples</A>
+               <UL>
+                  <LI><A HREF="#linuxbld">Building the samples on Linux</A></LI>
+                  <LI><A HREF="#linuxrun">Running the samples on Linux</A></LI>
+                  <LI><A HREF="#winbld">Building the samples on Windows</A></LI>
+                  <LI><A HREF="#winrun">Running the samples on Windows</A></LI>
+               </UL></LI>
+            <LI><A HREF="#help">Getting Help</A></LI>
+         </OL>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="requirements"><H3>System Requirements</H3></A>
+
+         <P>In order to use Tuscany SDO there are some minimum requirements:</P> 
+         <TABLE CLASS="bodyTable">
+
+            <TBODY>
+            <TR CLASS="a">
+               <TD><B>Software</B></TD>
+               <TD><B>Download Link</B></TD>
+            </TR>
+            <TR CLASS="b">
+               <TD>Operating systems: 
+                  <UL>
+                     <LI>Windows XP SP2</LI> 
+                     <LI>Linux</LI> 
+                  </UL>
+               </TD>
+               <TD> 
+               </TD>
+            </TR>
+            <TR CLASS="a">
+               <TD>Axis2C Release 0.92</TD>
+
+               <TD> 
+                  <A HREF="http://ws.apache.org/axis2/c/download.cgi" TARGET="_blank">http://ws.apache.org/axis2/c/download.cgi</A><BR />
+                  Please download and follow the installation instructions. Ensure you can run the Axis2C samples                  
+               </TD>
+            </TR>
+            <TR CLASS="b">
+               <TD>libxml2 version 2.6.20</TD>
+
+               <TD> 
+                  <A HREF="http://xmlsoft.org/downloads.html" TARGET="_blank">http://xmlsoft.org/downloads.html</A><BR />
+                  Most Linux systems have libxml2 by default. On Windows you need to download and install libxml2 from <A HREF="http://www.zlatkovic.com/libxml.en.html" TARGET="_blank">http://www.zlatkovic.com/libxml.en.html</A><BR />
+                  Please read the installation notes for libxml2 particularly regarding it's pre-req's iconv and zlib on Windows. <BR />
+                  These libraries will need to be on the PATH in order to run Tuscany SDO.
+               </TD>
+            </TR>
+            </TBODY>
+         </TABLE>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="install"><H3>Installing Tuscany SDO for C++</H3></A>
+         <A NAME="linuxbin"><H3>Getting Tuscany SDO for C++ working with the binary release on Linux</H3></A>
+          <OL>
+              <LI>Extract the binary tar package to a folder</LI>
+              <LI>Add the *install_dir*/lib directory to the LD_LIBRARY_PATH environment variable</LI>
+          </OL>
+         <A NAME="linuxsrc"><H3>Getting Tuscany SDO for C++ working with the source release on Linux</H3></A>
+          <OL>
+              <LI>Extract the source tar package to a folder &lt;tuscany_sdo&gt;</LI>
+              <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>LIBXML2_INCLUDE=&lt;path to libxml2 includes&gt;</LI>                                      
+                  <LI>LIBXML2_LIB=&lt;path to libxml2 lib&gt;<BR />
+                   Note: If you are using the default installation of libxml2 these are usually:<BR />
+                   LIBXML2_LIB=/usr/lib<BR />
+                   LIBXML2_INCLUDE=/usr/include/libxml2<BR /></LI>
+                                                                                                
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL></LI>
+              <LI>Build the source with the following command sequence:
+                  <UL>
+                      <LI>./configure</LI>
+                      <LI>make</LI>
+                      <LI>make install</LI>
+                  </UL>
+	              NOTE: If you don't provide a --prefix configure option, it will by default install into
+                  /usr/local/tuscany/sdo</LI>
+              <LI>Run the test:
+                  <UL>
+                      <LI>cd to &lt;tuscany_sdo&gt;/runtime/core/test</LI>
+                      <LI>./tuscany_sdo_test</LI>
+                  </UL></LI>
+          </OL>
+           
+        <A NAME="winbin"><H3>Getting Tuscany SDO for C++ working with the binary release on Windows</H3></A>
+          <OL>
+              <LI>Unzip the supplied zip file to a folder</LI>
+              <LI>Add the *install_dir*\bin directory to the PATH environment variable</LI>
+          </OL>
+        <A NAME="winsrc"><H3>Getting Tuscany SDO for C++ working with the source release on Windows</H3></A>
+           <OL>   
+              <LI>Unzip the supplied source zip file</LI>
+              <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>LIBXML2_HOME=&lt;path to installed libxml2&gt;</LI>
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL></LI>
+              <LI>You must have set up the environment for Microsoft Visual C++ tools. The build command 
+                  will call vcvars32 to set the environment. Ensure the directory containing this is on your path.
+                  This will be where you installed the compiler.</LI>
+              <LI>Build the source:
+                  <UL>
+                      <LI>cd &lt;to where you unzipped the source&gt;</LI>
+                      <LI>build</LI>                      
+                  </UL>
+	              This will build all the projects and put the required output into the 'deploy' directory<BR /><BR />
+                  Alternatively, open the workspace tuscany_sdo.dsw in Visual Studio 6 - you can build projects individually
+                  or build the test project to build all its dependencies. Running the test project should give a list of
+                  tests passed - this is currently 108 tests, no failures.</LI>
+              <LI>Add the 'deploy'\bin directory PATH environment variable</LI>
+          </OL>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="samples"><H3>Samples</H3></A>
+          <P>Tuscany SDO C++ includes some simple technology samples that demonstrate some of the basic sceanrios for C++ SDO. 
+            This page describes the samples and what is needed to install and run them.
+         </P>
+          <UL>
+         <LI>The ObjectCreation sample demonstrates building the metadata programmatically, followed by use 
+            of the metadata to instantiate objects in a graph.
+         </LI>
+         <LI>The XSDLoading sample shows how to load metadata from an XSD, and how to check for errors during 
+            parsing. The parser gathers all non-fatal errors into one list, so all errors can be checked at one
+            time after parsing. Elements which contained errors will have been omitted from the resulting metadata.
+         </LI>
+         <LI>The ChangeSummarySave sample modifies a data graph of employees, and saves the modified graph with
+            its change summary. The output in ChangeSummarySave-output.xml shows the summary and its relationship 
+            by references to the data graph.
+         </LI>
+         <LI>The Substitutes sample shows how to use substitites in XSD  to achieve a property which will accept a 
+            range of types.
+         </LI>
+         <LI>The Query sample shows how to use XPath to navigate within a graph to the required element. Note 
+            that exceptions such as "path not found" may well be thrown if the XPath specified does not lead to
+            a real object in the graph.
+         </LI>
+          </UL>
+         <P>The SDO samples are built together into a single executable called sdo_misc.exe on Windows and sdo_misc on Linux
+         </P>
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="linuxbld"><H3>Building the samples on Linux</H3></A>
+         <P>If using the binary distribution the samples are built and installed in
+            &lt;tuscany_sdo_install_dir&gt;/samples - go directly to <A HREF="#linuxrun">Running the samples on Linux</A>.</P>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL>
+             </LI>
+             <LI>Build the source with the following command sequence:
+                  <UL>
+                      <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples</LI>
+                      <LI>./configure</LI>
+                      <LI>make</LI>
+                      <LI>make install</LI>
+                  </UL>
+	              NOTE: If you don't provide a --prefix configure option, it will by default install into
+                  /usr/local/tuscany/sdo/samples/misc</LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="linuxrun"><H3>Running the samples on Linux</H3></A>
+         <OL>
+             <LI>Ensure that &lt;tuscany_sdo_install_dir&gt;/lib is included in the LD_LIBRARY_PATH environment variable
+             </LI>
+             <LI>Run the sample with the following commands:
+                <UL>
+                   <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples/misc/deploy</LI>
+                   <LI>./bin/sdo_misc</LI>
+                </UL>
+             </LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section">
+         <A NAME="winbld"><H3>Building the samples on Windows</H3></A>
+         <P>If using the binary distribution the samples are built and installed in
+            &lt;tuscany_sdo_install_dir&gt;/samples - go directly to <A HREF="#winrun">Running the samples on Windows</A>.</P>
+         <OL>
+             <LI>The following environment variables are required:                                 
+                <UL>
+                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                     
+                  <LI>AXIS2C_HOME=&lt;path to axis2c version 0.92&gt;</LI>
+                </UL>
+             </LI>
+             <LI>You must have set up the environment for Microsoft Visual C++ tools.
+                 The build command will call vcvars32 to set the environment. Ensure the 
+                 directory containing this is on your path. This will be where you 
+                 installed the compiler.
+             </LI>
+             <LI>Build the source, either via the Visual Studio 6 project under 
+                 &lt;tuscany_sdo_install_dir&gt;\samples\ides or via the command-line build file
+                 found at &lt;tuscany_sdo_install_dir&gt;\samples\ides\devstudio6\projects\misc\build.cmd
+                 which will build and deploy the samples.
+             </LI>
+         </OL>                                                  
+        </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="winrun"><H3>Running the samples on Windows</H3></A>
+         <OL>
+             <LI>Ensure that &lt;tuscany_sdo_install_dir&gt;\bin is included in the PATH environment variable
+             </LI>
+             <LI>Run the sample with the following commands:
+                <UL>
+                   <LI>cd &lt;tuscany_sdo_install_dir&gt;/samples/misc/deploy</LI>
+                   <LI>bin\sdo_misc</LI>
+                </UL>
+             </LI>
+         </OL>                                                  
+      </DIV>
+                                            <DIV CLASS="section"> 
+         <A NAME="help"><H3>Getting Help</H3></A>
+
+         <P>First place to look is at the Tuscany FAQ at 
+         <A HREF="http://incubator.apache.org/tuscany/faq.html" TARGET="_blank">http://incubator.apache.org/tuscany/faq.html</A> </P>
+
+         <P>Any problem with this release can be reported to the Tuscany 
+         <A HREF="http://incubator.apache.org/tuscany/mail-lists.html" TARGET="_blank">mailing lists</A> or create a JIRA issue at 
+         <A HREF="http://issues.apache.org/jira/browse/Tuscany" TARGET="_blank">http://issues.apache.org/jira/browse/Tuscany</A>.</P>
+      </DIV>
                     				</div>
 			</td>
 			<td background="images/WhiteR.png" width="14"></td>



---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org