| |
| <!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 - Ruby BigBank Sample</TITLE> |
| </HEAD> |
| |
| <BODY> |
| <DIV ID="bodyColumn"> |
| <DIV ID="contentBox"> |
| <DIV CLASS="section"> |
| <H1>Tuscany SCA Native Samples - Ruby BigBank Sample</H1> |
| |
| <P>This sample implements the "Simplified BigBank" scenario. A whitepaper describing |
| the scenario based on the SCA 0.9 Assembly specification can be found |
| <A HREF="http://www.osoa.org/display/Main/SCA+-+Previously+Published+Specifications">here</A>. |
| This sample uses multiple Ruby components, calls out to an external Web Service via a reference |
| and exposes the service as a Web Service. |
| </P> |
| <P>The Ruby BigBank sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| <LI><A HREF="../../doc/Axis2CWSExtension.html">Axis2/C Web Services 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>bigbank.account<BR/> |
| This contains the source code and SCDL artifacts for the SCA Ruby BigBank |
| composite implementing the account services. |
| </LI> |
| <LI>bigbank.client<BR/> |
| A sample client which does a local call to the BigBank service. |
| </LI> |
| <LI>bigbank.wsclient<BR/> |
| A sample client which uses an SCA Web Service reference to make a remote |
| call to the BigBank service. |
| </LI> |
| </UL> |
| <P>Additionally, there is the bigbank.app.composite file. This |
| describes the configuration of the SCA BigBank composite deployed to the SCA |
| runtime. |
| </P> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <H2>Contents</H2> |
| <OL> |
| <LI><A HREF="#linuxbld">Building the Ruby BigBank sample on Linux and Mac OS X</A></LI> |
| <LI><A HREF="#linuxrun">Running the Ruby BigBank sample on Linux and Mac OS X:</A></LI> |
| <UL> |
| <LI><A HREF="#linuxbasic">Running the basic client</A></LI> |
| <LI><A HREF="#linuxws">Running with Web Service clients</A></LI> |
| </UL> |
| <LI><A HREF="#winbld">Building the Ruby BigBank sample on Windows</A></LI> |
| <LI><A HREF="#winrun">Running the Ruby BigBank sample on Windows:</A></LI> |
| <UL> |
| <LI><A HREF="#winbasic">Running the basic client</A></LI> |
| <LI><A HREF="#winws">Running with Web Service clients</A></LI> |
| </UL> |
| <LI><A HREF="#help">Getting help</A></LI> |
| </OL> |
| </DIV> |
| |
| |
| <DIV CLASS="section"> |
| <A NAME="linuxbld"><H2>Building the Ruby BigBank 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>TUSCANY_SDOCPP=<path to installed Tuscany SDO> |
| </UL></LI> |
| </LI> |
| <LI>As the Ruby BigBank 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/RubyBigBank |
| </LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="linuxrun"><H2>Running the Ruby BigBank sample on Linux and Mac OS X</H2></A> |
| <A NAME="linuxbasic"><H3>BigBank with basic client</H3></A> |
| <OL> |
| <LI>The Ruby BigBank sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| <LI><A HREF="../../doc/Axis2CWSExtension.html">Axis2/C Web Services Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <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>Run the sample with the following commands: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>/samples/RubyBigBank/deploy/bigbank.client</LI> |
| <LI>./runclient.sh</LI> |
| </UL> |
| </LI> |
| </OL> |
| <A NAME="linuxws"><H3>BigBank with Web Service clients</H3></A> |
| <OL> |
| <LI>The Ruby BigBank sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| <LI><A HREF="../../doc/Axis2CWSExtension.html">Axis2/C Web Services Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <LI>Ensure you have enabled Axis2/C to run Tuscany SCA services. Follow the instructions |
| found <A HREF="../../doc/Axis2CWSExtension.html#deploy">here</A>. |
| </LI> |
| <LI>Start the Axis2/C simple http 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>AXIS2C_HOME=<path to Axis2/C version 0.96></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>/samples/RubyBigBank/deploy/bigbank.account</LI> |
| <LI>./runwsserver.sh</LI> |
| </OL> |
| </LI> |
| <LI>Now run the Web Service 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>AXIS2C_HOME=<path to Axis2/C version 0.96></LI> |
| </UL> |
| </LI> |
| <LI>Run the sample with the following commands: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>/samples/RubyBigBank/deploy/bigbank.wsclient</LI> |
| <LI>./runwsclient.sh</LI> |
| </UL> |
| </LI> |
| </OL> |
| </LI> |
| <LI>The PHP web client detailed in the |
| <A HREF="../CppBigBank/README.html">CppBigBank</A> sample can also be used |
| with the Ruby BigBank service that is served by the Axis2/C http server started above. |
| </LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="winbld"><H2>Building the Ruby BigBank 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\RubyBigBank</LI> |
| <LI>deploy.bat</LI> |
| </UL> |
| </LI> |
| </OL> |
| </DIV> |
| |
| <DIV CLASS="section"> |
| <A NAME="winrun"><H2>Running the Ruby BigBank sample on Windows</H2></A> |
| <A NAME="winbasic"><H3>BigBank with basic client</H3></A> |
| <OL> |
| <LI>The Ruby BigBank sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| <LI><A HREF="../../doc/Axis2CWSExtension.html">Axis2/C Web Services Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <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>Run the sample with the following commands: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>\samples\RubyBigBank\deploy\bigbank.client</LI> |
| <LI>runclient.bat</LI> |
| </UL> |
| </LI> |
| </OL> |
| <A NAME="winws"><H3>BigBank with Web Service clients</H3></A> |
| <OL> |
| <LI>The Ruby BigBank sample requires the following extensions: |
| <UL> |
| <LI><A HREF="../../doc/RubyExtension.html">Ruby Extension</A></LI> |
| <LI><A HREF="../../doc/Axis2CWSExtension.html">Axis2/C Web Services Extension</A></LI> |
| </UL> |
| Please follow the documentation to ensure you have these extensions built and installed |
| on your system |
| </LI> |
| <LI>Ensure you have enabled Axis2/C to run Tuscany SCA services. Follow the instructions |
| found <A HREF="../../doc/Axis2CWSExtension.html#deploy">here</A>. |
| </LI> |
| <LI>Start the Axis2/C simple http 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>AXIS2C_HOME=<path to Axis2/C version 0.96></LI> |
| </UL> |
| </LI> |
| <LI>cd <tuscany_sca_install_dir>\samples\RubyBigBank\deploy\bigbank.account |
| </LI> |
| <LI>runwsserver.bat</LI> |
| </OL> |
| </LI> |
| <LI>Now run the Web Service 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>AXIS2C_HOME=<path to Axis2/C version 0.96></LI> |
| </UL> |
| </LI> |
| <LI>Run the sample with the following commands: |
| <UL> |
| <LI>cd <tuscany_sca_install_dir>/samples/RubyBigBank/deploy/bigbank.wsclient</LI> |
| <LI>./runwsclient.bat</LI> |
| </UL> |
| </LI> |
| </OL> |
| </LI> |
| <LI>The PHP web client detailed in the |
| <A HREF="../CppBigBank/README.html">CppBigBank</A> sample can also be used |
| with the Ruby BigBank service that is served by the Axis2/C http server started above. |
| </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> |
| |
