tomcat6:undeploy

Full name:

org.apache.tomcat.maven:tomcat6-maven-plugin:2.0:undeploy

Description:

Undeploy a WAR from Tomcat.

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
charset String - The URL encoding charset to use when communicating with Tomcat manager.
Default value is: ISO-8859-1.
User property is: maven.tomcat.charset.
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.
url URL - The full URL of the Tomcat manager instance to use.
Default value is: http://localhost:8080/manager.
User property is: maven.tomcat.url.

Optional Parameters

Name Type Since Description
failOnError boolean - Whether to fail the build if the web application cannot be undeployed.
Default value is: true.
User property is: maven.tomcat.failOnError.
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 - 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.
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
  • Required: Yes
  • User Property: maven.tomcat.charset
  • Default: ISO-8859-1

failOnError:

Whether to fail the build if the web application cannot be undeployed.
  • Type: boolean
  • Required: No
  • User Property: maven.tomcat.failOnError
  • Default: true

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

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
  • 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
  • Required: No
  • User Property: maven.tomcat.server

url:

The full URL of the Tomcat manager instance to use.
  • Type: java.net.URL
  • 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