Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 55.1
edited by johnc
on 2009/04/08 20:41
Change comment: Removed -DarchetypeRepository from archetype:generate. Should now be downloaded from the wocommunity repository.
To version 65.1
edited by Lachlan Deck
on 2016/01/13 15:15
Change comment: At 2016 Quickstart tip

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.johnc
1 +XWiki.ldeck
Content
... ... @@ -1,161 +1,147 @@
1 -== Outline ==
1 +{{tip title="2016 QuickStart"}}
2 +See ([[http:~~/~~/lists.apple.com/archives/webobjects-dev/2016/Jan/msg00045.html>>url:http://lists.apple.com/archives/webobjects-dev/2016/Jan/msg00045.html||shape="rect"]])
2 2  
3 -{{toc style="disc" indent="20px"}}{{/toc}}
4 +**Steps 0-2** (as elaborated below)
4 4  
6 +0. Install Java 8
7 +~1. Install Maven 3
8 +2. Update ~~/.m2/settings.xml to include the wocommunity repo
9 +
10 +**Steps 3–6**
11 +
12 +3. Install Eclipse 4.5 for Committers ([[http:~~/~~/www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]])
13 +4. Install m2e (Help > Install New Software...)
14 +5. Install WOLips
15 +6. Preferences > Maven > Archetypes, Add Remote Catalog
16 + [[http:~~/~~/maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml>>url:http://maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml||shape="rect"]]
17 +
18 +[[url:http://maven.wocommunity.org/service/local/repositories/snapshots/content/archetype-catalog.xml||shape="rect"]]Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
19 +{{/tip}}
20 +
21 +----
22 +
23 +(% style="color: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
24 +
25 +(% style="color: rgb(0,0,0);font-size: 20.0px;" %)Step 0: Install latest Java
26 +
27 +If you're on a Mac, it's using old and busted Java 6. Update that to Java 8 ([[http:~~/~~/www.oracle.com/technetwork/java/javase/downloads/index.html>>url:http://www.oracle.com/technetwork/java/javase/downloads/index.html||shape="rect"]]).
28 +
5 5  == Step 1: Installing Maven ==
6 6  
7 -Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
31 +Downloading and installing the latest version of [[Maven>>url:https://maven.apache.org/download.cgi||shape="rect"]] is the first step to start using this tool via one of the following approaches.
8 8  
9 -{{tip title="Mac Tip"}}
33 +(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
10 10  
11 - install macports [http://www.macports.org/install.php], then on the terminal
12 - {noformat}sudo port install maven2{noformat}
35 +{{code title="MacPorts usage" theme="Emacs" language="bash"}}
36 +$ sudo port install maven3
37 +{{/code}}
13 13  
14 - In future, to keep this up to date:
15 - {noformat}sudo port upgrade maven2{noformat}
39 +(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
16 16  
17 -{{/tip}}
41 +{{code title="Homebrew usage" theme="Emacs" language="bash"}}
42 +$ brew install maven
43 +{{/code}}
18 18  
19 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
45 +(c) Or manually by downloading the binary tarball, copying it to /usr/local/, unpacking it, soft linking it and adding the path to your bash_profile:
20 20  
21 -== Step 2: Configuring your Maven Settings ==
47 +{{code title="Manual install" theme="Emacs" language="bash"}}
48 +$ sudo su
49 +$ cd /usr/local/
50 +$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
51 +$ tar -xzf apache-maven-3.3.3-bin.tar.gz
52 +$ ln -s apache-maven-3.3.3 apache-maven
53 +$ exit
54 +$ cd ~/
55 +$ vi .bash_profile
56 +{{/code}}
22 22  
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.,,
58 +Then in your bash profile, ensure your path and java home are updated:
24 24  
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:
60 +{{code title="~~/.bash_profile" theme="Emacs" linenumbers="true" language="text"}}
61 +...
62 +export PATH=/usr/local/apache-maven/bin:$PATH
63 +export JAVA_HOME=$(/usr/libexec/java_home)
64 +...
65 +{{/code}}
26 26  
27 -{{noformat}}
67 +
28 28  
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>
69 +Whichever installation approach you've taken, you should now be able to do
36 36  
37 - <profiles>
38 - <profile>
39 - <id>default</id>
40 - <activation>
41 - <activeByDefault>true</activeByDefault>
42 - </activation>
43 - <repositories>
44 - <repository>
45 - <id>wocommunity.releases</id>
46 - <name>WOCommunity Releases Repository</name>
47 - <url>
48 - http://maven.wocommunity.org/content/groups/public
49 - </url>
50 - <releases>
51 - <enabled>true</enabled>
52 - </releases>
53 - <snapshots>
54 - <enabled>false</enabled>
55 - </snapshots>
56 - </repository>
57 - <repository>
58 - <id>wocommunity.snapshots</id>
59 - <name>WOCommunity Snapshots Repository</name>
60 - <url>
61 - http://maven.wocommunity.org/content/groups/public-snapshots
62 - </url>
63 - <releases>
64 - <enabled>false</enabled>
65 - </releases>
66 - <snapshots>
67 - <enabled>true</enabled>
68 - </snapshots>
69 - </repository>
70 - </repositories>
71 - <pluginRepositories>
72 - <pluginRepository>
73 - <id>wocommunity.releases</id>
74 - <name>WOCommunity Releases Repository</name>
75 - <url>
76 - http://maven.wocommunity.org/content/groups/public
77 - </url>
78 - <releases>
79 - <enabled>true</enabled>
80 - </releases>
81 - <snapshots>
82 - <enabled>false</enabled>
83 - </snapshots>
84 - </pluginRepository>
85 - <pluginRepository>
86 - <id>wocommunity.snapshots</id>
87 - <name>WOCommunity Snapshots Repository</name>
88 - <url>
89 - http://maven.wocommunity.org/content/groups/public-snapshots
90 - </url>
91 - <releases>
92 - <enabled>false</enabled>
93 - </releases>
94 - <snapshots>
95 - <enabled>true</enabled>
96 - </snapshots>
97 - </pluginRepository>
98 - </pluginRepositories>
99 - </profile>
100 - </profiles>
101 -</settings>
71 +$ mvn -version
102 102  
103 -{{/noformat}}
73 +**NOTE 1**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
104 104  
105 -**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.
75 +**NOTE 2**: You might also like to install bash completion utilities:
106 106  
77 +* See this superuser answer for bash-completion installation: ([[http:~~/~~/superuser.com/questions/288438/bash-completion-for-commands-in-mac-os-x>>url:http://superuser.com/questions/288438/bash-completion-for-commands-in-mac-os-x||shape="rect"]]).
78 +* See also the following github repo for maven-bash-completion: ([[https:~~/~~/github.com/juven/maven-bash-completion>>url:https://github.com/juven/maven-bash-completion||shape="rect"]]).
79 +
80 +== Step 2: Configuring your Maven Settings ==
81 +
82 +Advanced users can skip this step, but it's highly recommended.
83 +
84 +[[doc:Quick Start Maven Settings Configuration Guide]]
85 +
86 +**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.
87 +
88 +Download the [[archetype-catalog.xml>>url:http://maven.wocommunity.org/content/groups/public/archetype-catalog.xml||shape="rect"]] and copy it to ~~/.m2/archetype-catalog.xml
89 +
90 +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.
91 +
107 107  == Step 3: Installing WebObjects Libraries ==
108 108  
109 109  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:
110 110  
111 111  {{noformat}}
97 +mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
112 112  
113 -mvn wobootstrap:install
114 -
115 115  {{/noformat}}
116 116  
117 -**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.
101 +**NOTE**: WebObjects must be installed.
118 118  
119 -{{warning title="Installing the right jars!"}}
103 +**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
120 120  
121 -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.
105 +**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.
122 122  
107 +{{warning title="Installing the right jars!"}}
108 +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.
123 123  {{/warning}}
124 124  
125 -== Step 4: Creating a WebObjects Project ==
111 +== Step 4: Creating a WebObjects or Wonder Project ==
126 126  
127 -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:
113 +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:
128 128  
129 129  {{noformat}}
130 -
131 -mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
116 +mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
132 132   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
133 - -DarchetypeVersion=2.0.16
118 + -DarchetypeVersion=2.1
134 134  
135 135  {{/noformat}}
136 136  
137 137  The maven-archetype-plugin will ask the required information to create the new project.
138 138  
139 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
124 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:woapplication-archetype]].
140 140  
141 -**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
126 +**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
142 142  
128 +**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"]].
129 +
143 143  == Step 5: Importing the Project into Eclipse ==
144 144  
145 145  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.
146 146  
147 147  {{note title="Warning"}}
148 -
149 149  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:
150 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
151 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
152 -# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
153 153  
137 +1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
138 +1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
139 +1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
154 154  {{/note}}
155 155  
156 156  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.
157 157  
158 -**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"]].
144 +**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"]].
159 159  
160 160  == Step 6: Building WebObjects Applications with Maven ==
161 161  
... ... @@ -162,7 +162,6 @@
162 162  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
163 163  
164 164  {{noformat}}
165 -
166 166  mvn clean package
167 167  
168 168  {{/noformat}}
... ... @@ -172,9 +172,8 @@
172 172  To install your project into your local repository:
173 173  
174 174  {{noformat}}
175 -
176 176  mvn clean install
177 177  
178 178  {{/noformat}}
179 179  
180 -This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
164 +This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}