42.3. 在消费者实现中使用上下文

概述

消费者实施可以通过 BindingProvider 接口访问上下文信息。BindingProvider 实例在两个独立上下文中保存上下文信息：

  • 请求上下文 请求上下文 允许您设置影响出站消息的属性。请求上下文属性应用到特定的端口实例，一旦设置，属性将影响端口上进行的每个后续操作调用，直到明确清除了属性等时间。例如，您可以使用请求上下文属性来设置连接超时，或者初始化在标头中发送的数据。
  • 响应上下文 响应上下文 允许您读取对从当前线程发出的最后一个操作调用的响应设置的属性值。响应上下文属性会在每个操作调用后重置。例如，您可以访问响应上下文属性来读取从最后入站消息接收的标头信息。
重要

只有放置在消息上下文的应用范围内的信息才可以被消费者实施访问。

获取上下文

使用 javax.xml.ws.BindingProvider 接口获取上下文。BindingProvider 接口有两种方法来获取上下文：

  • getRequestContext()getRequestContext （） 方法（如 例 42.7 “getRequestContext （） 方法” 所示）将请求上下文返回为 Map 对象。返回的 map 对象可以直接操作上下文的内容。

    例 42.7. getRequestContext （） 方法

    Map<String, Object>getRequestContext

  • getResponseContext()getResponseContext （） （如 例 42.8 “getResponseContext （） 方法” 所示）将响应上下文返回为 Map 对象。返回的 Map 对象的内容反映了响应上下文内容（来自当前线程中提出的远程服务最近一次成功请求）的状态。

    例 42.8. getResponseContext （） 方法

    map<String, Object&gt;getResponseContext

由于代理对象实施 BindingProvider 接口，因此可通过多播代理对象来获取 BindingProvider 对象。从 BindingProvider 对象获取的上下文仅对用于创建它的代理对象上调用的操作才有效。

例 42.9 “获取消费者的 Request 上下文” 显示为代理获取请求上下文的代码。

例 42.9. 获取消费者的 Request 上下文

// Proxy widgetProxy obtained previously
BindingProvider bp = (BindingProvider)widgetProxy;
Map<String, Object> requestContext = bp.getRequestContext();

从上下文读取属性

消费者上下文存储在 java.util.Map<String, Object> 对象中。映射具有包含任意对象的 String 对象和值的键。使用 java.util.Map.get （） 访问响应上下文属性映射中的条目。

要检索特定上下文属性，请 context PropertyName，使用 例 42.10 “阅读 Response Context Property” 中显示的代码。

例 42.10. 阅读 Response Context Property

// Invoke an operation.
port.SomeOperation();

// Read response context property.
java.util.Map<String, Object> responseContext =
  ((javax.xml.ws.BindingProvider)port).getResponseContext();
PropertyType propValue = (PropertyType) responseContext.get(ContextPropertyName);

在上下文中设置属性

使用者上下文是存储在 java.util.Map<String、Object > 对象中的哈希上下文。映射具有任意对象的 String 对象和值的键。要在上下文中设置属性，请使用 java.util.Map.put （） 方法。

虽然您可以在请求上下文和响应上下文中设置属性，但只有对请求上下文进行的更改对消息处理产生任何影响。当每个远程调用在当前线程上完成时，会重置响应上下文中的属性。

例 42.11 “设置 Request Context Property” 中显示的代码通过设置 BindingProvider.ENDPOINT_ADDRESS_PROPERTY 的值来更改目标服务提供商的地址。

例 42.11. 设置 Request Context Property

// Set request context property.
java.util.Map<String, Object> requestContext =
     ((javax.xml.ws.BindingProvider)port).getRequestContext();
requestContext.put(BindingProvider.ENDPOINT_ADDRESS_PROPERTY, "http://localhost:8080/widgets");

// Invoke an operation.
port.SomeOperation();
重要

在请求上下文中设置了一个属性后，其值将用于所有后续远程调用。您可以更改值，然后将使用 changed 值。

支持的上下文

Apache CXF 在消费者实现中支持以下上下文属性：

表 42.2. 使用者上下文属性

属性名称描述

javax.xml.ws.BindingProvider

ENDPOINT_ADDRESS_PROPERTY

指定目标服务的地址。该值保存为 String。

USERNAME_PROPERTY[a]

指定用于 HTTP 基本身份验证的用户名。该值保存为 String。

PASSWORD_PROPERTY[b]

指定用于 HTTP 基本身份验证的密码。该值保存为 String。

SESSION_MAINTAIN_PROPERTY[c]

指定客户端是否希望维护会话信息。该值保存为 布尔值 对象。

org.apache.cxf.ws.addressing.JAXWSAConstants

CLIENT_ADDRESSING_PROPERTIES

指定使用者用来联系所需服务提供商的 WS-Addressing 信息。该值保存为 org.apache.cxf.ws.addressing.AddressingProperties。

org.apache.cxf.transports.jms.context.JMSConstants

JMS_CLIENT_REQUEST_HEADERS

包含消息的 JMS 标头。更多信息请参阅 第 42.4 节 “使用 JMS 消息属性”。

[a] 此属性会被 HTTP 安全设置中定义的用户名覆盖。
[b] 此属性会被 HTTP 安全设置中定义的密码覆盖。
[c] Apache CXF 忽略此属性。