Jump to: navigation, search

Jetty/Feature/Jetty Jspc Maven Plugin

Jetty Jspc Maven Plugin

Warning2.png
Some or all of this content remains to be ported to Jetty 9 Documentation.
If you are interested in migrating this content see our contribution guide or contact us.


This plugin will help you pre-compile your jsps and works in conjunction with the maven war plugin to put them inside an assembled war.


Configuration

Here's the basic setup required to put the jspc plugin into your build:

<plugin>
  <groupId>org.mortbay.jetty</groupId>
   <artifactId>jetty-jspc-maven-plugin</artifactId>
   <version>7.0.0</version>
   <executions>
     <execution>
       <id>jspc</id>
       <goals>
         <goal>jspc</goal>
       </goals>
       <configuration>
       </configuration>
     </execution>
   </executions>
 </plugin>

Configurable Parameters

The configurable parameters are as follows:

Parameter Name Default Value Meaning
webXmlFragment "${basedir}/target/webfrag.xml" File into which to generate the servlet declarations. Will be merged with an existing web.xml.
packageRoot "jsp" Default root package name for all generated classes.
webAppSourceDirectory "${basedir}/src/main/webapp" Root of resources directory where jsps, tags etc are located.
webXml "${basedir}/src/main/webapp/WEB-INF/web.xml" The web.xml file to use to merge with the generated fragments.
includes "**\/*.jsp, **\/*.jspx" The comma separated list of patterns for file extensions to be processed.
excludes "**\/.svn\/**" The comma separated list of patterns for file extensions to be skipped.
classesDirectory "${project.build.outputDirectory}" Location of classes for the webapp.
generatedClasses "${project.build.outputDirectory}" Location to put the generated classes for the jsps.
keepSources false Controls whether or not .java files generated during compilation will be preserved.
validateXml false If true, validates tlds when parsing.
suppressSmap true Whether or not to generate JSR45 compliant debug info.
ignoreJspFragmentErrors false Whether or not to ignore precompilation errors caused by jsp fragments.
schemaResourcePrefix Allows a prefix to be appended to the standard schema locations so that they can be loaded from elsewhere.
insertionMarker A marker string in the src web.xml file which indicates where to merge in the generated web.xml fragment. Note that the marker string will NOT be preserved during the insertion. Can be left blank, in which case the generated fragment is inserted just before the line containing </web-app>.
verbose false Whether or not to output more verbose messages during compilation.
mergeFragment true Whether or not to merge the generated fragment file with the source web.xml. The merged file will go into the same directory as the webXmlFragment.

Taking all the default settings, here's how to configure the war plugin to use the generated web.xml that includes all of the jsp servlet declarations:

<plugin>
  <groupId>org.apache.maven.plugins</groupId>
  <artifactId>maven-war-plugin</artifactId>
  <configuration>
    <webXml>${basedir}/target/web.xml</webXml>
  </configuration>
</plugin>

Precompiling only for Production Build

As compiling jsps is usually done during preparation for a production release and not usually done during development, it is more convenient to put the plugin setup inside a <profile> which which can be deliberately invoked during prep for production.

For example, the following profile will only be invoked if the flag -Dprod is present on the run line:

<profiles>
    <profile>
      <id>prod</id>
      <activation>
        <property><name>prod</name></property>
      </activation>
      <build>
      <plugins>
        <plugin>
          <groupId>org.mortbay.jetty</groupId>
          <artifactId>jetty-jspc-maven-plugin</artifactId>
          <version>7.0.0</version>
          <!-- put your configuration in here -->
        </plugin>
        <plugin>
          <groupId>org.apache.maven.plugins</groupId>
          <artifactId>maven-war-plugin</artifactId>
          <!-- put your configuration in here -->
        </plugin>
      </plugins>
      </build>
    </profile>
  </profiles>

So, the following invocation would cause your code to be compiled, the jsps to be compiled, the <servlet> and <servlet-mapping>s inserted in the web.xml and your webapp assembled into a war:

mvn -Dprod package

Precompiling Jsps with Overlaid Wars

Precompiling jsps with an overlaid war requires a bit more configuration. This is because you need to separate the steps of unpacking the overlaid war and then repacking the final target war so the jetty-jspc-maven-plugin has the opportunity to access the overlaid resources.

In the example we'll show, we will use an overlaid war. The overlaid war will provide the web.xml file but the jsps will be in src/main/webapp (ie part of the project that uses the overlay). We will unpack the overlaid war file, compile the jsps and merge their servlet definitions into the extracted web.xml, then war up the lot.

Here's an example configuration of the war plugin that separate those phases into an unpack phase, and then a packing phase:

<plugin>
    <artifactId>maven-war-plugin</artifactId>
    <executions>
      <execution>
        <id>unpack</id>
        <goals><goal>exploded</goal></goals>
        <phase>generate-resources</phase>
        <configuration>
          <webappDirectory>target/foo</webappDirectory>
          <overlays>
            <overlay />
            <overlay>
              <groupId>org.eclipse.jetty</groupId>
              <artifactId>test-jetty-webapp</artifactId>
            </overlay>
          </overlays>
        </configuration>
      </execution>
      <execution>
        <id>pack</id>
        <goals><goal>war</goal></goals>
        <phase>package</phase>
        <configuration>
          <warSourceDirectory>target/foo</warSourceDirectory>
          <webXml>target/web.xml</webXml>
        </configuration>
      </execution>
    </executions>
</plugin>


Now you also need to configure the jetty-jspc-maven-plugin so that it can use the web.xml that was extracted by the war unpacking and merge in the generated definitions of the servlets. This is in target/foo/WEB-INF/web.xml. Using the default settings, the web.xml merged with the jsp servlet definitions will be put into target/web.xml.


<plugin>
    <groupId>org.mortbay.jetty</groupId>
     <artifactId>jetty-jspc-maven-plugin</artifactId>
     <version>${project.version}</version>
     <executions>
       <execution>
         <id>jspc</id>
         <goals>
           <goal>jspc</goal>
         </goals>
         <configuration>
            <webXml>target/foo/WEB-INF/web.xml</webXml>
            <includes>**/*.foo</includes>
            <excludes>**/*.fff</excludes>
        </configuration>
      </execution>
    </executions>
</plugin>