Skip to Content

Wiki source code of Quick Start

Version 41.1 by Henrique Prange on 2008/05/01 18:01
Hide last authors
Lachlan Deck 19.1 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
Henrique Prange 41.1 5 **NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
Lachlan Deck 19.1 6
7 == Step 2: Configuring your Maven Settings ==
8
Henrique Prange 41.1 9 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.,,
Lachlan Deck 19.1 10
Henrique Prange 41.1 11 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:
Lachlan Deck 19.1 12
Lachlan Deck 25.1 13 {{noformat}}
Lachlan Deck 19.1 14
Henrique Prange 41.1 15 <settings>
16 ...
Lachlan Deck 25.1 17 <pluginGroups>
18 <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
19 </pluginGroups>
Henrique Prange 41.1 20 ...
Lachlan Deck 25.1 21 <profiles>
22 <profile>
23 <pluginRepositories>
24 <pluginRepository>
Henrique Prange 41.1 25 <id>mdimension.releases</id>
26 <name>MDimension Releases Repository</name>
Lachlan Deck 25.1 27 <url>
Henrique Prange 41.1 28 http://webobjects.mdimension.com/maven2/releases
Lachlan Deck 25.1 29 </url>
30 <releases>
31 <enabled>true</enabled>
32 </releases>
33 <snapshots>
34 <enabled>false</enabled>
35 </snapshots>
36 </pluginRepository>
37 <pluginRepository>
Henrique Prange 41.1 38 <id>mdimension.snapshots</id>
39 <name>MDimension Snapshots Repository</name>
Lachlan Deck 25.1 40 <url>
Henrique Prange 41.1 41 http://webobjects.mdimension.com/maven2/snapshots
Lachlan Deck 25.1 42 </url>
43 <releases>
44 <enabled>false</enabled>
45 </releases>
46 <snapshots>
47 <enabled>true</enabled>
48 </snapshots>
49 </pluginRepository>
Henrique Prange 41.1 50 <pluginRepositories>
Lachlan Deck 25.1 51 </profile>
52 </profiles>
Henrique Prange 41.1 53 ...
Lachlan Deck 25.1 54 </settings>
Lachlan Deck 19.1 55
Lachlan Deck 25.1 56 {{/noformat}}
57
Henrique Prange 41.1 58 **NOTE**: You can download the complete settings.xml [[here|]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
Lachlan Deck 25.1 59
Lachlan Deck 19.1 60 == Step 3: Installing WebObjects Libraries ==
61
62 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:
63
64 {{noformat}}
65
66 mvn wobootstrap:install
67
68 {{/noformat}}
69
Lachlan Deck 25.1 70 **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.
Lachlan Deck 19.1 71
72 == Step 4: Creating a WebObjects Project ==
73
74 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:
75
76 {{noformat}}
77
78 mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
Henrique Prange 41.1 79 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
80 -DarchetypeVersion=2.0.14 \
81 -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
Lachlan Deck 19.1 82
83 {{/noformat}}
84
85 The maven-archetype-plugin will ask the required information to create the new project.
86
Lachlan Deck 25.1 87 **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
Lachlan Deck 19.1 88
89 == Step 5: Importing the Project into Eclipse ==
90
91 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.
92
93 {{note title="Warning"}}
94
95 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:
Henrique Prange 41.1 96 # Use the mvn eclipse:eclipse goal to update your .classpath file.
97 # Use the m2eclipse plug-in for Eclipse.
98 # Use the q4e plug-in for Eclipse.
Lachlan Deck 19.1 99
100 {{/note}}
101
102 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.
103
104 **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"]].
105
106 == Step 6: Building WebObjects Applications with Maven ==
107
Henrique Prange 41.1 108 Now, building your project with Maven is easy. Point to the project folder on Terminal and execute:
Lachlan Deck 19.1 109
110 {{noformat}}
111
Henrique Prange 41.1 112 mvn clean install
johnc 39.1 113
114 {{/noformat}}
115
116 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.