summaryrefslogtreecommitdiffstats
path: root/sca-java-1.x/trunk/tutorials/travelsample/README
blob: 9dacfb7165ffc6813085c79f314694ebd55f7687 (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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
Building the travel sample using ant
------------------------------------

1. Download and unzip JDK 1.6.0_07 (or later) and set the JAVA_HOME
   environment variable to the JDK base directory.
2. Install svn and ant.
3. Create a local directory to hold the travel sample code.  With this as
   your current directory, check out the complete travel sample from svn
   using the following command:
     svn co http://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/tutorials/travelsample
4. Download and unzip the Tuscany SCA Java 1.6 (or later) binary distribution
   and set the TUSCANY_HOME environment variable to the base directory
   containing the unzipped binary distribution.
5. Download and unzip the OpenEJB 3.0 (or later) binary distribution and set
   the OPENEJB_HOME environment variable to the base directory containing
   the unzipped binary distribution.
6. With the travelsample directory as your current directory, enter the
   command "ant compile".


Building the travel sample using maven
--------------------------------------

Most of the steps are similar to the above.  For completeness, a full list
of the steps needed is given here.

1. Download and unzip JDK 1.6.0_07 (or later) and set the JAVA_HOME
   environment variable to the JDK base directory.
2. Install svn and maven.
3. Create a local directory to hold the travel sample code.  With this as
   your current directory, check out the complete travel sample from svn
   using the following command:
     svn co http://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/tutorials/travelsample
4. Check the setting of the <tuscany.version> property in the
   travelsample/pom.xml file.  If you want to build the travel sample using
   a different Tuscany version, change this property as necessary.  The
   travel sample has been tested and runs correctly with Tuscany SCA Java 1.6. 
5. With the travelsample directory as your current directory, enter the
   command "mvn".  You will need a live internet connection so that maven
   can download any required files to your local repository.


Running the travel sample from the build directories
----------------------------------------------------

The travel sample consists of a number of related scenarios.  These scenarios
are listed below, together with instructions for running them.  The instructions
in this section will work irrespective of whether the travel sample was built
using ant or maven.

Most of the scenarios are run by opening a single command prompt window
and entering the command "ant run" into that window.  If a scenario is
listed with multiple commands, this means that it needs multiple command
prompt windows.  In this case, each of the listed commands must be entered
into its own separate command prompt window in the order shown.

For each scenario, the following are given:
 Directory: the current directory for the command prompt window or windows
 Command(s): the command or commands for running the scenario
 Contributions: SCA contributions used in this scenario
 Launchers: other launcher directories used in this scenario, if any
 Services: non-SCA services used in this scenario, if any
 Clients: non-SCA clients used in this scenario, if any

1) Jumpstart - First simple example of using Tuscany

Directory: launchers/jumpstart
Command: ant run
Contributions: introducing-trips

2) Introducing - Simplified introduction to the travel application

Directory: launchers/introducing
Command: ant run 
Contributions: introducing-client, introducing-tours, introducing-trips

3) Introducing (distributed) - Distributed services with a domain manager

Directory: launchers/introducing-client
Commands: ant run-domain, ant run-trips, ant run-tours, ant run
Contributions: introducing-client, introducing-tours, introducing-trips
Launchers: introducing-domain, introducing-tours, introducing-trips

4) Interaction - Different SCA interaction styles 

Directory: launchers/interaction
Command: ant run
Contributions: calendar, common, currency, flight, hotel, interaction-client, 
   interaction-service-remote, shoppingcart

5) Full application - The full interactive travel application

Directory: launchers/fullapp
Command: ant run
Contributions: car, common, creditcard-payment-jaxb-policy, currency, flight,
   fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
   fullapp-shoppingcart, fullapp-ui, hotel, payment-java-policy, scatours,
   shoppingcart, travelcatalog, trip, tripbooking

6) Full application (distributed) - Distributed services with a domain manager

Directory: launchers/fullapp-nodes
Commands: ant run-domain, ant run
Contributions: car, common, creditcard-payment-jaxb, currency, flight,
   fullapp-bespoketrip, fullapp-coordination, fullapp-currency, fullapp-packagedtrip,
   fullapp-shoppingcart, fullapp-ui, hotel, payment-java, scatours,
   shoppingcart, travelcatalog, trip, tripbooking
Launchers: fullapp-domain

7) Blog feed

Directory: launchers/blog-feed
Command: ant run
Contributions: blog-feed

8) Data binding

Directory: launchers/databinding
Command: ant run
Contributions: creditcard-payment-sdo, databinding-client, payment-java

9) Feed logger

Directory: launchers/feed-logger
Command: ant run
Contributions: feed-logger

10) Help pages

Directory: launchers/help-pages
Command: ant run
Contributions: help-pages

11) Policy

Directory: launchers/policy
Command: ant run
Contributions: creditcard-payment-jaxb-policy, policy-client, payment-java-policy

12) SCA currency converter service interoperating with SCA or non-SCA client

12a) SCA client

Directory: launchers/currency-converter
Command: ant run
Contributions: currency

12b) CORBA client

Directory: launchers/currency-converter-corba
Commands: ant run, ant run-client
Contributions: currency, currency-corba
Clients: currency-converter-corba

12c) JMS client

Directory: launchers/currency-converter-jms
Commands: ant run, ant run-client
Contributions: currency, currency-jms
Clients: currency-converter-jms

12d) RMI client

Directory: launchers/currency-converter-rmi
Commands: ant run, ant run-client
Contributions: currency, currency-rmi
Clients: currency-converter-rmi

12e) JAX-WS client

Directory: launchers/currency-converter-ws
Commands: ant run, ant run-client
Contributions: currency, currency-ws
Clients: currency-converter-ws-jaxws

13) SCA notification service interoperating with non-SCA SMS gateway service

13a) SMS gateway CORBA service

Directory: launchers/notification-corba
Commands: ant run-smsgateway, ant run 
Contributions: notification, notification-corba
Services: smsgateway-corba

13b) SMS gateway EJB service

Directory: launchers/notification-ejb
Commands: ant run-smsgateway, ant run 
Contributions: notification, notification-ejb
Services: smsgateway-ejb

13c) SMS gateway JMS service

Directory: launchers/notification-jms
Commands: ant run-smsgateway, ant run 
Contributions: notification, notification-jms
Services: smsgateway-jms

13d) SMS gateway RMI service

Directory: launchers/notification-rmi
Commands: ant run-smsgateway, ant run 
Contributions: notification, notification-rmi
Services: smsgateway-rmi

13e) SMS gateway JAX-WS service

Directory: launchers/notification-ws
Commands: ant run-smsgateway, ant run 
Contributions: notification, notification-ws
Services: smsgateway-jaxws


Running the travel sample from the distribution directories
-----------------------------------------------------------

If the travel sample was built using maven, a binary distribution
directory will be created containing all the built jar files together with
a "lib" directory containing a complete set of runtime dependencies for
these jar files.  You can run each of the scenarios from the binary
distribution by running one or more jar files using the "java -jar" command.

The jar files that you need to run for each scenario are listed below.
If multiple jar files are listed for a scenario, they must be run in
separate processes in the order listed.  The current directory for
the "java -jar" command must be set as follows:
 launchers/scatours-launcher-*.jar are run from the launchers directory 
 clients/scatours-client-*.jar are run from the clients directory 
 services/scatours-service-*.jar are run from the services directory 

For example, to run the "jumpstart" scenario, you would set your
current directory to the distribution "launchers" directory and run
the command
 java -jar scatours-launcher-jumpstart.jar

Here is a complete list of the launcher commands needed to run the
scenarios described above.

 1) Jumpstart - First simple example of using Tuscany
   java -jar scatours-launcher-jumpstart.jar

 2) Introducing - Simplified introduction to the travel application
   java -jar scatours-launcher-introducing.jar

 3) Introducing (distributed) - Distributed services with a domain manager
   java -jar scatours-launcher-introducing-domain.jar
   java -jar scatours-launcher-introducing-trips.jar
   java -jar scatours-launcher-introducing-tours.jar
   java -jar scatours-launcher-introducing-client.jar

 4) Interaction - Different SCA interaction styles 
   java -jar scatours-launcher-interaction.jar

 5) Full application - The full interactive travel application
   java -jar scatours-launcher-fullapp.jar

 6) Full application (distributed) - Distributed services with a domain manager
   java -jar scatours-launcher-fullapp-domain.jar
   java -jar scatours-launcher-fullapp-nodes.jar

 7) Blog feed
   java -jar scatours-launcher-blog-feed.jar

 8) Data binding
   java -jar scatours-launcher-databinding.jar

 9) Feed logger
   java -jar scatours-launcher-feed-logger.jar

10) Help pages
   java -jar scatours-launcher-help-pages.jar

11) Policy
   java -jar scatours-launcher-policy.jar

12) SCA currency converter service interoperating with SCA or non-SCA client

12a) SCA client
   java -jar scatours-launcher-currency-converter.jar

12b) CORBA client
   java -jar scatours-launcher-currency-converter-corba.jar
   java -jar scatours-client-currency-converter-corba.jar

12c) JMS client
   java -jar scatours-launcher-currency-converter-jms.jar
   java -jar scatours-client-currency-converter-jms.jar

12d) RMI client
   java -jar scatours-launcher-currency-converter-rmi.jar
   java -jar scatours-client-currency-converter-rmi.jar

12e) JAX-WS client
   java -jar scatours-launcher-currency-converter-ws.jar
   java -jar scatours-client-currency-converter-ws-jaxws.jar

13) SCA notification service interoperating with non-SCA SMS gateway service

13a) SMS gateway CORBA service
   java -jar scatours-service-smsgateway-corba.jar
   java -jar scatours-launcher-notification-corba.jar

13b) SMS gateway EJB service
   java -jar scatours-service-smsgateway-ejb.jar
   java -jar scatours-launcher-notification-ejb.jar

13c) SMS gateway JMS service
   java -jar scatours-service-smsgateway-jms.jar
   java -jar scatours-launcher-notification-jms.jar

13d) SMS gateway RMI service
   java -jar scatours-service-smsgateway-rmi.jar
   java -jar scatours-launcher-notification-rmi.jar

13e) SMS gateway JAX-WS service
   java -jar scatours-service-smsgateway-jaxws.jar
   java -jar scatours-launcher-notification-ws.jar