Changes for page Maven Kicking the tyres without changing your project structure

Last modified by Henrique Prange on 2015/09/11 17:57

From 14.1 to 15.1 From 22.1 to 23.1

From version 15.1

edited by Lachlan Deck
on 2008/06/15 04:51

Change comment: Fleshing it out some more. Still a work in progress.

To version 22.1

edited by Lachlan Deck
on 2008/06/24 00:39

Change comment: Add tip to hang in there with longish guide.

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -1,50 +1,118 @@
--So you're interested in //kicking the maven tyres//, so to speak, or just want to see what it's all about. The following provides hints on how to try maven with your current WebObjects projects without having to adopt a different file structure. Whilst this is not the recommended approach for the long term it allows you to try things out side-by-side with your current build system.
++So you're interested in //kicking the maven tyres//, so to speak, or just want to see what it's all about. The following provides hints on how to try maven with your current WebObjects projects, if say you're using the standard WOLips ant builds, without having to adopt a different file structure. Whilst this is not the recommended approach for the long term it allows you to try things out side-by-side with your current build system.
  {{info title="Recommended Homework (or pre-requisites)"}}
--It's really worth doing your homework on maven in order to understand it. The place to start is Learning Maven found at http://maven.apache.org. Various guides are also found at http://maven.apache.org/guides/.
++It's _really_ worth doing your homework on maven in order to understand it. The place to start is Learning Maven found at [http://maven.apache.org]. Various guides are also found at [http://maven.apache.org/guides/].
  At the very least you want to have read through, and understood, the [Getting Started Tutorial|http://maven.apache.org/guides/getting-started/index.html].
--The mailing list is also very helpful for getting help. See [Getting Help|http://maven.apache.org/users/getting-help.html].
++The maven user mailing list is also recommended for getting help. It's quite active and, as you find for the WebObjects mailing lists, is an invaluable resource. See [Getting Help|http://maven.apache.org/users/getting-help.html].
  {{/info}}
--=== Defining the Car - what's the aim ===
++{{tip title="Hang in there"}}
--This might be stating the obvious, but an OO developer will, in the course of time (or is //supposed// to anyway), build up various encapsulated, //reusable//, libraries or frameworks that can be tapped into for differing projects. So let's assume we have multiple frameworks and applications in our build. Each of these has some common ground, such as their dependencies on certain WebObjects frameworks, and of course they each may have something distinctive about them.
++This particular guide might look long but some of the xml is duplicated a few times to show differing examples.
--So the car, i.e., the layout of the frameworks and applications, might look like this:
++{{/tip}}
++=== What's the aim ===
++
++This might be stating the obvious, but an OO developer will, in the course of time (or is //supposed// to anyway), build up various encapsulated, //reusable//, libraries or frameworks that can be tapped into for differing projects. So let's assume we have multiple frameworks and applications in our build. Each of these has some common ground, such as their dependencies on certain WebObjects frameworks, or the file layout, and of course they each may have something distinctive about them.
++
++The layout of the frameworks and applications might look like this:
++
  {{noformat}}
--/
--/apps/
--/apps/ApplicationA/
--/apps/ApplicationB/
--/frameworks/
--/frameworks/CustomExtensions/
--/frameworks/CustomBusinessLogic/
--/frameworks/etc/
++/trunk/
++/trunk/apps/
++/trunk/apps/ApplicationA/
++/trunk/apps/ApplicationB/
++/trunk/frameworks/
++/trunk/frameworks/CustomExtensions/
++/trunk/frameworks/CustomBusinessLogic/
++/trunk/frameworks/etc/
  {{/noformat}}
--Our aim is to put as much configuration that's shared between all frameworks, for example, into /frameworks/pom.xml as possible so we only have to define it once. The configuration is inherited by a child pom.
++Our aim is twofold:
++1. put as much configuration as possible that's shared between all frameworks, for example, into /frameworks/pom.xml so we only have to define it once. The configuration is inherited by a child pom.
++1. Be able to issue a single command that will package each and every framework and application.
++
  === Key Concepts ===
--Typical things that make up a pom...
++Typical things that make up a pom are as follows. (Note: only pom identification is mandatory. All the others have defaults.)
--1. pom parent identification (who do I belong to?)
 . pom identification (who am I?)
++The base triplet used to identify an artifact (i.e., product)
++
++{{noformat}}
++
++  <artifactId>CustomExtensions</artifactId>
++  <groupId>com.mywostuff.frameworks</groupId>
++  <version>0.0.1-SNAPSHOT</version>
++
++{{/noformat}}
++
++1. pom packaging (i.e., what are we building?)
++The default value for the packaging element is JAR if not specified. For the purposes of this exercise, we'll use JAR for the frameworks and woapplication for the applications, which requires the woproject maven plugin (TODO revisit this scenario with the apple maven plugin)
++
++{{noformat}}
++
++  <packaging>woapplication</artifactId>
++
++{{/noformat}}
++
++1. pom parent identification (who do I belong to?)
++
++{{noformat}}
++
++  <parent>
++    <artifactId>frameworks</artifactId>
++    <groupId>com.mywostuff</groupId>
++  </parent>
++
++{{/noformat}}
++
 . modules (a.k.a kids; who belongs to me?)
++
++{{noformat}}
++
++  <modules>
++    <module>CustomExtensions</module>
++    <module>CustomBusinessLogic</module>
++  </modules>
++
++{{/noformat}}
++
 . dependencies (what do I need?)
++
++{{noformat}}
++
++  <dependencies>
++    <dependency>
++      <groupId>log4j</groupId>
++      <artifactId>log4j</artifactId>
++      <version>1.2.12</version>
++      <scope>compile</scope>
++    </dependency>
++    <dependency>
++      <groupId>junit</groupId>
++      <artifactId>junit</artifactId>
++      <version>4.4</version>
++      <scope>test</scope>
++    </dependency>
++  </dependencies>
++
++{{/noformat}}
++
 . build sources/resources (what do I have?)
 . properties and filtering resources (variable definitions)
 . dependency/plugin management (shared configuration and versioning)
 . repositories (where to find dependencies and plugins)
--Of course, with the plethora of plugins available for maven, this is only the tip of the iceberg but these main concepts will suffice for now.
++Of course, with the plethora of plugins available for maven, this is only the tip of the iceberg. However, these main concepts will suffice for now.
  === Alternate File System Layout Concepts ===
@@ -104,20 +104,297 @@
  === Project Dependencies Concepts ===
--Most projects, of course, have dependencies on other libraries or frameworks.
++Most projects, of course, have dependencies on other libraries or frameworks. See the [[Maven Getting Started#How//do//I//use//external//dependencies//>>http://maven.apache.org/guides/getting-started/index.html#How_do_I_use_external_dependencies]].
--=== Project Dependencies Prerequisites ===
++The following shows the mixture of third party dependencies and custom framework dependencies. Notice that the scope element determines the life cycle phase each dependency is relevant for. See [[Maven Model#class//dependency//>>http://maven.apache.org/ref/2.0.9/maven-model/maven.html#class_dependency]] for specific definitions.
--details to come...
++{{noformat}}
++  <dependencies>
++    <dependency>
++      <artifactId>CustomExtensions</artifactId>
++      <groupId>com.mywostuff.frameworks</groupId>
++      <version>0.0.1-SNAPSHOT</version>
++      <scope>compile</scope>
++    </dependency>
++    <dependency>
++      <groupId>log4j</groupId>
++      <artifactId>log4j</artifactId>
++      <version>1.2.12</version>
++      <scope>compile</scope>
++    </dependency>
++    <dependency>
++      <groupId>junit</groupId>
++      <artifactId>junit</artifactId>
++      <version>4.4</version>
++      <scope>test</scope>
++    </dependency>
++  </dependencies>
++
++{{/noformat}}
++
++=== Repositories ===
++
++So far we have assumed that maven just knows where to find third party libraries. There is the default local repository (e.g., ,,/.m2/repository) and a remote one at ibiblio.org or a mirror of the same. See [[http://maven.apache.org/guides/introduction/introduction-to-repositories.html]].,,
++
++{{noformat}}
++
++<repositories>
++    <repository>
++        <id>system-repo</id>
++        <name>internal repository</name>
++        <!-- TODO switch over to your intranet.domain -->
++        <url>file://${user.home}/.myarchiva</url>
++        <snapshots>
++            <enabled>true</enabled>
++            <updatePolicy>always</updatePolicy>
++            <checksumPolicy>ignore</checksumPolicy>
++        </snapshots>
++        <releases>
++            <enabled>true</enabled>
++            <updatePolicy>always</updatePolicy>
++            <checksumPolicy>ignore</checksumPolicy>
++        </releases>
++    </repository>
++    <repository>
++        <id>maven2-repository.dev.java.net</id>
++        <name>Java.net Repository for Maven</name>
++        <url>http://download.java.net/maven/2</url>
++        <snapshots>
++            <enabled>true</enabled>
++            <updatePolicy>daily</updatePolicy>
++        </snapshots>
++        <releases>
++            <enabled>true</enabled>
++            <updatePolicy>daily</updatePolicy>
++        </releases>
++    </repository>
++    <repository>
++        <id>webobjects.mdimension.com/releases</id>
++        <name>mdimension maven 2 releases repo</name>
++        <url>http://webobjects.mdimension.com/maven2/releases</url>
++        <snapshots>
++            <enabled>false</enabled>
++        </snapshots>
++        <releases>
++            <enabled>true</enabled>
++        </releases>
++    </repository>
++    <repository>
++        <id>webobjects.mdimension.com/snapshots</id>
++        <name>mdimension maven 2 snapshots repo</name>
++        <url>http://webobjects.mdimension.com/maven2/snapshots</url>
++        <snapshots>
++            <enabled>true</enabled>
++        </snapshots>
++        <releases>
++            <enabled>false</enabled>
++        </releases>
++    </repository>
++    <repository>
++        <id>objectstyle-maven2</id>
++        <name>objectstyle maven2 repo</name>
++        <url>http://objectstyle.org/maven2</url>
++        <snapshots>
++            <enabled>false</enabled>
++        </snapshots>
++        <releases>
++            <enabled>true</enabled>
++        </releases>
++    </repository>
++</repositories>
++
++{{/noformat}}
++
++Note: A remote repository is not guaranteed to keep older versions of libraries, for example, indefinitely. It's recommended that you set up one for your intranet which stores what you need for longevity. See both the above intro to repositories and [[http://www.theserverside.com/tt/articles/article.tss?l=SettingUpMavenRepository]].
++
  === Packaging Frameworks as Jars ===
--details to come...
++Here's the definition for /frameworks/pom.xml.
++{{code title="/frameworks/pom.xml"}}
++
++<?xml version="1.0" encoding="UTF-8"?>
++<project xmlns="http://maven.apache.org/POM/4.0.0"
++    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
++    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
++    http://maven.apache.org/xsd/maven-4.0.0.xsd">
++
++    <modelVersion>4.0.0</modelVersion>
++
++    <!-- parent artifact -->
++    <parent>
++        <artifactId>mywostuff</artifactId>
++        <groupId>com</groupId>
++        <version>1.0-SNAPSHOT</version>
++    </parent>
++
++    <!-- artifact identity -->
++    <artifactId>frameworks</artifactId>
++    <groupId>com.mywostuff</groupId>
++    <packaging>pom</packaging>
++
++    <!-- framework relevant properties -->
++    <properties>
++        <!-- NS related properties fills in Info.plist etc-->
++        <CFBundleDevelopmentRegion>English</CFBundleDevelopmentRegion>
++        <CFBundleGetInfoString></CFBundleGetInfoString>
++        <CFBundlePackageType>FMWK</CFBundlePackageType>
++        <CFBundleIconFile>WOAfile.icns</CFBundleIconFile>
++        <CFBundleInfoDictionaryVersion>6.0</CFBundleInfoDictionaryVersion>
++        <CFBundleVersion>5.3.1</CFBundleVersion>
++        <Has_WOComponents>true</Has_WOComponents>
++        <NSPrincipalClass>${mainclass}</NSPrincipalClass>
++        <NSResourcesBundlePath></NSResourcesBundlePath>
++    </properties>
++
++    <!-- modules -->
++    <modules>
++        <module>CustomExtensions</module>
++        <module>CustomBusinessLogic</module>
++    </modules>
++
++    <!-- specific dependencies (for modules) -->
++    <dependencies>
++        <dependency>
++            <artifactId>ERExtensions</artifactId>
++            <groupId>${wonder.common.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaWOExtensions</artifactId>
++            <groupId>${wonder.common.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaFoundation</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaJDBCAdaptor</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaWebObjects</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaEOControl</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaEOAccess</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaWebObjects</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++        <dependency>
++            <artifactId>JavaXML</artifactId>
++            <groupId>${webobjects.groupId}</groupId>
++        </dependency>
++    </dependencies>
++
++
++    <!-- build config (for modules) -->
++    <build>
++        <sourceDirectory>src</sourceDirectory>
++        <testSourceDirectory>tests</testSourceDirectory>
++        <resources>
++            <!-- relative dir for Info.plist -->
++            <resource>
++                <targetPath>Resources</targetPath>
++                <filtering>true</filtering>
++                <directory>../src/main/resources</directory>
++            </resource>
++            <resource>
++                <targetPath>Resources</targetPath>
++                <filtering>false</filtering>
++                <directory>Components</directory>
++            </resource>
++            <resource>
++                <targetPath>Resources</targetPath>
++                <filtering>false</filtering>
++                <directory>Resources</directory>
++            </resource>
++            <resource>
++                <targetPath>WebServerResources</targetPath>
++                <filtering>false</filtering>
++                <directory>WebServerResources</directory>
++            </resource>
++        </resources>
++        <plugins>
++            <plugin>
++                <groupId>org.apache.maven.plugins</groupId>
++                <artifactId>maven-compiler-plugin</artifactId>
++                <configuration>
++                    <source>${java.target}</source>
++                    <target>${java.target}</target>
++                </configuration>
++            </plugin>
++        </plugins>
++    </build>
++</project>
++
++{{/code}}
++
++and CustomExtensions which has no further dependencies
++
++{{code title="/frameworks/CustomBusinessLogic/pom.xml"}}
++
++<?xml version="1.0"?>
++<project>
++    <!-- parent artifact -->
++    <parent>
++        <artifactId>frameworks</artifactId>
++        <groupId>com.mywostuff</groupId>
++        <version>1.0-SNAPSHOT</version>
++    </parent>
++
++    <!-- artifact identity -->
++    <artifactId>CustomBusinessLogic</artifactId>
++    <groupId>com.mywostuff.frameworks</groupId>
++</project>
++
++{{/code}}
++
++and CustomBusinessLogic (which has a further dependency on CustomExtensions)
++
++{{code title="/frameworks/CustomBusinessLogic/pom.xml"}}
++
++<?xml version="1.0"?>
++<project>
++    <!-- parent artifact -->
++    <parent>
++        <artifactId>frameworks</artifactId>
++        <groupId>com.mywostuff</groupId>
++        <version>1.0-SNAPSHOT</version>
++    </parent>
++
++    <!-- artifact identity -->
++    <artifactId>CustomBusinessLogic</artifactId>
++    <groupId>com.mywostuff.frameworks</groupId>
++
++    <!-- specific dependencies -->
++    <dependencies>
++        <dependency>
++            <artifactId>CustomExtensions</artifactId>
++            <groupId>${pom.groupId}</groupId>
++        </dependency>
++    </dependencies>
++</project>
++
++{{/code}}
++
  === Packaging Applications ===
  details to come...
++=== Packaging Applications as True WAR ===
++
++You can find steps to package WO Applications as True WAR [[here>>Packaging WO Applications as true WAR with Maven]].
++
++more details to come...
++
  === Project Inheritance ===
  details to come...

Changes for page Maven Kicking the tyres without changing your project structure

Summary

Details

Applications

Navigation

My Recent Modifications

Need help?