summaryrefslogtreecommitdiffstats
path: root/tags/native-sca-1.0.incubating-M3-RC4/samples/AlertAggregator/README.html
blob: 69d5434527db2fec87b8421e4ef5084b70895fac (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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
<!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 - Alert Aggregator Sample</TITLE>
</HEAD>

<BODY>
<DIV ID="bodyColumn"> 
   <DIV ID="contentBox"> 
      <DIV CLASS="section"> 
         <H1>Tuscany SCA Native Samples - Alert Aggregator Sample</H1> 

         <P>This is a more complex sample that shows how Tuscany and SCA can be used to 
            develop and run mash-up style web applications.</P>
         <P>The Alert Aggregator sample aggregates items of information from various data 
            sources into a series of "alerts" that are displayed in an 
            automatically updating web page. Alert sources can currently include RSS/Atom 
            news feeds and POP3/IMAP email</P>
         <P>The Alert Aggregator sample requires the following extensions:
            <UL>
               <LI><A HREF="../../doc/RESTExtension.html">REST Service and Reference Extensions</A></LI>
               <LI><A HREF="../../doc/PythonExtension.html">Python Extension</A></LI>
            </UL>
            Please follow the documentation to ensure you have these extensions built and installed
            on your system
         </P>
         <P>Additionally, the Alert Aggregator sample requires the Python FeedParser library, available from
             <A HREF="http://feedparser.org" TARGET="_blank">http://feedparser.org</A>. Please download and
             install the library by following the documentation.</P>
         <P>There are three sub-projects in this workspace:
         <UL>
            <LI>sample.alerter<BR/>                
                This contains the source code and SCDL artifacts for the SCA components
                implementing the Alert Aggregator configuration and alert retrieval.
            </LI>
            <LI>sample.display<BR/>
                This contains the source code and SCDL artifacts for the SCA components
                implementing the display and storage of the retrieved alerts.
            </LI>
            <LI>httpserver<BR/>
                This contains a minimal configuration for the Apache HTTP server used
                to host the services as well as scripts to start and stop the server.
            </LI>
         </UL>
            Additionally, there is the sample.alerter.app.composite file. This     
            describes the configuration of the SCA composites deployed to the SCA
            runtime.</P>
         <P>The following SCA diagram shows the different components and composites and how the
            wiring between them is specified. Not all of these components are currently 
            implemented in this sample.</P>
         <IMG SRC="AlertAggregatorSCADiagram.png" ALT="Alert Aggregator SCA Diagram"/>
      </DIV>

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


       <DIV CLASS="section"> 
         <A NAME="linuxbld"><H2>Building the Alert Aggregator sample 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 sample 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>
                  <LI>TUSCANY_SDOCPP=&lt;path to installed Tuscany SDO&gt;</LI>
                </UL>
             </LI>
             <LI>As the Alert Aggregator sample is based on Python scripts, a specific compilation step is not necessary - 
                 only deployment is required. Deploy the Python samples only with the following command sequence:
                  <UL>
                      <LI>cd &lt;tuscany_sca_install_dir&gt;/samples</LI>
                      <LI>./configure --enable-python --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/AlertAggregator</LI>
         </OL>                                                  
        </DIV>

       <DIV CLASS="section"> 
         <A NAME="linuxrun"><H2>Running the Alert Aggregator sample on Linux and Mac OS X</H2></A>
         <OL>
             <LI>The Alert Aggregator sample requires the following extensions:
                <UL>
                   <LI><A HREF="../../doc/RESTExtension.html">REST Service and Reference Extensions</A></LI>
                   <LI><A HREF="../../doc/PythonExtension.html">Python Extension</A></LI>
                </UL>
                Please follow the documentation to ensure you have these extensions built and installed
                on your system
             </LI>
             <LI>The Alert Aggregator sample requires the Python FeedParser library, available from
                 <A HREF="http://feedparser.org" TARGET="_blank">http://feedparser.org</A>. Please download and
                 install the library by following the documentation.</LI>
             <LI>Start the Apache HTTPD server:
                <OL>
                   <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>PYTHON_LIB=&lt;path to the Python library&gt;<BR/>
                            Note: If you are using a default installation of Python 2.5 this is usually /usr/lib</LI>
                      </UL>
                   </LI>
                   <LI>cd &lt;tuscany_sca_install_dir&gt;/samples/AlertAggregator/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
                       &lt;tuscany_sca_install_dir&gt;/samples/AlertAggregator/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 from your web browser:
                <OL>
                   <LI>Point your browser at <A HREF="http://localhost:9090/index.html" TARGET="_blank">http://localhost:9090/index.html</A><BR/>
                       NOTE: If plain text is diplayed by your browser, rather than a rendered web page, you may need
                       to uncomment the LoadModule mime_module directive in the
                       &lt;tuscany_sca_install_dir&gt;/samples/AlertAggregator/deploy/httpserver/conf/httpd.conf file. Set the correct path to 
                       the mod_mime.so library and restart the server</LI>
                   <LI>You should see the Alert Aggregator web interface that allows you to:
                       <UL>
                           <LI>Read new alerts</LI>
                           <LI>Update alerts from all sources</LI>
                           <LI>Update alerts from a specific source</LI>
                           <LI>Edit the configuration of a data source</LI>
                           <LI>Add a new RSS/Atom or POP email data source</LI>
                           <LI>Remove a specific data source and all associated alerts</LI>
                       </UL>
                   </LI>
                </OL>
             </LI>
         </OL>                                                  
        </DIV>

        <DIV CLASS="section">
         <A NAME="winbld"><H2>Building the Alert Aggregator 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 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\AlertAggregator</LI>
                   <LI>deploy.bat</LI>
                </UL>
             </LI>
         </OL>                                                  
        </DIV>

       <DIV CLASS="section"> 
         <A NAME="winrun"><H2>Running the Alert Aggregator sample on Windows</H2></A>
           <OL>
                     
             <LI>The Alert Aggregator sample requires the following extensions:
                <UL>
                   <LI><A HREF="../../doc/RESTExtension.html">REST Service and Reference Extensions</A></LI>
                   <LI><A HREF="../../doc/PythonExtension.html">Python Extension</A></LI>
                </UL>
                Please follow the documentation to ensure you have these extensions built and installed
                on your system
             </LI>
             <LI>The Alert Aggregator sample requires the Python FeedParser library, available from
                 <A HREF="http://feedparser.org" TARGET="_blank">http://feedparser.org</A>. Please download and
                 install the library by following the documentation.</LI>
             <LI>Start the Apache HTTPD server:
                <OL>
                   <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>HTTPD_HOME=&lt;path to installed Apache HTTPD server&gt;</LI>                                                              
                      </UL>
                   </LI>
                   <LI>cd &lt;tuscany_sca_install_dir&gt;\samples\AlertAggregator\deploy\httpserver</LI>
                   <LI>startserver.bat</LI>
                </OL>
             </LI>
             <LI>Run the client from your web browser:
                <OL>
                   <LI>Point your browser at <A HREF="http://localhost:9090/index.html" TARGET="_blank">http://localhost:9090/index.html</A><BR/>
                       NOTE: If plain text is diplayed by your browser, rather than a rendered web page, you may need
                       to uncomment the LoadModule mime_module directive in the
                       &lt;tuscany_sca_install_dir&gt;\samples\AlertAggregator\deploy\httpserver\conf\httpd.conf file. Set the correct path to 
                       the mod_mime.so library (e.g. C:\Apache2.2\modules\mod_mime.so) and restart the server</LI>
                   <LI>You should see the Alert Aggregator web interface that allows you to:
                       <UL>
                           <LI>Read new alerts</LI>
                           <LI>Update alerts from all sources</LI>
                           <LI>Update alerts from a specific source</LI>
                           <LI>Edit the configuration of a data source</LI>
                           <LI>Add a new RSS/Atom or POP email data source</LI>
                           <LI>Remove a specific data source and all associated alerts</LI>
                       </UL>
                   </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&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>