tomcat6:run-war

全名:

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

描述:

使用嵌入式 Tomcat 服务器将当前项目作为打包的 Web 应用程序运行。

属性:

  • 需要执行 Maven 项目。
  • 需要解析范围内的构件依赖运行时.
  • 此目标是线程安全的，并支持并行构建。
  • 调用生命周期阶段的执行package在执行自身之前。

所需参数

名称 类型 始于 描述
path String - 要运行的 Web 应用程序使用的 Web 应用上下文路径。此路径必须始终以正斜杠 ('/') 开头。
默认值为: /${project.artifactId}.
用户属性为: maven.tomcat.path.
pluginArtifacts List 1.0 (无描述)
默认值为: ${plugin.artifacts}.
warDirectory File - 要运行的解压后的 WAR 目录的路径。
默认值为: ${project.build.directory}/${project.build.finalName}.

可选参数

名称 类型 始于 描述
addContextWarDependencies boolean 1.0 已弃用。请改用 webapps
默认值为: false.
用户属性为: maven.tomcat.addContextWarDependencies.
additionalConfigFilesDir File 1.0-alpha-2 此目录包含复制到 Tomcat conf 目录中的额外配置文件。
默认值为: ${basedir}/src/main/tomcatconf.
用户属性为: maven.tomcat.additionalConfigFilesDir.
address String 2.2 此 IP 地址将用于所有端口。
用户属性为: maven.tomcat.address.
ajpPort int 2.0 运行 Tomcat 服务器的 AJP 端口。默认值为 0，表示不会启动。AJP 连接器仅在值大于 0 时启动。
默认值为: 0.
用户属性为: maven.tomcat.ajp.port.
ajpProtocol String 2.0 运行 Tomcat 服务器的 AJP 协议。默认值为 ajp。注意：AJP 连接器仅在以下情况才会启动ajpPort > 0.
默认值为: ajp.
用户属性为: maven.tomcat.ajp.protocol.
aliases String[] 2.1 配置别名，请参见 主机名别名
backgroundProcessorDelay int - 表示每次 classpath 扫描更改调用之间的延迟（秒）
默认值为: -1.
用户属性为: maven.tomcat.backgroundProcessorDelay.
classLoaderClass String 2.0 要设置的类加载器类。
configurationDir File - 创建 Tomcat 服务器配置的目录。
默认值为: ${project.build.directory}/tomcat.
contextFile File - Tomcat 上下文 XML 文件的路径。
默认值为: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml.
contextReloadable boolean 2.0 如果您没有使用带有 reloadable = "true" 的上下文文件，则强制进行上下文扫描。使用 contextReloadable 的另一种方法是在您的上下文文件中添加属性 reloadable = "true"。
默认值为: false.
用户属性为: maven.tomcat.contextReloadable.
fork boolean 1.0 将其设置为 true 以允许 Maven 在调用 run 目标后继续执行。
默认值为: false.
用户属性为: maven.tomcat.fork.
hostName String 2.1 配置主机名
默认值为: localhost.
用户属性为: maven.tomcat.hostName.
httpsPort int 1.0 运行 Tomcat 服务器的 HTTPS 端口。默认值为 0，表示不会启动。HTTPS 连接器仅在值大于 0 时启动。
默认值为: 0.
用户属性为: maven.tomcat.httpsPort.
ignorePackaging boolean 1.0 如果设置为 true，则在项目打包不是 'war' 时忽略。
默认值为: false.
用户属性为: tomcat.ignorePackaging.
keystoreFile String 1.1 覆盖 HTTPS 连接器（如果启用）的默认 keystoreFile
keystorePass String 1.1 覆盖 HTTPS 连接器（如果启用）的默认 keystorePass
keystoreType String 2.0 覆盖用于服务器证书的密钥库文件类型。如果未指定，默认值为 "JKS"。
默认值为: JKS.
managerWarPath File 2.0 在您的嵌入式 Tomcat 中安装管理器
port int - 运行 Tomcat 服务器的端口。
默认值为: 8080.
用户属性为: maven.tomcat.port.
protocol String 2.0 运行 Tomcat 服务器的协议。默认值为 HTTP/1.1。请参见 HTTP 连接器 协议属性的可能值
默认值为: HTTP/1.1.
用户属性为: maven.tomcat.protocol.
serverXml File 1.0-alpha-2 要使用的 server.xml。注意：如果您使用此项，则必须在此文件中配置您的 Web 应用路径。
用户属性为: maven.tomcat.serverXml.
skip boolean 2.0 跳过执行
默认值为: false.
用户属性为: maven.tomcat.skip.
staticContextDocbase String 2.0 静态上下文文档根目录的完全限定路径。如果null则不会添加静态上下文
用户属性为: maven.tomcat.staticContextDocbase.
staticContextPath String 2.0 静态上下文
默认值为: /.
用户属性为: maven.tomcat.staticContextPath.
systemProperties Map 1.0-alpha-2 要传递给 Tomcat 服务器的系统属性列表。
tomcatUsers File - Tomcat 用户 XML 文件的路径。
用户属性为: maven.tomcat.tomcatUsers.file.
tomcatWebXml File 1.0-alpha-2 覆盖用于运行 Tomcat 的 web.xml 这将覆盖位于 $CATALINA_HOME/conf/ 的全局 Tomcat web.xml
用户属性为: maven.tomcat.webXml.
truststoreFile String 2.2 覆盖 HTTPS 连接器（如果启用）的默认 truststoreFile
truststorePass String 2.2 覆盖 HTTPS 连接器（如果启用）的默认 truststorePass
truststoreProvider String 2.2 覆盖 HTTPS 连接器（如果启用）的默认 truststoreProvider
truststoreType String 2.2 覆盖 HTTPS 连接器（如果启用）的默认 truststoreType
uriEncoding String 1.0 用于解码 URI 的字符编码。
默认值为: ISO-8859-1.
用户属性为: maven.tomcat.uriEncoding.
useBodyEncodingForURI boolean 2.2 (无描述)
默认值为: false.
用户属性为: maven.tomcat.useBodyEncodingForURI.
useNaming boolean 2.0

启用或禁用嵌入式 Tomcat 服务器的命名支持。默认情况下，Tomcat 6 中的嵌入式 Tomcat 带有启用的命名。与此相反，嵌入式 Tomcat 7 默认禁用命名。

注意：如果您提供一个server.xml给您的 Tomcat，则此设置将被忽略。请改在server.xml.


默认值为: true.
用户属性为: maven.tomcat.useNaming.
useSeparateTomcatClassLoader boolean 1.0 如果true则将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。
默认值为: false.
用户属性为: tomcat.useSeparateTomcatClassLoader.
webapps List 2.0 (无描述)

参数详情

addContextWarDependencies:

已弃用。请改用 webapps
将为每个类型为 'war' 且 'scope' 设置为 'tomcat' 的依赖项创建一个 Tomcat 上下文。换句话说，依赖项
   <type>war</type>
   <scope>tomcat</scope>
为了保持向后兼容性，默认值为 false。
  • 类型: boolean
  • 始于: 1.0
  • 必需: 否
  • 用户属性: maven.tomcat.addContextWarDependencies
  • 默认: false

additionalConfigFilesDir:

此目录包含复制到 Tomcat conf 目录中的额外配置文件。
  • 类型: java.io.File
  • 始于: 1.0-alpha-2
  • 必需: 否
  • 用户属性: maven.tomcat.additionalConfigFilesDir
  • 默认: ${basedir}/src/main/tomcatconf

address:

此 IP 地址将用于所有端口。
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否
  • 用户属性: maven.tomcat.address

ajpPort:

运行 Tomcat 服务器的 AJP 端口。默认值为 0，表示不会启动。AJP 连接器仅在值大于 0 时启动。
  • 类型: int
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.ajp.port
  • 默认: 0

ajpProtocol:

运行 Tomcat 服务器的 AJP 协议。默认值为 ajp。注意：AJP 连接器仅在以下情况才会启动ajpPort > 0.
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.ajp.protocol
  • 默认: ajp

aliases:

配置别名，请参见 主机名别名
  • 类型: java.lang.String[]
  • 始于: 2.1
  • 必需: 否

backgroundProcessorDelay:

表示每次 classpath 扫描更改调用之间的延迟（秒）
  • 类型: int
  • 必需: 否
  • 用户属性: maven.tomcat.backgroundProcessorDelay
  • 默认: -1

classLoaderClass:

要设置的类加载器类。
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否

configurationDir:

创建 Tomcat 服务器配置的目录。
  • 类型: java.io.File
  • 必需: 否
  • 默认: ${project.build.directory}/tomcat

contextFile:

Tomcat 上下文 XML 文件的路径。
  • 类型: java.io.File
  • 必需: 否
  • 默认: ${project.build.directory}/${project.build.finalName}/META-INF/context.xml

contextReloadable:

如果您没有使用带有 reloadable = "true" 的上下文文件，则强制进行上下文扫描。使用 contextReloadable 的另一种方法是在您的上下文文件中添加属性 reloadable = "true"。
  • 类型: boolean
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.contextReloadable
  • 默认: false

fork:

将其设置为 true 以允许 Maven 在调用 run 目标后继续执行。
  • 类型: boolean
  • 始于: 1.0
  • 必需: 否
  • 用户属性: maven.tomcat.fork
  • 默认: false

hostName:

配置主机名
  • 类型: java.lang.String
  • 始于: 2.1
  • 必需: 否
  • 用户属性: maven.tomcat.hostName
  • 默认: localhost

httpsPort:

运行 Tomcat 服务器的 HTTPS 端口。默认值为 0，表示不会启动。HTTPS 连接器仅在值大于 0 时启动。
  • 类型: int
  • 始于: 1.0
  • 必需: 否
  • 用户属性: maven.tomcat.httpsPort
  • 默认: 0

ignorePackaging:

如果设置为 true，则在项目打包不是 'war' 时忽略。
  • 类型: boolean
  • 始于: 1.0
  • 必需: 否
  • 用户属性: tomcat.ignorePackaging
  • 默认: false

keystoreFile:

覆盖 HTTPS 连接器（如果启用）的默认 keystoreFile
  • 类型: java.lang.String
  • 始于: 1.1
  • 必需: 否

keystorePass:

覆盖 HTTPS 连接器（如果启用）的默认 keystorePass
  • 类型: java.lang.String
  • 始于: 1.1
  • 必需: 否

keystoreType:

覆盖用于服务器证书的密钥库文件类型。如果未指定，默认值为 "JKS"。
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 默认: JKS

managerWarPath:

在您的嵌入式 Tomcat 中安装管理器
  • 类型: java.io.File
  • 始于: 2.0
  • 必需: 否

path:

要运行的 Web 应用程序使用的 Web 应用上下文路径。此路径必须始终以正斜杠 ('/') 开头。
  • 类型: java.lang.String
  • 必需: 是
  • 用户属性: maven.tomcat.path
  • 默认: /${project.artifactId}

pluginArtifacts:

(无描述)
  • 类型: java.util.List
  • 始于: 1.0
  • 必需: 是
  • 默认: ${plugin.artifacts}

port:

运行 Tomcat 服务器的端口。
  • 类型: int
  • 必需: 否
  • 用户属性: maven.tomcat.port
  • 默认: 8080

protocol:

运行 Tomcat 服务器的协议。默认值为 HTTP/1.1。请参见 HTTP 连接器 协议属性的可能值
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.protocol
  • 默认: HTTP/1.1

serverXml:

要使用的 server.xml。注意：如果您使用此项，则必须在此文件中配置您的 Web 应用路径。
  • 类型: java.io.File
  • 始于: 1.0-alpha-2
  • 必需: 否
  • 用户属性: maven.tomcat.serverXml

skip:

跳过执行
  • 类型: boolean
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.skip
  • 默认: false

staticContextDocbase:

静态上下文文档根目录的完全限定路径。如果null则不会添加静态上下文
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.staticContextDocbase

staticContextPath:

静态上下文
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.staticContextPath
  • 默认: /

systemProperties:

要传递给 Tomcat 服务器的系统属性列表。
  • 类型: java.util.Map
  • 始于: 1.0-alpha-2
  • 必需: 否

tomcatUsers:

Tomcat 用户 XML 文件的路径。
  • 类型: java.io.File
  • 必需: 否
  • 用户属性: maven.tomcat.tomcatUsers.file

tomcatWebXml:

覆盖用于运行 Tomcat 的 web.xml 这将覆盖位于 $CATALINA_HOME/conf/ 的全局 Tomcat web.xml
  • 类型: java.io.File
  • 始于: 1.0-alpha-2
  • 必需: 否
  • 用户属性: maven.tomcat.webXml

truststoreFile:

覆盖 HTTPS 连接器（如果启用）的默认 truststoreFile
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststorePass:

覆盖 HTTPS 连接器（如果启用）的默认 truststorePass
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststoreProvider:

覆盖 HTTPS 连接器（如果启用）的默认 truststoreProvider
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststoreType:

覆盖 HTTPS 连接器（如果启用）的默认 truststoreType
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

uriEncoding:

用于解码 URI 的字符编码。
  • 类型: java.lang.String
  • 始于: 1.0
  • 必需: 否
  • 用户属性: maven.tomcat.uriEncoding
  • 默认: ISO-8859-1

useBodyEncodingForURI:

(无描述)
  • 类型: boolean
  • 始于: 2.2
  • 必需: 否
  • 用户属性: maven.tomcat.useBodyEncodingForURI
  • 默认: false

useNaming:

启用或禁用嵌入式 Tomcat 服务器的命名支持。默认情况下，Tomcat 6 中的嵌入式 Tomcat 带有启用的命名。与此相反，嵌入式 Tomcat 7 默认禁用命名。

注意：如果您提供一个server.xml给您的 Tomcat，则此设置将被忽略。请改在server.xml.

  • 类型: boolean
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.useNaming
  • 默认: true

useSeparateTomcatClassLoader:

如果true则将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。
  • 类型: boolean
  • 始于: 1.0
  • 必需: 否
  • 用户属性: tomcat.useSeparateTomcatClassLoader
  • 默认: false

warDirectory:

要运行的解压后的 WAR 目录的路径。
  • 类型: java.io.File
  • 必需: 是
  • 默认: ${project.build.directory}/${project.build.finalName}

webapps:

(无描述)
  • 类型: java.util.List
  • 始于: 2.0
  • 必需: 否