Skip to Content

Changes for page Quick Start

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

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +WOL.Home.WOProject-Maven.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ldeck
1 +XWiki.paulh
Content
... ... @@ -1,152 +1,162 @@
1 -== Outline ==
1 +(% class="auto-cursor-target" %)
2 +
2 2  
3 -{{toc style="disc" indent="20px"}}{{/toc}}
4 +{{tip title="2016 QuickStart"}}
5 +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"]])
4 4  
7 +**Steps 0-2** (as elaborated below)
8 +
9 +0. Install Java 8 (or Java 11 ?)
10 +~1. Install Maven 3
11 +2. Update ~~/.m2/settings.xml to include the wocommunity repo
12 +
13 +**Steps 3–6**
14 +
15 +3. Install Eclipse 4.5 for Committers ([[http:~~/~~/www.eclipse.org/downloads/>>url:http://www.eclipse.org/downloads/||shape="rect"]])
16 +4. Install m2e via Help > Install New Software.... (See [[http:~~/~~/www.eclipse.org/m2e/>>url:http://www.eclipse.org/m2e/||shape="rect"]])
17 +5. Install [[doc:WOLips]]
18 +6. Preferences > Maven > Archetypes, Add Remote Catalog
19 + [[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"]]
20 +
21 +Done. The WebObjects jars are in the wocommunity repo, so no need to do woinstaller.jar hassle.
22 +{{/tip}}
23 +
24 +----
25 +
26 +(% style="color:#000000; font-size:24.0px" %)Detailed Instructions...
27 +
28 +(% style="color:#000000; font-size:20.0px" %)Step 0: Install latest Java
29 +
30 +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"]]).
31 +
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.
34 +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"}}
36 +(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}
38 +{{code language="bash" theme="Emacs" title="MacPorts usage"}}
39 +$ sudo port install maven3
40 +{{/code}}
13 13  
14 - In future, to keep this up to date:
15 - {noformat}sudo port upgrade maven2{noformat}
42 +(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
16 16  
17 -{{/tip}}
44 +{{code language="bash" theme="Emacs" title="Homebrew usage"}}
45 +$ brew install maven
46 +{{/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.
48 +(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 ==
50 +{{code language="bash" theme="Emacs" title="Manual install"}}
51 +$ sudo su
52 +$ cd /usr/local/
53 +$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
54 +$ tar -xzf apache-maven-3.3.3-bin.tar.gz
55 +$ ln -s apache-maven-3.3.3 apache-maven
56 +$ exit
57 +$ cd ~/
58 +$ vi .bash_profile
59 +{{/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.,,
61 +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:
63 +{{code language="text" theme="Emacs" linenumbers="true" title="/.bash_profile"}}
64 +...
65 +export PATH=/usr/local/apache-maven/bin:$PATH
66 +export JAVA_HOME=$(/usr/libexec/java_home)
67 +...
68 +{{/code}}
26 26  
27 -{{noformat}}
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>
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>
71 +Whichever installation approach you've taken, you should now be able to do
73 73  
74 -{{/noformat}}
73 +$ mvn -version
75 75  
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.
75 +**NOTE 1**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:WOL.Home.WOProject-Maven.General Maven Documentation.WebHome]] for more information.
77 77  
77 +**NOTE 2**: You might also like to install bash completion utilities:
78 +
79 +* 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"]]).
80 +* 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"]]).
81 +
82 +== Step 2: Configuring your Maven Settings ==
83 +
84 +Advanced users can skip this step, but it's highly recommended.
85 +
86 +[[doc:WOL.Home.WOProject-Maven.Quick Start.Quick Start Maven Settings Configuration Guide.WebHome]]
87 +
88 +**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.
89 +
90 +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
91 +
92 +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.
93 +
78 78  == Step 3: Installing WebObjects Libraries ==
79 79  
80 80  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:
81 81  
82 -{{noformat}}
98 +{{{mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3}}}
83 83  
84 -mvn wobootstrap:install
100 +**NOTE**: WebObjects must be installed.
85 85  
86 -{{/noformat}}
87 87  
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.
89 89  
90 -{{warning title="Installing the right jars!"}}
104 +[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
91 91  
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.
106 +{{{NOTE: [ERROR] No plugin found for prefix 'wobootstrap' in the current project and in the plugin groups [org.apache.maven.plugins, org.codehaus.mojo] available from the repositories [local (/home/ray/.m2/repository), central ()] > [Help 1]}}}
93 93  
94 -{{/warning}}
108 +What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
95 95  
96 -== Step 4: Creating a WebObjects Project ==
110 +**See** the [[doc:WOL.Home.WOProject-Maven.maven-wobootstrap-plugin.WebHome]] documentation for more information and options for specifying a specific version.
97 97  
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:
112 +**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.
99 99  
100 -{{noformat}}
114 +{{warning title="Installing the right jars!"}}
115 +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.
116 +{{/warning}}
101 101  
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
118 +== Step 4: Creating a WebObjects or Wonder Project ==
106 106  
107 -{{/noformat}}
120 +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:
108 108  
122 +{{{mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
123 + -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
124 + -DarchetypeVersion=2.1}}}
125 +
109 109  The maven-archetype-plugin will ask the required information to create the new project.
110 110  
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]].
128 +**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[doc:WOL.Home.WOProject-Maven.woapplication-archetype.WebHome]].
112 112  
113 -**NOTE**: You can use archetypes within Eclipse as described [[here>>Maven Create WO Application Project||anchor="m2eclipse"]].
130 +**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Home.WOLips Tutorials.Maven Create WO Application Project.WebHome||anchor="m2eclipse"]].
114 114  
132 +**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"]].
133 +
115 115  == Step 5: Importing the Project into Eclipse ==
116 116  
117 117  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.
118 118  
119 119  {{note title="Warning"}}
120 -
121 121  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.
125 125  
141 +1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
142 +1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
143 +1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
126 126  {{/note}}
127 127  
128 128  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.
129 129  
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"]].
148 +**NOTE**: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration [[here>>doc:WOL.Home.WOProject-Maven.General Maven Documentation.WebHome||anchor="IDE Integration"]].
131 131  
132 132  == Step 6: Building WebObjects Applications with Maven ==
133 133  
134 134  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
135 135  
136 -{{noformat}}
154 +{{{mvn clean package}}}
137 137  
138 -mvn clean package
139 -
140 -{{/noformat}}
141 -
142 142  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.
143 143  
144 144  To install your project into your local repository:
145 145  
146 -{{noformat}}
160 +{{{mvn clean install}}}
147 147  
148 -mvn clean install
149 -
150 -{{/noformat}}
151 -
152 -This will install your project into ##,,/.m2/repository/your/project/groupId/artifactId/version/...,,##
162 +This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}
settings.xml
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +1.9 KB
Content
... ... @@ -1,0 +1,73 @@
1 +<settings xmlns="http://maven.apache.org/POM/4.0.0"
2 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
4 + http://maven.apache.org/xsd/settings-1.0.0.xsd">
5 + <pluginGroups>
6 + <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
7 + </pluginGroups>
8 +
9 + <profiles>
10 + <profile>
11 + <id>default</id>
12 + <activation>
13 + <activeByDefault>true</activeByDefault>
14 + </activation>
15 + <repositories>
16 + <repository>
17 + <id>wocommunity.releases</id>
18 + <name>WOCommunity Releases Repository</name>
19 + <url>
20 + http://maven.wocommunity.org/content/groups/public
21 + </url>
22 + <releases>
23 + <enabled>true</enabled>
24 + </releases>
25 + <snapshots>
26 + <enabled>false</enabled>
27 + </snapshots>
28 + </repository>
29 + <repository>
30 + <id>wocommunity.snapshots</id>
31 + <name>WOCommunity Snapshots Repository</name>
32 + <url>
33 + http://maven.wocommunity.org/content/groups/public-snapshots
34 + </url>
35 + <releases>
36 + <enabled>false</enabled>
37 + </releases>
38 + <snapshots>
39 + <enabled>true</enabled>
40 + </snapshots>
41 + </repository>
42 + </repositories>
43 + <pluginRepositories>
44 + <pluginRepository>
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 + </pluginRepository>
57 + <pluginRepository>
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 + </pluginRepository>
70 + </pluginRepositories>
71 + </profile>
72 + </profiles>
73 +</settings>