Changes for page Quick Start

Summary

• Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Parent

...	...	@@ -1,0 +1,1 @@
	1	+WOL.Home.WOProject-Maven.WebHome

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.ldeck
	1	+XWiki.paulh

Content

...	...	@@ -1,142 +1,154 @@
1		-== Outline ==
	1	+(% class="auto-cursor-target" %)
	2	+You should be able to get a "Hello, World!" Wonder application running using [[Maven>>https://maven.apache.org]] in about 10 minutes.
2	2
3		-== Step 0: Install latest Java ==
	4	+(% id="HAssumptions" class="auto-cursor-target" %)
	5	+= Assumptions =
4	4
5		-If you're on a Mac, it's using old and busted Java 6. Update that to Java 8.
	7	+We're going to make a few assumptions to keep this page brief:
6	6
7		-== Step 1: Installing Maven ==
	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. Any version will do. People are running WebObjects on Java 21 in production.
	11	+1. You have Eclipse and WOLips installed. Install the [[latest version of Eclipse>>https://www.eclipse.org/downloads/packages/]], along with the [[latest WOLips>>https://github.com/wocommunity/wolips]] if you haven't already.
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 via one of the following approaches.
	13	+(% id="HSetup" class="auto-cursor-target" %)
	14	+= Setup =
10	10
11		-(a) You can use MacPorts ([[https:~~/~~/www.macports.org>>url:https://www.macports.org||shape="rect"]]) to install:
	16	+(% class="auto-cursor-target" %)
	17	+You need to install Maven:
12	12
13		-{{code title="MacPorts usage" theme="Emacs" language="bash"}}
14		-$ sudo port install maven3
15		-{{/code}}
	19	+(% class="auto-cursor-target" %)
	20	+{{{$ cd ~/Applications
	21	+$ curl -O https://dlcdn.apache.org/maven/maven-3/3.9.9/binaries/apache-maven-3.9.9-bin.zip
	22	+$ unzip apache-maven-3.9.9-bin.zip
	23	+$ ln -s apache-maven-3.9.9 apache-maven
	24	+}}}
16	16
17		-(b) Or similarly via Homebrew ([[http:~~/~~/brew.sh>>url:http://brew.sh||shape="rect"]]):
	26	+Add ##bin## to your path in your shell's startup file, say ##~~/.zshrc##:
18	18
19		-{{code title="Homebrew usage" theme="Emacs" language="bash"}}
20		-$ brew install maven
21		-{{/code}}
	28	+{{{PATH=$PATH:/Users/paulh/Applications/apache-maven-3.9.9/bin
	29	+}}}
22	22
23		-(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:
	31	+(% class="auto-cursor-target" %)
	32	+Confirm you have it installed:
24	24
25		-{{code title="Manual install" theme="Emacs" language="bash"}}
26		-$ sudo su
27		-$ cd /usr/local/
28		-$ curl -O http://mirror.tcpdiag.net/apache/maven/maven-3/3.3.3/binaries/apache-maven-3.3.3-bin.tar.gz
29		-$ tar -xzf apache-maven-3.3.3-bin.tar.gz
30		-$ ln -s apache-maven-3.3.3 apache-maven
31		-$ exit
32		-$ cd ~/
33		-$ vi .bash_profile
34		-{{/code}}
	34	+(% class="auto-cursor-target" %)
	35	+{{{$ mvn --version
	36	+Apache Maven 3.9.6 (bc0240f3c744dd6b6ec2920b3cd08dcc295161ae)
	37	+}}}
35	35
36		-Then in your bash profile, ensure your path and java home are updated:
	39	+(% class="auto-cursor-target" %)
	40	+Finally, add ##~~/.m2/settings.xml##:
37	37
38		-{{code title="~~/.bash_profile" theme="Emacs" linenumbers="true" language="text"}}
39		-...
40		-export PATH=/usr/local/apache-maven/bin:$PATH
41		-export JAVA_HOME=$(/usr/libexec/java_home)
42		-...
43		-{{/code}}
	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	+}}}
44	44
45		-
	82	+(% id="HCreateanewapplicationproject" class="auto-cursor-target" %)
	83	+= Create a new application project =
46	46
47		-Whichever installation approach you've taken, you should now be able to do
	85	+(% class="auto-cursor-target" %)
	86	+Make a new directory somewhere, and run:
48	48
49		-$ mvn -version
	88	+{{{$ mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
	89	+ -DarchetypeGroupId=org.wocommunity \
	90	+ -DarchetypeVersion=3.0 -DaskForDefaultPropertyValues=true}}}
50	50
51		-**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.
	92	+(% class="auto-cursor-target" %)
	93	+After some downloading, Maven will prompt you:
52	52
53		-**NOTE 2**: You might also like to install bash completion utilities:
	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}}}
54	54
55		-* 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"]]).
56		-* 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"]]).
57	57
58		-== Step 2: Configuring your Maven Settings ==
	104	+You can enter any version of Java. You should definitely change ##WonderVersion## from 7.2 → 7.4. Hit 'Y' to confirm when requested.
59	59
60		-Advanced users can skip this step, but it's highly recommended.
	106	+(% class="box infomessage" %)
	107	+(((
	108	+If you enter a ##JavaVersion## greater than 1.8 (there are people using Java 21 in production, for example: enter ##21##), you need to add the following line to build.properties:
	109	+\\##jvmOptions=~-~-add-exports java.base/sun.security.action=ALL-UNNAMED ~-~-add-exports java.base/sun.util.calendar=ALL-UNNAMED##
	110	+)))
61	61
62		-[[doc:Quick Start Maven Settings Configuration Guide]]
63	63
64		-**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.
	113	+(% id="HBuildandlaunchtheapplication" class="auto-cursor-target" %)
	114	+= Build and launch the application =
65	65
66		-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
	116	+(% class="auto-cursor-target" %)
	117	+From the same directory, run:
67	67
68		-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.
	119	+(% class="auto-cursor-target" %)
	120	+{{{$ cd Foo
	121	+$ mvn package}}}
69	69
70		-== Step 3: Installing WebObjects Libraries ==
	123	+(% class="auto-cursor-target" %)
	124	+Once Maven has finished building, you can launch:
71	71
72		-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:
	126	+(% class="auto-cursor-target" %)
	127	+{{{$ ./target/Foo.woa/Foo}}}
73	73
74		-{{noformat}}
75		-mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
	129	+(% class="auto-cursor-target" %)
	130	+A browser should open and show:
76	76
77		-{{/noformat}}
	132	+>Hello WOnder world!
78	78
79		-**NOTE**: WebObjects must be installed.
	134	+(% id="HImportyourprojectintoEclipse" class="auto-cursor-target" %)
	135	+= Import your project into Eclipse =
80	80
81		-**See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
	137	+(% class="auto-cursor-target" %)
	138	+A final, optional step is to bring the project into Eclipse.
82	82
83		-**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.
	140	+1. File > Import... > Maven > Existing Maven Projects
	141	+1. Using the file browser, find the top-level "Foo" folder containing the project you created above, click Open.
	142	+1. Ensure ##pom.xml## is checked and click Finish.
84	84
85		-{{warning title="Installing the right jars!"}}
86		-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.
87		-{{/warning}}
	144	+(% class="box infomessage" %)
	145	+(((
	146	+As above, if you're using Java beyond Java 8, you need to add the following to the launch configuration under Arguments > VM arguments:
	147	+\\##~-~-add-exports java.base/sun.security.action=ALL-UNNAMED ~-~-add-exports java.base/sun.util.calendar=ALL-UNNAMED##
	148	+)))
88	88
89		-== Step 4: Creating a WebObjects or Wonder Project ==
90	90
91		-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:
92	92
93		-{{noformat}}
94		-mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
95		- -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
96		- -DarchetypeVersion=2.1
97	97
98		-{{/noformat}}
99		-
100		-The maven-archetype-plugin will ask the required information to create the new project.
101		-
102		-**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]].
103		-
104		-**NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
105		-
106		-**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"]].
107		-
108		-== Step 5: Importing the Project into Eclipse ==
109		-
110		-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.
111		-
112		-{{note title="Warning"}}
113		-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:
114		-
115		-1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
116		-1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
117		-1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
118		-{{/note}}
119		-
120		-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.
121		-
122		-**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"]].
123		-
124		-== Step 6: Building WebObjects Applications with Maven ==
125		-
126		-Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
127		-
128		-{{noformat}}
129		-mvn clean package
130		-
131		-{{/noformat}}
132		-
133		-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.
134		-
135		-To install your project into your local repository:
136		-
137		-{{noformat}}
138		-mvn clean install
139		-
140		-{{/noformat}}
141		-
142		-This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}
	153	+(% class="auto-cursor-target" %)
	154	+You're done.