tomcat6:run

全名:

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

描述:

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

属性:

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

必需参数

名称 类型 起始版本 描述
path String - 用于运行的 Web 应用程序的 webapp 上下文路径。此路径必须始终以斜杠（'/'）开头。
默认值为: /${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 添加到 webappclassloader 中
默认值为: true.
用户属性为: maven.tomcat.addWarDependenciesInClassloader.
additionalClasspathDirs List 2.0-beta-1 要添加到嵌入式 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 时才会启动。
默认值为: 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 文件的路径。
默认值为: src/main/webapp/META-INF/context.xml.
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.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 注意：如果使用此项，您必须在此文件中配置您的 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 服务器的系统属性列表。
tomcatUsers File - Tomcat 用户 XML 文件的路径。
用户属性为: maven.tomcat.tomcatUsers.file.
tomcatWebXml File 1.0-alpha-2 覆盖提供的 web.xml 以运行 tomcat 此项会覆盖位于 $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 中的嵌入式 Tomcat 命名默认是禁用的。

注意：如果您为 Tomcat 提供了server.xml，则此设置将被忽略。请改为在 server.xml 中配置命名。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 - 运行的 Web 应用程序的 Web 资源目录。
默认值为: ${basedir}/src/main/webapp.
用户属性为: tomcat.warSourceDirectory.
webapps List 2.0 （无描述）

参数详情

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 添加到 webappclassloader 中
  • 类型: boolean
  • 起始版本: 2.0
  • 必需: 否
  • 用户属性: maven.tomcat.addWarDependenciesInClassloader
  • 默认: true

additionalClasspathDirs:

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

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
  • 必需: 否
  • 默认: src/main/webapp/META-INF/context.xml

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.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 应用程序的 webapp 上下文路径。此路径必须始终以斜杠（'/'）开头。
  • 类型: 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 注意：如果使用此项，您必须在此文件中配置您的 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
  • 必需: 否

tomcatUsers:

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

tomcatWebXml:

覆盖提供的 web.xml 以运行 tomcat 此项会覆盖位于 $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 中的嵌入式 Tomcat 命名默认是禁用的。

注意：如果您为 Tomcat 提供了server.xml，则此设置将被忽略。请改为在 server.xml 中配置命名。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
  • 必需: 否
  • 用户属性: tomcat.warSourceDirectory
  • 默认: ${basedir}/src/main/webapp

webapps:

（无描述）
  • 类型: java.util.List
  • 起始版本: 2.0
  • 必需: 否