tomcat6:exploded

Full name:

org.apache.tomcat.maven:tomcat6-maven-plugin:2.0-beta-1:exploded

Description:

Deploy an exploded WAR to 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.
mode String - 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.
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}.
update boolean - Whether Tomcat should automatically undeploy webapps that already exist when deploying.
Default value is: false.
url URL - The full URL of the Tomcat manager instance to use.
Default value is: http://localhost:8080/manager.
warDirectory File - The path of the exploded WAR directory to deploy.

Optional Parameters

Name Type Since Description
contextFile File - The path of the Tomcat context XML file. This is not used for war deployment mode.
ignorePackaging boolean 1.1 If set to true ignore if packaging of project is not 'war'.
Default value is: false.
password String 1.0-alpha-2 The password to use for deployment
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.
tag String - The Tomcat webapp tag name to use.
username String 1.0-alpha-2 The tomcat username to use for deployment

Parameter Details

charset:

The URL encoding charset to use when communicating with Tomcat manager.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${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
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Required: Yes
  • Expression: ${maven.tomcat.mode}
  • Default: war

password:

The password to use for deployment
  • Type: java.lang.String
  • Since: 1.0-alpha-2
  • Required: No
  • Expression: ${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
  • Expression: ${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
  • Expression: ${maven.tomcat.server}

tag:

The Tomcat webapp tag name to use.
  • Type: java.lang.String
  • Required: No
  • Expression: ${maven.tomcat.tag}

update:

Whether Tomcat should automatically undeploy webapps that already exist when deploying.
  • Type: boolean
  • Required: Yes
  • Expression: ${maven.tomcat.update}
  • Default: false

url:

The full URL of the Tomcat manager instance to use.
  • Type: java.net.URL
  • Required: Yes
  • Expression: ${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
  • Expression: ${tomcat.username}

warDirectory:

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