Skip to Content

Changes for page Quick Start

Last modified by Paul Hoadley on 2025/01/30 02:09
From version 57.1
edited by Henrique Prange
on 2008/05/02 09:59
Change comment: There is no comment for this version
To version 77.2
edited by Paul Hoadley
on 2023/12/25 09:22
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.hprange
1 +XWiki.paulh
Content
... ... @@ -1,116 +1,138 @@
1 -== Step 1: Installing Maven ==
1 +(% class="auto-cursor-target" %)
2 +You should be able to get a "Hello, World!" Wonder application running using Maven in about 10 minutes.
2 2  
3 -Downloading and installing the latest version of [[Maven>>http://maven.apache.org/download]] is the first step to start using this tool.
4 +(% id="HAssumptions" class="auto-cursor-target" %)
5 += Assumptions =
4 4  
5 -**NOTE**: It is very helpful if you understand some Maven concepts before continue with this tutorial. See [[General Maven Documentation]] for more information.
7 +We're going to make a few assumptions to keep this page brief:
6 6  
7 -== Step 2: Configuring your Maven Settings ==
9 +1. You are running macOS X. You can probably get a WebObjects development environment up on a different OS, but we won't cover that here.
10 +1. You have Java installed. //We are actually going to assume you're using Java 8//, but only because it's just marginally easier to launch the application under Java 8. People are running WebObjects on Java 21 in production.
11 +1. You have Eclipse and WOLips installed. Eclipse versions as recent as 2023-09 have been shown to be just fine, albeit with a slightly modified WOLips. Again we won't cover any of that here.
8 8  
9 -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 at .m2 folder in the user home (,,/.m2 on Unix systems and C:ocuments and Settingsserm2 on Windows). If this file doesn't exist yet, just create it.,,
13 +(% id="HSetup" class="auto-cursor-target" %)
14 += Setup =
10 10  
11 -You have to define the WOProject plug-in group and the repositories to download the plug-ins. The following snippet shows how to make this configuration:
16 +(% class="auto-cursor-target" %)
17 +You need to install Maven.
12 12  
13 -{{noformat}}
19 +(% class="auto-cursor-target" %)
20 +{{{$ cd ~/Applications
21 +$ curl -O https://dlcdn.apache.org/maven/maven-3/3.9.6/binaries/apache-maven-3.9.6-bin.zip
22 +$ unzip apache-maven-3.9.6-bin.zip
23 +$ ln -s apache-maven-3.9.6 apache-maven
24 +}}}
14 14  
15 -<settings>
16 - ...
17 - <pluginGroups>
18 - <pluginGroup>org.objectstyle.woproject.maven2</pluginGroup>
19 - </pluginGroups>
20 - ...
21 - <profiles>
22 - <profile>
23 - <pluginRepositories>
24 - <pluginRepository>
25 - <id>mdimension.releases</id>
26 - <name>MDimension Releases Repository</name>
27 - <url>
28 - http://webobjects.mdimension.com/maven2/releases
29 - </url>
30 - <releases>
31 - <enabled>true</enabled>
32 - </releases>
33 - <snapshots>
34 - <enabled>false</enabled>
35 - </snapshots>
36 - </pluginRepository>
37 - <pluginRepository>
38 - <id>mdimension.snapshots</id>
39 - <name>MDimension Snapshots Repository</name>
40 - <url>
41 - http://webobjects.mdimension.com/maven2/snapshots
42 - </url>
43 - <releases>
44 - <enabled>false</enabled>
45 - </releases>
46 - <snapshots>
47 - <enabled>true</enabled>
48 - </snapshots>
49 - </pluginRepository>
50 - <pluginRepositories>
51 - </profile>
52 - </profiles>
53 - ...
54 -</settings>
26 +Add ##bin## to your path in your shell's startup file, say ##~~/.zshrc##.
55 55  
56 -{{/noformat}}
28 +{{{PATH=$PATH:/Users/paulh/Applications/apache-maven-3.9.6/bin
29 +}}}
57 57  
58 -**NOTE**: You can download the complete settings.xml [[here>>^settings.xml]]. See [[Maven Settings Reference>>http://maven.apache.org/settings.html]] if you want more information about the settings.xml file.
31 +(% class="auto-cursor-target" %)
32 +Confirm you have it installed:
59 59  
60 -== Step 3: Installing WebObjects Libraries ==
34 +(% class="auto-cursor-target" %)
35 +{{{$ mvn --version
36 +Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
37 +}}}
61 61  
62 -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:
39 +(% class="auto-cursor-target" %)
40 +Finally, add ~~/.m2/settings.xml:
63 63  
64 -{{noformat}}
42 +(% class="auto-cursor-target" %)
43 +{{{<settings xmlns="http://maven.apache.org/POM/4.0.0"
44 + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
45 + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
46 + http://maven.apache.org/xsd/settings-1.0.0.xsd">
47 + <profiles>
48 + <profile>
49 + <id>wocommunity</id>
50 + <activation>
51 + <activeByDefault>true</activeByDefault>
52 + </activation>
53 + <repositories>
54 + <repository>
55 + <id>wocommunity</id>
56 + <url>https://maven.wocommunity.org/content/groups/public/</url>
57 + <releases>
58 + <enabled>true</enabled>
59 + </releases>
60 + <snapshots>
61 + <enabled>true</enabled>
62 + </snapshots>
63 + </repository>
64 + </repositories>
65 + <pluginRepositories>
66 + <pluginRepository>
67 + <id>wocommunity</id>
68 + <url>https://maven.wocommunity.org/content/groups/public/</url>
69 + <releases>
70 + <enabled>true</enabled>
71 + </releases>
72 + <snapshots>
73 + <enabled>false</enabled>
74 + </snapshots>
75 + </pluginRepository>
76 + </pluginRepositories>
77 + </profile>
78 + </profiles>
79 +</settings>
80 +}}}
65 65  
66 -mvn wobootstrap:install
82 +(% id="HCreateanewapplicationproject" class="auto-cursor-target" %)
83 += Create a new application project =
67 67  
68 -{{/noformat}}
85 +(% class="auto-cursor-target" %)
86 +Make a new directory somewhere, and run:
69 69  
70 -**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.
88 +{{{$ mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
89 + -DarchetypeGroupId=org.wocommunity \
90 + -DarchetypeVersion=3.0 -DaskForDefaultPropertyValues=true}}}
71 71  
72 -== Step 4: Creating a WebObjects Project ==
92 +(% class="auto-cursor-target" %)
93 +After some downloading, Maven will prompt you:
73 73  
74 -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:
95 +(% class="auto-cursor-target" %)
96 +{{{Define value for property 'JavaVersion' 1.8: : 1.8
97 +Define value for property 'WonderVersion' 7.2: : 7.4
98 +Define value for property 'groupId': example.app
99 +Define value for property 'artifactId': Foo
100 +Define value for property 'version' 1.0-SNAPSHOT: : 0.1-SNAPSHOT
101 +Define value for property 'package' example.app: : example.app.foo}}}
75 75  
76 -{{noformat}}
103 +(% class="auto-cursor-target" %)
104 +You can enter your own values if you like, but remember to stick with Java 1.8 for the moment. Hit 'Y' to confirm when requested.
77 77  
78 -mvn archetype:generate -DarchetypeArtifactId=woapplication-archetype \
79 - -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
80 - -DarchetypeVersion=2.0.14 \
81 - -DarchetypeRepository=http://webobjects.mdimension.com/maven2/releases
106 +(% id="HBuildandlaunchtheapplication" class="auto-cursor-target" %)
107 += Build and launch the application =
82 82  
83 -{{/noformat}}
109 +(% class="auto-cursor-target" %)
110 +From the same directory, run:
84 84  
85 -The maven-archetype-plugin will ask the required information to create the new project.
112 +(% class="auto-cursor-target" %)
113 +{{{$ cd Foo
114 +$ mvn package}}}
86 86  
87 -**NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype]].
116 +(% class="auto-cursor-target" %)
117 +Once Maven has finished building, you can launch:
88 88  
89 -== Step 5: Importing the Project into Eclipse ==
119 +(% class="auto-cursor-target" %)
120 +{{{$ ./target/Foo.woa/Foo}}}
90 90  
91 -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.
122 +(% class="auto-cursor-target" %)
123 +A browser should open and show:
92 92  
93 -{{note title="Warning"}}
125 +>Hello WOnder world!
94 94  
95 -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:
96 -# Use the mvn eclipse:eclipse goal to update your .classpath file.
97 -# Use the m2eclipse plug-in for Eclipse.
98 -# Use the q4e plug-in for Eclipse.
127 +(% id="HImportyourprojectintoEclipse" class="auto-cursor-target" %)
128 += Import your project into Eclipse =
99 99  
100 -{{/note}}
130 +(% class="auto-cursor-target" %)
131 +A final, optional step is to bring the project into Eclipse.
101 101  
102 -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.
133 +1. File > Import... > Maven > Existing Maven Projects
134 +1. Using the file browser, find the top-level "Foo" folder containing the project you created above, click Open.
135 +1. Ensure ##pom.xml## is checked and click Finish.
103 103  
104 -**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"]].
105 -
106 -== Step 6: Building WebObjects Applications with Maven ==
107 -
108 -Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
109 -
110 -{{noformat}}
111 -
112 -mvn clean install
113 -
114 -{{/noformat}}
115 -
116 -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.
137 +(% class="auto-cursor-target" %)
138 +You're done.
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>