pluginConfiguration - Web 服务器插件 (pluginConfiguration)

生成 Web 服务器插件配置文件时使用的属性

NameTypeDefaultDescription
pluginInstallRootstring/opt/IBM/WebSphere/PluginsWeb 服务器主机的文件系统上 Web 服务器插件安装位置
webserverNamestringwebserver1此配置将使用的 Web 服务器名称。用来生成插件日志文件位置(如果日志文件名或目录未显式指定此位置)。
webserverPortint
Min: -1

Max: 65535
80Web 服务器 HTTP 端口
webserverSecurePortint
Min: -1

Max: 65535
443Web 服务器 HTTPS 端口
sslKeyringLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.kdbWeb 服务器主机上 SSL 密钥环文件的标准路径
sslStashfileLocationstring${pluginInstallRoot}/config/${webserverName}/plugin-key.sthWeb 服务器主机上的 SSL 隐藏文件的标准路径
sslCertlabelstring指定当 Web 容器从插件请求客户机证书时,该插件要使用的密钥环中的证书的标签。
ipv6Preferred布尔型false当解析应用程序服务器主机名 {null} 或 {0},以在可能时首选地址类型时使用
httpEndpointRef对顶级 httpEndpoint 元素的引用(字符串)。defaultHttpEndpoint指定要包括在已生成 plugin-cfg.xml 文件中的 HTTP 端点的标识。该端点在集群中定义服务器。缺省值为“defaultHttpEndpoint”。
connectTimeout具有秒精度的时间段5s标识应用程序服务器应保持与 Web 服务器的连接的最长时间。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
serverIOTimeout具有秒精度的时间段900s标识 Web 服务器插件等待发送请求或从应用程序服务器接收响应的最长时间。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
wsServerIOTimeout具有秒精度的时间段确定 Web 服务器插件等待发送请求或从应用程序服务器接收 websocket 响应的最长时间。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
wsServerIdleTimeout具有秒精度的时间段确定 Web 服务器插件等待终止空闲 websocket 连接的最长时间。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
extendedHandshake布尔型false如果为 true,那么 Web 服务器插件使用扩展握手来确定应用程序服务器是否正在运行。
waitForContinue布尔型false如果为 false(缺省值),那么 Web 服务器插件使用具有消息体的 HTTP 请求来发送“Expect: 100-continue”头。如果设置为 true,那么 Web 服务器插件使用每个 HTTP 请求发送“Expect: 100-continue”头。如果 Web 服务器与应用程序服务器之间有防火墙,并且您对没有请求主体的请求重试很敏感,请考虑将此值设置为 true。
logFileName文件路径Web 服务器插件日志文件的标准路径。“目录”组成部分必须已存在。对于基于 Apache 的 Web 服务器,以管道字符开头的路径会解释为外部管道记录器。如果指定了此项,那么路径将覆盖 logDirLocation。
logDirLocation目录路径${pluginInstallRoot}/logs/${webserverName}不推荐使用:用于标识 http_plugin.log 文件所在的目录。请参阅“日志文件名”。
serverIOTimeoutRetryint
Min: -1

Max: 65535
-1限制在读/写超时之后请求重试的次数。缺省值为 {-1},将不应用其他限制,因此,将由集群中的可用服务器数来限制重试次数。值 {0} 指示没有重试。此值仅限用于服务器集群,而不适用于由于 HTTP 插件连接超时而引起的连接失败或超时,也不适用于 Web 套接字超时。
loadBalanceWeight整形20此值在运行时动态更改。每次为服务器分配请求时,都会降低该服务器的权重。所有服务器的所有权重降至小于或等于 0 的值时,Web 服务器插件会重新调整所有权重,使其大于 0。
serverRole
  • BACKUP
  • PRIMARY
PRIMARY服务器角色将服务器标识为主服务器或备份服务器。主服务器可用时,Web 服务器插件将其用于负载均衡和故障转移。但是,如果主服务器都不可用,那么 Web 服务器插件仅使用备份服务器进行负载均衡和故障转移。
BACKUP
备份
PRIMARY
主要
ESIEnable布尔型trueESIEnable 属性允许 Edge Side Include 处理对响应进行缓存。此属性允许在 Web 服务器插件配置文件中禁用 ESI。
ESIMaxCacheSize整形1024ESIMaxCacheSize 为高速缓存的最大大小,缺省为 1MB。此属性允许在 Web 服务器插件配置文件中覆盖该值。
ESIInvalidationMonitor布尔型falseESIInvalidationMonitor 指定 ESI 处理器是否应从应用程序服务器接收失效指令。此属性允许在 Web 服务器插件配置文件中覆盖该值。
ESIEnableToPassCookies布尔型falseESIEnableToPassCookies 允许将会话 cookie 转发至 WebSphere Application Server。此属性允许在 Web 服务器插件配置文件中覆盖该值。
trustedProxyEnable布尔型启用要使用的可信代理。指定了此属性时,此属性将覆盖 Web 服务器插件配置文件中的值。
trustedProxyGroupstring可信代理的逗号分隔列表。指定了此属性时,此属性将覆盖 Web 服务器插件配置文件中的值。

httpEndpoint

指定要包括在已生成 plugin-cfg.xml 文件中的 HTTP 端点的标识。该端点在集群中定义服务器。缺省值为“defaultHttpEndpoint”。

NameTypeDefaultDescription
onError
  • IGNORE
  • WARN
  • FAIL
WARN启动端点失败时要执行的操作。
IGNORE
服务器在发生配置错误时将不会发出警告和错误消息。
WARN
服务器在发生配置错误时将发出警告和错误消息。
FAIL
服务器在第一次发生错误时将发出警告或错误消息,然后停止服务器。
enabled布尔型true切换端点的可用性。值为 true 时,分派器将激活此端点以处理 HTTP 请求。
hoststringlocalhost客户机用于请求资源的 IP 地址、带域名后缀的域名服务器 (DNS) 主机名,或仅 DNS 主机名。使用“*”可表示所有可用网络接口。
httpPortint
Min: -1

Max: 65535
用于客户机 HTTP 请求的端口。使用 -1 可禁用此端口。
httpsPortint
Min: -1

Max: 65535
用于使用 SSL (https) 保护的客户机 HTTP 请求的端口。使用 -1 可禁用此端口。
httpOptionsRef对顶级 httpOptions 元素的引用(字符串)。defaultHttpOptions端点的 HTTP 协议选项。
sslOptionsRef对顶级 sslOptions 元素的引用(字符串)。端点的 SSL 协议选项。
tcpOptionsRef对顶级 tcpOptions 元素的引用(字符串)。defaultTCPOptions端点的 TCP 协议选项。
accessLoggingRef对顶级 httpAccessLogging 元素的引用(字符串)。端点的 HTTP 访问日志记录配置。

httpEndpoint > httpOptions

端点的 HTTP 协议选项。

NameTypeDefaultDescription
keepAliveEnabled布尔型true启用持续连接(HTTP 保持活动)。如果为 true,那么连接将保持活动状态,以供多个顺序请求和响应重复使用。如果为 false,那么发送响应之后将关闭连接。
maxKeepAliveRequestsint
Min: -1
100启用持续连接时,单个 HTTP 连接上允许的最大持续请求数。值为 -1 时意味着不受限制。
persistTimeout具有秒精度的时间段30s将允许套接字在各个请求之间保持空闲的时间量。仅当启用持续连接时,此设置才适用。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
readTimeout具有秒精度的时间段60s发生第一次读取之后,用于等待读请求在套接字上完成的时间量。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
writeTimeout具有秒精度的时间段60s响应数据的每个部分在套接字上等待传输的时间量。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
removeServerHeader布尔型false从 HTTP 头除去服务器实现信息,并同时禁用缺省 Liberty 概要文件欢迎页面。
NoCacheCookiesControl布尔型true允许使用者控制“设置 Cookie”头的存在是否会导致使用匹配的无高速缓存值更新“高速缓存控制”头。这还会添加“到期”头。
AutoDecompression布尔型true指定 HTTP 通道是否自动解压传入请求主体数据。

httpEndpoint > sslOptions

端点的 SSL 协议选项。

NameTypeDefaultDescription
sessionTimeout具有秒精度的时间段1d用于等待读或写请求在套接字上完成的时间量。特定于协议的超时将覆盖此值。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m) 或秒 (s)。例如,以 30s 的形式指定 30 秒。可将多个值包括在单个条目中。例如,1m30s 相当于 90 秒。
suppressHandshakeErrors布尔型false禁用记录 SSL 握手错误。SSL 握手错误会在正常操作期间发生,但是当 SSL 行为异常时,这些消息将很有用。
sslRef对顶级 ssl 元素的引用(字符串)。缺省 SSL 配置指令表。缺省值为 defaultSSLSettings。
sslSessionTimeout具有毫秒精度的时间段8640msSSL 通道建立的 SSL 会话的超时限制。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m)、秒 (s) 或毫秒 (ms)。例如,以 500ms 的形式指定 500 毫秒。可将多个值包括在单个条目中。例如,1s500ms 相当于 1.5 秒。

httpEndpoint > tcpOptions

端点的 TCP 协议选项。

NameTypeDefaultDescription
inactivityTimeout具有毫秒精度的时间段60s用于等待读或写请求在套接字上完成的时间量。特定于协议的超时将覆盖此值。. 指定后跟时间单位的正整数,时间单位可以是小时 (h)、分钟 (m)、秒 (s) 或毫秒 (ms)。例如,以 500ms 的形式指定 500 毫秒。可将多个值包括在单个条目中。例如,1s500ms 相当于 1.5 秒。
soReuseAddr布尔型true允许立即重新绑定到没有任何处于活动状态的侦听器的端口。
addressIncludeListstring允许在此端点上进行入站连接的地址的逗号分隔列表。您可以指定 IPv4 或 IPv6 地址。IPv4 或 IPv6 地址中的所有值必须用数字或星号通配符表示。
addressExcludeListstring不允许在此端点上进行入站连接的地址的逗号分隔列表。您可以指定 IPv4 或 IPv6 地址。IPv4 或 IPv6 地址中的所有值必须用数字或星号通配符表示。
hostNameIncludeListstring允许在此端点上进行入站连接的主机名的逗号分隔列表。主机名是不区分大小写的,可以星号(用作通配符)开头。但是,不能在主机名中的任何其他位置使用星号。例如,*.abc.com 有效,但 *.abc.* 无效。
hostNameExcludeListstring不允许在此端点上进行入站连接的主机名的逗号分隔列表。主机名是不区分大小写的,可以星号(用作通配符)开头。但是,不能在主机名中的任何其他位置使用星号。例如,*.abc.com 有效,但 *.abc.* 无效。

httpEndpoint > accessLogging

端点的 HTTP 访问日志记录配置。

NameTypeDefaultDescription
enabled布尔型true启用访问日志记录。
filePath文件路径${server.output.dir}/logs/http_access.log访问日志文件的目录路径和名称。指定目录路径时可以使用标准变量替换,如 ${server.output.dir}。
logFormatstring%h %u %{t}W "%r" %s %b指定记录客户机访问信息时使用的日志格式。
maxFileSizeint
Min: 0
20回滚之前日志文件的最大大小,以兆字节计;值为 0 意味着无限制。
maxFilesint
Min: 0
2除去最早的日志文件之前将保留的日志文件的最大数目;值为 0 意味着无限制。

extraConfigProperties

将添加到生成的插件配置文件中 Config 元素的其他属性。IBM 支持人员可指定这些属性来修改 Web 服务器插件的行为。