Child pages
  • Maven Kicking the tyres without changing your project structure

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

The layout of the frameworks and applications might look like this:

No Format

/trunk/
/trunk/apps/
/trunk/apps/ApplicationA/
/trunk/apps/ApplicationB/
/trunk/frameworks/
/trunk/frameworks/CustomExtensions/
/trunk/frameworks/CustomBusinessLogic/
/trunk/frameworks/etc/

...

Typical things that make up a pom are as follows. (Note: only pom identification is mandatory. All the others have defaults.)

  1. pom identification (who am I?)
    The base triplet used to identify an artifact (i.e., something you need to build/package/install)

    No Format
       <artifactId>CustomExtensions</artifactId>
      <groupId>com.mywostuff.frameworks</groupId>
      <version>0.0.1-SNAPSHOT</version>
    
  2. 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)

    No Format
       <packaging>woapplication</artifactId>packaging>
    
  3. pom parent identification (who do I belong to?)

    No Format
       <parent>
        <artifactId>frameworks</artifactId>
        <groupId>com.mywostuff</groupId>
      </parent>
    
  4. modules (a.k.a kids; who belongs to me?)

    No Format
       <modules>
        <module>CustomExtensions</module>
        <module>CustomBusinessLogic</module>
      </modules>
    
  5. dependencies (what do I need?)

    No Format
       <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>
    
  6. build sources/resources (what do I have?)
  7. properties and filtering resources (variable definitions)
  8. dependency/plugin management (shared configuration and versioning)
  9. repositories (where to find dependencies and plugins)

...

In this case though, we're just trying to "kick the tyres", so we don't want to have to move our files around. The following roughly resembles the current WebObjects WOLips produced project layout (a.k.a Fluffy Bunny layout).

No Format

/MyProject
/MyProject/Components
/MyProject/Resources
/MyProject/Sources
/MyProject/Tests
/MyProject/WebServerResources

...

Code Block
xml
xml
titlepom.xml

<...>
  <build>
    <sourceDirectory>Sources</sourceDirectory>
    <testSourceDirectory>Tests</testSourceDirectory>
    <resources>
      <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>
    <...>
  </build>
<...>

...

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 WOL:Maven Model#class_dependency for specific definitions.

No Format
   <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>

...

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. Repositories are what lets you specify, "my app needs commons-logging-1.1.1" and maven can then pull it into the build as needed. Here we're adding some additional repositories to the defaults. You might want to setup one for your workgroup, and then there are some useful WO-related ones as well. We can include this in the master trunk/pom.xml file, then all the children can use it.

No Format

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

...

Here's the definition for /frameworks/pom.xml, definitions here will be shared by all of the individual framework pom.xml files. Note that it depends on the following Info.plist file being located under trunk/frameworks/src/main/resources (maven builds can use files stored in common off of a shared structure):

Attachments
uploadfalse
patternsInfo.plist

Code Block
xml
xml
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 Block
xml
xml
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 Block
xml
xml
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 Block
xml
xml
title/apps/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>
        <groupId>com</groupId>
        <artifactId>mywostuff</artifactId>
        <version>1.0-SNAPSHOT</version>
    </parent>

    <!-- artifact identity -->
    <artifactId>apps</artifactId>
    <groupId>com.mywostuff</groupId>
    <packaging>pom</packaging>

    <!-- modules -->
    <modules>
        <module>ApplicationA</module>
        <module>ApplicationB</module>
    </modules>

    <!-- specific dependencies (for modules) -->
    <dependencies>
        <!-- wonder frameworks -->
        <dependency>
            <artifactId>ERExtensions</artifactId>
            <groupId>${wonder.common.groupId}</groupId>
        </dependency>
        <dependency>
            <artifactId>JavaWOExtensions</artifactId>
            <groupId>${wonder.common.groupId}</groupId>
        </dependency>

        <!-- project libs -->
        <dependency>
            <artifactId>CustomExtensions</artifactId>
            <groupId>${my.frameworks.groupId}</groupId>
        </dependency>
        <dependency>
            <artifactId>CustomBusinessLogic</artifactId>
            <groupId>${my.frameworks.groupId}</groupId>
        </dependency>

        <!-- webobjects dependencies -->
        <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>
            <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>
                <artifactId>maven-wolifecycle-plugin</artifactId>
                <groupId>org.objectstyle.woproject.maven2</groupId>
                <version>2.0.15</version>
                <extensions>true</extensions>
                <configuration>
                    <source>${java.target}</source>
                    <target>${java.target}</target>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <configuration>
                    <javadocVersion>${java.target}</javadocVersion>
                    <locale>en-AU</locale>
                    <minmemory>128m</minmemory>
                    <maxmemory>512m</maxmemory>
                </configuration>
            </plugin>
            <!--
            TODO build numbering
            <plugin>
                <groupId>org.codehaus.mojo</groupId>
                <artifactId>maven-buildnumber-plugin</artifactId>
                <version>0.9.6</version>
                <executions>
                    <execution>
                        <phase>validate</phase>
                        <goals>
                            <goal>create</goal>
                        </goals>
                    </execution>
                </executions>
                <configuration>
                    <doCheck>true</doCheck>
                    <doUpdate>true</doUpdate>
                </configuration>
            </plugin>
            -->
        </plugins>
        <pluginManagement>
            <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>
        </pluginManagement>
    </build>
</project>

...

Code Block
xml
xml
title/apps/ApplicationA/pom.xml

<?xml version="1.0"?>
<project>
    <modelVersion>4.0.0</modelVersion>

    <!-- parent artifact -->
    <parent>
        <artifactId>apps</artifactId>
        <groupId>com.mywostuff</groupId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../apps</relativePath> <!-- e.g., (optional) if your app is under /trunk -->
    </parent>

    <!-- artifact identity -->
    <artifactId>ApplicationA</artifactId>
    <groupId>com.mywostuff.apps</groupId>
    <packaging>woapplication</packaging> <!-- woproject specific packaging -->

    <!-- specific properties -->
    <properties>
        <!-- general properties -->
        <mainclass>your.app.Application</mainclass>
    </properties>

    <!-- specific dependencies -->
    <dependencies>
        <!-- wonder frameworks -->
        <dependency>
            <artifactId>Ajax</artifactId>
            <groupId>${wonder.ajax.groupId}</groupId>
        </dependency>
        <dependency>
            <artifactId>ERCaptcha</artifactId>
            <groupId>${wonder.common.groupId}</groupId>
            <!-- requires jcaptcha-all below -->
        </dependency>
        <dependency>
            <artifactId>WOOgnl</artifactId>
            <groupId>${wonder.common.groupId}</groupId>
        </dependency>

        <!-- general libs -->
        <dependency>
            <artifactId>jcaptcha-all</artifactId>
            <groupId>com.octo.captcha</groupId>
        </dependency>
        <dependency>
            <artifactId>commons-collections</artifactId>
            <groupId>commons-collections</groupId>
        </dependency>
        <dependency>
            <groupId>ognl</groupId>
            <artifactId>ognl</artifactId>
        </dependency>
    </dependencies>
</project>

...