Skip to Content

Wiki source code of Quick Start

Version 21.1 by egeze on 2011/05/01 06:35
Show last authors
1 == Outline ==
2
3 == Step 1: Installing Maven ==
4
5 Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
6
7 {{tip title="Mac Tip"}}
8
9 install macports [http://www.macports.org/install.php], then on the terminal{noformat}sudo port install maven2{noformat}
10
11 In future, to keep this up to date:{noformat}sudo port upgrade maven2{noformat}
12
13 {{/tip}}
14
15 **NOTE**: It is very helpful if you understand some Maven concepts before continuing 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 in a folder called ##.m2## in each user's home directory (,,/.m2 on Unix systems and C:ocuments and SettingsserNamem2 on Windows). If this file does not yet exist, you can just create it.,,
20
21 You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following xml is sufficient to configure maven for using WOProject-maven plugin:
22
23 {{noformat}}
24
25 <settings xmlns="http://maven.apache.org/POM/4.0.0"
26 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
27 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
28 http://maven.apache.org/xsd/settings-1.0.0.xsd">
29 <pluginGroups>
30 <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
31 </pluginGroups>
32
33 <profiles>
34 <profile>
35 <id>default</id>
36 <activation>
37 <activeByDefault>true</activeByDefault>
38 </activation>
39 <repositories>
40 <repository>
41 <id>wocommunity.releases</id>
42 <name>WOCommunity Releases Repository</name>
43 <url>
44 http://maven.wocommunity.org/content/groups/public
45 </url>
46 <releases>
47 <enabled>true</enabled>
48 </releases>
49 <snapshots>
50 <enabled>false</enabled>
51 </snapshots>
52 </repository>
53 <repository>
54 <id>wocommunity.snapshots</id>
55 <name>WOCommunity Snapshots Repository</name>
56 <url>
57 http://maven.wocommunity.org/content/groups/public-snapshots
58 </url>
59 <releases>
60 <enabled>false</enabled>
61 </releases>
62 <snapshots>
63 <enabled>true</enabled>
64 </snapshots>
65 </repository>
66 </repositories>
67 <pluginRepositories>
68 <pluginRepository>
69 <id>wocommunity.releases</id>
70 <name>WOCommunity Releases Repository</name>
71 <url>
72 http://maven.wocommunity.org/content/groups/public
73 </url>
74 <releases>
75 <enabled>true</enabled>
76 </releases>
77 <snapshots>
78 <enabled>false</enabled>
79 </snapshots>
80 </pluginRepository>
81 <pluginRepository>
82 <id>wocommunity.snapshots</id>
83 <name>WOCommunity Snapshots Repository</name>
84 <url>
85 http://maven.wocommunity.org/content/groups/public-snapshots
86 </url>
87 <releases>
88 <enabled>false</enabled>
89 </releases>
90 <snapshots>
91 <enabled>true</enabled>
92 </snapshots>
93 </pluginRepository>
94 </pluginRepositories>
95 </profile>
96 </profiles>
97 </settings>
98
99 {{/noformat}}
100
101 **NOTE**: You can download the complete and most recent settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
102
103 == Step 3: Installing WebObjects Libraries ==
104
105 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:
106
107 {{noformat}}
108
109 mvn wobootstrap:install
110
111 {{/noformat}}
112
113 **NOTE**: WebObjects must be installed. See the [[maven-wobootstrap-plugin>>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.
114
115 {{warning title="Installing the right jars!"}}
116
117 Do *not* link to or install the WebObjects jars located inside {{/System/Library/Frameworks}} or {{/Library/Frameworks}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{/Library/WebObjects/lib}}. For example, the jar {{/Library/WebObjects/lib/JavaWebObjects.jar}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar}} does not.
118
119 {{/warning}}
120
121 == Step 4: Creating a WebObjects Project ==
122
123 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:
124
125 {{noformat}}
126
127 mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
128 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
129 -DarchetypeVersion=2.0.17
130
131 {{/noformat}}
132
133 The maven-archetype-plugin will ask the required information to create the new project.
134
135 **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>woapplication-archetype]].
136
137 **NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
138
139 == Step 5: Importing the Project into Eclipse ==
140
141 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.
142
143 {{note title="Warning"}}
144
145 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:
146 # Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
147 # Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
148 # Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
149
150 {{/note}}
151
152 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.
153
154 **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"]].
155
156 == Step 6: Building WebObjects Applications with Maven ==
157
158 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
159
160 {{noformat}}
161
162 mvn clean package
163
164 {{/noformat}}
165
166 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.
167
168 To install your project into your local repository:
169
170 {{noformat}}
171
172 mvn clean install
173
174 {{/noformat}}
175
176 This will install your project into ##/.m2/repository/your/project/groupId/artifactId/version/...##