summaryrefslogtreecommitdiffstats
path: root/tags/native-sca-1.0.incubating-M3-RC1/samples/RestYahoo/README.html
blob: 4e0ab14b1abbbb353844da78bef8d41e81110ee0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
<!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 Yahoo Search Sample</TITLE>
</HEAD>

<BODY>
<DIV ID="bodyColumn"> 
   <DIV ID="contentBox"> 
      <DIV CLASS="section"> 
         <H2>Tuscany SCA Native Samples - REST Yahoo Search Sample</H2> 
         
         <P>This is a very simple sample to show how to use the SCA REST binding to
            invoke the Yahoo Web Search REST service.
         </P>
         <P>The REST Yahoo Search sample requires the following extensions:
            <UL>
               <LI><A HREF="../../doc/RESTExtension.html">REST Reference Extensions</A></LI>
               <LI><A HREF="../../doc/PythonExtension.html">Python Extension</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 two sub projects in this workspace:</P>
         <UL>
            <LI>sample.yahoo<BR/>
                This contains the SCDL artifacts and Python source code for the WebSearch 
                Component which calls a Reference that is configured to call the 
                Yahoo service
            </LI>
            <LI>sample.yahoo.client<BR/>
                A Ruby client which calls the WebSearch component
            </LI>
         </UL>
         <P>Additionally, there is the sample.yahoo.app.composite file. This 
            describes the configuration of the SCA Yahoo Search composite deployed to 
            the SCA runtime.                                                                      
         </P>
      </DIV>

      <DIV CLASS="section"> 
         <H2>Contents</H2> 
         <OL>
            <LI><A HREF="#linuxbld">Building the REST Yahoo Search sample on Linux and Mac OS X</A></LI>
            <LI><A HREF="#linuxrun">Running the REST Yahoo Search sample on Linux and Mac OS X</A></LI>
            <LI><A HREF="#winbld">Building the REST Yahoo Search sample on Windows</A></LI>
            <LI><A HREF="#winrun">Running the REST Yahoo Search sample on Windows</A></LI>
            <LI><A HREF="#help">Getting help</A></LI>
         </OL>
      </DIV>


       <DIV CLASS="section"> 
         <A NAME="linuxbld"><H2>Building the Ruby & Python samples on Linux and Mac OS X</H2></A>
         <P>If using the binary distribution the samples are built and installed in
            &lt;tuscany_sca_install_dir&gt;/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=&lt;path to installed Tuscany SCA&gt;                                      
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;                                      
                </UL></LI>
             </LI>
             <LI>As the REST Yahoo sample is based on Ruby and Python scripts, a specific compilation step is not necessary - 
                 only deployment is required. Deploy the Ruby and Python samples only with the following command sequence:
                  <UL>
                      <LI>cd &lt;tuscany_sca_install_dir&gt;/samples</LI>
                      <LI>./configure --enable-ruby --enable-python --enable-cpp=no --prefix=$TUSCANY_SCACPP</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/RestYahoo</LI>
         </OL>                                                  
        </DIV>

       <DIV CLASS="section"> 
         <A NAME="linuxrun"><H2>Running the REST Yahoo Search sample on Linux and Mac OS X</H2></A>
         <OL>
             <LI>The REST Yahoo Search sample requires the following extensions:
                <UL>
                   <LI><A HREF="../../doc/RESTExtension.html">REST Reference Extensions</A></LI>
                   <LI><A HREF="../../doc/PythonExtension.html">Python Extension</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>The following environment variables are required:                                 
                <UL>
                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
                </UL>
             </LI>
             <LI>Run the sample with the following commands:
                <UL>
                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/RestYahoo/deploy/sample.yahoo.client</LI>
                   <LI>./runclient.sh</LI>
                </UL>
             </LI>
         </OL>                                                  
        </DIV>

        <DIV CLASS="section">
         <A NAME="winbld"><H2>Building the REST Yahoo Search sample on Windows</H2></A>
         <P>If using the binary distribution the samples are built and installed in
            &lt;tuscany_sca_install_dir&gt;\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=&lt;path to installed Tuscany SCA&gt;                                      
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;                                      
                </UL></LI>
             </LI>
             <LI>As this sample is based on Ruby and Python scripts, a specific compilation step is not necessary - 
                 only deployment is required. Deploy the sample with the following commands:
                 <UL>
                   <LI>cd &lt;tuscany_sca_install_dir&gt;\samples\RestYahoo</LI>
                   <LI>deploy.bat</LI>
                </UL>
             </LI>
         </OL>                                                  
        </DIV>

       <DIV CLASS="section"> 
         <A NAME="winrun"><H2>Running the REST Yahoo Search sample on Windows</H2></A>
         <OL>
             <LI>The REST Yahoo Search sample requires the following extensions:
                <UL>
                   <LI><A HREF="../../doc/RESTExtension.html">REST Reference Extensions</A></LI>
                   <LI><A HREF="../../doc/PythonExtension.html">Python Extension</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>The following environment variables are required:                                 
                <UL>
                  <LI>TUSCANY_SCACPP=&lt;path to installed Tuscany SCA&gt;</LI>                                      
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>                                      
                  <LI>LIBCURL_HOME=&lt;path to libcurl&gt;</LI>
                </UL>
             </LI>
             <LI>Run the sample with the following commands:
                <UL>
                   <LI>cd &lt;tuscany_sca_install_dir&gt;\samples\RestYahoo\deploy\sample.yahoo.client</LI>
                   <LI>runclient.bat</LI>
                </UL>
             </LI>
         </OL>                                                  
      </DIV>


              
      <DIV CLASS="section"> 
         <A NAME="help"><H2>Getting Help</H2></A>

         <P>First place to look is at the Tuscany FAQ at 
         <A HREF="http://incubator.apache.org/tuscany/faq.html"
            TARGET="_blank">http://incubator.apache.org/tuscany/faq.html</A> </P>

         <P>Any problem with this release can be reported to the Tuscany 
         <A HREF="http://incubator.apache.org/tuscany/mail-lists.html"
            TARGET="_blank">mailing lists</A> or create a JIRA issue at&nbsp;<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>