Ear Building in Maven

[Kris Massey]

Hey guys...Ive been trying to figure this out for a couple of hours now and just cant see the issue...

Below Ive added 5 pom.xml files that Ive fog...one Java Module, one EJB module, one Web module, One Enterprise Module and the master pom

Java Module

<project>
  <modelVersion>4.0.0</modelVersion>
  <!-- 1. Specify group ID, artifact ID and version for child project. -->
  <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
  <artifactId>module1</artifactId>
  <version>1.0</version>
  <!-- 2. Specify the type of the project: "jar", "war", "ear", "ejb", "ejb3", "rar", "par", "pom", "maven-plugin" -->

  <packaging>jar</packaging>

  <!-- 3. Specify parameters and the location of the parent project. -->
  <parent>
    <groupId>myMultiProjectGroupId</groupId>
    <artifactId>myMultiProjectArtifactId</artifactId>
    <version>myMultiProjectVersion</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <!-- 4. Dependencies on another libraries, projects etc. -->
  <dependencies>
  </dependencies>

  <!-- 5. Specify the content of generated artifact. -->
  <build>
    <!-- 5.1. Specify the final name of the artifact. -->
    <finalName>module1</finalName>
    <defaultGoal>package</defaultGoal>
    <!-- 5.2. Specify the location of sources (for non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/java -->
    <sourceDirectory>../src/java</sourceDirectory>
    <!-- 5.3. Specify the location of the filter file (if filtering is used). -->
    <!-- 5.4. Specify the location of resources (for non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/resources -->
    <resources>
      <resource>
        <directory>../src/resources</directory>
        <filtering>true</filtering>
        <excludes>
          <exclude>*web*.xml</exclude>
        </excludes>
      </resource>
    </resources>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>

          <!-- 5.5. Specify used Java version. -->
          <source>1.5</source>
          <target>1.5</target>

          <!-- 5.6. Specify files to include. -->
          <includes>
            <include>**/com/**</include>
          </includes>

          <!-- 5.7. Specify files to exclude (if required). -->
          <excludes>
            <exclude>com/sun/**/*.java</exclude>
          </excludes>
        </configuration>
      </plugin>
    </plugins>
  </build>

</project>

EJB Module

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
  <artifactId>ejbModule</artifactId>
  <packaging>ejb</packaging>
  <version>1.0</version>
  <name>myEJBModule1</name>
  <url>http://maven.apache.org</url>

  <!-- 2. Reference to parent project. -->
    <parent>
    <groupId>myMultiProjectGroupId</groupId>
    <artifactId>myMultiProjectArtifactId</artifactId>
    <version>myMultiProjectVersion</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <!-- 3. Dependencies on another libraries, projects etc. -->
  <dependencies>
    <!-- 3.1. Specify dependencies on external libraries. -->
    <!-- 3.2. Specify dependencies on EJB libraries. -->


    <!-- 3.3. Specify dependencies on internal libraries. -->
    <dependency>
      <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
      <artifactId>module1</artifactId>
      <version>1.0</version>

      <!-- 3.3.1. This library is required at runtime. -->
      <scope>runtime</scope>
    </dependency>
  </dependencies>

  <!-- 4. Specify the content of generated artifact. -->
  <build>

    <!-- 4.1. Specify the final name of the artifact. -->
    <finalName>ejbModule</finalName>

    <defaultGoal>package</defaultGoal>

    <!-- 4.2. Specify the location of sources (if you have non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/java -->
    <sourceDirectory>../../src/java</sourceDirectory>

    <!-- 4.3. We don't want to filter for this module: "filters" section is empty. -->

    <!-- 4.4. Specify the location of resources (for non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/resources -->
    <resources>
      <resource>
        <directory>../src/java/META-INF</directory>
        <targetPath>META-INF</targetPath>
        <filtering>false</filtering>
        <excludes>
          <exclude>*application*.xml</exclude>
        </excludes>
      </resource>
    </resources>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <!-- 4.5. Specify used Java version. -->
          <source>1.5</source>
          <target>1.5</target>

          <!-- 4.6. Specify files to include. -->
          <includes>
            <include>**/ejb/**</include>
          </includes>

          <!-- 4.7. Nothing to exclude. -->
        </configuration>
      </plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-ejb-plugin</artifactId>
<configuration>
<ejbVersion>3.0</ejbVersion>
</configuration>
</plugin>


    </plugins>

  </build>

</project>

Web Module

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
  <artifactId>myWebApplicationModule1</artifactId>
  <packaging>war</packaging>
  <version>1.0</version>
  <name>myWebApplicationModule1 Maven Webapp</name>
  <url>http://maven.apache.org</url>

<parent>
    <groupId>myMultiProjectGroupId</groupId>
    <artifactId>myMultiProjectArtifactId</artifactId>
    <version>myMultiProjectVersion</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <!-- 3. Dependencies on another libraries, projects etc. -->
  <dependencies>
    <!-- 3.1. Specify dependencies on external libraries. -->

    <!-- 3.2. Specify dependency on servlet API library. -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>servlet-api</artifactId>
      <version>2.4</version>

      <!-- 3.2.1. This library is provided by Web Container. -->
      <scope>provided</scope>
    </dependency>

    <!-- 3.3. Specify dependency on JSP API library (if required). -->
    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>jsp-api</artifactId>
      <version>2.0</version>

      <!-- 3.3.1. This library is provided by WEB Container. -->
      <scope>provided</scope>
    </dependency>

    <!-- 3.4. Specify dependency on other web libraries: tags, struts, tiles etc... (if required). -->

    <!-- 3.5. Specify dependency on database driver -->

    <!-- 3.6. Specify dependencies on EJB libraries (if required). -->

    <!-- 3.7. Specify dependencies on internal libraries. -->
    <dependency>
      <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
      <artifactId>module1</artifactId>
      <version>1.0</version>

      <!-- 3.7.1. This library is required at runtime. -->
      <scope>runtime</scope>
    </dependency>

    <dependency>
      <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
      <artifactId>ejbModule</artifactId>
      <version>1.0</version>

      <!-- 3.7.2. This library is required at runtime. -->
      <scope>runtime</scope>
    </dependency>

  </dependencies>

  <!-- 4. Specify the content of generated artifact. -->
  <build>

    <!-- 4.1. Specify the final name of the artifact. -->
    <finalName>webModule</finalName>

    <defaultGoal>package</defaultGoal>

    <!-- 4.2. Specify the location of sources (if you have non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/java -->
    <sourceDirectory>../src/java</sourceDirectory>

    <!-- 4.3. We don't want to filter for this module: "filters" section is empty. -->

    <!-- 4.4. Specify the location of resources (for non-standard location). -->
    <!-- Defailt is: ${basedir}/src/main/resources -->
    <resources>
      <resource>
        <directory>../src/config</directory>
        <filtering>false</filtering>
        <includes>
          <include>*.properties</include>
        </includes>
      </resource>

      <resource>
        <directory>../src/resources</directory>
        <filtering>false</filtering>
      </resource>
    </resources>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <!-- 4.5. Specify used Java version. -->
          <source>1.5</source>
          <target>1.5</target>

          <!-- 4.6. Specify files to include. -->
          <includes>
          </includes>

          <!-- 4.7. Specify files to exclude (if required). -->
          <excludes>
          </excludes>
        </configuration>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-war-plugin</artifactId>
        <configuration>
          <!-- 4.8. Specify the location of Web Application directory (if non-standard). -->
          <!-- Defailt is: ${basedir}/src/main/webapp -->
          <warSourceDirectory>../src/web</warSourceDirectory>
        </configuration>
      </plugin>
    </plugins>
  </build>

</project>

Enterprise module

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
  <artifactId>myEnterpriseApplicationModule</artifactId>
  <packaging>ear</packaging>
  <version>1.0</version>
  <name>enterpriceModule</name>
  <url>http://maven.apache.org</url>

  <parent>
    <groupId>myMultiProjectGroupId</groupId>
    <artifactId>myMultiProjectArtifactId</artifactId>
    <version>myMultiProjectVersion</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <!-- 3. Dependencies on another modules within the multi-module project. -->
  <dependencies>
    <!-- 3.1. Dependency on Java Module. -->
    <dependency>
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>module1</artifactId>
    	<version>1.0</version>
	<type>jar</type>
    </dependency>
      

      <!-- 3.2. We need to include this module into application.xml; required by EJB module. -->
      <!-- 3.3. Dependency on EJB Module. -->
	<dependency>
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>ejbModule</artifactId>
    	<version>1.0</version>
	<type>ejb</type>
    </dependency>

    <dependency>
      <!-- 3.4. Dependency on Web Application Module. -->
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>webModule</artifactId>
    	<version>1.0</version>
      <type>war</type>
    </dependency>
  </dependencies>

  <!-- 4. Specify the content of generated artifact. -->
  <build>

    <!-- 4.1. Specify the final name of the artifact. -->
    <finalName>myEnterpriseApplicationModuleFinalName</finalName>

    <defaultGoal>package</defaultGoal>

    <!-- 4.2. We don't want to filter for this module: "filters" section is empty. -->

    <!-- 4.3. Specify the location of resources (for non-standard location). -->
    <!-- Defailt is: ${project.build.outputDirectory} -->
    <!-- The file: application.xml will be automatically generated. -->
    <resources>
      <resource>
        <directory>../src/java/META-INF</directory>
        <targetPath>META-INF</targetPath>
        <filtering>false</filtering>
        <includes>
          <include>weblogic-application.xml</include>
        </includes>
      </resource>
    </resources>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>

        <!-- 4.4. Specify used Java version. -->
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-ear-plugin</artifactId>
        <configuration>
	<generateApplicationXml>true</generateApplicationXml>
          <!-- 4.5. Specify modules to include. -->
          <modules>

            <!-- 4.5.1. Include Java Module. -->
            <javaModule>
              <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
              <artifactId>module1</artifactId>
              <artifactId>1.0</artifactId>

              <!-- 4.5.1.1. Only if you want different file name inside "ear" file. -->
              <bundleFileName>myBundleJavaModule1FileName</bundleFileName>
            </javaModule>

            <!-- 4.5.2. Include EJB Module. -->
            <ejbModule>
              <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
              <artifactId>ejbModule</artifactId>
              <artifactId>1.0</artifactId>
            </ejbModule>

            <!-- 4.5.3. Include Web Application Module. -->
            <webModule>
              <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
              <artifactId>webModule1</artifactId>
              <artifactId>1.0</artifactId>

              <!-- 4.5.3.2. Specify the context root if you need different name. -->
              <!-- Default is: "/${pom.artifactId} -->
              <contextRoot>iris</contextRoot>
            </webModule>

            <!-- 4.5.4. Maven will also treat dependent 3-rd-party libraries as modules.
                        You have to exclude them or redirect to "APP-INF/lib" directory. -->
            <javaModule>
              <groupId>antlr</groupId>
              <artifactId>antlr</artifactId>
              <bundleDir>APP-INF/lib</bundleDir>
            </javaModule>

          </modules>
        </configuration>
      </plugin>

    </plugins>
  </build>
</project>

Master Pom

<project>
  <modelVersion>4.0.0</modelVersion>

  <!-- 1. Specify group ID, artifact ID and version for the parent project. -->
  <groupId>myMultiProjectGroupId</groupId>
  <artifactId>myMultiProjectArtifactId</artifactId>
  <version>myMultiProjectVersion</version>

  <!-- 2. Specify "pom" type. This type indicates that this project is parent multi-project. -->
  <packaging>pom</packaging>

  <!-- 3. List all children projects names (name is directory name as well). -->
  <modules>
    <module>myJavaModule1</module>
    <module>myEJBModule1</module>
    <module>myWebApplicationModule1</module>
    <module>myEnterpriseApplicationModule</module>
  </modules>
<build>
    <defaultGoal>package</defaultGoal>
   
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <!-- 3. Specify used Java version. -->
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>

    </plugins>
  </build>
</project>

When I try and package everything the Java, EJB and Web modules work fine...however the Enterprise module fails with the error below

[INFO] Scanning for projects...
[INFO] ------------------------------------------------------------------------
[INFO] Building enterpriceModule
[INFO]    task-segment: [package]
[INFO] ------------------------------------------------------------------------
[INFO] [ear:generate-application-xml]
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Artifact[jar:myMultiProjectGroupId.myMultiProjectArtifactId:1.0] is not a dependency of the project.
[INFO] ------------------------------------------------------------------------
[INFO] For more information, run Maven with the -e switch
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 1 second
[INFO] Finished at: Thu Mar 26 15:52:50 GMT 2009
[INFO] Final Memory: 4M/8M
[INFO] ------------------------------------------------------------------------

My file structure is
myMultiProjectArtifactId
--myJavaModule1
--myEJBModule1
--myWebApplicationModule1
--myEnterpriseApplicationModule


Im sure the problem is fairly simple but this is the first time Ive tried using maven this way and really am stumped..any help would be great!

Cheers
Kris

[Martijn Verburg]

Very quick response here (I'm running out the door), I think it's because you haven't declared the dependencies in the POM for your EAR.

[Kris Massey]

and thats where you lose me! do you mean like this?

<dependency>
    	<groupId>myMultiProjectGroupId</groupId>
    	<artifactId>myMultiProjectArtifactId</artifactId>
    	<version>1.0</version>
	<type>pom</type>
    </dependency>

Im sure you know what if I add it throws an error about a missing artifact...

[Martijn Verburg]

OK, Looking at it a little more in detail this morning (warning no coffee yet!), I see that you have in your EAR pom items like:

# <!-- 4.5.1. Include Java Module. -->
# <javaModule>
# <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
# <artifactId>module1</artifactId>
# <artifactId>1.0</artifactId>
#
# <!-- 4.5.1.1. Only if you want different file name inside "ear" file. -->
# <bundleFileName>myBundleJavaModule1FileName</bundleFileName>
# </javaModule>

I assume you're using Maven 2.0.10 or 2.1.0?

* Having <artifactId> twice seems wrong to me, but I wouldn't use javaModule in the first place (see next point)
* Using javaModule is deprecated, use jarModule instead, e.g.:

<jarModule>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <bundleDir>lib</bundleDir>
    <includeInApplicationXml>true</includeInApplicationXml>
</jarModule>

The dependency is then listed as:

<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-web</artifactId>
    <version>2.5.4</version>
    <scope>provided</scope>
</dependency>

[Kris Massey]

Thanks for the help...

I managed to get it all working this morning after tinkering with a few things, all the changes were in the ejbModule pom file which Ive added incase anyone gets the same problem and comes across this.

<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/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
  <artifactId>myEnterpriseApplicationModule</artifactId>
  <packaging>ear</packaging>
  <version>1.0</version>
  <name>enterpriceModule</name>
  <url>http://maven.apache.org</url>

  <parent>
    <groupId>myMultiProjectGroupId</groupId>
    <artifactId>myMultiProjectArtifactId</artifactId>
    <version>myMultiProjectVersion</version>
    <relativePath>../pom.xml</relativePath>
  </parent>

  <!-- 3. Dependencies on another modules within the multi-module project. -->
  <dependencies>
    <!-- 3.1. Dependency on Java Module. -->
    <dependency>
    	<groupId>org.antlr</groupId>
    	<artifactId>antlr</artifactId>
    	<version>3.1.3</version>
	<type>jar</type>
	<scope>provided</scope>
    </dependency>

    <!-- 3.1. Dependency on Java Module. -->
    <dependency>
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>module1</artifactId>
    	<version>1.0</version>
	<type>pom</type>
    </dependency>
      

      <!-- 3.2. We need to include this module into application.xml; required by EJB module. -->
      <!-- 3.3. Dependency on EJB Module. -->
	<dependency>
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>ejbModule</artifactId>
    	<version>1.0</version>
	<type>ejb</type>
    </dependency>

    <dependency>
      <!-- 3.4. Dependency on Web Application Module. -->
    	<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
    	<artifactId>webModule</artifactId>
    	<version>1.0</version>
      <type>war</type>
    </dependency>
  </dependencies>

  <!-- 4. Specify the content of generated artifact. -->
  <build>

    <!-- 4.1. Specify the final name of the artifact. -->
    <finalName>myEnterpriseApplicationModuleFinalName</finalName>

    <defaultGoal>package</defaultGoal>

    <!-- 4.2. We don't want to filter for this module: "filters" section is empty. -->

    <!-- 4.3. Specify the location of resources (for non-standard location). -->
    <!-- Defailt is: ${project.build.outputDirectory} -->
    <!-- The file: application.xml will be automatically generated. -->
    <resources>
      <resource>
        <directory>../src/java/META-INF</directory>
        <targetPath>META-INF</targetPath>
        <filtering>false</filtering>
        <includes>
          <include>weblogic-application.xml</include>
        </includes>
      </resource>
    </resources>

    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>

        <!-- 4.4. Specify used Java version. -->
        <configuration>
          <source>1.5</source>
          <target>1.5</target>
        </configuration>
      </plugin>

      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-ear-plugin</artifactId>
        <configuration>
	<generateApplicationXml>true</generateApplicationXml>
          <!-- 4.5. Specify modules to include. -->
          <modules>

            <!-- 4.5.1. Include Java Module. -->
            <jarModule>
              <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
              <artifactId>module1</artifactId>
              <bundleDir>lib</bundleDir>  

              <!-- 4.5.1.1. Only if you want different file name inside "ear" file. -->
              <bundleFileName>myBundleJavaModule1FileName</bundleFileName>
            </jarModule>

            <!-- 4.5.2. Include EJB Module. -->
            <ejbModule>
              <groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
              <artifactId>ejbModule</artifactId>
            </ejbModule>

            <!-- 4.5.3. Include Web Application Module. -->
            <webModule>
<groupId>myMultiProjectGroupId.myMultiProjectArtifactId</groupId>
<artifactId>webModule</artifactId>
<contextRoot>/webapp</contextRoot>

              <!-- 4.5.3.2. Specify the context root if you need different name. -->
              <!-- Default is: "/${pom.artifactId} -->
            </webModule>

            <!-- 4.5.4. Maven will also treat dependent 3-rd-party libraries as modules.
                        You have to exclude them or redirect to "APP-INF/lib" directory. -->
            <javaModule>
              <groupId>antlr</groupId>
              <artifactId>antlr</artifactId>
              <bundleDir>APP-INF/lib</bundleDir>
            </javaModule>

          </modules>
        </configuration>
      </plugin>

    </plugins>
  </build>
</project>

One quick question is about the dependecy below Ive had to add

<dependency>
    	<groupId>org.antlr</groupId>
    	<artifactId>antlr</artifactId>
    	<version>3.1.3</version>
	<type>jar</type>
	<scope>provided</scope>
    </dependency>

Could you give me a brief guide as to why this is needed?

[Martijn Verburg]

I'm not sure why you need that dependency, what complains when you don't have it?

[Kris Massey]

[ERROR] BUILD FAILURE
[INFO] ------------------------------------------------------------------------
[INFO] Artifact[jar:antlr:antlr] is not a dependency of the project.

is the error I get, I googled it an everyone says just add it as provded inthe scope and everything works...seems a but of a bodge to me and I would like to know why its needed

[Martijn Verburg]

Hmm, I'm afraid I can't easily tell you why, I certainly don't include it for my Maven EAR builds!