Quick Start

Version 61.1 by Ramsey Gurley on 2015/04/30 21:05

Warning: For security reasons, the document is displayed in restricted mode as it is not the current version. There may be differences and errors due to this.

Outline

Step 1: Installing Maven

Downloading and installing the latest version of Maven is the first step to start using this tool.

Mac Tip

install macports http://www.macports.org/install.php, then on the terminal:

Unknown macro: noformat. Click on this message for details.

In future, to keep this up to date:

Unknown macro: noformat. Click on this message for details.

Don't forget to install maven_select:

Unknown macro: noformat. Click on this message for details.

NOTE: It is very helpful if you understand some Maven concepts before continuing with this tutorial. See General Maven Documentation for more information.

Step 2: Configuring your Maven Settings

Advanced users can skip this step, but it's highly recommended.

Quick Start Maven Settings Configuration Guide

NOTE for those who know what to do: You can download the complete and most recent settings.xml here and install it to ~/.m2/settings.xml.

See Maven Settings Reference if you want more information about additional options for the settings.xml file.

Step 3: Installing WebObjects Libraries

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:

Unknown macro: noformat. Click on this message for details.

NOTE: WebObjects must be installed.

See the maven-wobootstrap-plugin documentation for more information and options for specifying a specific version.

See Maven Introduction to Repositories if you want more information about Maven repositories.

Installing the right jars!

Do not link to or install the WebObjects jars located inside /System/Library/Frameworks or /Library/Frameworks. If you're installing an older version of WebObjects you must obtain the jars that the WebObjects installer had previously installed into /Library/WebObjects/lib. For example, the jar /Library/WebObjects/lib/JavaWebObjects.jar has the complete set of resources and files included for the dependency JavaWebObjects whereas /System/Library/Frameworks/JavaWebObjects.framework/Resources/Java/javawebobjects.jar does not.

Step 4: Creating a WebObjects or Wonder Project

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:

Unknown macro: noformat. Click on this message for details.

The maven-archetype-plugin will ask the required information to create the new project.

NOTE: You can use archetype catalogs to reduce the number of properties to set while creating a project. See the documentation of woapplication-archetype.

NOTE: You can use archetypes within Eclipse as described here.

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/.

Step 5: Importing the Project into Eclipse

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.

Warning

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:

Use the mvn eclipse:eclipse goal to update your .classpath file.
Use the m2eclipse plug-in for Eclipse.
Use the q4e plug-in for Eclipse.

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.

NOTE: This tutorial assumes you have chosen the option 2. You can find more information about IDE integration here.

Step 6: Building WebObjects Applications with Maven

Now, building your project with Maven is easy. Go to the project folder on Terminal and execute:

Unknown macro: noformat. Click on this message for details.

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.

To install your project into your local repository:

Unknown macro: noformat. Click on this message for details.

This will install your project into ~/.m2/repository/your/project/groupId/artifactId/version/...