Skip to Content

Wiki source code of Quick Start

Version 65.1 by Lachlan Deck on 2016/01/13 15:15
Show last authors
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"]])
3
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 (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
29 == Step 1: Installing Maven ==
30
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.
32
33 (a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
34
35 {{code title="MacPorts usage" theme="Emacs" language="bash"}}
36 $ sudo port install maven3
37 {{/code}}
38
39 (b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
40
41 {{code title="Homebrew usage" theme="Emacs" language="bash"}}
42 $ brew install maven
43 {{/code}}
44
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:
46
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}}
57
58 Then in your bash profile, ensure your path and java home are updated:
59
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}}
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
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
92 == Step 3: Installing WebObjects Libraries ==
93
94 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:
95
96 {{noformat}}
97 mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
98
99 {{/noformat}}
100
101 **NOTE**: WebObjects must be installed.
102
103 **See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
104
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.
106
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.
109 {{/warning}}
110
111 == Step 4: Creating a WebObjects or Wonder Project ==
112
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:
114
115 {{noformat}}
116 mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
117 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
118 -DarchetypeVersion=2.1
119
120 {{/noformat}}
121
122 The maven-archetype-plugin will ask the required information to create the new project.
123
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]].
125
126 **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
127
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
130 == Step 5: Importing the Project into Eclipse ==
131
132 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.
133
134 {{note title="Warning"}}
135 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:
136
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.
140 {{/note}}
141
142 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.
143
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"]].
145
146 == Step 6: Building WebObjects Applications with Maven ==
147
148 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
149
150 {{noformat}}
151 mvn clean package
152
153 {{/noformat}}
154
155 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.
156
157 To install your project into your local repository:
158
159 {{noformat}}
160 mvn clean install
161
162 {{/noformat}}
163
164 This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}