tomcat7:run

全名:

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

描述:

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

属性:

  • 需要执行一个 Maven 项目。
  • 需要解析作用域内的构件依赖test.
  • 此目标是线程安全的并支持并行构建。
  • 起始版本2.0.
  • 调用执行 生命周期阶段process-classes在自身执行之前。

必选参数

名称 类型 起始版本 描述
path String 2.0 用于运行的 Web 应用程序的 Web 应用上下文路径。此路径必须始终以正斜杠 ('/') 开头。
默认值为: /${project.artifactId}.
用户属性为: maven.tomcat.path.
pluginArtifacts List 1.0 (无描述)
默认值为: ${plugin.artifacts}.

可选参数

名称 类型 起始版本 描述
addContextWarDependencies boolean 1.0 已弃用。请改用 webapps
默认值为: false.
用户属性为: maven.tomcat.addContextWarDependencies.
addWarDependenciesInClassloader boolean 2.0 将把 war 依赖项中的 /WEB-INF/lib/*.jar 和 /WEB-INF/classes 添加到 webapp 类加载器中
默认值为: true.
用户属性为: maven.tomcat.addWarDependenciesInClassloader.
additionalClasspathDirs List 2.0 要添加到嵌入式 Tomcat 类路径的额外可选目录。
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 表示每次 classpath 扫描更改调用之间的延迟（秒）
默认值为: -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.
delegate boolean 1.0 设置用于配置我们 ClassLoader 的“遵循标准委托模型”标志。
默认值为: true.
用户属性为: tomcat.delegate.
fork boolean 1.0 将其设置为 true 以允许 Maven 在调用 run 目标后继续执行。
默认值为: 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-fragment，它们将被读取。如果出于性能原因您不需要，可以将其禁用。
默认值为: true.
用户属性为: maven.tomcat.jarScan.allDirectories.
keystoreFile String 1.1 覆盖 HTTPS 连接器（如果启用）的默认 keystoreFile
keystorePass String 1.1 覆盖 HTTPS 连接器（如果启用）的默认 keystorePass
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 会将端口转储到属性文件中（属性名称请参见 ports）。如果为空，则不生成文件
用户属性为: 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 注意：如果您使用此项，则必须在此文件中配置您的 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 服务器的系统属性列表。
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 服务器的命名支持。

注意：如果您提供一个server.xml您的 Tomcat，则此设置将被忽略。请改为在以下位置配置命名：server.xml.


默认值为: true.
用户属性为: maven.tomcat.useNaming.
useSeparateTomcatClassLoader boolean 1.0 如果true将创建一个与 Maven 核心分离的新类加载器来启动 Tomcat。
默认值为: false.
用户属性为: tomcat.useSeparateTomcatClassLoader.
useTestClasspath boolean 2.0 将使用测试类路径而不是编译类路径，并且也会添加测试依赖项
默认值为: false.
用户属性为: maven.tomcat.useTestClasspath.
warSourceDirectory File 2.0 运行中的 Web 应用程序的 Web 资源目录。
默认值为: ${basedir}/src/main/webapp.
用户属性为: tomcat.warSourceDirectory.
webapps List 2.0 要部署的 Web 应用构件集合。元素是 <webapp>，包含常规的 GAVC 以及 contextPath 和/或 contextFile 元素。

参数详情

addContextWarDependencies:

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

addWarDependenciesInClassloader:

将把 war 依赖项中的 /WEB-INF/lib/*.jar 和 /WEB-INF/classes 添加到 webapp 类加载器中
  • 类型: boolean
  • 起始版本: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.addWarDependenciesInClassloader
  • 默认值: true

additionalClasspathDirs:

要添加到嵌入式 Tomcat 类路径的额外可选目录。
  • 类型: java.util.List
  • 起始版本: 2.0
  • 必需: 否

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:

表示每次 classpath 扫描更改调用之间的延迟（秒）
  • 类型: 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

delegate:

设置用于配置我们 ClassLoader 的“遵循标准委托模型”标志。
  • 类型: boolean
  • 起始版本: 1.0
  • 必需: 否
  • 用户属性: tomcat.delegate
  • 默认值: true

fork:

将其设置为 true 以允许 Maven 在调用 run 目标后继续执行。
  • 类型: 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-fragment，它们将被读取。如果出于性能原因您不需要，可以将其禁用。
  • 类型: boolean
  • 起始版本: 2.2
  • 必需: 否
  • 用户属性: maven.tomcat.jarScan.allDirectories
  • 默认值: true

keystoreFile:

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

keystorePass:

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

keystoreType:

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

path:

用于运行的 Web 应用程序的 Web 应用上下文路径。此路径必须始终以正斜杠 ('/') 开头。
  • 类型: 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:

会将端口转储到属性文件中（属性名称请参见 ports）。如果为空，则不生成文件
  • 类型: 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 注意：如果您使用此项，则必须在此文件中配置您的 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
  • 必需: 否

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 服务器的命名支持。

注意：如果您提供一个server.xml您的 Tomcat，则此设置将被忽略。请改为在以下位置配置命名：server.xml.

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

useSeparateTomcatClassLoader:

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

useTestClasspath:

将使用测试类路径而不是编译类路径，并且也会添加测试依赖项
  • 类型: boolean
  • 起始版本: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.useTestClasspath
  • 默认值: false

warSourceDirectory:

运行中的 Web 应用程序的 Web 资源目录。
  • 类型: java.io.File
  • 起始版本: 2.0
  • 必需: 否
  • 用户属性: tomcat.warSourceDirectory
  • 默认值: ${basedir}/src/main/webapp

webapps:

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