summaryrefslogtreecommitdiffstats
path: root/sandbox/old/contrib/old-samples/readme.html
blob: cea10e77b530bce30d4bffd01b0fca02d7da7394 (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
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<!--
 * 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 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
    <title>Apache Tuscany Sample Applications</title>
    <link rel="stylesheet" href="css/samples.css" type="text/css">
</head>
<body>
<h1>Apache Tuscany Sample Applications</h1>
<p>
    Thank you for your interest in Apache Tuscany in using the Service Component Architecture (SCA)
    for building applications. This package contains a number of samples that illustrate some of
    the core concepts in SCA and shows how to build and run them using Apache Tuscany.
</p>

<h2>Pre-requisites</h2>

<p>
    The samples assume that you have certain tools in your local environment, specifically:
</p>
<ul>
    <li>a Java5 development kit</li>
    <li><a href="http://maven.apache.org/download.html">Apache Maven v2.0.4</a> or later</li>
</ul>
<p>To run the web application samples you will also require a J2EE 1.4 web container such as
    <a href="http://tomcat.apache.org/download-55.cgi">Apache Tomcat 5.5</a>
</p>

<h2 id="GettingStarted">Getting Started</h2>

<p>
    Many of the samples use pre-built SCA composites that implement the services they are using.
    These need to be built before any of the individual samples. To do this run:
</p>
<pre class="command">
$ mvn install
</pre>
<p>
    from this directory.
</p>
<p>
    Please see the <a href="common/readme.html">common</a> module for information on these composites.
</p>
<h3>Standalone Samples</h3>
<p>
    These sample applications are intended to be run in a standalone environment in conjunction
    with an installed version of Apache Tuscany. You can download a distribution from
    <a href="http://people.apache.org/dist/incubator/tuscany/java/sca/">http://people.apache.org/dist/incubator/tuscany/java/sca/</a>
</p>
<p>
    Please see the <a href="standalone/readme.html">standalone</a> module for specific details on running these samples.
</p>
<h3>Web Application Samples</h3>
<p>
    These sample applications are intended to be run in a standard web container such as Apache Tomcat
    or Jetty. The projects for these use a Maven plugin to package a standard WAR file that can then be deployed
    to the web container using its standard deployment tools. An Apache Tuscany distribution does not need
    to be included on your local machine as the Tuscany runtime is automatically downloaded by the
    Maven plugin.
</p>
<p>
    Please see the <a href="webapp/readme.html">webapp</a> module for specific details on running these samples.
</p>
<h2>Frequently Asked Questions</h2>
<p>Help! Something is not working right ...</p>
<p>
    Please see the <a href="faq.html">faq</a> page in this directory for more information.
    Additional help may also be found on the <a href="http://cwiki.apache.org/TUSCANY/tuscany-sca-faq.html">project wiki</a>
</p>
<p>
    You can also contact the project members directly on the mailing list
    <a href="mailto:tuscany-user@ws.apache.org">tuscany-user@ws.apache.org</a>
</p>
</body>
</html>