tomcat6:deploy

Full name:

org.apache.tomcat.maven:tomcat6-maven-plugin:2.3-SNAPSHOT:deploy

Description:

Deploy a WAR to Tomcat.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Since version: 1.0-alpha-2.
  • Invokes the execution of the lifecycle phase package prior to executing itself.

Required Parameters

Name Type Since Description
charset String 1.0-alpha-2 The URL encoding charset to use when communicating with Tomcat manager.
Default value is: ISO-8859-1.
User property is: maven.tomcat.charset.
mode String 1.0-alpha-2 The deployment mode to use. This must be either war to deploy the war, context to deploy the context XML file, or both to deploy the war with the context XML file.
Default value is: war.
User property is: maven.tomcat.mode.
path String 1.0-alpha-2 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.
update boolean 1.0-alpha-2 Whether Tomcat should automatically undeploy webapps that already exist when deploying.
Default value is: false.
User property is: maven.tomcat.update.
url URL 1.0-alpha-2 The full URL of the Tomcat manager instance to use.
Default value is: http://localhost:8080/manager.
User property is: maven.tomcat.url.
warFile File 1.0-alpha-2 The path of the WAR file to deploy.
Default value is: ${project.build.directory}/${project.build.finalName}.war.

Optional Parameters

Name Type Since Description
contextFile File 1.0-alpha-2 The path of the Tomcat context XML file. This is not used for war deployment mode.
Default value is: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml.
ignorePackaging boolean 1.1 If set to true ignore if packaging of project is not 'war'.
Default value is: false.
User property is: tomcat.ignorePackaging.
password String 1.0-alpha-2 The password to use for deployment
User property is: tomcat.password.
server String 1.0-alpha-2 The server id in settings.xml to use when authenticating with Tomcat manager, or null to use defaults of username admin and no password.
User property is: maven.tomcat.server.
tag String 1.0-alpha-2 The Tomcat webapp tag name to use.
User property is: maven.tomcat.tag.
username String 1.0-alpha-2 The tomcat username to use for deployment
User property is: tomcat.username.

Parameter Details

charset:

The URL encoding charset to use when communicating with Tomcat manager.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: Yes
  • User Property: maven.tomcat.charset
  • Default: ISO-8859-1

contextFile:

The path of the Tomcat context XML file. This is not used for war deployment mode.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: No
  • Default: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml

ignorePackaging:

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

mode:

The deployment mode to use. This must be either war to deploy the war, context to deploy the context XML file, or both to deploy the war with the context XML file.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: Yes
  • User Property: maven.tomcat.mode
  • Default: war

password:

The password to use for deployment
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: tomcat.password

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
  • Since: 1.0-alpha-2
  • Required: Yes
  • User Property: maven.tomcat.path
  • Default: /${project.artifactId}

server:

The server id in settings.xml to use when authenticating with Tomcat manager, or null to use defaults of username admin and no password.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: maven.tomcat.server

tag:

The Tomcat webapp tag name to use.
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: maven.tomcat.tag

update:

Whether Tomcat should automatically undeploy webapps that already exist when deploying.
  • Type: boolean
  • Since: 1.0-alpha-2
  • Required: Yes
  • User Property: maven.tomcat.update
  • Default: false

url:

The full URL of the Tomcat manager instance to use.
  • Type: java.net.URL
  • Since: 1.0-alpha-2
  • Required: Yes
  • User Property: maven.tomcat.url
  • Default: http://localhost:8080/manager

username:

The tomcat username to use for deployment
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • User Property: tomcat.username

warFile:

The path of the WAR file to deploy.
  • Type: java.io.File
  • Since: 1.0-alpha-2
  • Required: Yes
  • Default: ${project.build.directory}/${project.build.finalName}.war