Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 59.1
edited by Lachlan Deck
on 2011/08/20 19:56
Change comment: Updating archetypeVersion to use for quick start. Adding reminder about installing maven_select.
To version 68.1
edited by Lachlan Deck
on 2016/01/13 15:21
Change comment: Migrated to Confluence 5.3

Summary

Details

Page properties
Content
... ... @@ -1,60 +1,111 @@
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  
4 +**Steps 0-2** (as elaborated below)
5 +
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 via Help > Install New Software.... (See [[http:~~/~~/www.eclipse.org/m2e/>>url:http://www.eclipse.org/m2e/||shape="rect"]])
14 +5. Install [[doc: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 +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 +
3 3  == Step 1: Installing Maven ==
4 4  
5 -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.
6 6  
7 -{{tip title="Mac Tip"}}
33 +(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
8 8  
9 -install macports [http://www.macports.org/install.php], then on the terminal:
10 -{noformat}
11 -sudo port install maven3
12 -{noformat}
35 +{{code theme="Emacs" language="bash" title="MacPorts usage"}}
36 +$ sudo port install maven3
37 +{{/code}}
13 13  
14 -In future, to keep this up to date:
15 -{noformat}
16 -sudo port upgrade maven3
17 -{noformat}
39 +(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
18 18  
19 -Don't forget to install maven_select:
20 -{noformat}
21 -sudo port install maven_select
22 -{noformat}
41 +{{code theme="Emacs" language="bash" title="Homebrew usage"}}
42 +$ brew install maven
43 +{{/code}}
23 23  
24 -{{/tip}}
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:
25 25  
26 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[General Maven Documentation]] for more information.
47 +{{code theme="Emacs" language="bash" title="Manual install"}}
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}}
27 27  
58 +Then in your bash profile, ensure your path and java home are updated:
59 +
60 +{{code theme="Emacs" language="text" title="~~/.bash_profile" linenumbers="true"}}
61 +...
62 +export PATH=/usr/local/apache-maven/bin:$PATH
63 +export JAVA_HOME=$(/usr/libexec/java_home)
64 +...
65 +{{/code}}
66 +
67 +
68 +
69 +Whichever installation approach you've taken, you should now be able to do
70 +
71 +$ mvn -version
72 +
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.
74 +
75 +**NOTE 2**: You might also like to install bash completion utilities:
76 +
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 +
28 28  == Step 2: Configuring your Maven Settings ==
29 29  
30 30  Advanced users can skip this step, but it's highly recommended.
31 31  
32 -[[Quick Start Maven Settings Configuration Guide]]
84 +[[doc:Quick Start Maven Settings Configuration Guide]]
33 33  
34 -**NOTE for those who know what to do**: You can download the complete and most recent settings.xml [[here>>^settings.xml]] and install it to /.m2/settings.xml.
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.
35 35  
36 -See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about additional options for the settings.xml file.
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
37 37  
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 +
38 38  == Step 3: Installing WebObjects Libraries ==
39 39  
40 40  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:
41 41  
42 42  {{noformat}}
97 +mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
43 43  
44 -mvn wobootstrap:install
45 -
46 46  {{/noformat}}
47 47  
48 48  **NOTE**: WebObjects must be installed.
49 49  
50 -**See** the [[maven-wobootstrap-plugin>>maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
103 +**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
51 51  
52 -**See** [[Maven Introduction to Repositories>>http://maven.apache.org/guides/introduction/introduction-to-repositories.html]] if you want more information about Maven repositories.
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.
53 53  
54 54  {{warning title="Installing the right jars!"}}
55 -
56 -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.
57 -
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.
58 58  {{/warning}}
59 59  
60 60  == Step 4: Creating a WebObjects or Wonder Project ==
... ... @@ -62,7 +62,6 @@
62 62  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:
63 63  
64 64  {{noformat}}
65 -
66 66  mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
67 67   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
68 68   -DarchetypeVersion=2.1
... ... @@ -71,11 +71,11 @@
71 71  
72 72  The maven-archetype-plugin will ask the required information to create the new project.
73 73  
74 -**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]].
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]].
75 75  
76 -**NOTE**: You can use archetypes within Eclipse as described [[here>>documentation: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"]].
77 77  
78 -**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/]].**
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"]].
79 79  
80 80  == Step 5: Importing the Project into Eclipse ==
81 81  
... ... @@ -82,17 +82,16 @@
82 82  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.
83 83  
84 84  {{note title="Warning"}}
85 -
86 86  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:
87 -# Use the [mvn eclipse:eclipse|http://maven.apache.org/plugins/maven-eclipse-plugin/] goal to update your .classpath file.
88 -# Use the [m2eclipse|http://m2eclipse.codehaus.org/] plug-in for Eclipse.
89 -# Use the [q4e|http://code.google.com/p/q4e/] plug-in for Eclipse.
90 90  
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.
91 91  {{/note}}
92 92  
93 93  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.
94 94  
95 -**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"]].
96 96  
97 97  == Step 6: Building WebObjects Applications with Maven ==
98 98  
... ... @@ -99,7 +99,6 @@
99 99  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
100 100  
101 101  {{noformat}}
102 -
103 103  mvn clean package
104 104  
105 105  {{/noformat}}
... ... @@ -109,9 +109,8 @@
109 109  To install your project into your local repository:
110 110  
111 111  {{noformat}}
112 -
113 113  mvn clean install
114 114  
115 115  {{/noformat}}
116 116  
117 -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}}