Skip to Content

Wiki source code of Quick Start

Version 60.1 by Lachlan Deck on 2011/08/20 19:56
Hide last authors
Lachlan Deck 59.1 1 == Outline ==
2
Lachlan Deck 19.1 3 == Step 1: Installing Maven ==
4
Lachlan Deck 60.1 5 Downloading and installing the latest version of [[Maven>>url:http://maven.apache.org/download||shape="rect"]] is the first step to start using this tool.
Lachlan Deck 19.1 6
Lachlan Deck 59.1 7 {{tip title="Mac Tip"}}
Lachlan Deck 60.1 8 install macports [[http:~~/~~/www.macports.org/install.php>>url:http://www.macports.org/install.php||shape="rect"]], then on the terminal:
Lachlan Deck 19.1 9
Lachlan Deck 60.1 10 {{noformat}}
11
Lachlan Deck 59.1 12 sudo port install maven3
Lachlan Deck 19.1 13
Lachlan Deck 60.1 14 {{/noformat}}
15
Lachlan Deck 59.1 16 In future, to keep this up to date:
Lachlan Deck 60.1 17
18 {{noformat}}
19
Lachlan Deck 59.1 20 sudo port upgrade maven3
Lachlan Deck 19.1 21
Lachlan Deck 60.1 22 {{/noformat}}
23
Lachlan Deck 59.1 24 Don't forget to install maven_select:
Lachlan Deck 60.1 25
26 {{noformat}}
27
Lachlan Deck 59.1 28 sudo port install maven_select
Lachlan Deck 19.1 29
Lachlan Deck 60.1 30 {{/noformat}}
Lachlan Deck 59.1 31 {{/tip}}
Lachlan Deck 19.1 32
Lachlan Deck 60.1 33 **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 34
Lachlan Deck 59.1 35 == Step 2: Configuring your Maven Settings ==
Lachlan Deck 25.1 36
Lachlan Deck 59.1 37 Advanced users can skip this step, but it's highly recommended.
Lachlan Deck 25.1 38
Lachlan Deck 60.1 39 [[doc:Quick Start Maven Settings Configuration Guide]]
Lachlan Deck 59.1 40
Lachlan Deck 60.1 41 **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 42
Lachlan Deck 60.1 43 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 44
Lachlan Deck 19.1 45 == Step 3: Installing WebObjects Libraries ==
46
47 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:
48
49 {{noformat}}
50
51 mvn wobootstrap:install
52
53 {{/noformat}}
54
Lachlan Deck 59.1 55 **NOTE**: WebObjects must be installed.
Lachlan Deck 19.1 56
Lachlan Deck 60.1 57 **See** the [[maven-wobootstrap-plugin>>doc:maven-wobootstrap-plugin]] documentation for more information and options for specifying a specific version.
Lachlan Deck 19.1 58
Lachlan Deck 60.1 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.
Lachlan Deck 19.1 60
Lachlan Deck 59.1 61 {{warning title="Installing the right jars!"}}
Lachlan Deck 60.1 62 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 63 {{/warning}}
64
65 == Step 4: Creating a WebObjects or Wonder Project ==
66
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
Lachlan Deck 19.1 69 {{noformat}}
70
Lachlan Deck 59.1 71 mvn archetype:generate -DarchetypeArtifactId=erxapplication-archetype \
72 -DarchetypeGroupId=org.objectstyle.woproject.maven2 \
73 -DarchetypeVersion=2.1
Lachlan Deck 19.1 74
75 {{/noformat}}
76
77 The maven-archetype-plugin will ask the required information to create the new project.
78
Lachlan Deck 60.1 79 **NOTE**: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of [[woapplication-archetype>>doc:woapplication-archetype]].
Lachlan Deck 19.1 80
Lachlan Deck 60.1 81 **NOTE**: You can use archetypes within Eclipse as described [[here>>doc:documentation.Maven Create WO Application Project||anchor="m2eclipse"]].
Lachlan Deck 59.1 82
Lachlan Deck 60.1 83 **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 84
Lachlan Deck 19.1 85 == Step 5: Importing the Project into Eclipse ==
86
87 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.
88
89 {{note title="Warning"}}
90 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:
91
Lachlan Deck 60.1 92 1. Use the [[mvn eclipse:eclipse>>url:http://maven.apache.org/plugins/maven-eclipse-plugin/||shape="rect"]] goal to update your .classpath file.
93 1. Use the [[m2eclipse>>url:http://m2eclipse.codehaus.org/||shape="rect"]] plug-in for Eclipse.
94 1. Use the [[q4e>>url:http://code.google.com/p/q4e/||shape="rect"]] plug-in for Eclipse.
Lachlan Deck 19.1 95 {{/note}}
96
97 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.
98
Lachlan Deck 60.1 99 **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 100
101 == Step 6: Building WebObjects Applications with Maven ==
102
johnc 47.1 103 Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:
Lachlan Deck 19.1 104
105 {{noformat}}
106
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}}
116
Henrique Prange 57.1 117 mvn clean install
johnc 47.1 118
119 {{/noformat}}
120
Lachlan Deck 60.1 121 This will install your project into {{code language="none"}}~/.m2/repository/your/project/groupId/artifactId/version/...{{/code}}