Tuscany SCA Native Samples - REST Calculator Sample

This is a very simple sample to show how an SCA composite can wire together two Ruby components to implement a Calculator service and expose that service as a REST Service running under Apache HTTPD.

The REST Calculator sample requires the following extensions:

Please follow the documentation to ensure you have these extensions built and installed on your system

There are three sub projects in this workspace:

  • sample.calculator
    This contains the Ruby scripts and SCDL artifacts for the SCA Calculator composite implementing the sample Calculator.
  • sample.calculator.restclient
    A sample client which does a local call to the Calculator service.
  • httpserver
    A minimal configuration for the Apache HTTP server used to host the REST service as well as scripts to start and stop the server.

Additionally, there is the sample.calculator.app.composite file. This describes the configuration of the SCA Calculator composite deployed to the SCA runtime.

Contents

  1. Building the REST Calculator sample on Linux and Mac OS X
  2. Running the REST Calculator sample on Linux and Mac OS X
  3. Building the REST Calculator sample on Windows
  4. Running the REST Calculator sample on Windows
  5. Getting help

Building the REST Calculator sample on Linux and Mac OS X

If using the binary distribution the samples are built and installed in <tuscany_sca_install_dir>/samples - go directly to Running the samples on Linux and Mac OS X.

  1. The following environment variables are required:
    • TUSCANY_SCACPP=<path to installed Tuscany SCA>
    • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
  2. As the REST Calculator sample is based on Ruby scripts, a specific compilation step is not necessary - only deployment is required. Deploy the Ruby samples only with the following command sequence:
    • cd <tuscany_sca_install_dir>/samples
    • ./configure --enable-ruby --enable-cpp=no --prefix=$TUSCANY_SCACPP/samples
    • make install
    NOTE: If you don't provide the --prefix configure option, it will by default install into /usr/local/tuscany/sca/samples/RestCalculator

Running the REST Calculator sample on Linux and Mac OS X
  1. The REST Calculator sample requires the following extensions: Please follow the documentation to ensure you have these extensions built and installed on your system
  2. Start the HTTPD server:
    1. The following environment variables are required:
      • TUSCANY_SCACPP=<path to installed Tuscany SCA>
      • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
    2. cd <tuscany_sca_install_dir>/samples/RestCalculator/deploy/httpserver
    3. ./startserver.sh
      NOTE: Depending on your installation of Apache HTTPD you may need to log in as root before following these steps. If so, you may also need to uncomment the User and Group directives in the <tuscany_sca_install_dir>/samples/RestCalculator/deploy/httpserver/conf/httpd.conf file and set these to the appropriate username and group that the server should run as
  3. Run the client:
    1. The following environment variables are required:
      • TUSCANY_SCACPP=<path to installed Tuscany SCA>
      • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
    2. cd <tuscany_sca_install_dir>/samples/RestCalculator/deploy/sample.calculator.restclient
    3. ./runrestclient.sh

Building the REST Calculator sample on Windows

If using the binary distribution the samples are built and installed in <tuscany_sca_install_dir>\samples - go directly to Running the samples on Windows.

  1. The following environment variables are required:
    • TUSCANY_SCACPP=<path to installed Tuscany SCA>
    • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
  2. As this sample is based on Ruby scripts, a specific compilation step is not necessary - only deployment is required. Deploy the sample with the following commands:
    • cd <tuscany_sca_install_dir>\samples\RestCalculator
    • deploy.bat

Running the REST Calculator sample on Windows
  1. The REST Calculator sample requires the following extensions: Please follow the documentation to ensure you have these extensions built and installed on your system
  2. Start the HTTPD server:
    1. The following environment variables are required:
      • TUSCANY_SCACPP=<path to installed Tuscany SCA>
      • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
      • HTTPD_HOME=<path to installed Apache HTTPD server>
    2. cd <tuscany_sca_install_dir>\samples\RestCalculator\deploy\httpserver
    3. startserver.bat
  3. Run the client:
    1. The following environment variables are required:
      • TUSCANY_SCACPP=<path to installed Tuscany SCA>
      • TUSCANY_SDOCPP=<path to installed Tuscany SDO>
      • LIBCURL_HOME=<path to installed libcurl libraries>
    2. cd <tuscany_sca_install_dir>\samples\RestCalculator\deploy\sample.calculator.restclient
    3. runrestclient.bat

Getting Help

The first place to look is at the Tuscany SCA FAQ at http://cwiki.apache.org/confluence/display/TUSCANY/Tuscany+SCA+-+FAQ

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.