From bdd0a41aed7edf21ec2a65cfa17a86af2ef8c48a Mon Sep 17 00:00:00 2001 From: dims Date: Tue, 17 Jun 2008 00:23:01 +0000 Subject: Move Tuscany from Incubator to top level. git-svn-id: http://svn.us.apache.org/repos/asf/tuscany@668359 13f79535-47bb-0310-9956-ffa450edef68 --- cpp/sca/GettingStarted.html | 487 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 487 insertions(+) create mode 100644 cpp/sca/GettingStarted.html (limited to 'cpp/sca/GettingStarted.html') diff --git a/cpp/sca/GettingStarted.html b/cpp/sca/GettingStarted.html new file mode 100644 index 0000000000..d0f3f2b50b --- /dev/null +++ b/cpp/sca/GettingStarted.html @@ -0,0 +1,487 @@ + + + + + + + + + + + + Tuscany SCA Native - Getting Started + + + +
+
+
+

Tuscany - Getting Started - SCA Native Milestone release 3

+ +

Tuscany SCA Native provides a runtime implementation for the Service Component + Architecture 0.96 Assembly specification and the 0.95 C++ Client & Implementation specification + (found here), + written in C++ and currently supports C++, Python and Ruby + component implementation types. This page describes what is needed to install and run Tuscany + SCA Native.
If you haven't already done so, the first + step is to download the SCA Native Milestone release 3 of Apache Tuscany from our + download page.
+

+
+ +
+

Contents

+
    +
  1. System Requirements
    2. +
  2. Installing Tuscany SCA.. +
    3. +
  3. Tuscany SCA Extensions
    4. +
  4. Samples
    5. +
  5. User Guide Documents
    6. +
  6. Getting Help
    7. +
+
+ + +
+

System Requirements

 + +

In order to run Tuscany SCA there are some + minimum requirements:

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
SoftwareNotes and Download Link
Operating systems: +
    + +
  • Windows XP SP2
    • +
  • Linux
    • +
  • Mac OS X
    • +
+ 		+ Linux distributions tested on include Redhat Enterprise Linux v3, Redhat Enterprise Linux v4, + Ubuntu 6.06 LTS and Fedora Core 5. +
Tuscany SDO for C++ Milestone Release 3 + http://incubator.apache.org/tuscany/download.html
+ Please download and follow the installation instructions +
Optional: Java SDK 1.4 or later + http://java.sun.com/javase/downloads/index.jsp
+ This is required for building and running the SCAGEN code generation tool, which is used + when developing Tuscany SCA C++ components. This is not required when only developing + Python or Ruby SCA components. +
Optional: Apache Ant 1.6 or later + http://ant.apache.org
+ This is required for building the SCAGEN code generation tool, which is used + when developing Tuscany SCA C++ components. This is only required when building + the C++ extension from a source distribution of Tuscany SCA Native. +
Optional: Python version 2.5 + http://www.python.org/download/
+ This is required for building or running the Tuscany SCA Python extension + (see below). + Please download and follow the installation instructions. +
Optional: Ruby version 1.8.x + http://www.ruby-lang.org
+ This is required for building or running the Tuscany SCA Ruby extension + (see below). + Please download and follow the installation instructions. You should + be able to build the Tuscany SCA Ruby Extension with other versions of Ruby. +
Optional: Axis2/C Release 0.96 + http://ws.apache.org/axis2/c/download.cgi
+ This is required for building and running the Tuscany SCA Web Service extension + (see below). + Please download and follow the installation instructions. Ensure you can run the Axis2/C samples +
Optional: Apache HTTPD version 2.2 + http://httpd.apache.org
+ This is required for building and running the Tuscany SCA REST extension + (see below). It is also required for some + of the Web Services samples. + Please download and follow the installation instructions. +
Optional: libcurl version 7.15 or higher + http://curl.haxx.se/download.html
+ This is required for building and running the Tuscany SCA REST extension + (see below). + Please download and follow the installation instructions. +
+
+
+

Installing Tuscany SCA Native

 +

Getting Tuscany SCA Native working with the source release on Linux or Mac OS X

 +
    +
  1. Extract the source tar package to a folder <tuscany_sca_install_dir>
    2. +
  2. The following environment variables are required: +
      +
    • TUSCANY_SDOCPP=<path to installed Tuscany SDO> +
    3. +
  3. See the extensions documentation for other environment variables and + configration flags that are required to build specific extensions.
    4. +
  4. To build only the Tuscany SCA Native kernel libraries use the following command sequence: +
      +
    • ./configure --prefix=<tuscany_sca_install_dir>/deploy --enable-static=no --enable-cpp=no --enable-wsbinding=no
      • +
    • make
      • +
    • make install
      • +
    + NOTE: If you don't provide a --prefix configure option, it will by default install into + /usr/local/tuscany/sca. Use ./configure --help to see all the available + options: + --enable-cpp build C++ component type extension [default=yes] + --enable-wsbinding build Web Service binding extension [default=no] + --enable-scabinding build SCA default binding extension [default=no] + --enable-restbinding build REST binding extension [default=no] + --enable-python build Python component type extension [default=no] + --enable-ruby build Ruby component type extension [default=no] + A script, build_scanative.sh, is provided that will build and install SCA Native. This script will install to the + location specified by the TUSCANY_SCACPP environment variable if set or into a deploy directory at <tuscany_sca_install_dir>/deploy. + This script will check the environment variable settings and will build the extensions whose dependencies are set. For example if RUBY_LIB and + RUBY_HOME are set configure will be called with the --enable-ruby=yes option. +
    5. +
  5. Set the TUSCANY_SCACPP environment variable to point to the <tuscany_sca_install_dir>/deploy + directory that contains the built Tuscany SCA distribution
    6. +
+ +

Getting Tuscany SCA Native working with the binary release on Windows

 +
    +
  1. Unzip the supplied zip file to a folder
    2. +
  2. Set the TUSCANY_SCACPP environment variable to point to the directory that was just unzipped
    3. +
  3. Add the <tuscany_sca_install_dir>\bin directory to the PATH environment variable
    4. +
+

Getting Tuscany SCA Native working with the source release on Windows

 +
    +
  1. Unzip the supplied source zip file
    2. +
  2. The following environment variables are required: +
      +
    • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
      • +
    3. +
  3. 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.
    4. +
  4. See the extensions documentation for other environment variables + that are required to build specific extensions.
    5. +
  5. Build the source: +
      +
    • cd <to where you unzipped the source>
      • +
    • build [Debug]
      • +
    + This will build all the projects and put the required output into the 'deploy' directory

    + Alternatively, open the VS Express workspace at <tuscany_sca_install_dir>\VSExpress\tuscany_sca\tuscany_sca.sln
    6. +
  6. Set the TUSCANY_SCACPP environment variable to point to the 'deploy' directory that was just created
    7. +
+
+ +
+

Tuscany SCA Extensions

 +

Tuscany SCA is composed of two distinct areas: the kernel and extensions. The kernel provides the + implementation of the + Service + Component Architecture Assembly Model specification, reading composite files, loading the + appropriate extensions and invoking components via references and services during runtime. The + extensions provide the functionality required to call a component implementation (e.g. a C++ class + compiled into a dll) or invoke a binding (e.g. make a Web Services call). +

+

The table below details the extensions that are included with Tuscany SCA Native Milestone + Release 3. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
ExtensionDetails
+ C++ + Provides the SCA C++ client API and enables C++ component implementations + and interfaces. See the C++ extension documentation, the + SCA + C++ Client and Implementation specification for more details about the SCA C++ + Programming Model and the Creating C++ SCA Components + document for a step-by-step example.
+ Requires: +
    +
  • Java SDK 1.4 or later + - for building and running the SCAGEN code generation tool, which is used + when developing Tuscany SCA C++ components.
    • +
  • Apache Ant 1.6 or later + - for building the SCAGEN code generation tool. This is only required when building + the C++ extension from a source distribution of Tuscany SCA Native.
    • +
+
+ Python + Provides a Python SCA client API and enables Python component implementations. + See the Python extension documentation for + more details.
+ Requires: + +
+ Ruby + Provides a Ruby SCA client API and enables Ruby component implementations. + See the Ruby extension documentation for + more details.
+ Requires: + +
+ Axis2/C Web Services + Provides the Web Service bindings enabling Tuscany to call SCA references via + Web Services or expose SCA services as Web Services. See the + SCA + Web Service bindings specification for more details about SCA Web Service support + and the Enabling Web Service + access to SCA Components document for a step-by-step example.
+ Requires: + +
+ REST + Provides the REST bindings enabling Tuscany to call SCA references via + REST HTTP calls or expose SCA services as REST Services. See the + REST extension documentation for more details.
+ Requires: + +
+ SCA + Provides a default SCA binding enabling Tuscany to determine the appropriate technology + to use to provide services or invoke references. Currently this defaults to using the + Axis2/C Web Services binding. See the + SCA extension documentation for more details.
+ Requires: + +
+
+ +
+

Samples

 + + + + + + + +
SCA Technology samples + Simple samples that emphasize how to to use + Service Component Architecture technology. Follow the + instructions on the samples Getting Started + page to build and run the Tuscany SCA samples +
+
+
+
+

User Guide Documents

 + + + + + + + + + + + + + + + + + + + +
Creating and building a Tuscany SCA C++ component + A document that describes how to create, build and run a Tuscany SCA C++ component. +
Enabling Web Service access to your Tuscany SCA component + A document that describes how to expose a Tuscany SCA C++ component as a Web Service via the Tuscany Axis2/C Web Service support. +
The Tuscany SCA Python Programming Model + A document that describes how to create and run a Tuscany SCA Python component. +
The Tuscany SCA Ruby Programming Model + A document that describes how to create and run a Tuscany SCA Ruby component. +
+
+
+
+

Getting Help

 + +

The first place to look is at the Tuscany FAQ at +

+ +

Any problem with this release can be reported to the Tuscany + mailing lists or create a JIRA issue at http://issues.apache.org/jira/browse/Tuscany.

+ + +

 

+ +

 

+ +

 

+ + + + + + +
+ +

Thank you for your interest in Tuscany.

-The + Tuscany Development Team +
+
+
+
+ + + -- cgit v1.2.3