tomcat6:run-war

Full name:

org.apache.tomcat.maven:tomcat6-maven-plugin:2.1:run-war

Description:

Runs the current project as a packaged web application using an embedded Tomcat server.

Attributes:

  • Requires a Maven project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Required Parameters

Name Type Since Description
path String - The webapp context path to use for the web application being run. This must always start with a forward-slash ('/').
Default value is: /${project.artifactId}.
User property is: maven.tomcat.path.
pluginArtifacts List 1.0 (no description)
Default value is: ${plugin.artifacts}.
warDirectory File - The path of the exploded WAR directory to run.
Default value is: ${project.build.directory}/${project.build.finalName}.

Optional Parameters

Name Type Since Description
addContextWarDependencies boolean 1.0 Deprecated. use webapps instead
Default value is: false.
User property is: maven.tomcat.addContextWarDependencies.
additionalConfigFilesDir File 1.0-alpha-2 The directory contains additional configuration Files that copied in the Tomcat conf Directory.
Default value is: ${basedir}/src/main/tomcatconf.
User property is: maven.tomcat.additionalConfigFilesDir.
ajpPort int 2.0 The AJP port to run the Tomcat server on. By default it's 0 this means won't be started. The ajp connector will be started only for value > 0.
Default value is: 0.
User property is: maven.tomcat.ajp.port.
ajpProtocol String 2.0 The AJP protocol to run the Tomcat server on. By default it's ajp. NOTE The ajp connector will be started only if ajpPort > 0.
Default value is: ajp.
User property is: maven.tomcat.ajp.protocol.
aliases String[] 2.1 configure aliases see Host Name aliases
backgroundProcessorDelay int - represents the delay in seconds between each classPathScanning change invocation
Default value is: -1.
User property is: maven.tomcat.backgroundProcessorDelay.
classLoaderClass String 2.0 Class loader class to set.
configurationDir File - The directory to create the Tomcat server configuration under.
Default value is: ${project.build.directory}/tomcat.
contextFile File - The path of the Tomcat context XML file.
Default value is: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml.
contextReloadable boolean 2.0 Force context scanning if you don't use a context file with reloadable = "true". The other way to use contextReloadable is to add attribute reloadable = "true" in your context file.
Default value is: false.
User property is: maven.tomcat.contextReloadable.
fork boolean 1.0 Set this to true to allow Maven to continue to execute after invoking the run goal.
Default value is: false.
User property is: maven.tomcat.fork.
hostName String 2.1 configure host name
Default value is: localhost.
User property is: maven.tomcat.hostName.
httpsPort int 1.0 The https port to run the Tomcat server on. By default it's 0 this means won't be started. The https connector will be started only for value > 0.
Default value is: 0.
User property is: maven.tomcat.httpsPort.
ignorePackaging boolean 1.0 If set to true ignore if packaging of project is not 'war'.
Default value is: false.
User property is: tomcat.ignorePackaging.
keystoreFile String 1.1 Override the default keystoreFile for the HTTPS connector (if enabled)
keystorePass String 1.1 Override the default keystorePass for the HTTPS connector (if enabled)
keystoreType String 2.0 Override the type of keystore file to be used for the server certificate. If not specified, the default value is "JKS".
Default value is: JKS.
managerWarPath File 2.0 to install a manager in your embeded tomcat
port int - The port to run the Tomcat server on.
Default value is: 8080.
User property is: maven.tomcat.port.
protocol String 2.0 The protocol to run the Tomcat server on. By default it's HTTP/1.1.
Default value is: HTTP/1.1.
User property is: maven.tomcat.protocol.
serverXml File 1.0-alpha-2 server.xml to use Note if you use this you must configure in this file your webapp paths.
User property is: maven.tomcat.serverXml.
skip boolean 2.0 Skip execution
Default value is: false.
User property is: maven.tomcat.skip.
staticContextDocbase String 2.0 The static context docroot base fully qualified path. if null static context won't be added
User property is: maven.tomcat.staticContextDocbase.
staticContextPath String 2.0 The static context
Default value is: /.
User property is: maven.tomcat.staticContextPath.
systemProperties Map 1.0-alpha-2 List of System properties to pass to the Tomcat Server.
tomcatUsers File - The path of the Tomcat users XML file.
User property is: maven.tomcat.tomcatUsers.file.
tomcatWebXml File 1.0-alpha-2 overriding the providing web.xml to run tomcat This override the global Tomcat web.xml located in $CATALINA_HOME/conf/
User property is: maven.tomcat.webXml.
uriEncoding String 1.0 The character encoding to use for decoding URIs.
Default value is: ISO-8859-1.
User property is: maven.tomcat.uriEncoding.
useNaming boolean 2.0

Enables or disables naming support for the embedded Tomcat server. By default the embedded Tomcat in Tomcat 6 comes with naming enabled. In contrast to this the embedded Tomcat 7 comes with naming disabled by default.

Note: This setting is ignored if you provide a server.xml for your Tomcat. Instead please configure naming in the server.xml.


Default value is: true.
User property is: maven.tomcat.useNaming.
useSeparateTomcatClassLoader boolean 1.0 if true a new classLoader separated from maven core will be created to start tomcat.
Default value is: false.
User property is: tomcat.useSeparateTomcatClassLoader.
webapps List 2.0 (no description)

Parameter Details

addContextWarDependencies:

Deprecated. use webapps instead
Will create a tomcat context for each dependencies of war type with 'scope' set to 'tomcat'. In other words, dependencies with: 
   <type>war</type>
   <scope>tomcat</scope>
To preserve backward compatibility it's false by default.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.tomcat.addContextWarDependencies
  • Default: false

additionalConfigFilesDir:

The directory contains additional configuration Files that copied in the Tomcat conf Directory.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: maven.tomcat.additionalConfigFilesDir
  • Default: ${basedir}/src/main/tomcatconf

ajpPort:

The AJP port to run the Tomcat server on. By default it's 0 this means won't be started. The ajp connector will be started only for value > 0.
  • Type: int
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.ajp.port
  • Default: 0

ajpProtocol:

The AJP protocol to run the Tomcat server on. By default it's ajp. NOTE The ajp connector will be started only if ajpPort > 0.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.ajp.protocol
  • Default: ajp

aliases:

configure aliases see Host Name aliases
  • Type: java.lang.String[]
  • Since: 2.1
  • Required: No

backgroundProcessorDelay:

represents the delay in seconds between each classPathScanning change invocation
  • Type: int
  • Required: No
  • User Property: maven.tomcat.backgroundProcessorDelay
  • Default: -1

classLoaderClass:

Class loader class to set.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No

configurationDir:

The directory to create the Tomcat server configuration under.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/tomcat

contextFile:

The path of the Tomcat context XML file.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml

contextReloadable:

Force context scanning if you don't use a context file with reloadable = "true". The other way to use contextReloadable is to add attribute reloadable = "true" in your context file.
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.contextReloadable
  • Default: false

fork:

Set this to true to allow Maven to continue to execute after invoking the run goal.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: maven.tomcat.fork
  • Default: false

hostName:

configure host name
  • Type: java.lang.String
  • Since: 2.1
  • Required: No
  • User Property: maven.tomcat.hostName
  • Default: localhost

httpsPort:

The https port to run the Tomcat server on. By default it's 0 this means won't be started. The https connector will be started only for value > 0.
  • Type: int
  • Since: 1.0
  • Required: No
  • User Property: maven.tomcat.httpsPort
  • Default: 0

ignorePackaging:

If set to true ignore if packaging of project is not 'war'.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: tomcat.ignorePackaging
  • Default: false

keystoreFile:

Override the default keystoreFile for the HTTPS connector (if enabled)
  • Type: java.lang.String
  • Since: 1.1
  • Required: No

keystorePass:

Override the default keystorePass for the HTTPS connector (if enabled)
  • Type: java.lang.String
  • Since: 1.1
  • Required: No

keystoreType:

Override the type of keystore file to be used for the server certificate. If not specified, the default value is "JKS".
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • Default: JKS

managerWarPath:

to install a manager in your embeded tomcat
  • Type: java.io.File
  • Since: 2.0
  • Required: No

path:

The webapp context path to use for the web application being run. This must always start with a forward-slash ('/').
  • Type: java.lang.String
  • Required: Yes
  • User Property: maven.tomcat.path
  • Default: /${project.artifactId}

pluginArtifacts:

(no description)
  • Type: java.util.List
  • Since: 1.0
  • Required: Yes
  • Default: ${plugin.artifacts}

port:

The port to run the Tomcat server on.
  • Type: int
  • Required: No
  • User Property: maven.tomcat.port
  • Default: 8080

protocol:

The protocol to run the Tomcat server on. By default it's HTTP/1.1.
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.protocol
  • Default: HTTP/1.1

serverXml:

server.xml to use Note if you use this you must configure in this file your webapp paths.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: maven.tomcat.serverXml

skip:

Skip execution
  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.skip
  • Default: false

staticContextDocbase:

The static context docroot base fully qualified path. if null static context won't be added
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.staticContextDocbase

staticContextPath:

The static context
  • Type: java.lang.String
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.staticContextPath
  • Default: /

systemProperties:

List of System properties to pass to the Tomcat Server.
  • Type: java.util.Map
  • Since: 1.0-alpha-2
  • Required: No

tomcatUsers:

The path of the Tomcat users XML file.
  • Type: java.io.File
  • Required: No
  • User Property: maven.tomcat.tomcatUsers.file

tomcatWebXml:

overriding the providing web.xml to run tomcat This override the global Tomcat web.xml located in $CATALINA_HOME/conf/
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: maven.tomcat.webXml

uriEncoding:

The character encoding to use for decoding URIs.
  • Type: java.lang.String
  • Since: 1.0
  • Required: No
  • User Property: maven.tomcat.uriEncoding
  • Default: ISO-8859-1

useNaming:

Enables or disables naming support for the embedded Tomcat server. By default the embedded Tomcat in Tomcat 6 comes with naming enabled. In contrast to this the embedded Tomcat 7 comes with naming disabled by default.

Note: This setting is ignored if you provide a server.xml for your Tomcat. Instead please configure naming in the server.xml.

  • Type: boolean
  • Since: 2.0
  • Required: No
  • User Property: maven.tomcat.useNaming
  • Default: true

useSeparateTomcatClassLoader:

if true a new classLoader separated from maven core will be created to start tomcat.
  • Type: boolean
  • Since: 1.0
  • Required: No
  • User Property: tomcat.useSeparateTomcatClassLoader
  • Default: false

warDirectory:

The path of the exploded WAR directory to run.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/${project.build.finalName}

webapps:

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