12.2. 配置一个消费者


12.2.1. HTTP Consumer Endpoints 的机制

HTTP 消费者端点可以指定很多 HTTP 连接属性,包括端点是否自动接受重定向响应,端点是否可以使用块,端点是否会请求持久的,端点如何与代理交互。除了 HTTP 连接属性外,HTTP 使用者端点还可指定保护方法。

消费者端点可以使用以下两种机制进行配置:

12.2.2. 使用配置

命名空间

用于配置 HTTP 消费者端点的元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素,您必须将 例 12.4 “HTTP Consumer 配置命名空间” 中显示的行添加到端点配置文件的 Bean 元素中。另外,您必须将配置元素的命名空间添加到 xsi:schemaLocation 属性中。

例 12.4. HTTP Consumer 配置命名空间

<beans ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       ...
       xsi:schemaLocation="...
                           http://cxf.apache.org/transports/http/configuration
                              http://cxf.apache.org/schemas/configuration/http-conf.xsd
                          ...">

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

conduit 元素

您可以使用 http-conf:conduit 元素及其子项来配置 HTTP consumer 端点。http-conf:conduit 元素使用单个属性名称,用于指定与端点对应的 WSDL 端口 元素。name 属性的值采用 portQName'.http-conduit' 的形式。例 12.5 “http-conf:conduit Element” 显示 http-conf:conduit 元素,用于为 WSDL 片段 < port binding="widgetSOAPBinding" name="widgetSOAPPort& gt; 指定的端点添加配置。

例 12.5. http-conf:conduit Element

...
  <http-conf:conduit name="{http://widgets/widgetvendor.net}widgetSOAPPort.http-conduit">
    ...
  </http-conf:conduit>
...

http-conf:conduit 元素含有指定配置信息的子元素。它们在 表 12.1 “用于配置 HTTP Consumer Endpoint 的元素” 中进行了说明。

表 12.1. 用于配置 HTTP Consumer Endpoint 的元素
element描述

http-conf:client

指定 HTTP 连接属性,如超时、保留请求、内容类型等。请参阅 “client 元素”一节

http-conf:authorization

指定用于配置端点预先使用的基本身份验证方法的参数。首选的方法是提供 http-conf:basicAuthSupplier 对象。

http-conf:proxyAuthorization

指定用于为传出 HTTP 代理服务器配置基本身份验证的参数。

http-conf:tlsClientParameters

指定用于配置 SSL/TLS 的参数。

http-conf:basicAuthSupplier

指定提供端点使用的基本身份验证信息的对象 bean 引用或类名称,可抢占或响应 401 HTTP 质询。

http-conf:trustDecider

指定对象的 bean 引用或类名称,用于检查 HTTP (S) URLConnection 对象,以便在传输任何信息前建立与 HTTPS 服务提供商的连接的信任。

client 元素

http-conf:client 元素用于配置消费者端点 HTTP 连接的非安全属性。其属性(如 表 12.2 “HTTP Consumer Configuration Attributes” 所述)指定连接的属性。

表 12.2. HTTP Consumer Configuration Attributes
属性描述

ConnectionTimeout

指定消费者在连接超时前尝试建立连接的时间长度(以毫秒为单位)。默认值为 30000

0 指定使用者将继续无限期地发送请求。

ReceiveTimeout

指定消费者在超时前等待响应的时间长度(以毫秒为单位)。默认值为 30000

0 指定使用者将无限期等待。

AutoRedirect

指定消费者是否会自动遵循服务器发出的重定向。默认值为 false

MaxRetransmits

指定消费者要重新传输请求以满足重定向的次数上限。默认值为 -1,指定允许无限重新传输。

AllowChunking

指定消费者是否使用块发送请求。默认值为 true,指定消费者在发送请求时将使用块。

如果以下条件之一为 true,则无法使用块:

  • http-conf:basicAuthSupplier 配置为立即提供凭证。
  • AutoRedirect 设置为 true

在这两种情况下,AllowChunking 的值都被忽略,块会被禁止。

accept

指定消费者准备处理哪些媒体类型。该值用作 HTTP Accept 属性的值。属性的值使用多用途互联网邮件扩展(MIME)类型来指定。

AcceptLanguage

指定接收响应时使用者喜欢的语言(例如,美国英语)。该值用作 HTTP AcceptLanguage 属性的值。

语言标签由标准(ISO)国际组织规定,通常通过组合语言代码(由 ISO-639 标准决定)和国家/地区代码(由 ISO-3166 标准决定)由 ISO-3166 标准决定,由连字符分开。例如,De-US 代表美国英语。

AcceptEncoding

指定消费者已准备好处理的内容编码。内容编码标签由互联网编号授权机构(IANA)规定。该值用作 HTTP AcceptEncoding 属性的值。

ContentType

指定消息正文中发送数据的介质类型。介质类型使用多用途的互联网邮件扩展(MIME)类型来指定。该值用作 HTTP ContentType 属性的值。默认为 text/xml

对于 Web 服务,这应设置为 text/xml。如果客户端正在向 CGI 脚本发送 HTML 表单数据,则应该将其设置为 application/x-www-form-urlencoded。如果 HTTP POST 请求绑定到固定有效负载格式(与 SOAP 不同),则内容类型通常设置为 application/octet-stream

主机

指定请求被调用的资源的互联网主机和端口号。该值用作 HTTP Host 属性的值。

通常不需要此属性。只有某些 DNS 场景或应用程序设计才需要它。例如,它指示了集群客户端首选的主机(即,用于虚拟服务器映射到相同的互联网协议(IP)地址)。

连接

指定在每个请求/响应对话框后,是否保持打开或关闭特定连接。有两个有效值:

  • keep-Alive - 指定消费者希望连接在初始请求/响应序列后保持打开状态。如果服务器符合它,则连接将保持打开状态,直到使用者关闭为止。
  • 关闭(默认)- 指定在每个请求/响应序列后关闭到服务器的连接。

CacheControl

指定有关通过链中涉及缓存的缓存遵守行为的指令,这些指令由来自消费者到服务提供商的请求组成。请参阅 第 12.2.4 节 “消费者缓存控制指令”

cookie

指定与所有请求一起发送的静态 Cookie。

BrowserType

指定请求源自的浏览器的信息。在 World Wide Web consortium (W3C)的 HTTP 规格中,这也被称为 user-agent。某些服务器根据发送请求的客户端进行优化。

推荐程序

指定定向到消费者在特定服务上发出请求的资源的 URL。该值用作 HTTP 推荐 属性的值

当请求是浏览器用户点击超链接而不是输入 URL 时,会使用此 HTTP 属性。这可允许服务器根据之前的任务流优化处理,并为日志、优化缓存、跟踪过时或错误类型链路等目的生成后端链接列表。但是,它通常在 Web 服务应用程序中使用。

如果 AutoRedirect 属性设置为 true,并且请求被重定向,则 refer er 属性中指定的任何值都会被覆盖。HTTP Referer 属性的值设置为重定向使用者原始请求的服务的 URL。

DecoupledEndpoint

指定在一个单独的 provider→consumer 连接中接收响应的分离端点的 URL。有关使用分离端点的更多信息,请参阅 第 12.6 节 “在拒绝模式中使用 HTTP 传输”

您必须配置使用者端点和服务供应商端点,以使用 WS-Addressing 分离端点才能工作。

ProxyServer

指定路由请求的代理服务器的 URL。

ProxyServerPort

指定路由请求的代理服务器的端口号。

ProxyServerType

指定用于路由请求的代理服务器的类型。有效值为:

  • HTTP(默认)
  • SOCKS

示例

例 12.6 “HTTP Consumer Endpoint 配置” 显示要保持与请求间打开的 HTTP 消费者端点的配置,该端点只会在每次调用一次重新传输请求,且无法使用块流。

例 12.6. HTTP Consumer Endpoint 配置

<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"
       xsi:schemaLocation="http://cxf.apache.org/transports/http/configuration
                             http://cxf.apache.org/schemas/configuration/http-conf.xsd
                           http://www.springframework.org/schema/beans
                             http://www.springframework.org/schema/beans/spring-beans.xsd">

  <http-conf:conduit name="{http://apache.org/hello_world_soap_http}SoapPort.http-conduit">
    <http-conf:client Connection="Keep-Alive"
                      MaxRetransmits="1"
                      AllowChunking="false" />
  </http-conf:conduit>
</beans>

更多信息

有关 HTTP conduits 的更多信息,请参阅 第 16 章 conduits

12.2.3. 使用 WSDL

命名空间

用于配置 HTTP 消费者端点的 WSDL 扩展元素在命名空间 http://cxf.apache.org/transports/http/configuration 中定义。通常会使用前缀 http-conf 来引用。要使用 HTTP 配置元素,您必须将 例 12.7 “HTTP Consumer WSDL 元素的命名空间” 中显示的行添加到端点 WSDL 文档中的 定义 元素中。

例 12.7. HTTP Consumer WSDL 元素的命名空间

<definitions ...
       xmlns:http-conf="http://cxf.apache.org/transports/http/configuration"

Undertow 运行时或 Netty 运行时

您可以使用 http-conf 命名空间中的元素来配置 Undertow 运行时或 Netty 运行时。

client 元素

http-conf:client 元素用于指定 WSDL 文档中的 HTTP 消费者的连接属性。http-conf:client 元素是 WSDL 端口 元素的子级。它具有与配置文件中使用的 client 元素相同的属性。属性在 表 12.2 “HTTP Consumer Configuration Attributes” 中描述。

示例

例 12.8 “WSDL 配置 HTTP Consumer 端点” 显示 WSDL 片段,用于配置 HTTP 消费者端点来指定它与缓存交互。

例 12.8. WSDL 配置 HTTP Consumer 端点

<service ... >
  <port ... >
    <soap:address ... />
    <http-conf:client CacheControl="no-cache" />
  </port>
</service>

12.2.4. 消费者缓存控制指令

表 12.3 “http-conf:client Cache Control Directives” 列出 HTTP 使用者支持的缓存控制指令。

表 12.3. http-conf:client Cache Control Directives
指令行为

no-cache

缓存无法使用特定的响应来满足后续请求,而不必先评估服务器响应。如果使用此值指定特定的响应标头字段,则限制仅适用于响应中的这些标头字段。如果没有指定响应标头字段,这个限制将应用到整个响应。

no-store

缓存不得存储响应的任何部分或调用它的请求的任何部分。

max-age

消费者可以接受其年龄不超过指定时间(以秒为单位)的响应。

max-stale

用户可以接受超过其过期时间的回复。如果一个值被分配到 max-stale,它代表响应的过期时间之外的秒数,使用者仍然可以接受该响应。如果没有分配值,使用者可以接受任何年龄的过时响应。

min-fresh

消费者希望获得至少指定秒数代表的回复。

no-transform

缓存不得在提供程序和消费者之间修改内容的介质类型或位置。

only-if-cached

缓存应仅返回当前存储在缓存中的响应,且不需要重新加载或撤销响应。

cache-extension

指定其他缓存指令的额外扩展。扩展可以是信息或行为。在标准指令上下文中指定了扩展指令,以便不了解扩展指令的应用程序可以遵循标准 指令强制的行为。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.