Skip to Content

Wiki source code of Quick Start

Version 34.1 by Lachlan Deck on 2008/11/23 15:37
Show last authors
1 == Step 1: Installing Maven ==
2
3 Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
4
5 {{tip title="Mac Tip"}}
6
7 install macports [http://www.macports.org/install.php], then on the terminal
8 {noformat}sudo port install maven2{noformat}
9
10 In future, to keep this up to date:
11 {noformat}sudo port upgrade maven2{noformat}
12
13 {{/tip}}
14
15 **NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
16
17 == Step 2: Configuring your Maven Settings ==
18
19 Before start using Maven, you have to configure it in order to use the plug-ins provided by WOProject. General Maven configuration is made in a settings.xml file. This file can be found at .m2 folder in the user home (,,/.m2 on Unix systems and C:ocuments and Settingsserm2 on Windows). If this file doesn't exist yet, just create it.,,
20
21 You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following snippet shows how to make this configuration:
22
23 {{noformat}}
24
25 <settings>
26 ...
27 <pluginGroups>
28 <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
29 </pluginGroups>
30 ...
31 <profiles>
32 <profile>
33 <id>default</id>
34 <activation>
35 <activeByDefault>true</activeByDefault>
36 </activation>
37 <pluginRepositories>
38 <pluginRepository>
39 <id>mdimension.releases</id>
40 <name>MDimension Releases Repository</name>
41 <url>
42 http://webobjects.mdimension.com/maven2/releases
43 </url>
44 <releases>
45 <enabled>true</enabled>
46 </releases>
47 <snapshots>
48 <enabled>false</enabled>
49 </snapshots>
50 </pluginRepository>
51 <pluginRepository>
52 <id>mdimension.snapshots</id>
53 <name>MDimension Snapshots Repository</name>
54 <url>
55 http://webobjects.mdimension.com/maven2/snapshots
56 </url>
57 <releases>
58 <enabled>false</enabled>
59 </releases>
60 <snapshots>
61 <enabled>true</enabled>
62 </snapshots>
63 </pluginRepository>
64 </pluginRepositories>
65 </profile>
66 </profiles>
67 ...
68 </settings>
69
70 {{/noformat}}
71
72 **NOTE**: You can download the complete settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
73
74 == Step 3: Installing WebObjects Libraries ==
75
76 Maven takes control of all your project's dependencies. To develop WebObjects applications, Maven has to reference the WebObjects jars. You have to install the WebObjects libraries into your local repository to accomplish this:
77
78 {{noformat}}
79
80 mvn wobootstrap:install
81
82 {{/noformat}}
83
84 **NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin]] documentation for more information. See [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
85
86 == Step 4: Creating a WebObjects Project ==
87
88 Archetypes are the fast way to create a new project using Maven. WOProject provides one archetype to create WebObjects Application. Execute the following command to generate a basic WebObjects project:
89
90 {{noformat}}
91
92 mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
93 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
94 -DarchetypeVersion=2.0.16 \
95 -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
96
97 {{/noformat}}
98
99 The maven-archetype-plugin will ask the required information to create the new project.
100
101 **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
102
103 **NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
104
105 == Step 5: Importing the Project into Eclipse ==
106
107 The new project is ready to be imported into Eclipse workspace. Use the Eclipse's import wizard (File > Import...) and choose the option "Existing Projects into Workspace". Select the root directory of your new project and finish the import wizard.
108
109 {{note title="Warning"}}
110
111 As Maven takes care of the dependency management, you must use a mechanism to add the jars to your Eclipse build path. There are 3 options:
112 # Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
113 # Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
114 # Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
115
116 {{/note}}
117
118 After adding the project dependencies to your Eclipse build path, WOLips can build the project and you will be able to start developing and running the application.
119
120 **NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>General Maven Documentation||anchor="IDE Integration"]].
121
122 == Step 6: Building WebObjects Applications with Maven ==
123
124 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
125
126 {{noformat}}
127
128 mvn clean install
129
130 {{/noformat}}
131
132 This goal will generate a WOA package inside the target folder of your project. It also generates two compressed packages: one for woapplication and other for the webserver resources.