Apache Tomcat Maven 插件 :: Tomcat 7.x - tomcat7:run-war

tomcat7:run-war

全名:

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

描述:

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

属性:

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

必填参数

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

可选参数

名称	类型	始于	描述
添加上下文 WAR 依赖项	`布尔值`	`1.0`	已弃用。请改用 webapps 默认值为: `false`. 用户属性为: `maven.tomcat.addContextWarDependencies`.
附加配置文件目录	`文件`	`1.0-alpha-2`	该目录包含复制到 Tomcat conf 目录中的附加配置文件。默认值为: `${basedir}/src/main/tomcatconf`. 用户属性为: `maven.tomcat.additionalConfigFilesDir`.
地址	`字符串`	`2.2`	此 IP 地址将用于所有端口用户属性为: `maven.tomcat.address`.
AJP 端口	`整型`	`2.0`	运行 Tomcat 服务器的 AJP 端口。默认值为 0，表示不会启动。只有当值大于 0 时，AJP 连接器才会启动。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.ajp.port 默认值为: `0`. 用户属性为: `maven.tomcat.ajp.port`.
AJP 协议	`字符串`	`2.0`	运行 Tomcat 服务器的 AJP 协议。默认值为 ajp。注意：只有当`AJP 端口`> 0 时，AJP 连接器才会启动。可能的值有 org.apache.coyote.ajp.AjpProtocol - 支持执行器的新阻塞 Java 连接器 org.apache.coyote.ajp.AjpAprProtocol - APR/原生连接器。默认值为: `org.apache.coyote.ajp.AjpProtocol`. 用户属性为: `maven.tomcat.ajp.protocol`.
别名	`字符串数组`	`2.0`	配置别名，请参见主机名别名
后台处理器延迟	`整型`	`2.0`	表示每次 classPathScanning 更改调用之间的延迟（秒）默认值为: `-1`. 用户属性为: `maven.tomcat.backgroundProcessorDelay`.
类加载器类	`字符串`	`2.0`	要设置的类加载器类。
客户端认证	`字符串`	`2.1`	为 HTTPS 启用客户端认证（如果已配置），请参见 https://tomcat.net.cn/tomcat-7.0-doc/config/http.html#SSL_Support_-_BIO_and_NIO 默认值为: `false`. 用户属性为: `maven.tomcat.https.clientAuth`.
配置目录	`文件`	`2.0`	创建 Tomcat 服务器配置的目录。默认值为: `${project.build.directory}/tomcat`.
上下文文件	`文件`	`2.0`	Tomcat 上下文 XML 文件的路径。自 2.0 版本起，此文件作为 Maven 资源进行过滤，因此您可以使用插值令牌 ${ }。用户属性为: `maven.tomcat.contextFile`.
上下文可重新加载	`布尔值`	`2.0`	如果您没有使用带有 reloadable = "true" 的上下文文件，则强制进行上下文扫描。另一种使用 contextReloadable 的方法是在您的上下文文件中添加属性 reloadable = "true"。默认值为: `false`. 用户属性为: `maven.tomcat.contextReloadable`.
分叉	`布尔值`	`1.0`	将其设置为 true 以允许 Maven 在调用运行目标后继续执行。默认值为: `false`. 用户属性为: `maven.tomcat.fork`.
主机名	`字符串`	`2.0`	配置主机名默认值为: `localhost`. 用户属性为: `maven.tomcat.hostName`.
HTTPS 端口	`整型`	`1.0`	运行 Tomcat 服务器的 HTTPS 端口。默认值为 0，表示不会启动。只有当值大于 0 时，HTTPS 连接器才会启动。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.https.port 默认值为: `0`. 用户属性为: `maven.tomcat.httpsPort`.
忽略打包	`布尔值`	`1.0`	如果设置为 true，则在项目打包不是 'war' 时忽略。默认值为: `false`. 用户属性为: `tomcat.ignorePackaging`.
扫描所有 Jar 目录	`布尔值`	`2.2`	如果您的反应器中的模块包含 Web 片段，它们将被读取。如果您出于性能原因不需要它们，可以禁用此功能。默认值为: `true`. 用户属性为: `maven.tomcat.jarScan.allDirectories`.
密钥库文件	`字符串`	`1.1`	覆盖 HTTPS 连接器（如果启用）的默认 keystoreFile
密钥库密码	`字符串`	`1.1`	覆盖 HTTPS 连接器（如果启用）的默认 keystorePass
密钥库类型	`字符串`	`2.0`	覆盖用于服务器证书的密钥库文件类型。如果未指定，默认值为 "JKS"。默认值为: `JKS`.
端口	`整型`	`2.0`	运行 Tomcat 服务器的端口。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.http.port 默认值为: `8080`. 用户属性为: `maven.tomcat.port`.
端口属性文件路径	`字符串`	`2.0`	将端口转储到属性文件（有关属性名称，请参见端口）。如果为空，则不生成文件用户属性为: `maven.tomcat.propertiesPortFilePath`.
协议	`字符串`	`2.0`	运行 Tomcat 服务器的协议。默认值为 HTTP/1.1。请参见 HTTP 连接器协议属性的可能值默认值为: `HTTP/1.1`. 用户属性为: `maven.tomcat.protocol`.
server.xml	`文件`	`1.0-alpha-2`	要使用的 server.xml。请注意，如果您使用此选项，必须在此文件中配置您的 Web 应用路径。用户属性为: `maven.tomcat.serverXml`.
跳过	`布尔值`	`2.0`	跳过执行默认值为: `false`. 用户属性为: `maven.tomcat.skip`.
静态上下文文档库	`字符串`	`2.0`	静态上下文文档根目录的完全限定路径，如果为`null`则静态上下文将不会添加用户属性为: `maven.tomcat.staticContextDocbase`.
静态上下文路径	`字符串`	`2.0`	静态上下文默认值为: `/`. 用户属性为: `maven.tomcat.staticContextPath`.
系统属性	`映射`	`1.0-alpha-2`	要传递给 Tomcat 服务器的系统属性列表。
Tomcat 日志文件	`文件`	`2.0`	Tomcat 日志配置的路径。用户属性为: `maven.tomcat.tomcatLogging.file`.
Tomcat 用户	`文件`	`2.0`	Tomcat 用户 XML 文件的路径。用户属性为: `maven.tomcat.tomcatUsers.file`.
Tomcat Web XML	`文件`	`1.0-alpha-2`	覆盖提供的 web.xml 以运行 Tomcat。这将覆盖位于 $CATALINA_HOME/conf/ 中的全局 Tomcat web.xml 用户属性为: `maven.tomcat.webXml`.
信任管理器类名	`字符串`	`2.2`	(无描述)
信任最大证书长度	`字符串`	`2.2`	(无描述)
信任库算法	`字符串`	`2.2`	(无描述)
信任库文件	`字符串`	`2.2`	(无描述)
信任库密码	`字符串`	`2.2`	(无描述)
信任库提供者	`字符串`	`2.2`	(无描述)
信任库类型	`字符串`	`2.2`	(无描述)
URI 编码	`字符串`	`1.0`	用于解码 URI 的字符编码。默认值为: `ISO-8859-1`. 用户属性为: `maven.tomcat.uriEncoding`.
对 URI 使用正文编码	`布尔值`	`2.2`	(无描述) 默认值为: `false`. 用户属性为: `maven.tomcat.useBodyEncodingForURI`.
使用命名	`布尔值`	`2.0`	启用或禁用嵌入式 Tomcat 服务器的命名支持。注意：如果您为您的 Tomcat 提供了`server.xml`，则此设置将被忽略。请改为在`server.xml`. 默认值为: `true`. 用户属性为: `maven.tomcat.useNaming`.
使用独立的 Tomcat 类加载器	`布尔值`	`1.0`	如果为`true`true，将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。默认值为: `false`. 用户属性为: `tomcat.useSeparateTomcatClassLoader`.
Web 应用	`列表`	`2.0`	要部署的 Web 应用构件集合。元素是 <webapp>，包含常见的 GAVC 以及 contextPath 和/或 contextFile 元素。

参数详情

添加上下文 WAR 依赖项:

已弃用。请改用 webapps

将为每个类型为 WAR 且“scope”设置为“tomcat”的依赖项创建一个 Tomcat 上下文。换句话说，依赖项（带

   <type>war</type>
   <scope>tomcat</scope>

为保持向后兼容性，默认值为 false。

类型: 布尔值
始于: 1.0
必需: 否
用户属性: maven.tomcat.addContextWarDependencies
默认: false

附加配置文件目录:

该目录包含复制到 Tomcat conf 目录中的附加配置文件。

类型: java.io.File
始于: 1.0-alpha-2
必需: 否
用户属性: maven.tomcat.additionalConfigFilesDir
默认: ${basedir}/src/main/tomcatconf

地址:

此 IP 地址将用于所有端口

类型: java.lang.String
始于: 2.2
必需: 否
用户属性: maven.tomcat.address

AJP 端口:

运行 Tomcat 服务器的 AJP 端口。默认值为 0，表示不会启动。只有当值大于 0 时，AJP 连接器才会启动。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.ajp.port

类型: 整型
始于: 2.0
必需: 否
用户属性: maven.tomcat.ajp.port
默认: 0

AJP 协议:

运行 Tomcat 服务器的 AJP 协议。默认值为 ajp。注意：只有当AJP 端口> 0 时，AJP 连接器才会启动。可能的值有

org.apache.coyote.ajp.AjpProtocol - 支持执行器的新阻塞 Java 连接器
org.apache.coyote.ajp.AjpAprProtocol - APR/原生连接器。

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.ajp.protocol
默认: org.apache.coyote.ajp.AjpProtocol

别名:

配置别名，请参见主机名别名

类型: java.lang.String[]
始于: 2.0
必需: 否

后台处理器延迟:

表示每次 classPathScanning 更改调用之间的延迟（秒）

类型: 整型
始于: 2.0
必需: 否
用户属性: maven.tomcat.backgroundProcessorDelay
默认: -1

类加载器类:

要设置的类加载器类。

类型: java.lang.String
始于: 2.0
必需: 否

客户端认证:

为 HTTPS 启用客户端认证（如果已配置），请参见 https://tomcat.net.cn/tomcat-7.0-doc/config/http.html#SSL_Support_-_BIO_and_NIO

类型: java.lang.String
始于: 2.1
必需: 否
用户属性: maven.tomcat.https.clientAuth
默认: false

配置目录:

创建 Tomcat 服务器配置的目录。

类型: java.io.File
始于: 2.0
必需: 否
默认: ${project.build.directory}/tomcat

上下文文件:

Tomcat 上下文 XML 文件的路径。

自 2.0 版本起，此文件作为 Maven 资源进行过滤，因此您可以使用插值令牌 ${ }。

类型: java.io.File
始于: 2.0
必需: 否
用户属性: maven.tomcat.contextFile

上下文可重新加载:

如果您没有使用带有 reloadable = "true" 的上下文文件，则强制进行上下文扫描。另一种使用 contextReloadable 的方法是在您的上下文文件中添加属性 reloadable = "true"。

类型: 布尔值
始于: 2.0
必需: 否
用户属性: maven.tomcat.contextReloadable
默认: false

分叉:

将其设置为 true 以允许 Maven 在调用运行目标后继续执行。

类型: 布尔值
始于: 1.0
必需: 否
用户属性: maven.tomcat.fork
默认: false

主机名:

配置主机名

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.hostName
默认: localhost

HTTPS 端口:

运行 Tomcat 服务器的 HTTPS 端口。默认值为 0，表示不会启动。只有当值大于 0 时，HTTPS 连接器才会启动。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.https.port

类型: 整型
始于: 1.0
必需: 否
用户属性: maven.tomcat.httpsPort
默认: 0

忽略打包:

如果设置为 true，则在项目打包不是 'war' 时忽略。

类型: 布尔值
始于: 1.0
必需: 否
用户属性: tomcat.ignorePackaging
默认: false

扫描所有 Jar 目录:

如果您的反应器中的模块包含 Web 片段，它们将被读取。如果您出于性能原因不需要它们，可以禁用此功能。

类型: 布尔值
始于: 2.2
必需: 否
用户属性: maven.tomcat.jarScan.allDirectories
默认: true

密钥库文件:

覆盖 HTTPS 连接器（如果启用）的默认 keystoreFile

类型: java.lang.String
始于: 1.1
必需: 否

密钥库密码:

覆盖 HTTPS 连接器（如果启用）的默认 keystorePass

类型: java.lang.String
始于: 1.1
必需: 否

密钥库类型:

覆盖用于服务器证书的密钥库文件类型。如果未指定，默认值为 "JKS"。

类型: java.lang.String
始于: 2.0
必需: 否
默认: JKS

路径:

要运行的 Web 应用程序使用的 Web 应用上下文路径。此路径必须始终以正斜杠 ('/') 开头。

类型: java.lang.String
始于: 2.0
必需: 是
用户属性: maven.tomcat.path
默认: /${project.artifactId}

插件构件:

(无描述)

类型: java.util.List
始于: 1.0
必需: 是
默认: ${plugin.artifacts}

端口:

运行 Tomcat 服务器的端口。它将作为系统属性和 session.executionProperties 公开，键为 tomcat.maven.http.port

类型: 整型
始于: 2.0
必需: 否
用户属性: maven.tomcat.port
默认: 8080

端口属性文件路径:

将端口转储到属性文件（有关属性名称，请参见端口）。如果为空，则不生成文件

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.propertiesPortFilePath

协议:

运行 Tomcat 服务器的协议。默认值为 HTTP/1.1。请参见 HTTP 连接器协议属性的可能值

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.protocol
默认: HTTP/1.1

server.xml:

要使用的 server.xml。请注意，如果您使用此选项，必须在此文件中配置您的 Web 应用路径。

类型: java.io.File
始于: 1.0-alpha-2
必需: 否
用户属性: maven.tomcat.serverXml

跳过:

跳过执行

类型: 布尔值
始于: 2.0
必需: 否
用户属性: maven.tomcat.skip
默认: false

静态上下文文档库:

静态上下文文档根目录的完全限定路径，如果为null则静态上下文将不会添加

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.staticContextDocbase

静态上下文路径:

静态上下文

类型: java.lang.String
始于: 2.0
必需: 否
用户属性: maven.tomcat.staticContextPath
默认: /

系统属性:

要传递给 Tomcat 服务器的系统属性列表。

类型: java.util.Map
始于: 1.0-alpha-2
必需: 否

Tomcat 日志文件:

Tomcat 日志配置的路径。

类型: java.io.File
始于: 2.0
必需: 否
用户属性: maven.tomcat.tomcatLogging.file

Tomcat 用户:

Tomcat 用户 XML 文件的路径。

类型: java.io.File
始于: 2.0
必需: 否
用户属性: maven.tomcat.tomcatUsers.file

Tomcat Web XML:

覆盖提供的 web.xml 以运行 Tomcat。这将覆盖位于 $CATALINA_HOME/conf/ 中的全局 Tomcat web.xml

类型: java.io.File
始于: 1.0-alpha-2
必需: 否
用户属性: maven.tomcat.webXml

信任管理器类名:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任最大证书长度:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任库算法:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任库文件:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任库密码:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任库提供者:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

信任库类型:

(无描述)

类型: java.lang.String
始于: 2.2
必需: 否

URI 编码:

用于解码 URI 的字符编码。

类型: java.lang.String
始于: 1.0
必需: 否
用户属性: maven.tomcat.uriEncoding
默认: ISO-8859-1

对 URI 使用正文编码:

(无描述)

类型: 布尔值
始于: 2.2
必需: 否
用户属性: maven.tomcat.useBodyEncodingForURI
默认: false

使用命名:

启用或禁用嵌入式 Tomcat 服务器的命名支持。

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

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

使用独立的 Tomcat 类加载器:

如果为truetrue，将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。

类型: 布尔值
始于: 1.0
必需: 否
用户属性: tomcat.useSeparateTomcatClassLoader
默认: false

WAR 目录:

要运行的解压后的 WAR 目录的路径。

类型: java.io.File
始于: 2.0
必需: 是
用户属性: maven.tomcat.warDirectory
默认: ${project.build.directory}/${project.build.finalName}

Web 应用:

要部署的 Web 应用构件集合。元素是 <webapp>，包含常见的 GAVC 以及 contextPath 和/或 contextFile 元素。

类型: java.util.List
始于: 2.0
必需: 否