tomcat7:run-war-only

完整名称:

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

描述:

与 run-war 目标相同，但不分叉打包周期。

属性:

  • 需要执行 Maven 项目。
  • 需要解析作用域内的构件runtime.
  • 该目标是线程安全的，并支持并行构建。
  • 始于版本2.0.

必需参数

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

可选参数

名称 类型 始于 描述
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 时才会启动。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.ajp.port
默认值为: 0.
用户属性为: maven.tomcat.ajp.port.
ajpProtocol String 2.0 Tomcat 服务器运行的 AJP 协议。默认为 ajp。注意：AJP 连接器仅在ajpPort大于 0。可取值有
  • org.apache.coyote.ajp.AjpProtocol - 支持执行器的新阻塞 Java 连接器
  • org.apache.coyote.ajp.AjpAprProtocol - APR/原生连接器。

默认值为: org.apache.coyote.ajp.AjpProtocol.
用户属性为: maven.tomcat.ajp.protocol.
aliases String[] 2.0 配置别名，请参见 主机名别名
backgroundProcessorDelay int 2.0 表示每次类路径扫描更改调用之间的延迟（秒）
默认值为: -1.
用户属性为: maven.tomcat.backgroundProcessorDelay.
classLoaderClass String 2.0 要设置的类加载器类。
clientAuth String 2.1 为 HTTPS（如果已配置）启用客户端身份验证，请参见 https://tomcat.net.cn/tomcat-7.0-doc/config/http.html#SSL_Support_-_BIO_and_NIO
默认值为: false.
用户属性为: maven.tomcat.https.clientAuth.
configurationDir File 2.0 创建 Tomcat 服务器配置的目录。
默认值为: ${project.build.directory}/tomcat.
contextFile File 2.0

Tomcat 上下文 XML 文件的路径。

自 2.0 版本发布以来，该文件被过滤为 Maven 资源，因此您可以使用插值标记 ${ }


用户属性为: maven.tomcat.contextFile.
contextReloadable boolean 2.0 如果您不使用带有 reloadable = "true" 的上下文文件，则强制进行上下文扫描。另一种使用 contextReloadable 的方式是在您的上下文文件中添加属性 reloadable = "true"。
默认值为: false.
用户属性为: maven.tomcat.contextReloadable.
fork boolean 1.0 将其设置为 true，以允许 Maven 在调用运行目标后继续执行。
默认值为: false.
用户属性为: maven.tomcat.fork.
hostName String 2.0 配置主机名
默认值为: localhost.
用户属性为: maven.tomcat.hostName.
httpsPort int 1.0 Tomcat 服务器运行的 HTTPS 端口。默认为 0，表示不会启动。HTTPS 连接器只有在值 > 0 时才会启动。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.https.port
默认值为: 0.
用户属性为: maven.tomcat.httpsPort.
ignorePackaging boolean 1.0 如果设置为 true，则忽略项目打包不是 'war' 的情况。
默认值为: false.
用户属性为: tomcat.ignorePackaging.
jarScanAllDirectories boolean 2.2 如果您的反应器中的某个模块包含 web-fragments，它们将被读取。如果出于性能考虑您不需要此功能，可以将其禁用。
默认值为: true.
用户属性为: maven.tomcat.jarScan.allDirectories.
keystoreFile String 1.1 覆盖 HTTPS 连接器（如果启用）的默认密钥库文件
keystorePass String 1.1 覆盖 HTTPS 连接器（如果启用）的默认密钥库密码
keystoreType String 2.0 覆盖用于服务器证书的密钥库文件类型。如果未指定，默认值为 "JKS"。
默认值为: JKS.
port int 2.0 Tomcat 服务器运行的端口。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.http.port
默认值为: 8080.
用户属性为: maven.tomcat.port.
propertiesPortFilePath String 2.0 将端口转储到属性文件（有关属性名称请参阅端口）。如果为空，则不生成文件
用户属性为: maven.tomcat.propertiesPortFilePath.
protocol String 2.0 Tomcat 服务器运行的协议。默认为 HTTP/1.1。参见 HTTP 连接器协议属性的可能值
默认值为: HTTP/1.1.
用户属性为: maven.tomcat.protocol.
serverXml File 1.0-alpha-2 要使用的 server.xml 注意：如果您使用此项，则必须在此文件中配置您的 webapp 路径。
用户属性为: 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 服务器的系统属性列表。
tomcatLoggingFile File 2.0 Tomcat 日志配置的路径。
用户属性为: maven.tomcat.tomcatLogging.file.
tomcatUsers File 2.0 Tomcat 用户 XML 文件的路径。
用户属性为: maven.tomcat.tomcatUsers.file.
tomcatWebXml File 1.0-alpha-2 覆盖提供的 web.xml 以运行 tomcat 这将覆盖位于 $CATALINA_HOME/conf/ 的全局 Tomcat web.xml
用户属性为: maven.tomcat.webXml.
trustManagerClassName String 2.2 （无描述）
trustMaxCertLength String 2.2 （无描述）
truststoreAlgorithm String 2.2 （无描述）
truststoreFile String 2.2 （无描述）
truststorePass String 2.2 （无描述）
truststoreProvider String 2.2 （无描述）
truststoreType String 2.2 （无描述）
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 提供了server.xml，此设置将被忽略。请改为在server.xml.


默认值为: true.
用户属性为: maven.tomcat.useNaming.
中配置命名 boolean 1.0 useSeparateTomcatClassLoadertrue如果为 true，将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。
默认值为: false.
用户属性为: tomcat.useSeparateTomcatClassLoader.
webapps List 2.0 要部署的 webapp 构件集合。元素是 <webapp>，包含通常的 GAVC 以及 contextPath 和/或 contextFile 元素。

参数详情

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 时才会启动。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.ajp.port
  • 类型: int
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.ajp.port
  • 默认: 0

ajpProtocol:

Tomcat 服务器运行的 AJP 协议。默认为 ajp。注意：AJP 连接器仅在ajpPort大于 0。可取值有
  • 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

aliases:

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

backgroundProcessorDelay:

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

classLoaderClass:

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

clientAuth:

为 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

configurationDir:

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

contextFile:

Tomcat 上下文 XML 文件的路径。

自 2.0 版本发布以来，该文件被过滤为 Maven 资源，因此您可以使用插值标记 ${ }

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

contextReloadable:

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

fork:

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

hostName:

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

httpsPort:

Tomcat 服务器运行的 HTTPS 端口。默认为 0，表示不会启动。HTTPS 连接器只有在值 > 0 时才会启动。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.https.port
  • 类型: int
  • 始于: 1.0
  • 必需: 否
  • 用户属性: maven.tomcat.httpsPort
  • 默认: 0

ignorePackaging:

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

jarScanAllDirectories:

如果您的反应器中的某个模块包含 web-fragments，它们将被读取。如果出于性能考虑您不需要此功能，可以将其禁用。
  • 类型: boolean
  • 始于: 2.2
  • 必需: 否
  • 用户属性: maven.tomcat.jarScan.allDirectories
  • 默认: true

keystoreFile:

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

keystorePass:

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

keystoreType:

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

path:

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

pluginArtifacts:

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

port:

Tomcat 服务器运行的端口。将作为系统属性和 session.executionProperties 暴露，键为 tomcat.maven.http.port
  • 类型: int
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.port
  • 默认: 8080

propertiesPortFilePath:

将端口转储到属性文件（有关属性名称请参阅端口）。如果为空，则不生成文件
  • 类型: java.lang.String
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.propertiesPortFilePath

protocol:

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

serverXml:

要使用的 server.xml 注意：如果您使用此项，则必须在此文件中配置您的 webapp 路径。
  • 类型: 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
  • 必需: 否

tomcatLoggingFile:

Tomcat 日志配置的路径。
  • 类型: java.io.File
  • 始于: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.tomcatLogging.file

tomcatUsers:

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

tomcatWebXml:

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

trustManagerClassName:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

trustMaxCertLength:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststoreAlgorithm:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststoreFile:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststorePass:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

truststoreProvider:

（无描述）
  • 类型: java.lang.String
  • 始于: 2.2
  • 必需: 否

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 提供了server.xml，此设置将被忽略。请改为在server.xml.

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

中配置命名:

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

warDirectory:

要运行的解压后的 WAR 目录路径。
  • 类型: java.io.File
  • 始于: 2.0
  • 必需: 是
  • 用户属性: maven.tomcat.warDirectory
  • 默认: ${project.build.directory}/${project.build.finalName}

webapps:

要部署的 webapp 构件集合。元素是 <webapp>，包含通常的 GAVC 以及 contextPath 和/或 contextFile 元素。
  • 类型: java.util.List
  • 始于: 2.0
  • 必需: 否