Skip to Content

Wiki source code of Quick Start

Version 66.1 by Ramsey Gurley on 2015/05/01 21:00
Hide last authors
Ramsey Gurley 66.1 1 == Outline ==
Lachlan Deck 59.1 2
Ramsey Gurley 66.1 3 == Step 0: Install latest Java ==
Lachlan Deck 19.1 4
Ramsey Gurley 66.1 5 If you're on a Mac, it's using old and busted Java 6. Update that to Java 8.
Lachlan Deck 19.1 6
Ramsey Gurley 63.1 7 == Step 1: Installing Maven ==
Lachlan Deck 19.1 8
Ramsey Gurley 66.1 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:
Lachlan Deck 19.1 10
Ramsey Gurley 66.1 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
Ramsey Gurley 63.1 20 {{/code}}
Lachlan Deck 60.1 21
Ramsey Gurley 66.1 22 Then in your bash profile, make your path look something like:
Lachlan Deck 60.1 23
Ramsey Gurley 66.1 24 export PATH=/usr/local/apache-maven/bin:$PATH
Lachlan Deck 19.1 25
Ramsey Gurley 66.1 26 And tell maven where your non-mac Java home is located
Lachlan Deck 60.1 27
Ramsey Gurley 63.1 28 export JAVA_HOME=$(/usr/libexec/java_home)
Lachlan Deck 60.1 29
Ramsey Gurley 66.1 30 You should now be able to do
Lachlan Deck 19.1 31
Ramsey Gurley 66.1 32 mvn -version
Lachlan Deck 19.1 33
Ramsey Gurley 66.1 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.
Lachlan Deck 19.1 35
Lachlan Deck 59.1 36 == Step 2: Configuring your Maven Settings ==
Lachlan Deck 25.1 37
Lachlan Deck 59.1 38 Advanced users can skip this step, but it's highly recommended.
Lachlan Deck 25.1 39
Lachlan Deck 60.1 40 [[doc:Quick Start Maven Settings Configuration Guide]]
Lachlan Deck 59.1 41
Lachlan Deck 60.1 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.
Lachlan Deck 59.1 43
Lachlan Deck 64.1 44 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
45
Lachlan Deck 60.1 46 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.
Lachlan Deck 59.1 47
Lachlan Deck 19.1 48 == Step 3: Installing WebObjects Libraries ==
49
Ramsey Gurley 62.1 50 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:
Lachlan Deck 19.1 51
52 {{noformat}}
Ramsey Gurley 62.1 53 mvn wobootstrap:install -DwebObjectsLibFolder=/Library/WebObjects/lib -DwebObjectsVersion=5.4.3
Lachlan Deck 19.1 54
55 {{/noformat}}
56
Lachlan Deck 59.1 57 **NOTE**: WebObjects must be installed.
Lachlan Deck 19.1 58
Ramsey Gurley 61.1 59 **See** the [[doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
Lachlan Deck 19.1 60
Lachlan Deck 60.1 61 **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.
Lachlan Deck 19.1 62
Lachlan Deck 59.1 63 {{warning title="Installing the right jars!"}}
Lachlan Deck 60.1 64 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.
Lachlan Deck 59.1 65 {{/warning}}
66
67 == Step 4: Creating a WebObjects or Wonder Project ==
68
69 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:
70
Lachlan Deck 19.1 71 {{noformat}}
Lachlan Deck 59.1 72 mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
73 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
74 -DarchetypeVersion=2.1
Lachlan Deck 19.1 75
76 {{/noformat}}
77
78 The maven-archetype-plugin will ask the required information to create the new project.
79
Ramsey Gurley 61.1 80 **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]].
Lachlan Deck 19.1 81
Lachlan Deck 60.1 82 **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
Lachlan Deck 59.1 83
Ramsey Gurley 61.1 84 **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"]].
Lachlan Deck 59.1 85
Lachlan Deck 19.1 86 == Step 5: Importing the Project into Eclipse ==
87
88 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.
89
90 {{note title="Warning"}}
91 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:
92
Lachlan Deck 60.1 93 1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
94 1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
95 1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
Lachlan Deck 19.1 96 {{/note}}
97
98 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.
99
Lachlan Deck 60.1 100 **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"]].
Lachlan Deck 19.1 101
102 == Step 6: Building WebObjects Applications with Maven ==
103
johnc 47.1 104 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
Lachlan Deck 19.1 105
106 {{noformat}}
Lachlan Deck 59.1 107 mvn clean package
108
109 {{/noformat}}
110
111 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.
112
113 To install your project into your local repository:
114
115 {{noformat}}
Henrique Prange 57.1 116 mvn clean install
johnc 47.1 117
118 {{/noformat}}
119
Lachlan Deck 60.1 120 This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}