summaryrefslogtreecommitdiffstats
path: root/site/trunk/site-publish/tuscany-maven-archetypes.html
blob: b17f710a1b004cdec906e2e37fddb1753a9139b0 (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
319
320
321
322
323
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML>

    <HEAD>
           <META name="description" content="Apache Tuscany">
   <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture,  sca, service component architecture, das, sdo, csa, ruby, opensource">



        <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css">

        <LINK rel="SHORTCUT ICON" href="http://cwiki.apache.org/confluence/display/TUSCANY/$images/favicon.ico">   

        <TITLE>Tuscany Maven Archetypes : Apache Tuscany</TITLE>

    <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD>

    

    <BODY onload="init()">

        

        
    <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg">

        <TR>

            <TD valing="top" align="left">

			    <A href="http://cwiki.apache.org/confluence/pages/viewpage.action?spaceKey=TUSCANY&title=$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A>

			</TD>

			<TD>

                <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A>

            </TD>

            

            <TD width="100%">

                &nbsp;

            </TD>

            <!--td align="right">

                <img src="http://incubator.apache.org/tuscany/images/apache- incubator- logo.png" border="0">

            </td-->



            <!-- Adds the edit page link to the top banner-->

            <TD valign="bottom">

                <DIV style="padding: 2px 10px; margin: 0px;">

                    <A href="http://cwiki.apache.org/confluence/pages/editpage.action?pageId=2329557">

                    <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A>

                </DIV>

            </TD>



        </TR>

    </TABLE>




        
    <TABLE border="0" cellpadding="2" cellspacing="0" width="100%">

        <TR class="topBar">

            <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%">

                &nbsp;<A href="home.html" title="Apache Tuscany">Apache Tuscany</A>&nbsp;&gt;&nbsp;<A href="home.html" title="Home">Home</A>&nbsp;&gt;&nbsp;<A href="sca-overview.html" title="SCA Overview">SCA Overview</A>&nbsp;&gt;&nbsp;<A href="sca-java-2x.html" title="SCA Java 2.x">SCA Java 2.x</A>&nbsp;&gt;&nbsp;<A href="" title="Tuscany Maven Archetypes">Tuscany Maven Archetypes</A>

            </TD>

            

            <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true">

            <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A>&nbsp;&nbsp;

            </TD>

        </TR>

    </TABLE>




        <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF">

            <TR>

                <TD align="left" valign="top">

                    
    <DIV id="PageContent">

        
        

        <DIV class="pagecontent">

            <DIV class="wiki-content">

                <TABLE class="sectionMacroWithBorder" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR>
<TD class="confluenceTd" valign="top" width="15%">
<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="home.html" title="Home">Home</A><BR>
<A href="http://www.apache.org/licenses/LICENSE-2.0.html" rel="nofollow">License </A><BR>
<A href="sca-java-get-involved.html" title="SCA Java Get Involved">Get Involved</A><BR>
<A href="sca-java-found-a-bug.html" title="SCA Java Found A Bug">Found a Bug?</A></P>
</DIV></DIV>

<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java.html" title="SCA Java">SCA Java Home</A><BR>
<A href="tuscany-dashboard.html" title="Tuscany Dashboard">SCA Dashboard</A><BR>
<A href="java-sca-tools.html" title="Java SCA Tools">Tools </A><BR>
<A href="tuscany-sca-java-faq.html" title="Tuscany SCA Java - FAQ">FAQ</A></P>
</DIV></DIV>

<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 1.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java-releases.html" title="SCA Java Releases">Downloads</A><BR>
<A href="java-sca-documentation-menu.html" title="Java SCA Documentation Menu">Documentation</A><BR>
<A href="https://svn.apache.org/repos/asf/tuscany/sca-java-1.x/trunk/" rel="nofollow">1.x Source Code</A><BR>
<A href="http://tinyurl.com/8rlxd3" rel="nofollow">Roadmap</A></P>
</DIV></DIV>

<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>SCA Java 2.x</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;">
<P><A href="sca-java-2x-releases.html" title="SCA Java 2.x Releases">Downloads</A><BR>
<A href="http://bit.ly/1DTAYA" rel="nofollow">Documentation</A><BR>
<A href="https://svn.apache.org/repos/asf/tuscany/java/sca/" rel="nofollow">2.x Source Code</A><BR>
<A href="http://tinyurl.com/8rlxd3" rel="nofollow">Roadmap</A></P>
</DIV></DIV>
</TD>
<TD class="confluenceTd" valign="top" width="85%">

<H1><A name="TuscanyMavenArchetypes-TuscanyMavenArchetypes"></A>Tuscany Maven Archetypes</H1>

<P>Tuscany provides some <A href="http://maven.apache.org/guides/introduction/introduction-to-archetypes.html" rel="nofollow">Maven archetypes </A> to make it easy to get going using Tuscany. Maven archetypes provide a simple way to create a project thats configured with exactly what you need to develop your application. You don't need to download, install, or pre-configure Tuscany or your environment, thats all done for you automatically, all you need pre-installed is Maven and Java.</P>

<P>To give it a try run the following command:</P>

<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
mvn archetype:generate -DarchetypeCatalog=http:<SPAN class="code-comment">//tuscany.apache.org</SPAN>
</PRE>
</DIV></DIV>

<P>That will list out the available archetypes and ask you to choose which one you want:</P>

<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
Choose archetype:
1: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-contribution-jar (Create an SCA contribution JAR)
</SPAN>2: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart (Create a Tuscany SCA and JSP project)
</SPAN>3: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart-stripes (Create a Tuscany SCA and Stripes Web Framework project)
</SPAN>4: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart-jsf (Create a Tuscany SCA and JSF project)
</SPAN>Choose a number:  (1/2/3/4):
</PRE>
</DIV></DIV>

<P>You are then prompted to answer several questions about the project such as the Maven group and artifact IDs, Java package names etc. Some of those will show default values before the prompt so you can just hit enter to take the default. Thats it, and then the Maven project is created in a folder in the current directory named after the artifactid you entered.</P>

<P>The following shows the console session for creating an SCA contribution JAR:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
Choose a number:  (1/2/3/4): 4
Define value <SPAN class="code-keyword">for</SPAN> groupId: : org.myco.sca.test
Define value <SPAN class="code-keyword">for</SPAN> artifactId: : scatest
Define value <SPAN class="code-keyword">for</SPAN> version:  1.0-SNAPSHOT: :
Define value <SPAN class="code-keyword">for</SPAN> <SPAN class="code-keyword">package</SPAN>:  org.myco.sca.test: :
Confirm properties configuration:
groupId: org.myco.sca.test
artifactId: scatest
version: 1.0-SNAPSHOT
<SPAN class="code-keyword">package</SPAN>: org.myco.sca.test
 Y: :
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1 minute 15 seconds
[INFO] Finished at: Tue Mar 31 15:08:45 BST 2009
[INFO] Final Memory: 8M/14M
[INFO] ------------------------------------------------------------------------
</PRE>
</DIV></DIV>

<P>That will create a Maven project in a folder named scatest with the following directory structure and files:</P>
<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
scatest\pom.xml
scatest\src\main\java\org\myco\sca\test\HelloworldImpl.java
scatest\src\main\java\org\myco\sca\test\HelloworldService.java
scatest\src\main\resources\helloworld.composite
scatest\src\main\resources\META-INF\sca-contribution.xml
</PRE>
</DIV></DIV>

<P>When using one of the archetypes which create webapp projects the pom.xml is configured with the maven Jetty plugin so you can run the webapp right away without needing to install the WAR file into an appserver by using the command &quot;mvn jetty:run&quot;. The following shows an examaple of this using the tuscany-quickstart archetype:</P>

<DIV class="code panel" style="border-width: 1px;"><DIV class="codeContent panelContent">
<PRE class="code-java">
&gt; mvn archetype:generate -DarchetypeCatalog=http:<SPAN class="code-comment">//tuscany.apache.org
</SPAN>[INFO] Scanning <SPAN class="code-keyword">for</SPAN> projects...
. . .
Choose archetype:
1: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-contribution-jar (Create an SCA JAR contribution project)
</SPAN>2: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-contribution-zip (Create an SCA ZIP contribution project)
</SPAN>3: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart (Create a simple SCA webapp project)
</SPAN>4: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart-jsf (Create a Webapp using SCA and JSF)
</SPAN>5: http:<SPAN class="code-comment">//tuscany.apache.org -&gt; tuscany-quickstart-stripes (Create a Webapp using SCA and the Stripes Web Framework)
</SPAN>Choose a number:  (1/2/3/4/5): 3
Define value <SPAN class="code-keyword">for</SPAN> groupId: : mygroup
Define value <SPAN class="code-keyword">for</SPAN> artifactId: : mytest
Define value <SPAN class="code-keyword">for</SPAN> version:  1.0-SNAPSHOT: :
Define value <SPAN class="code-keyword">for</SPAN> <SPAN class="code-keyword">package</SPAN>:  mygroup: :
Confirm properties configuration:
groupId: mygroup
artifactId: mytest
version: 1.0-SNAPSHOT
<SPAN class="code-keyword">package</SPAN>: mygroup
 Y: :
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------

&gt; cd mytest
&gt; mvn jetty:run
. . .
[INFO] Started Jetty Server
</PRE>
</DIV></DIV> 

<P>The webapp runs at the context path of the artifact name on port 8080 so on a web browser go to <A href="http://localhost:8080/mytest/" rel="nofollow">http://localhost:8080/mytest/</A> and you should see a page showing:</P>

<P>Calling HelloworldService sayHello(&quot;world&quot;) returns:<BR>
Hello world </P>

</TD></TR></TBODY></TABLE>

            </DIV>

        </DIV>

    </DIV>


                </TD>

            </TR>

        </TABLE>



        
    
    <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript">

    </SCRIPT>

    <SCRIPT type="text/javascript">

       _uacct = "UA-1174707-5";

       urchinTracker();

    </SCRIPT>

    

    
    <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A>    



    <DIV class="footer">

        Copyright &copy; 2003-2008, The Apache Software Foundation&nbsp;&nbsp;

    </DIV>




    </BODY>

</HTML>