Inspired by the Jetty Maven Plugin, the TomEE Maven Plugin is a feature-rich plugin that allows for:

• easy provisioning of a TomEE server
• server start and stop
• application deploy and undeploy

Simply add the following to your pom.xml

<plugin>
  <groupId>org.apache.openejb.maven</groupId>
  <artifactId>tomee-maven-plugin</artifactId>
  <version>1.0.1</version>
  <configuration>
    <tomeeVersion>1.5.0</tomeeVersion>
    <tomeeClassifier>plus</tomeeClassifier>
  </configuration>
</plugin>

The available commands can be discovered running:

mvn tomee:help

Should print output like the following:

[INFO] Available commands:
[INFO]  - tomee:run: run and wait for the server
[INFO]  - tomee:debug: run in debug mode and wait for the server (alias of run)
[INFO]  - tomee:start: run the server
[INFO]  - tomee:stop: stop the server (to use with start)
[INFO]  - tomee:configtest: run configtest tomcat command
[INFO]  - tomee:deploy <path>: deploy path archive
[INFO]  - tomee:undeploy <path>: undeploy path archive. Note it should be the same path than the one used in deploy command
[INFO]  - tomee:list: list ejbs deployed
[INFO]  - tomee:build: build tomee but does not start it
[INFO]  - tomee:help: this

Note that for the tomee:deploy and tomee:undeploy goals, the path can either be specified within the section of the pom.xml using the parameter, or it can be passed via the user property tomee-plugin.archive. If a relative path is passed for the deploy path archive, this must be relative to the TomEE server.

Available configuration elements:

Some more tweak

The lib tag allows to enrich the container with some additional librairies.

It supports some interesting pattern to complete the default maven format.

• remove:<some prefix of jar in lib folder>: remove all jar starting with the specified prefix
• unzip:<some maven zip>: extract the zip in lib folder
• ?name=<new-name>: rename the libary once copied in lib folder

Note: the name tweak can be used to rename applications too

Provisioning Example

This plugin is also usable in projects which are not war. For instance you can use it in a pom project to setup a TomEE install, add libraries, deploy apps then run the server.

  <plugin>
    <groupId>org.apache.openejb.maven</groupId>
    <artifactId>tomee-maven-plugin</artifactId>
    <version>1.0.0</version>
    <configuration>
      <tomeeVersion>1.5.0</tomeeVersion>
      <tomeeClassifier>plus</tomeeClassifier>
      <debug>false</debug>
      <debugPort>5005</debugPort>
      <args>-Dfoo=bar</args>
      <config>${project.basedir}/src/test/tomee/conf</config>
      <libs>
        <lib>mysql:mysql-connector-java:5.1.20</lib>
      </libs>
      <webapps>
         <webapp>org.superbiz:myapp:4.3?name=ROOT</webapp>
         <webapp>org.superbiz:api:1.1</webapp>
      </webapps>
      <apps>
          <app>org.superbiz:mybugapp:3.2:ear</app>
      </apps>
      <libs>
          <lib>mysql:mysql-connector-java:5.1.21</lib>
          <lib>unzip:org.superbiz:hibernate-bundle:4.1.0.Final:zip</lib>
          <lib>remove:openjpa-</lib>
      </libs>
    </configuration>
  </plugin>

Auto Reloading example

<plugin>
  <groupId>org.apache.openejb.maven</groupId>
  <artifactId>tomee-maven-plugin</artifactId>
  <version>1.0.1</version>
  <configuration>
    <synchronization>
      <extensions>
        <extension>.class</extension> <!-- if you want to update each time you build with mvn compile -->
      </extensions>
    </synchronization>
    <reloadOnUpdate>true</reloadOnUpdate>
  </configuration>
</plugin>

Synchronization block supports the following configuration:

• resourcesDir (default src/main/webapp)
• binariesDir (default target/classes)
• targetBinariesDir (default tomee/webapps/finalName/WEB-INF/classes)
• targetResourcesDir (default tomee/webapps/finalName)
• updateInterval (default 5 - in second)
• extensions (default html, xhtml, js and css)
• regex: a regex should match file to takeinto account when updating

reloadOnUpdate means to reload the context (webapp). It means undeploying/redeploying it.