= TomEE Embedded Maven Plugin
:index-group: TomEE Maven Plugin
:jbake-date: 2018-12-05
:jbake-type: page
:jbake-status: published


link:tomee-maven-plugin.html[TomEE Maven Plugin] provides a nice way to
run "as in production" a server fully configured keeping the
configuration in the project (easiness of sharing between team members).
However for modern web development the fact to run the "exploded war"
prevents to develop web resources in place. TomEE embedded maven plugin
solves it directly allowing to directly deploy the war project in place
using "classpath as war" option.

It also allows to use a flat classpath deployment which is often use
with microservices.

== tomee-embedded:run

Full name:

- `org.apache.tomee.maven:tomee-embedded-maven-plugin:8.0.0-M3:run`

Description:

- Run an Embedded TomEE.

Attributes:

- Requires a Maven project to be executed.

- Requires dependency resolution of artifacts in scope: runtime+system.

- Requires dependency collection of artifacts in scope: runtime.

== Optional Parameters

[.table.table-bordered,options="header"]
|===
|Name|Type|Since|Description

|<<ajpPort, ajpPort>>

|int

|-

|(no description) +
Default value is: `8009`. +
User property is: `tomee-embedded-plugin.ajp`. +

|<<applicationCopyFolder, applicationCopyFolder>>

|File

|-

|(no description) +
Default value is: `${project.build.directory}/tomee-embedded/applications`. +
User property is: `tomee-plugin.application-copy`.

|<<applicationScopes, applicationScopes>>

|List

|-

|(no description)

|<<applications, applications>>

|List

|-

|(no description)

|<<classpathAsWar, classpathAsWar>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-embedded-plugin.classpathAsWar`.

|<<clientAuth, clientAuth>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.clientAuth`.

|<<containerProperties, containerProperties>>

|Map

|-

|(no description)

|<<context, context>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.context`.

|<<dir, dir>>

|String

|-

|(no description) +
Default value is: `${project.build.directory}/apache-tomee-embedded`. +
User property is: `tomee-embedded-plugin.lib`.

|<<docBase, docBase>>

|File

|-

|(no description) +
Default value is: `${project.basedir}/src/main/webapp`. +
User property is: `tomee-embedded-plugin.docBase`.

|<<forceJspDevelopment, forceJspDevelopment>>

|boolean

|-

|force webapp to be reloadable. +
Default value is: `true`. +
User property is: `tomee-plugin.jsp-development`.

|<<host, host>>

|String

|-

|(no description) +
Default value is: `localhost`. +
User property is: `tomee-embedded-plugin.host`.

|<<httpPort, httpPort>>

|int

|-

|(no description) +
Default value is: `8080`. +
User property is: `tomee-embedded-plugin.http`.

|<<httpsPort, httpsPort>>

|int

|-

|(no description) +
Default value is: `8443`. +
User property is: `tomee-embedded-plugin.httpsPort`.

|<<inlinedServerXml, inlinedServerXml>>

|PlexusConfiguration

|-

|(no description)

|<<inlinedTomEEXml, inlinedTomEEXml>>

|PlexusConfiguration

|-

|(no description)

|<<keepServerXmlAsThis, keepServerXmlAsThis>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-embedded-plugin.keepServerXmlAsThis`.

|<<keyAlias, keyAlias>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.keyAlias`.

|<<keystoreFile, keystoreFile>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.keystoreFile`.

|<<keystorePass, keystorePass>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.keystorePass`.

|<<keystoreType, keystoreType>>

|String

|-

|(no description) +
Default value is: `JKS`. +
User property is: `tomee-embedded-plugin.keystoreType`.

|<<mavenLog, mavenLog>>

|boolean

|-

|(no description) +
Default value is: `true`. +
User property is: `tomee-embedded-plugin.mavenLog`.

|<<modules, modules>>

|List

|-

|(no description) +
Default value is: `${project.build.outputDirectory}`. +
User property is: `tomee-embedded-plugin.modules`.

|<<packaging, packaging>>

|String

|-

|(no description) +
Default value is: `${project.packaging}`.

|<<quickSession, quickSession>>

|boolean

|-

|(no description) +
Default value is: `true`. +
User property is: `tomee-embedded-plugin.quickSession`.

|<<roles, roles>>

|Map

|-

|(no description)

|<<serverXml, serverXml>>

|File

|-

|(no description)

|<<skipCurrentProject, skipCurrentProject>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-plugin.skip-current-project`.

|<<skipHttp, skipHttp>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-embedded-plugin.skipHttp`.

|<<ssl, ssl>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-embedded-plugin.ssl`.

|<<sslProtocol, sslProtocol>>

|String

|-

|(no description) +
User property is: `tomee-embedded-plugin.sslProtocol`.

|<<stopPort, stopPort>>

|int

|-

|(no description) +
Default value is: `8005`. +
User property is: `tomee-embedded-plugin.stop`.

|<<useProjectClasspath, useProjectClasspath>>

|boolean

|-

|(no description) +
Default value is: `true`. +
User property is: `tomee-embedded-plugin.useProjectClasspath`.

|<<users, users>>

|Map

|-

|(no description)

|<<warFile, warFile>>

|File

|-

|(no description) +
Default value is: `${project.build.directory}/{project.build.finalName}`.

|<<webResourceCached, webResourceCached>>

|boolean

|-

|(no description) +
Default value is: `true`. +
User property is: `tomee-embedded-plugin.webResourceCached`.

|<<withEjbRemote, withEjbRemote>>

|boolean

|-

|(no description) +
Default value is: `false`. +
User property is: `tomee-embedded-plugin.withEjbRemote`.

|<<workDir, workDir>>

|File

|-

|(no description) +
Default value is: `${project.build.directory}/tomee-embedded-work`. +
User property is: `tomee-plugin.work`.
|===

== Parameter Details

[[ajpPort]]*ajpPort:* +
(no description)

- Type: int
- Required: No
- User Property: `tomee-embedded-plugin.ajp`
- Default: `8009`

[[applicationCopyFolder]]*applicationCopyFolder:* +
(no description)

- Type: java.io.File
- Required: No
- User Property: `tomee-plugin.application-copy`
- Default: `${project.build.directory}/tomee-embedded/applications`

[[applicationScopes]]*applicationScopes:* +
(no description)

- Type: java.util.List
- Required: No

[[applications]]*applications:* +
(no description)

- Type: java.util.List
- Required: No

[[classpathAsWar]]*classpathAsWar:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.classpathAsWar`
- Default: `false`

[[clientAuth]]*clientAuth:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.clientAuth`

[[containerProperties]]*containerProperties:* +
(no description)

- Type: java.util.Map
- Required: No

[[context]]*context:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.context`

[[dir]]*dir:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.lib`
- Default: `${project.build.directory}/apache-tomee-embedded`

[[docBase]]*docBase:* +
(no description)

- Type: java.io.File
- Required: No
- User Property: `tomee-embedded-plugin.docBase`
- Default: `${project.basedir}/src/main/webapp`

[[forceJspDevelopment]]*forceJspDevelopment:* +
force webapp to be reloadable

- Type: boolean
- Required: No
- User Property: `tomee-plugin.jsp-development`
- Default: `true`

[[host]]*host:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.host`
- Default: `localhost`

[[httpPort]]*httpPort:* +
(no description)

- Type: int
- Required: No
- User Property: `tomee-embedded-plugin.http`
- Default: `8080`

[[httpsPort]]*httpsPort:* +
(no description)

- Type: int
- Required: No
- User Property: `tomee-embedded-plugin.httpsPort`
- Default: `8443`

[[inlinedServerXml]]*inlinedServerXml:* +
(no description)

- Type: org.codehaus.plexus.configuration.PlexusConfiguration
- Required: No

[[inlinedTomEEXml]]*inlinedTomEEXml:* +
(no description)

- Type: org.codehaus.plexus.configuration.PlexusConfiguration
- Required: No

[[keepServerXmlAsThis]]*keepServerXmlAsThis:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.keepServerXmlAsThis`
- Default: `false`

[[keyAlias]]*keyAlias:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.keyAlias`

[[keystoreFile]]*keystoreFile:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.keystoreFile`

[[keystorePass]]*keystorePass:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.keystorePass`

[[keystoreType]]*keystoreType:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.keystoreType`
- Default: `JKS`

[[mavenLog]]*mavenLog:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.mavenLog`
- Default: `true`

[[modules]]*modules:* +
(no description)

- Type: java.util.List
- Required: No
- User Property: `tomee-embedded-plugin.modules`
- Default: `${project.build.outputDirectory}`

[[packaging]]*packaging:* +
(no description)

- Type: java.lang.String
- Required: No
- Default: `${project.packaging}`

[[quickSession]]*quickSession:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.quickSession`
- Default: `true`

[[roles]]*roles:* +
(no description)

- Type: java.util.Map
- Required: No

[[serverXml]]*serverXml:* +
(no description)

- Type: java.io.File
- Required: No

[[skipCurrentProject]]*skipCurrentProject:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-plugin.skip-current-project`
- Default: `false`

[[skipHttp]]*skipHttp:* +
(no description)

- Type: boolean
 -Required: No
- User Property: `tomee-embedded-plugin.skipHttp`
- Default: `false`

[[ssl]]*ssl:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.ssl`
- Default: `false`

[[sslProtocol]]*sslProtocol:* +
(no description)

- Type: java.lang.String
- Required: No
- User Property: `tomee-embedded-plugin.sslProtocol`

[[stopPort]]*stopPort:* +
(no description)

- Type: int
- Required: No
- User Property: `tomee-embedded-plugin.stop`
- Default: `8005`

[[useProjectClasspath]]*useProjectClasspath:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.useProjectClasspath`
- Default: `true`

[[users]]*users:* +
(no description)

- Type: java.util.Map
- Required: No

[[warFile]]*warFile:* +
(no description)

- Type: java.io.File
- Required: No
- Default: `${project.build.directory}/{project.build.finalName}`

[[webResourceCached]]*webResourceCached:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.webResourceCached`
- Default: `true`

[[withEjbRemote]]*withEjbRemote:* +
(no description)

- Type: boolean
- Required: No
- User Property: `tomee-embedded-plugin.withEjbRemote`
- Default: `false`

[[workDir]]*workDir:* +
(no description)

- Type: java.io.File
- Required: No
- User Property: `tomee-plugin.work`
- Default: `${project.build.directory}/tomee-embedded-work`
