Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 60.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: There is no comment for this version
To version 53.1
edited by Lachlan Deck
on 2008/12/08 15:48
Change comment: Quick review - adding table of contents, grammar fixes.

Summary

Details

Page properties
Content
... ... @@ -1,47 +1,80 @@
1 1  == Outline ==
2 2  
3 +{{toc style="disc" indent="20px"}}{{/toc}}
4 +
3 3  == Step 1: Installing Maven ==
4 4  
5 -Downloading and installing the latest version of [[Maven>>url:http://maven.apache.org/download||shape="rect"]] is the first step to start using this tool.
7 +Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
6 6  
7 7  {{tip title="Mac Tip"}}
8 -install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:
9 9  
10 -{{noformat}}
11 + install macports [http://www.macports.org/install.php], then on the terminal
12 + {noformat}sudo port install maven2{noformat}
11 11  
12 -sudo port install maven3
14 + In future, to keep this up to date:
15 + {noformat}sudo port upgrade maven2{noformat}
13 13  
14 -{{/noformat}}
17 +{{/tip}}
15 15  
16 -In future, to keep this up to date:
19 +**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
17 17  
18 -{{noformat}}
21 +== Step 2: Configuring your Maven Settings ==
19 19  
20 -sudo port upgrade maven3
23 +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.,,
21 21  
22 -{{/noformat}}
25 +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:
23 23  
24 -Don't forget to install maven_select:
25 -
26 26  {{noformat}}
27 27  
28 -sudo port install maven_select
29 +<settings xmlns="http://maven.apache.org/POM/4.0.0"
30 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
31 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
32 + http://maven.apache.org/xsd/settings-1.0.0.xsd">
33 + <pluginGroups>
34 + <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
35 + </pluginGroups>
36 + <profiles>
37 + <profile>
38 + <id>woproject</id>
39 + <activation>
40 + <activeByDefault>true</activeByDefault>
41 + </activation>
42 + <pluginRepositories>
43 + <pluginRepository>
44 + <id>mdimension.releases</id>
45 + <name>MDimension Releases Repository</name>
46 + <url>
47 + http://webobjects.mdimension.com/maven2/releases
48 + </url>
49 + <releases>
50 + <enabled>true</enabled>
51 + </releases>
52 + <snapshots>
53 + <enabled>false</enabled>
54 + </snapshots>
55 + </pluginRepository>
56 + <pluginRepository>
57 + <id>mdimension.snapshots</id>
58 + <name>MDimension Snapshots Repository</name>
59 + <url>
60 + http://webobjects.mdimension.com/maven2/snapshots
61 + </url>
62 + <releases>
63 + <enabled>false</enabled>
64 + </releases>
65 + <snapshots>
66 + <enabled>true</enabled>
67 + </snapshots>
68 + </pluginRepository>
69 + </pluginRepositories>
70 + </profile>
71 + </profiles>
72 +</settings>
29 29  
30 30  {{/noformat}}
31 -{{/tip}}
32 32  
33 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
76 +**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.
34 34  
35 -== Step 2: Configuring your Maven Settings ==
36 -
37 -Advanced users can skip this step, but it's highly recommended.
38 -
39 -[[doc:Quick Start Maven Settings Configuration Guide]]
40 -
41 -**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>attach:settings.xml]] and install it to ~~/.m2/settings.xml.
42 -
43 -See [[Maven Settings Reference>>url:http://maven.apache.org/settings.html||shape="rect"]] if you want more information about additional options for the settings.xml file.
44 -
45 45  == Step 3: Installing WebObjects Libraries ==
46 46  
47 47  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:
... ... @@ -52,51 +52,49 @@
52 52  
53 53  {{/noformat}}
54 54  
55 -**NOTE**: WebObjects must be installed.
88 +**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.
56 56  
57 -**See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
90 +{{warning title="Installing the right jars!"}}
58 58  
59 -**See** [[Maven Introduction to Repositories>>url:http://maven.apache.org/guides/introduction/introduction-to-repositories.html||shape="rect"]] if you want more information about Maven repositories.
92 +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.
60 60  
61 -{{warning title="Installing the right jars!"}}
62 -Do **not** link to or install the WebObjects jars located inside {{code language="none"}}/System/Library/Frameworks{{/code}} or {{code language="none"}}/Library/Frameworks{{/code}}. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into {{code language="none"}}/Library/WebObjects/lib{{/code}}. For example, the jar {{code language="none"}}/Library/WebObjects/lib/JavaWebObjects.jar{{/code}} has the complete set of resources and files included for the dependency JavaWebObjects whereas {{code language="none"}}/System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar{{/code}} does not.
63 63  {{/warning}}
64 64  
65 -== Step 4: Creating a WebObjects or Wonder Project ==
96 +== Step 4: Creating a WebObjects Project ==
66 66  
67 -Archetypes are the fast way to create a new project using Maven and WOProject provides various archetypes of its own to get you started with WebObjects, or better, Wonder-based applications. Execute the following command to generate a basic Wonder application project:
98 +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:
68 68  
69 69  {{noformat}}
70 70  
71 -mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
72 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
73 - -DarchetypeVersion=2.1
102 +mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
103 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
104 + -DarchetypeVersion=2.0.16 \
105 + -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
74 74  
75 75  {{/noformat}}
76 76  
77 77  The maven-archetype-plugin will ask the required information to create the new project.
78 78  
79 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>doc:woapplication-archetype]].
111 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
80 80  
81 -**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
113 +**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
82 82  
83 -**NOTE:** You can see the list of available archetypes in the following location: [[http:~~/~~/wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/>>url:http://wo-repository.moleque.com.br/nexus/content/groups/public/org/objectstyle/woproject/maven2/||shape="rect"]].
84 -
85 85  == Step 5: Importing the Project into Eclipse ==
86 86  
87 87  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.
88 88  
89 89  {{note title="Warning"}}
120 +
90 90  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:
122 +# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
123 +# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
124 +# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
91 91  
92 -1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
93 -1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
94 -1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
95 95  {{/note}}
96 96  
97 97  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.
98 98  
99 -**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>doc:General Maven Documentation||anchor="IDE Integration"]].
130 +**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"]].
100 100  
101 101  == Step 6: Building WebObjects Applications with Maven ==
102 102  
... ... @@ -118,4 +118,4 @@
118 118  
119 119  {{/noformat}}
120 120  
121 -This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}
152 +This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##