| |
| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| <!-- |
| Licensed to the Apache Software Foundation (ASF) under one |
| or more contributor license agreements. See the NOTICE file |
| distributed with this work for additional information |
| regarding copyright ownership. The ASF licenses this file |
| to you under the Apache License, Version 2.0 (the |
| "License"); you may not use this file except in compliance |
| with the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| Unless required by applicable law or agreed to in writing, |
| software distributed under the License is distributed on an |
| "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| KIND, either express or implied. See the License for the |
| specific language governing permissions and limitations |
| under the License. |
| --> |
| |
| <HTML> |
| <HEAD> |
| <META CONTENT="text/html; charset=iso-8859-1" HTTP-EQUIV="Content-Type"> |
| <META CONTENT="text/css" HTTP-EQUIV="Content-Style-Type"> |
| <STYLE MEDIA="all" TYPE="text/css"> |
| @import url("../../doc/css/maven-base.css"); |
| @import url("../../doc/css/maven-theme.css"); |
| </STYLE> |
| |
| <LINK HREF="../doc/css/maven-theme.css" MEDIA="print" REL="stylesheet" |
| TYPE="text/css"> |
| <TITLE>Tuscany SCA Native Samples - REST Calculator Sample</TITLE> |
| </HEAD> |
| |
| <BODY> |
| <DIV ID="bodyColumn"> |
| <DIV ID="contentBox"> |
| <DIV CLASS="section"> |
| <H1>Tuscany SCA Native Samples - REST Calculator Sample</H1> |
| |
| <P>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. |
| </P> |
| <P>The REST Calculator sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RestExtension.html">REST Service & Reference Extensions</A></LI> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system</P> |
| <P>There are three sub projects in this workspace:</P> |
| <UL> |
| <LI>sample.calculator<BR/> |
| This contains the Ruby scripts and SCDL artifacts for the SCA Calculator |
| composite implementing the sample Calculator. |
| </LI> |
| <LI>sample.calculator.restclient<BR/> |
| A sample client which does a local call to the Calculator service. |
| </LI> |
| <LI>httpserver<BR/> |
| A minimal configuration for the Apache HTTP server used to host the |
| REST service as well as scripts to start and stop the server. |
| </LI> |
| </UL> |
| <P>Additionally, there is the sample.calculator.app.composite file. This |
| describes the configuration of the SCA Calculator composite deployed to the SCA |
| runtime. |
| </P> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <H2>Contents</H2> |
| <OL> |
| <LI><A HREF="#linuxbld">Building the REST Calculator sample on Linux and Mac OS X</A></LI> |
| <LI><A HREF="#linuxrun">Running the REST Calculator sample on Linux and Mac OS X</A></LI> |
| <LI><A HREF="#winbld">Building the REST Calculator sample on Windows</A></LI> |
| <LI><A HREF="#winrun">Running the REST Calculator sample on Windows</A></LI> |
| <LI><A HREF="#help">Getting help</A></LI> |
| </OL> |
| </DIV> |
| |
| |
| <DIV CLASS="section"> |
| <A NAME="linuxbld"><H2>Building the REST Calculator sample on Linux and Mac OS X</H2></A> |
| <P>If using the binary distribution the samples are built and installed in |
| <tuscany_sca_install_dir>/samples - go directly to <A HREF="#linuxrun">Running the samples on Linux and Mac OS X</A>.</P> |
| <OL> |
| <LI>The following environment variables are required: |
| <UL> |
| <LI>TUSCANY_SCACPP=<path to installed Tuscany SCA></LI> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI> |
| </UL> |
| </LI> |
| <LI>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: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>/samples</LI> |
| <LI>./configure --enable-ruby --enable-cpp=no --prefix=$TUSCANY_SCACPP/samples</LI> |
| <LI>make install</LI> |
| </UL> |
| NOTE: If you don't provide the --prefix configure option, it will by default install into |
| /usr/local/tuscany/sca/samples/RestCalculator</LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="linuxrun"><H2>Running the REST Calculator sample on Linux and Mac OS X</H2></A> |
| <OL> |
| <LI>The REST Calculator sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RestExtension.html">REST Service & Reference Extensions</A></LI> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <LI>Start the HTTPD server: |
| <OL> |
| <LI>The following environment variables are required: |
| <UL> |
| <LI>TUSCANY_SCACPP=<path to installed Tuscany SCA></LI> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>/samples/RestCalculator/deploy/httpserver</LI> |
| <LI>./startserver.sh<BR/> |
| 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</LI> |
| </OL> |
| </LI> |
| <LI>Run the client: |
| <OL> |
| <LI>The following environment variables are required: |
| <UL> |
| <LI>TUSCANY_SCACPP=<path to installed Tuscany SCA></LI> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>/samples/RestCalculator/deploy/sample.calculator.restclient</LI> |
| <LI>./runrestclient.sh</LI> |
| </OL> |
| </LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="winbld"><H2>Building the REST Calculator sample on Windows</H2></A> |
| <P>If using the binary distribution the samples are built and installed in |
| <tuscany_sca_install_dir>\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=<path to installed Tuscany SCA> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO> |
| </UL></LI> |
| </LI> |
| <LI>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: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>\samples\RestCalculator</LI> |
| <LI>deploy.bat</LI> |
| </UL> |
| </LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="winrun"><H2>Running the REST Calculator sample on Windows</H2></A> |
| <OL> |
| <LI>The REST Calculator sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RestExtension.html">REST Service & Reference Extensions</A></LI> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <LI>Start the HTTPD server: |
| <OL> |
| <LI>The following environment variables are required: |
| <UL> |
| <LI>TUSCANY_SCACPP=<path to installed Tuscany SCA></LI> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI> |
| <LI>HTTPD_HOME=<path to installed Apache HTTPD server></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>\samples\RestCalculator\deploy\httpserver</LI> |
| <LI>startserver.bat</LI> |
| </OL> |
| </LI> |
| <LI>Run the client: |
| <OL> |
| <LI>The following environment variables are required: |
| <UL> |
| <LI>TUSCANY_SCACPP=<path to installed Tuscany SCA></LI> |
| <LI>TUSCANY_SDOCPP=<path to installed Tuscany SDO></LI> |
| <LI>LIBCURL_HOME=<path to installed libcurl libraries></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>\samples\RestCalculator\deploy\sample.calculator.restclient</LI> |
| <LI>runrestclient.bat</LI> |
| </OL> |
| </LI> |
| </OL> |
| </DIV> |
| |
| |
| |
| <DIV CLASS="section"> |
| <A NAME="help"><H2>Getting Help</H2></A> |
| |
| <P>The first place to look is at the Tuscany SCA FAQ at |
| <A HREF="http://cwiki.apache.org/confluence/display/TUSCANY/Tuscany+SCA+-+FAQ" |
| TARGET="_blank">http://cwiki.apache.org/confluence/display/TUSCANY/Tuscany+SCA+-+FAQ</A> </P> |
| |
| <P>Any problem with this release can be reported to the Tuscany |
| <A HREF="http://cwiki.apache.org/TUSCANY/mailing-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> |
| </DIV> |
| </BODY> |
| |
| </HTML> |
| |
