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 2007/03/06 17:57:52 UTC
svn commit: r515211 - in /incubator/tuscany/cpp/sca: GettingStarted.html
doc/Axis2CWSExtension.html doc/CppExtension.html doc/RESTExtension.html
doc/RubyExtension.html doc/SCAExtension.html
Author: ajborley
Date: Tue Mar 6 08:57:52 2007
New Revision: 515211
URL: http://svn.apache.org/viewvc?view=rev&rev=515211
Log:
More documentation updates
Modified:
incubator/tuscany/cpp/sca/GettingStarted.html
incubator/tuscany/cpp/sca/doc/Axis2CWSExtension.html
incubator/tuscany/cpp/sca/doc/CppExtension.html
incubator/tuscany/cpp/sca/doc/RESTExtension.html
incubator/tuscany/cpp/sca/doc/RubyExtension.html
incubator/tuscany/cpp/sca/doc/SCAExtension.html
Modified: incubator/tuscany/cpp/sca/GettingStarted.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/GettingStarted.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/GettingStarted.html (original)
+++ incubator/tuscany/cpp/sca/GettingStarted.html Tue Mar 6 08:57:52 2007
@@ -306,7 +306,7 @@
<A HREF="doc/CppExtension.html">C++</A>
</TD>
<TD>Provides the SCA C++ client API and enables C++ component implementations
- and interfaces. See the
+ and interfaces. See the <A HREF="doc/CppExtension.html">C++ extension documentation</A>, the
<A HREF="http://www.osoa.org/display/Main/Service+Component+Architecture+Specifications">SCA
C++ Client and Implementation specification</A> for more details about the SCA C++
Programming Model and the <A HREF="doc/CppExtension.html#components">Creating C++ SCA Components</A>
@@ -393,9 +393,9 @@
<A HREF="doc/RESTExtension.html">REST extension documentation</A> for more details.<BR/>
<STRONG>Requires:</STRONG>
<UL>
- <LI><A HREF="http://httpd.apache.org" TARGET="_blank">Apache HTTPD version 2.2</TD>
+ <LI><A HREF="http://httpd.apache.org" TARGET="_blank">Apache HTTPD version 2.2</A>
- for building and running the REST Service extension</LI>
- <LI><A HREF="http://curl.haxx.se/download.html" TARGET="_blank">libcurl version 7.15 or higher</TD>
+ <LI><A HREF="http://curl.haxx.se/download.html" TARGET="_blank">libcurl version 7.15 or higher</A>
- for building and running the REST Reference extension</LI>
</UL>
</TD>
@@ -441,13 +441,13 @@
<TABLE CLASS="bodyTable">
<TBODY>
<TR CLASS="a">
- <TD STYLE="vertical-align: top; white-space: nowrap;"><A HREF="doc/CPPComponents.html">Creating and building a Tuscany SCA C++ component</A>
+ <TD STYLE="vertical-align: top; white-space: nowrap;"><A HREF="doc/CPPExtension.html#components">Creating and building a Tuscany SCA C++ component</A>
</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;"><A HREF="doc/Axis2CWSService.html">Enabling Web Service access to your Tuscany SCA component</A>
+ <TD STYLE="vertical-align: top; white-space: nowrap;"><A HREF="doc/Axis2CWSExtension.html#service">Enabling Web Service access to your Tuscany SCA component</A>
</TD>
<TD>A document that describes how to expose a Tuscany SCA C++ component as a Web Service via the Tuscany Axis2/C Web Service support.
</TD>
Modified: incubator/tuscany/cpp/sca/doc/Axis2CWSExtension.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/doc/Axis2CWSExtension.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/doc/Axis2CWSExtension.html (original)
+++ incubator/tuscany/cpp/sca/doc/Axis2CWSExtension.html Tue Mar 6 08:57:52 2007
@@ -30,20 +30,20 @@
<LINK HREF="css/maven-theme.css" MEDIA="print" REL="stylesheet"
TYPE="text/css">
- <TITLE>Tuscany SCA Native - Enabling Axis2C Web Services</TITLE>
+ <TITLE>Tuscany SCA Native - Axis2/C Web Services Extension</TITLE>
</HEAD>
<BODY>
<DIV ID="bodyColumn">
<DIV ID="contentBox">
<DIV CLASS="section">
- <H2>Tuscany SCA Native - Enabling Axis2C Web Services</H2>
+ <H1>Tuscany SCA Native - Axis2/C Web Services Extension</H1>
- <P>This document describes the deployment and use of the Axis2C Web Service
- (binding.ws) service support in the Apache Tuscany SCA Native runtime.
+ <P>This document describes the installation, deployment and use of the Axis2/C Web Service
+ support in the Apache Tuscany SCA Native runtime.
</P>
<P>The WS service code is based on <A HREF="http://ws.apache.org/axis2/c">Apache
- Axis2C version 0.96</A> and allows SCA components to be invoked via Web
+ Axis2/C version 0.96</A> and allows SCA components to be invoked via Web
Service calls.
</P>
<P>WS service currently supports Document/literal Wrapped style Web Services
@@ -63,7 +63,15 @@
<DIV CLASS="section">
<H2>Contents</H2>
<OL>
- <LI><A HREF="#deploy">Deploying the Tuscany Web Service support to Axis2C..</A>
+ <LI><A HREF="#requirements">System Requirements</A></LI>
+ <LI><A HREF="#install">Installing the Tuscany SCA Axis2/C Web Services Extension..</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="#deploy">Deploying the Tuscany Web Service support to Axis2/C..</A>
<UL>
<LI><A HREF="#autodeploy">..automatically via scripts</A></LI>
<LI><A HREF="#mandeploy">..manually</A></LI>
@@ -74,17 +82,102 @@
</OL>
</DIV>
+ <DIV CLASS="section">
+ <A NAME="requirements"><H2>System Requirements</H2></A>
+
+ <P>In order to install and use the Tuscany SCA Axis2/C Web Services Extension there are some
+ extra requirements in addition to the <A HREF="../GettingStarted.html#requirements">Tuscany
+ SCA requirements</A>:</P>
+ <TABLE CLASS="bodyTable">
+
+ <TBODY>
+ <TR CLASS="a">
+ <TD><B>Software</B></TD>
+ <TD><B>Download Link</B></TD>
+ </TR>
+ <TR CLASS="b">
+ <TD>Axis2/C version 0.96</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 Axis2/C samples.
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="install"><H2>Installing the Tuscany SCA Axis2/C Extension</H2></A>
+ <A NAME="linuxbin"><H3>Getting the Tuscany SCA Axis2/C Extension working with the binary release on Linux</H3></A>
+ <OL>
+ <LI>Ensure the AXIS2C_HOME environment variable is set to the Axis2/C installation</LI>
+ <LI>Deploy the Axis2/C Web Services extension by following the <A HREF="#deploy">deployment steps</A></LI>
+ </OL>
+ <A NAME="linuxsrc"><H3>Getting the Tuscany SCA Axis2/C Extension working with the source release on Linux</H3></A>
+ <OL>
+ <LI>You will need the Tuscany SCA and SDO libraries - follow the instructions
+ <A HREF="../GettingStarted.html">here</A> to build the SCA libraries and default extensions</LI>
+ <LI>The following environment variables are required:
+ <UL>
+ <LI>TUSCANY_SCACPP=<path to built Tuscany SCA></LI>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI>
+ <LI>AXIS2C_HOME=<path to Axis2/C installation></LI>
+ </UL></LI>
+ <LI>Build the Axis2/C source only with the following command sequence:
+ <UL>
+ <LI>cd <tuscany_sca_install_dir></LI>
+ <LI>./configure --prefix=$TUSCANY_SCACPP --enable-wsbinding --enable-cpp=no</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 the Tuscany SCA Axis2/C Extension working with the binary release on Windows</H3></A>
+ <OL>
+ <LI>Ensure the AXIS2C_HOME environment variable is set to the Axis2/C installation</LI>
+ <LI>Deploy the Axis2/C Web Services extension by following the <A HREF="#deploy">deployment steps</A></LI>
+ </OL>
+ <A NAME="winsrc"><H3>Getting the Tuscany SCA Axis2/C Extension 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_SCACPP=<path to built Tuscany SCA></LI>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI>
+ <LI>AXIS2C_HOME=<path to Axis2/C installation></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 <to where you unzipped the source></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 at <tuscany_sca_install_dir>/projects/tuscany_sca/tuscany_sca.dsw
+ in Visual Studio 6 or at at <tuscany_sca_install_dir>/projectsvc7/tuscany_sca/tuscany_sca.sln
+ in Visual Studio 7.1 - you can build projects individually
+ or build the samples to rebuild all the projects</LI>
+ </OL>
+ </DIV>
+
<DIV CLASS="section">
- <A NAME="deploy"><H2>Deploying the Tuscany Web Service support to Axis2C</H2></A>
+ <A NAME="deploy"><H2>Deploying the Tuscany Web Service support to Axis2/C</H2></A>
<A NAME="autodeploy"><H3>Deploying via scripts</H3></A>
- <P>Tuscany provides simple shell scripts to deploy the Web Service support to Axis2C.
- However, the script <STRONG>will overwrite your Axis2C axis.xml file</STRONG>, so if you
- have altered your axis2.xml from the default provided by the Axis2C distribution, it is
+ <P>Tuscany provides simple shell scripts to deploy the Web Service support to Axis2/C.
+ However, the script <STRONG>will overwrite your Axis2/C axis.xml file</STRONG>, so if you
+ have altered your axis2.xml from the default provided by the Axis2/C distribution, it is
recommended that you follow the <A HREF="#mandeploy">manual deployment</A> steps
outlined below.
</P>
- <P>To automatically deploy Tuscany Web Service support to Axis2C on Linux:
+ <P>To automatically deploy Tuscany Web Service support to Axis2/C on Linux:
<OL>
<LI>The AXIS2C_HOME environment variable is required:
<UL>
@@ -98,7 +191,7 @@
</LI>
</OL>
</P>
- <P>To automatically deploy Tuscany Web Service support to Axis2C on Windows:
+ <P>To automatically deploy Tuscany Web Service support to Axis2/C on Windows:
<OL>
<LI>The AXIS2C_HOME environment variable is required:
<UL>
@@ -115,7 +208,7 @@
<A NAME="mandeploy"><H3>Deploying manually</H3></A>
- <P>To deploy Tuscany Web Service support to Axis2C manually, use the following steps:
+ <P>To deploy Tuscany Web Service support to Axis2/C manually, use the following steps:
</P>
<OL>
<LI>
@@ -213,10 +306,10 @@
<reference>CalculatorComponent/CalculatorService</reference>
</service></PRE>
</LI>
- <LI>You are now ready to start the Axis2C HTTP server. Remember you will need to have the
+ <LI>You are now ready to start the Axis2/C HTTP server. Remember you will need to have the
TUSCANY_SCACPP, TUSCANY_SDOCPP and AXIS2C_HOME environment variables set,
- as well as the SCA and SDO bin directories and the Axis2C lib directory on
- your PATH on Windows or the SCA, SDO and Axis2C lib directories on
+ as well as the SCA and SDO bin directories and the Axis2/C lib directory on
+ your PATH on Windows or the SCA, SDO and Axis2/C lib directories on
your LD_LIBRARY_PATH on Linux. You will also need to set the TUSCANY_SCACPP_SYSTEM_ROOT
and TUSCANY_SCACPP_DEFAULT_COMPONENT environment variables to the
path to your SCA component directory structure and the default component respectively.
@@ -244,8 +337,8 @@
</UL>
</LI>
</OL>
- <P>Your component should now be exposed as an Axis2C Web Service, via the WS
- service you created. See the Axis2C documentation for writing clients to
+ <P>Your component should now be exposed as an Axis2/C Web Service, via the WS
+ service you created. See the Axis2/C documentation for writing clients to
invoke the Web Service, or you can use any other Web Service client platform
(e.g. <A HREF="http://ws.apache.org/axis2">Axis2 for Java</A>), or you can
invoke your service from another SCA application by using Tuscany's WS
Modified: incubator/tuscany/cpp/sca/doc/CppExtension.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/doc/CppExtension.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/doc/CppExtension.html (original)
+++ incubator/tuscany/cpp/sca/doc/CppExtension.html Tue Mar 6 08:57:52 2007
@@ -37,10 +37,12 @@
<DIV ID="bodyColumn">
<DIV ID="contentBox">
<DIV CLASS="section">
- <H1>Tuscany SCA Native - Creating C++ SCA Components</H1>
-
- <P>This document describes how to create and run SCA components in Tuscany SCA Native
- milestone release 3.
+ <H1>Tuscany SCA Native - C++ Extension</H1>
+ <P>The Tuscany C++ extension allows C++ classes to be used as components in
+ SCA composites and as clients that can invoke SCA services.
+ </P>
+ <P>This document describes how to build and install the C++ extension and create and run SCA
+ components in Tuscany SCA Native milestone release 3.
</P>
<P>See the <A HREF="http://www.osoa.org/display/Main/Service+Component+Architecture+Specifications">SCA
C++ Client and Implementation specification</A> for more details about the SCA C++
@@ -51,8 +53,109 @@
demonstrate the use of C++ components
</P>
</DIV>
+
+ <DIV CLASS="section">
+ <H2>Contents</H2>
+ <OL>
+ <LI><A HREF="#requirements">System Requirements</A></LI>
+ <LI><A HREF="#install">Installing the Tuscany SCA C++ Extension..</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="#components">Creating and deploying an SCA C++ Component</A></LI>
+ <LI><A HREF="#help">Getting help</A></LI>
+ </OL>
+ </DIV>
+ <DIV CLASS="section">
+ <A NAME="requirements"><H2>System Requirements</H2></A>
+
+ <P>In order to install and use the Tuscany SCA C++ Extension there are some
+ extra requirements in addition to the <A HREF="../GettingStarted.html#requirements">Tuscany
+ SCA requirements</A>:</P>
+ <TABLE CLASS="bodyTable">
+
+ <TBODY>
+ <TR CLASS="a">
+ <TD><B>Software</B></TD>
+ <TD><B>Download Link</B></TD>
+ </TR>
+ <TR CLASS="b">
+ <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</A><BR/>
+ For building and running the SCAGEN code generation tool, which is used when developing
+ Tuscany SCA C++ components. Please download and follow the installation instructions</TD>
+ </TR>
+ <TR CLASS="a">
+ <TD>Apache Ant 1.6 or later</TD>
+ <TD><A HREF="http://ant.apache.org" TARGET="_blank">http://ant.apache.org</A><BR/>
+ For building the SCAGEN code generation tool. This is only required when building
+ the C++ extension from a source distribution of Tuscany SCA Native.
+ Please download and follow the installation instructions</TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="install"><H2>Installing the Tuscany SCA C++ Extension</H2></A>
+ <A NAME="linuxbin"><H3>Getting the Tuscany SCA C++ Extension working with the binary release on Linux</H3></A>
+ <OL>
+ <LI>Add the <tuscany_sca_install_dir>/extensions/cpp/lib directory to the PATH environment variable</LI>
+ </OL>
+ <A NAME="linuxsrc"><H3>Getting the Tuscany SCA C++ Extension working with the source release on Linux</H3></A>
+ <OL>
+ <LI>You will need the Tuscany SCA kernel and SDO libraries - follow the instructions
+ <A HREF="../GettingStarted.html">here</A> to build the SCA libraries and default extensions</LI>
+ <LI>The following environment variables are required:
+ <UL>
+ <LI>TUSCANY_SCACPP=<path to built Tuscany SCA></LI>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI>
+ </UL></LI>
+ <LI>Build the C++ source only with the following command sequence:
+ <UL>
+ <LI>cd <tuscany_sca_install_dir></LI>
+ <LI>./configure --prefix=$TUSCANY_SCACPP --enable-cpp</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 the Tuscany SCA C++ Extension working with the binary release on Windows</H3></A>
+ <OL>
+ <LI>Add the <tuscany_sca_install_dir>/extensions/cpp/lib directory to the LD_LIBRARY_PATH environment variable</LI>
+ </OL>
+ <A NAME="winsrc"><H3>Getting the Tuscany SCA C++ Extension 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_SCACPP=<path to built Tuscany SCA>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO>
+ </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 <to where you unzipped the source></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 at <tuscany_sca_install_dir>/projects/tuscany_sca/tuscany_sca.dsw
+ in Visual Studio 6 or at at <tuscany_sca_install_dir>/projectsvc7/tuscany_sca/tuscany_sca.sln
+ in Visual Studio 7.1 - you can build projects individually
+ <LI>Set the TUSCANY_SCACPP environment variable to point to the 'deploy' directory that was just created</LI>
+ </OL>
+ </DIV>
+
<DIV CLASS="section">
- <H2>Creating and deploying an SCA C++ Component</H2>
+ <A NAME="components"><H2>Creating and deploying an SCA C++ Component</H2></A>
<P>Each SCA C++ component needs:
</P>
<UL>
Modified: incubator/tuscany/cpp/sca/doc/RESTExtension.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/doc/RESTExtension.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/doc/RESTExtension.html (original)
+++ incubator/tuscany/cpp/sca/doc/RESTExtension.html Tue Mar 6 08:57:52 2007
@@ -37,23 +37,234 @@
<DIV ID="bodyColumn">
<DIV ID="contentBox">
<DIV CLASS="section">
- <H2>Tuscany SCA Native - REST Extension</H2>
+ <H1>Tuscany SCA Native - REST Extension</H1>
<P>This document describes the deployment and use of the REST
- (binding.rest) support in the Apache Tuscany SCA Native runtime.
+ binding support in the Apache Tuscany SCA Native runtime.
</P>
- TODO fix this doc!
+ <P>The Tuscany REST extension allows SCA services and references to be invoked
+ via HTTP REST calls
+ </P>
+ <P>The following samples demonstrate use of the REST extension:</P>
+ <UL>
+ <LI><A HREF="../samples/RestCalculator/README.html">RestCalculator</A></LI>
+ <LI><A HREF="../samples/RestCustomer/README.html">RestCustomer</A></LI>
+ <LI><A HREF="../samples/RestYahoo/README.html">RestYahoo</A></LI>
+ <LI><A HREF="../samples/AlertAggregator/README.html">AlertAggregator</A></LI>
+ </UL>
</DIV>
-
<DIV CLASS="section">
<H2>Contents</H2>
<OL>
- <LI><A HREF="#deploy">Deploying the Tuscany REST service support to Apache HTTPD..</A></LI>
+ <LI><A HREF="#requirements">System Requirements</A></LI>
+ <LI><A HREF="#install">Installing the Tuscany SCA REST Extension..</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="#deploy">Deploying the Tuscany REST Service extension to the HTTPD server</A></LI>
+ <LI><A HREF="#resource">The Tuscany REST extension resource pattern</A></LI>
+ <LI><A HREF="#rpc">The Tuscany REST extension RPC pattern</A></LI>
+ <LI><A HREF="#help">Getting help</A></LI>
</OL>
</DIV>
+ <DIV CLASS="section">
+ <A NAME="requirements"><H2>System Requirements</H2></A>
+
+ <P>In order to install and use the Tuscany SCA REST Extension there are some
+ extra requirements in addition to the <A HREF="../GettingStarted.html#requirements">Tuscany
+ SCA requirements</A>:</P>
+ <TABLE CLASS="bodyTable">
+
+ <TBODY>
+ <TR CLASS="a">
+ <TD><B>Software</B></TD>
+ <TD><B>Download Link</B></TD>
+ </TR>
+ <TR CLASS="b">
+ <TD>Apache HTTPD version 2.2</TD>
+ <TD>
+ <A HREF="http://httpd.apache.org"
+ TARGET="_blank">http://httpd.apache.org</A><BR/>
+ Please download and follow the installation instructions. This is required
+ for building the REST Service extension and for hosting and running REST services.
+ </TD>
+ </TR>
+ <TR CLASS="a">
+ <TD>libcurl version 7.15 or higher</TD>
+ <TD>
+ <A HREF="http://curl.haxx.se/download.html"
+ TARGET="_blank">http://curl.haxx.se/download.html</A><BR/>
+ Please download and follow the installation instructions. This is required
+ for building the REST Reference extension and for calling REST references.<BR/>
+ On Windows, the extension was developed and tested against the "Win32 - MSVC 7.15.1 devel"
+ library provided by Chris Drake. On Linux and Mac, the libcurl libraries were built from
+ the 7.16.1 source.
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="install"><H2>Installing the Tuscany SCA REST Extension</H2></A>
+ <A NAME="linuxbin"><H3>Getting the Tuscany SCA REST Extension working with the binary release on Linux</H3></A>
+ <OL>
+ <LI>Follow the <A HREF="#deploy">deployment steps</A> below to ensure the HTTPD server
+ invokes Tuscany when it receives an appropriate HTTP request</LI>
+ <LI>Ensure the libcurl and HTTPD libraries are available on the LD_LIBRARY_PATH environment variable</LI>
+ </OL>
+ <A NAME="linuxsrc"><H3>Getting the Tuscany SCA REST Extension working with the source release on Linux</H3></A>
+ <OL>
+ <LI>You will need the Tuscany SCA and SDO libraries - follow the instructions
+ <A HREF="../GettingStarted.html">here</A> to build the SCA libraries and default extensions</LI>
+ <LI>The following environment variables are required:
+ <UL>
+ <LI>TUSCANY_SCACPP=<path to built Tuscany SCA>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO>
+ <LI>APR_INCLUDE=<path to APR includes></LI>
+ <LI>HTTPD_INCLUDE=<path to HTTPD includes><BR/>
+ Note: If you are using a default installation of HTTPD these are usually:<BR/>
+ APR_INCLUDE=/usr/include/apr-1<BR/>
+ HTTPD_INCLUDE=/usr/include/httpd</LI>
+ <LI>CURL_INCLUDE=<path to libcurl includes></LI>
+ <LI>CURL_LIB<path to libcurl libraries><BR/>
+ Note: If you are using a default installation of libcurl these are usually:<BR/>
+ CURL_INCLUDE=/usr/include/curl<BR/>
+ CURL_LIB=/usr/lib</LI>
+ </UL></LI>
+ <LI>Build the REST source only with the following command sequence:
+ <UL>
+ <LI>cd <tuscany_sca_install_dir></LI>
+ <LI>./configure --prefix=$TUSCANY_SCACPP --enable-restbinding --enable-cpp=no --enable-wsbinding=no</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 the Tuscany SCA REST Extension working with the binary release on Windows</H3></A>
+ <OL>
+ <LI>Follow the <A HREF="#deploy">deployment steps</A> below to ensure the HTTPD server
+ invokes Tuscany when it receives an appropriate HTTP request</LI>
+ <LI>Ensure the libcurl and HTTPD libraries are available on the PATH environment variable</LI>
+ </OL>
+ <A NAME="winsrc"><H3>Getting the Tuscany SCA REST Extension 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_SCACPP=<path to built Tuscany SCA>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO>
+ <LI>HTTPD_HOME=<path to installed HTTPD server>
+ <LI>LIBCURL_HOME=<path to installed libcurl libraries>
+ </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 <to where you unzipped the source></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 at <tuscany_sca_install_dir>/projects/tuscany_sca/tuscany_sca.dsw
+ in Visual Studio 6 or at at <tuscany_sca_install_dir>/projectsvc7/tuscany_sca/tuscany_sca.sln
+ in Visual Studio 7.1 - you can build projects individually
+ or build the samples to rebuild all the projects</LI>
+ </OL>
+ </DIV>
<DIV CLASS="section">
+ <A NAME="deploy"><H2>Deploying the Tuscany REST Service extension to the HTTPD server</H2></A>
+ <P>The following samples demonstrate use of the REST extension:</P>
+ <UL>
+ <LI><A HREF="../samples/RestCalculator/README.html">RestCalculator</A></LI>
+ <LI><A HREF="../samples/RestCustomer/README.html">RestCustomer</A></LI>
+ <LI><A HREF="../samples/RestYahoo/README.html">RestYahoo</A></LI>
+ <LI><A HREF="../samples/AlertAggregator/README.html">AlertAggregator</A></LI>
+ </UL>
+ <P>Each of these samples generate a set of configuration files for the HTTPD server. Use the startserver
+ script that comes with each sample to generate the files and start the server with the REST Service
+ extension enabled. The instructions below detail the information that is provided in these configuration
+ files.</P>
+ <OL>
+ <LI>On Windows, load the sca_rest_module into HTTPD by adding the following line to the conf/httpd.conf file:
+<PRE>LoadModule sca_rest_module <path to installed Tuscany SCA>/extensions/rest/service/bin/tuscany_sca_mod_rest.dll</PRE>
+ On Linux, use the following line:
+<PRE>LoadModule sca_rest_module <path to installed Tuscany SCA>/extensions/rest/service/lib/libtuscany_sca_mod_rest.so</PRE>
+ </LI>
+ <LI>Set a TuscanyHome directive to the installation of Tuscany SCA Native:
+<PRE>TuscanyHome <path to installed Tuscany SCA></PRE>
+ </LI>
+ <LI>Create a Location directive for the URL to be used and set the sca_rest_module as the handler to
+ be invoked when requests for the location are received. Also set the TuscanyRoot directive for
+ this Location, set to the location of the SCA application to be invoked:
+<PRE>
+<Location /rest>
+ SetHandler sca_rest_module
+ TuscanyRoot <path to installed Tuscany SCA>/samples/RestCalculator/deploy/
+</Location>
+</PRE>
+ The above example will mean that calls to http://myserver/rest will be handled by Tuscany SCA Native
+ and configured to invoke the RestCalculator sample application.
+ </LI>
+ </OL>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="resource"><H2>Tuscany REST Extension Resource Pattern</H2></A>
+ <P>If the SCA service or reference uses an <interface.rest> interface, CRUD
+ (Create, Retrieve, Update, Delete) methods are mapped to HTTP verbs to access resource
+ representations as follows:</P>
+ <UL>
+ <LI>uri = create(resource)<BR/>
+ HTTP POST <binding-uri> + an XML element representing the resource to create<BR/>
+ Returns Location header containing the uri of the created resource</LI>
+ <LI>resource = retrieve()<BR/>
+ HTTP GET <binding-uri><BR/>
+ Returns an XML element representing the REST resource</LI>
+ <LI>resource = retrieve(uri, parm-value-1, parm-value-n)<BR/>
+ HTTP GET uri/parm-value-1/parm-value-n<BR/>
+ or if uri ends with a '?':<BR/>
+ HTTP GET uri?parm-name-1=parm-value1&parm-name-n=parm-value-n<BR/>
+ Returns an XML element representing the REST resource</LI>
+ <LI>update(resource)<BR/>
+ HTTP PUT <binding-uri> + an XML element representing the updated resource</LI>
+ <LI>update(uri, parm-1, parm-n, resource)<BR/>
+ HTTP PUT uri/parm-value-1/parm-value-n + an XML element representing the updated resource<BR/>
+ or if uri ends with a '?':<BR/>
+ HTTP PUT uri?parm-name-1=parm-value1&parm-name-n=parm-value-n + an XML element representing the updated resource</LI>
+ <LI>delete()<BR/>
+ HTTP DELETE <binding-uri></LI>
+ <LI>delete(uri, parm-1, parm-n)<BR/>
+ HTTP DELETE uri/parm-value-1/parm-value-n<BR/>
+ or if uri ends with a '?':<BR/>
+ HTTP DELETE uri?parm-name-1=parm-value1&parm-name-n=parm-value-n</LI>
+ </UL>
+ <P>In this mode, HTTP return codes are used almost as described in the Atom spec. Also
+ GET returns etags with the retrieved resource representations to help caching by clients.</P>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="rpc"><H2>Tuscany REST Extension RPC Pattern</H2></A>
+ <P>If the SCA service/reference does not use an <interface.rest> interface, then this is
+ not a real REST pattern, we simply flow method calls over XML / HTTP as follows:</P>
+ <UL><LI>result = method-abc(parm-1, parm-n)
+ <UL>
+ <LI>if single input parameter of complex type:<BR/>
+ HTTP POST <binding-uri>/method-abc + XML element representing the complex parameter</LI>
+ <LI>or if multiple parameters including parameters of complex types:<BR/>
+ HTTP POST <binding-uri>/method-abc + Mime multipart/form-data body containing one parameter per part</LI>
+ <LI>or if multiple parameters all of simple types:<BR/>
+ HTTP GET <binding-uri>/method-abc?parm-1-name=parm-1-value&parm-n-name=parm-n-value</LI>
+ </UL>
+ Returns an XML element representing the result</LI>
+ </UL>
</DIV>
<DIV CLASS="section">
Modified: incubator/tuscany/cpp/sca/doc/RubyExtension.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/doc/RubyExtension.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/doc/RubyExtension.html (original)
+++ incubator/tuscany/cpp/sca/doc/RubyExtension.html Tue Mar 6 08:57:52 2007
@@ -160,7 +160,6 @@
in Visual Studio 6 or at at <tuscany_sca_install_dir>/projectsvc7/tuscany_sca/tuscany_sca.sln
in Visual Studio 7.1 - 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>
Modified: incubator/tuscany/cpp/sca/doc/SCAExtension.html
URL: http://svn.apache.org/viewvc/incubator/tuscany/cpp/sca/doc/SCAExtension.html?view=diff&rev=515211&r1=515210&r2=515211
==============================================================================
--- incubator/tuscany/cpp/sca/doc/SCAExtension.html (original)
+++ incubator/tuscany/cpp/sca/doc/SCAExtension.html Tue Mar 6 08:57:52 2007
@@ -42,16 +42,135 @@
<P>This document describes the deployment and use of the SCA
binding support in the Apache Tuscany SCA Native runtime.
</P>
- TODO fix this doc!
+ <P>The Tuscany REST binding extension allows components to be invoked via REST
+ calls using the HTTP REST syntax.
+ </P>
+ <P>The following samples demonstrate use of the REST extension:</P>
+ <UL>
+ <LI><A HREF="../samples/RestCalculator/README.html">RestCalculator</A></LI>
+ <LI><A HREF="../samples/RestCustomer/README.html">RestCustomer</A></LI>
+ <LI><A HREF="../samples/RestYahoo/README.html">RestYahoo</A></LI>
+ <LI><A HREF="../samples/HTTPDBigBank/README.html">HTTPDBigBank</A></LI>
+ </UL>
</DIV>
-
<DIV CLASS="section">
<H2>Contents</H2>
<OL>
- <LI></LI>
+ <LI><A HREF="#requirements">System Requirements</A></LI>
+ <LI><A HREF="#install">Installing the Tuscany SCA Ruby Extension..</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="#pm">The Tuscany Ruby Programming Model</A></LI>
+ <UL>
+ <LI><A HREF="#clients">Clients</A></LI>
+ <LI><A HREF="#components">SCA Components</A></LI>
+ <LI><A HREF="#references">Component references</A></LI>
+ <LI><A HREF="#properties">Component properties</A></LI>
+ </UL>
+ <LI><A HREF="#help">Getting help</A></LI>
</OL>
</DIV>
+ <DIV CLASS="section">
+ <A NAME="requirements"><H2>System Requirements</H2></A>
+
+ <P>In order to install and use the Tuscany SCA Ruby Extension there are some
+ extra requirements in addition to the <A HREF="../GettingStarted.html#requirements">Tuscany
+ SCA requirements</A>:</P>
+ <TABLE CLASS="bodyTable">
+
+ <TBODY>
+ <TR CLASS="a">
+ <TD><B>Software</B></TD>
+ <TD><B>Download Link</B></TD>
+ </TR>
+ <TR CLASS="b">
+ <TD>Ruby version 1.8.x</TD>
+ <TD>
+ <A HREF="http://www.ruby-lang.org"
+ TARGET="_blank">http://www.ruby-lang.org</A><BR/>
+ Please download and follow the installation instructions. You should
+ be able to build the Tuscany SCA Ruby Extension with other versions of Ruby.
+ The extension has been tested with the
+ <A HREF="http://rubyforge.org/frs/download.php/12751/ruby185-21.exe">Ruby 1.8.5 One-Click Installer</A>
+ on Windows and the <A HREF="ftp://ftp.ruby-lang.org/pub/ruby/ruby-1.8.5-p12.tar.gz">1.8.5 source code</A>
+ (compiled locally) on Linux.
+ </TD>
+ </TR>
+ </TBODY>
+ </TABLE>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="install"><H2>Installing the Tuscany SCA Ruby Extension</H2></A>
+ <A NAME="linuxbin"><H3>Getting the Tuscany SCA Ruby Extension working with the binary release on Linux</H3></A>
+ <OL>
+ <LI>Ensure the Ruby libraries are available on the PATH environment variable</LI>
+ </OL>
+ <A NAME="linuxsrc"><H3>Getting the Tuscany SCA Ruby Extension working with the source release on Linux</H3></A>
+ <OL>
+ <LI>You will need the Tuscany SCA and SDO libraries - follow the instructions
+ <A HREF="../GettingStarted.html">here</A> to build the SCA libraries and default extensions</LI>
+ <LI>The following environment variables are required:
+ <UL>
+ <LI>TUSCANY_SCACPP=<path to built Tuscany SCA>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO>
+ <LI>RUBY_LIB=<path to Ruby libraries></LI>
+ <LI>RUBY_INCLUDE=<path to Ruby includes><BR/>
+ Note: If you are using a default installation of Ruby these are usually:<BR/>
+ RUBY_LIB=/usr/lib<BR/>
+ RUBY_INCLUDE=/usr/lib/ruby/1.8/i386-linux</LI>
+ </UL></LI>
+ <LI>Build the Ruby source only with the following command sequence:
+ <UL>
+ <LI>cd <tuscany_sca_install_dir></LI>
+ <LI>./configure --prefix=$TUSCANY_SCACPP --enable-ruby --enable-cpp=no</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 the Tuscany SCA Ruby Extension working with the binary release on Windows</H3></A>
+ <OL>
+ <LI>Ensure the Ruby libraries are available on the PATH environment variable</LI>
+ </OL>
+ <A NAME="winsrc"><H3>Getting the Tuscany SCA Ruby Extension 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_SCACPP=<path to built Tuscany SCA>
+ <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO>
+ <LI>RUBY_HOME=<path to installed Ruby>
+ </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 <to where you unzipped the source></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 at <tuscany_sca_install_dir>/projects/tuscany_sca/tuscany_sca.dsw
+ in Visual Studio 6 or at at <tuscany_sca_install_dir>/projectsvc7/tuscany_sca/tuscany_sca.sln
+ in Visual Studio 7.1 - you can build projects individually
+ or build the samples to rebuild all the projects</LI>
+ </OL>
+ </DIV>
+
+ <DIV CLASS="section">
+ <A NAME="pm"><H2>The Tuscany Ruby Programming Model</H2></A>
+ <P>This section will explain the Tuscany Ruby programming model to help you to
+ write your own Ruby components and clients.
+ </P>
+ </DIV>
<DIV CLASS="section">
</DIV>
---------------------------------------------------------------------
To unsubscribe, e-mail: tuscany-commits-unsubscribe@ws.apache.org
For additional commands, e-mail: tuscany-commits-help@ws.apache.org