Pre-compile JSPs from a Maven Overlay

Maven WAR Overlays are wonderful things, allowing for manipulation of a WAR artifact published by someone else into what you need for your application.

Pre-compiling JSPs (JSPC) is great when you don't want users to potentially be hit with the wait for your container to compile the JSP on first visit.

Here is how to put the two together:
<br /><dependencies><br /> <!-- ===== Compile Time Dependencies ============================== --><br /> <dependency><br /> <groupid>org.jasig.portlet</groupid><br /> <artifactid>WeatherPortlet</artifactid><br /> <version>${WeatherPortlet.version}</version><br /> <type>war</type><br /> </dependency><br /> <br /> <!-- Needed for JSPC --><br /> <dependency><br /> <groupid>javax.portlet</groupid><br /> <artifactid>portlet-api</artifactid><br /> <scope>provided</scope><br /> </dependency><br /> <dependency><br /> <groupid>org.apache.pluto</groupid><br /> <artifactid>pluto-taglib</artifactid><br /> <scope>provided</scope><br /> </dependency><br /></dependencies><br /><br /><build><br /> <plugins><br /> <plugin><br /> <groupid>org.apache.maven.plugins</groupid><br /> <artifactid>maven-war-plugin</artifactid><br /> <version>2.0.2</version> <!-- The 2.1-beta-1 plugin doesn't work due to http://jira.codehaus.org/browse/MWAR-158 --><br /> <executions><br /> <execution><br /> <id>build-directory-tree</id><br /> <phase>process-resources</phase><br /> <goals><br /> <goal>exploded</goal><br /> </goals><br /> <configuration><br /> <overlays><br /> <overlay><br /> <groupid>org.jasig.portlet</groupid><br /> <artifactid>WeatherPortlet</artifactid><br /> <includes><br /> <include>**</include><br /> <include>META-INF/context.xml</include><br /> </includes><br /> </overlay><br /> </overlays><br /> </configuration><br /> </execution><br /> <execution><br /> <id>build-war</id><br /> <phase>package</phase><br /> <goals><br /> <goal>war</goal><br /> </goals><br /> <configuration><br /> <webxml>${project.basedir}/target/jspweb.xml</webxml><br /> </configuration><br /> </execution><br /> </executions><br /> </plugin><br /> <plugin><br /> <groupid>org.codehaus.mojo.jspc</groupid><br /> <artifactid>jspc-maven-plugin</artifactid><br /> <version>2.0-alpha-3</version><br /> <executions><br /> <execution><br /> <goals><br /> <goal>compile</goal><br /> </goals><br /> </execution><br /> </executions><br /> <configuration><br /> <inputwebxml>${project.basedir}/target/${project.artifactId}/WEB-INF/web.xml</inputwebxml><br /> <sources><br /> <directory>${project.basedir}/target/${project.artifactId}</directory><br /> <includes><br /> <include>**/*.jsp</include><br /> </includes><br /> </sources><br /> </configuration><br /> <br /> <dependencies><br /> <dependency><br /> <groupid>org.codehaus.mojo.jspc</groupid><br /> <artifactid>jspc-compiler-tomcat6</artifactid><br /> <version>2.0-alpha-3</version><br /> </dependency><br /> </dependencies><br /> </plugin><br /> </plugins><br /></build><br />

In the above example the following things are happening:

1. The org.jasig.portlet:WeatherPortlet WAR artifact is declared as a dependency. This is the WAR that will have its JSPs compiled.
2. Due to operation ordering the maven-war-plugin is split into two executions.
   
1. First the build-directory-tree execution extracts the overlay WAR during Maven's process-resources phase. This ensures the WAR contents are in place before JSPC runs.
2. Second the build-war execution re-packages the WAR using the JSPC generated XML file as the web.xml included in the WAR.
   
3. The JSPC plugin is configured to look in the target directory for the web.xml to modify and the JSPs to compile.