Eclipse Web App using Maven

Tuesday, 10 May 2011 09:23

Create a skeleton web application using Maven

Create a web app skeleton using the maven archetype plugin

mvn archetype:generate -DgroupId=ch.javatutorial.sample -DartifactId=java-webapp -DarchetypeArtifactId=maven-archetype-webapp

A project with the following project's pom.xml-file should be created:

<project>
  <modelVersion>4.0.0</modelVersion>
  <groupId>ch.javatutorial.sampl</groupId>
  <artifactId>java-webapp</artifactId>
<packaging>war</packaging>
  <version>1.0-SNAPSHOT</version>
  <dependencies>
    <dependency>
      <groupId>junit</groupId>
      <artifactId>junit</artifactId>
      <version>3.8.1</version>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <finalName>java-webapp</finalName>
  </build>
</project>

Create eclipse configuration files

 mvn -Dwtpversion=2.0 compile eclipse:eclipse

The plugin actually can create WTP R7, 1.0, 1.5 and 2.0 configuration files.

What version of Eclipse does WTP work with?

Eclipse�s �.classpath� and �.project� configuration files are created. And you will noticed a new �.setting� folder is created. Inside contains �org.eclipse.wst.common.component� and �org.eclipse.wst.common.project.facet.core.xml�, both files for WTP or Faces support in Eclipse.

The produced org.eclipse.wst.common.project.facet.core.xml should look like :

<faceted-project>
  <fixed facet="jst.java"/>
  <fixed facet="jst.web"/>
  <installed facet="jst.web" version="2.4"/>
  <installed facet="jst.java" version="1.5"/>
</faceted-project>

if you have declared a dependency to servlet-api the jst.web version will take the dependency version.
In the below example you will have a version 6.0 for your jst.web according to your dependency definition

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>servlet-api</artifactId>
    <version>6.0.32</version>
</dependency>

<project-modules id="moduleCoreId" project-version="1.5.0">
  <wb-module deploy-name="java-webapp">
    <property 
         name="context-root"    
         value="java-webapp"/>
    <wb-resource 
         deploy-path="/" 
         source-path="src/main/webapp"/>
    <property 
         name="java-output-path" 
         value="/target/classes"/>
    <wb-resource 
         deploy-path="/WEB-INF/classes" 
         source-path="src/main/resources"/>
  </wb-module>
</project-modules>

<?xml version="1.0" encoding="UTF-8"?>
<project-modules id="moduleCoreId" project-version="1.5.0">
  <wb-module deploy-name="web">
      
      <wb-resource deploy-path="/" source-path="src/main/webapp" tag="defaultRootSource"/>
    <wb-resource deploy-path="/WEB-INF/classes" source-path="src/main/java"/>
    <wb-resource deploy-path="/WEB-INF/classes" source-path="src/main/resources"/>
    
    <dependent-module archiveName="subModule.jar" deploy-path="/WEB-INF/lib" handle="module:/resource/subModule/subModule">
            <dependency-type>uses</dependency-type>
    </dependent-module>
    
    <property name="context-root" value="web"/>
    <property name="java-output-path" value="/web/target/classes"/>
  </wb-module>
</project-modules>

<?xml version="1.0" encoding="UTF-8"?>
<faceted-project>
     <runtime name="Apache Geronimo v3.0"/>
     <fixed facet="jst.web"/>
     <fixed facet="java"/>
     <fixed facet="wst.jsdt.web"/>
     <installed facet="java" version="1.6"/>
     <installed facet="jst.web" version="3.0"/>
     <installed facet="org.apache.geronimo.facet" version="1.3"/>
     <installed facet="jst.jsf" version="2.0"/>
     <installed facet="wst.jsdt.web" version="1.0"/>
</faceted-project>

<plugin> 
          <groupId>org.apache.maven.plugins</groupId> 
          <artifactId>maven-eclipse-plugin</artifactId>
          <version>2.8</version>
          <configuration>
              <projectNameTemplate>[artifactId]</projectNameTemplate>
              <wtpapplicationxml>true</wtpapplicationxml>
              <wtpversion>2.0</wtpversion>
              <downloadSources>true</downloadSources>
              <downloadJavadocs>true</downloadJavadocs>
              <useProjectReferences>true</useProjectReferences>
              <workspace>..</workspace>
              <additionalConfig>
                  <file>
                      <name>.settings/org.eclipse.wst.common.project.facet.core.xml</name>
                      <location>file:///${basedir}/src/main/config/${appserver.name}/org.eclipse.wst.common.project.facet.core.xml</location>
                  </file>
                  <file>
                      <name>.settings/org.eclipse.wst.common.component</name>
                      <location>file:///${basedir}/src/main/config/${appserver.name}/org.eclipse.wst.common.component</location>
                  </file>
              </additionalConfig>                    
          </configuration>
      </plugin>

mvn eclipse:clean eclipse:eclipse

Add comment