Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 63.1
edited by Ramsey Gurley
on 2015/05/01 13:23
Change comment: There is no comment for this version
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.ramsey
1 +XWiki.paulh
Content
... ... @@ -1,46 +1,94 @@
1 -== Outline ==
1 +(% class="auto-cursor-target" %)
2 +
2 2  
3 -== Step 0: Install latest Java ==
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  
5 -If you're on a Mac, it's using old and busted Java 6. Update that to Java 8.
7 +**Steps 0-2** (as elaborated below)
6 6  
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 +
7 7  == Step 1: Installing Maven ==
8 8  
9 -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. Download the binary tarball, copy it to /usr/local/, unpack it, soft link it and add the path to your bash_profile:
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.
10 10  
11 -{{code title="shell"}}
12 -sudo su
13 -cd /usr/local/
14 -curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
15 -tar -xzf apache-maven-3.3.3-bin.tar.gz
16 -ln -s apache-maven-3.3.3 apache-maven
17 -exit
18 -cd ~/
19 -vi .bash_profile
36 +(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
37 +
38 +{{code language="bash" theme="Emacs" title="MacPorts usage"}}
39 +$ sudo port install maven3
20 20  {{/code}}
21 21  
22 -Then in your bash profile, make your path look something like:
42 +(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
23 23  
24 -export PATH=/usr/local/apache-maven/bin:$PATH
44 +{{code language="bash" theme="Emacs" title="Homebrew usage"}}
45 +$ brew install maven
46 +{{/code}}
25 25  
26 -And tell maven where your non-mac Java home is located
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:
27 27  
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}}
60 +
61 +Then in your bash profile, ensure your path and java home are updated:
62 +
63 +{{code language="text" theme="Emacs" linenumbers="true" title="/.bash_profile"}}
64 +...
65 +export PATH=/usr/local/apache-maven/bin:$PATH
28 28  export JAVA_HOME=$(/usr/libexec/java_home)
67 +...
68 +{{/code}}
29 29  
30 -You should now be able to do
31 31  
32 -mvn -version
71 +Whichever installation approach you've taken, you should now be able to do
33 33  
34 -**NOTE**: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See [[doc:General Maven Documentation]] for more information.
73 +$ mvn -version
35 35  
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.
76 +
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 +
36 36  == Step 2: Configuring your Maven Settings ==
37 37  
38 38  Advanced users can skip this step, but it's highly recommended.
39 39  
40 -[[doc:Quick Start Maven Settings Configuration Guide]]
86 +[[doc:WOL.Home.WOProject-Maven.Quick Start.Quick Start Maven Settings Configuration Guide.WebHome]]
41 41  
42 42  **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.
43 43  
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 +
44 44  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.
45 45  
46 46  == Step 3: Installing WebObjects Libraries ==
... ... @@ -47,15 +47,20 @@
47 47  
48 48  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:
49 49  
50 -{{noformat}}
51 -mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
98 +{{{mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3}}}
52 52  
53 -{{/noformat}}
54 -
55 55  **NOTE**: WebObjects must be installed.
56 56  
57 -**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
58 58  
103 +
104 +[[https:~~/~~/repo.maven.apache.org/maven2>>url:https://repo.maven.apache.org/maven2||shape="rect"]]
105 +
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]}}}
107 +
108 +What does one do about this error? rrk (ray at ganymede.org) 2022 06-24
109 +
110 +**See** the [[doc:WOL.Home.WOProject-Maven.maven-wobootstrap-plugin.WebHome]] documentation for more information and options for specifying a specific version.
111 +
59 59  **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.
60 60  
61 61  {{warning title="Installing the right jars!"}}
... ... @@ -66,18 +66,15 @@
66 66  
67 67  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:
68 68  
69 -{{noformat}}
70 -mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
122 +{{{mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
71 71   -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
72 - -DarchetypeVersion=2.1
124 + -DarchetypeVersion=2.1}}}
73 73  
74 -{{/noformat}}
75 -
76 76  The maven-archetype-plugin will ask the required information to create the new project.
77 77  
78 -**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]].
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]].
79 79  
80 -**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.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"]].
81 81  
82 82  **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"]].
83 83  
... ... @@ -95,24 +95,18 @@
95 95  
96 96  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.
97 97  
98 -**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"]].
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"]].
99 99  
100 100  == Step 6: Building WebObjects Applications with Maven ==
101 101  
102 102  Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
103 103  
104 -{{noformat}}
105 -mvn clean package
154 +{{{mvn clean package}}}
106 106  
107 -{{/noformat}}
108 -
109 109  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.
110 110  
111 111  To install your project into your local repository:
112 112  
113 -{{noformat}}
114 -mvn clean install
160 +{{{mvn clean install}}}
115 115  
116 -{{/noformat}}
117 -
118 118  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>