Skip to Content

Wiki source code of Quick Start

Version 75.1 by Ulrich Köster on 2023/11/13 11:58
Hide last authors
Ray Kiddy 69.1 1 (% class="auto-cursor-target" %)
2 \\
3
Lachlan Deck 67.1 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"]])
Lachlan Deck 59.1 6
Lachlan Deck 67.1 7 **Steps 0-2** (as elaborated below)
Lachlan Deck 19.1 8
Ray Kiddy 69.1 9 0. Install Java 8 (or Java 11 ?)
Lachlan Deck 67.1 10 ~1. Install Maven 3
11 2. Update ~~/.m2/settings.xml to include the wocommunity repo
Lachlan Deck 19.1 12
Lachlan Deck 67.1 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: rgb(0,0,0);font-size: 24.0px;" %)Detailed Instructions...
27
28 (% style="color: rgb(0,0,0);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
Ramsey Gurley 63.1 32 == Step 1: Installing Maven ==
Lachlan Deck 19.1 33
Lachlan Deck 67.1 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.
Lachlan Deck 19.1 35
Lachlan Deck 67.1 36 (a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
37
Ray Kiddy 69.1 38 {{code language="bash" theme="Emacs" title="MacPorts usage"}}
Lachlan Deck 67.1 39 $ sudo port install maven3
Ramsey Gurley 63.1 40 {{/code}}
Lachlan Deck 60.1 41
Lachlan Deck 67.1 42 (b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
Lachlan Deck 60.1 43
Ray Kiddy 69.1 44 {{code language="bash" theme="Emacs" title="Homebrew usage"}}
Lachlan Deck 67.1 45 $ brew install maven
46 {{/code}}
Lachlan Deck 19.1 47
Lachlan Deck 67.1 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:
Lachlan Deck 60.1 49
Ray Kiddy 69.1 50 {{code language="bash" theme="Emacs" title="Manual install"}}
Lachlan Deck 67.1 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}}
60
61 Then in your bash profile, ensure your path and java home are updated:
62
Ray Kiddy 69.1 63 {{code language="text" theme="Emacs" title="~~/.bash_profile" linenumbers="true"}}
Lachlan Deck 67.1 64 ...
65 export PATH=/usr/local/apache-maven/bin:$PATH
Ramsey Gurley 63.1 66 export JAVA_HOME=$(/usr/libexec/java_home)
Lachlan Deck 67.1 67 ...
68 {{/code}}
Lachlan Deck 60.1 69
Ray Kiddy 69.1 70 \\
Lachlan Deck 19.1 71
Lachlan Deck 67.1 72 Whichever installation approach you've taken, you should now be able to do
Lachlan Deck 19.1 73
Lachlan Deck 67.1 74 $ mvn -version
Lachlan Deck 19.1 75
Paul Hoadley 70.1 76 **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.
Lachlan Deck 67.1 77
78 **NOTE 2**: You might also like to install bash completion utilities:
79
80 * 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"]]).
81 * 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"]]).
82
Lachlan Deck 59.1 83 == Step 2: Configuring your Maven Settings ==
Lachlan Deck 25.1 84
Lachlan Deck 59.1 85 Advanced users can skip this step, but it's highly recommended.
Lachlan Deck 25.1 86
Lachlan Deck 72.1 87 [[doc:WOL.Home.WOProject-Maven.Quick Start.Quick Start Maven Settings Configuration Guide.WebHome]]
Lachlan Deck 59.1 88
Lachlan Deck 60.1 89 **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.
Lachlan Deck 59.1 90
Lachlan Deck 64.1 91 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
92
Lachlan Deck 60.1 93 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.
Lachlan Deck 59.1 94
Lachlan Deck 19.1 95 == Step 3: Installing WebObjects Libraries ==
96
Ramsey Gurley 62.1 97 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:
Lachlan Deck 19.1 98
99 {{noformat}}
Ramsey Gurley 62.1 100 mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
Lachlan Deck 19.1 101
102 {{/noformat}}
103
Lachlan Deck 59.1 104 **NOTE**: WebObjects must be installed.
Lachlan Deck 19.1 105
Ray Kiddy 69.1 106
107
Paul Hoadley 70.1 108 [[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
109
Ray Kiddy 69.1 110 {{{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]}}}
111
112 What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
113
Lachlan Deck 73.1 114 **See** the [[doc:WOL.Home.WOProject-Maven.maven-wobootstrap-plugin.WebHome]] documentation for more information and options for specifying a specific version.
Lachlan Deck 19.1 115
Lachlan Deck 60.1 116 **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.
Lachlan Deck 19.1 117
Lachlan Deck 59.1 118 {{warning title="Installing the right jars!"}}
Lachlan Deck 60.1 119 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.
Lachlan Deck 59.1 120 {{/warning}}
121
122 == Step 4: Creating a WebObjects or Wonder Project ==
123
124 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:
125
Lachlan Deck 19.1 126 {{noformat}}
Lachlan Deck 59.1 127 mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
128 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
129 -DarchetypeVersion=2.1
Lachlan Deck 19.1 130
131 {{/noformat}}
132
133 The maven-archetype-plugin will ask the required information to create the new project.
134
Ulrich Köster 74.1 135 **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]].
Lachlan Deck 19.1 136
Ulrich Köster 75.1 137 **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Home.WOLips Tutorials.Maven Create WO Application Project.WebHome||anchor="m2eclipse"]].
Lachlan Deck 59.1 138
Ramsey Gurley 61.1 139 **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"]].
Lachlan Deck 59.1 140
Lachlan Deck 19.1 141 == Step 5: Importing the Project into Eclipse ==
142
143 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.
144
145 {{note title="Warning"}}
146 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:
147
Lachlan Deck 60.1 148 1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
149 1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
150 1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
Lachlan Deck 19.1 151 {{/note}}
152
153 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.
154
Paul Hoadley 70.1 155 **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"]].
Lachlan Deck 19.1 156
157 == Step 6: Building WebObjects Applications with Maven ==
158
johnc 47.1 159 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
Lachlan Deck 19.1 160
161 {{noformat}}
Lachlan Deck 59.1 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}}
Henrique Prange 57.1 171 mvn clean install
johnc 47.1 172
173 {{/noformat}}
174
Lachlan Deck 60.1 175 This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}