Plugin Documentation

Goals available for this plugin:

Goal Description
tomee:build Create a TomEE instance respecting all the provided configuration but doesn't run it.
tomee:configtest valid Tomcat config.
tomee:deploy Deploy an application.
tomee:help Print help.
tomee:list List deployed EJBs.
tomee:run Start and wait (ctrl+x).
tomee:start Start in background TomEE.
tomee:stop Stop TomEE (for start command).
tomee:undeploy Undeploy an application.

Usage

You should specify the version in your project's plugin configuration:

  <project>
    ...
    <build>
      <!-- To define the plugin version in your parent POM -->
      <pluginManagement>
        <plugins>
          <plugin>
            <groupId>org.apache.openejb.maven</groupId>
            <artifactId>tomee-maven-plugin</artifactId>
            <version>1.0.0.xa</version>
          </plugin>
          ...
        </plugins>
      </pluginManagement>
      <!-- To use the plugin goals in your POM or parent POM -->
      <plugins>
        <plugin>
          <groupId>org.apache.openejb.maven</groupId>
          <artifactId>tomee-maven-plugin</artifactId>
          <version>1.0.0.xa</version>
        </plugin>
        ...
      </plugins>
    </build>
    ...
  </project>
Note: run, build, start, stop, configtest commands basically share the same config. Both deploy and undeploy commands shares the same configuration too.

tomee:run

Full name:

org.apache.openejb.maven:tomee-maven-plugin:1.0.0-SNAPSHOT:run

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope:runtime.

Optional Parameters

Name Type Since Description
apacheRepos String - (no description)
Default value is:snapshots.
User property is:tomee-plugin.apache-repos.
appDir String - relative to tomee.base.
Default value is:apps.
apps List - (no description)
args String - (no description)
User property is:tomee-plugin.args.
bin File - (no description)
Default value is:${project.basedir}/src/main/tomee/bin.
User property is:tomee-plugin.bin.
config File - (no description)
Default value is:${project.basedir}/src/main/tomee/conf.
User property is:tomee-plugin.conf.
debug boolean - (no description)
Default value is:false.
User property is:tomee-plugin.debug.
debugPort int - (no description)
Default value is:5005.
User property is:tomee-plugin.debugPort.
lib File - (no description)
Default value is:${project.basedir}/src/main/tomee/lib.
User property is:tomee-plugin.lib.
libDir String - relative to tomee.base.
Default value is:lib.
libs List - supported formats: --> groupId:artifactId:version... --> unzip:groupId:artifactId:version... --> remove:prefix (often prefix = artifactId)
packaging String - (no description)
User property is:project.packaging.
password String - (no description)
User property is:tomee-plugin.pwd.
realm String - (no description)
User property is:tomee-plugin.realm.
removeDefaultWebapps boolean - (no description)
Default value is:true.
User property is:tomee-plugin.remove-default-webapps.
skipCurrentProject boolean - (no description)
Default value is:false.
User property is:tomee-plugin.skipCurrentProject.
systemVariables Map - (no description)
tomeeArtifactId String - (no description)
Default value is:apache-tomee.
User property is:tomee-plugin.artifactId.
tomeeClassifier String - (no description)
Default value is:webprofile.
User property is:tomee-plugin.classifier.
tomeeGroupId String - (no description)
Default value is:org.apache.openejb.
User property is:tomee-plugin.groupId.
tomeeHost String - (no description)
Default value is:localhost.
User property is:tomee-plugin.host.
tomeeHttpPort int - (no description)
Default value is:8080.
User property is:tomee-plugin.http.
tomeeShutdownPort int - (no description)
Default value is:8005.
User property is:tomee-plugin.shutdown.
tomeeVersion String - (no description)
Default value is:1.1.0-SNAPSHOT.
User property is:tomee-plugin.version.
user String - (no description)
User property is:tomee-plugin.user.
webappDir String - relative to tomee.base.
Default value is:webapps.
webapps List - (no description)

Parameter Details

apacheRepos:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.apache-repos
  • Default: snapshots

appDir:

relative to tomee.base.
  • Type: java.lang.String
  • Required: No
  • Default: apps

apps:

(no description)
  • Type: java.util.List
  • Required: No

args:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.args

bin:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: tomee-plugin.bin
  • Default: ${project.basedir}/src/main/tomee/bin

config:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: tomee-plugin.conf
  • Default: ${project.basedir}/src/main/tomee/conf

debug:

(no description)
  • Type: boolean
  • Required: No
  • User Property: tomee-plugin.debug
  • Default: false

debugPort:

(no description)
  • Type: int
  • Required: No
  • User Property: tomee-plugin.debugPort
  • Default: 5005

lib:

(no description)
  • Type: java.io.File
  • Required: No
  • User Property: tomee-plugin.lib
  • Default: ${project.basedir}/src/main/tomee/lib

libDir:

relative to tomee.base.
  • Type: java.lang.String
  • Required: No
  • Default: lib

libs:

supported formats: --> groupId:artifactId:version... --> unzip:groupId:artifactId:version... --> remove:prefix (often prefix = artifactId)
  • Type: java.util.List
  • Required: No

packaging:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: project.packaging

password:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.pwd

realm:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.realm

removeDefaultWebapps:

(no description)
  • Type: boolean
  • Required: No
  • User Property: tomee-plugin.remove-default-webapps
  • Default: true

skipCurrentProject:

(no description)
  • Type: boolean
  • Required: No
  • User Property: tomee-plugin.skipCurrentProject
  • Default: false

systemVariables:

(no description)
  • Type: java.util.Map
  • Required: No

tomeeArtifactId:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.artifactId
  • Default: apache-tomee

tomeeClassifier:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.classifier
  • Default: webprofile

tomeeGroupId:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.groupId
  • Default: org.apache.openejb

tomeeHost:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.host
  • Default: localhost

tomeeHttpPort:

(no description)
  • Type: int
  • Required: No
  • User Property: tomee-plugin.http
  • Default: 8080

tomeeShutdownPort:

(no description)
  • Type: int
  • Required: No
  • User Property: tomee-plugin.shutdown
  • Default: 8005

tomeeVersion:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.version
  • Default: 1.1.0-SNAPSHOT

user:

(no description)
  • Type: java.lang.String
  • Required: No
  • User Property: tomee-plugin.user

webappDir:

relative to tomee.base.
  • Type: java.lang.String
  • Required: No
  • Default: webapps

webapps:

(no description)
  • Type: java.util.List
  • Required: No

tomee:deploy

Full name:

org.apache.openejb.maven:tomee-maven-plugin:1.0.0-SNAPSHOT:deploy

Description:

(no description)

Attributes:

Required Parameters

Name Type Since Description
path String - (no description)
User property is:tomee-plugin.archive.

Optional Parameters

Name Type Since Description
password String - (no description)
User property is:tomee-plugin.pwd.
realm String - (no description)
User property is:tomee-plugin.realm.
systemVariables Map - (no description)
tomeeHost String - (no description)
Default value is:localhost.
User property is:tomee-plugin.host.
tomeeHttpPort int - (no description)
Default value is:8080.
User property is:tomee-plugin.http.
user String - (no description)
User property is:tomee-plugin.user.

Parameter Details

password:

(no description)

path:

(no description)

realm:

(no description)

systemVariables:

(no description)

tomeeHost:

(no description)

tomeeHttpPort:

(no description)

user:

(no description)

tomee:list

Full name:

org.apache.openejb.maven:tomee-maven-plugin:1.0.0-SNAPSHOT:list

Description:

highly inspired from openejb command helper but with some different data.

Attributes:

Optional Parameters

Name Type Since Description
password String - (no description)
User property is:tomee-plugin.pwd.
realm String - (no description)
User property is:tomee-plugin.realm.
tomeeHost String - (no description)
Default value is:localhost.
User property is:tomee-plugin.host.
tomeeHttpPort int - (no description)
Default value is:8080.
User property is:tomee-plugin.http.
user String - (no description)
User property is:tomee-plugin.user.

Parameter Details

password:

(no description)

realm:

(no description)

tomeeHost:

(no description)

tomeeHttpPort:

(no description)

user:

(no description)