42.2. 在服务实现中使用上下文
概述
使用 WebServiceContext 接口的服务实施提供了上下文信息。从 WebServiceContext 对象,您可以获取一个 MessageContext
对象,该对象使用应用程序范围内当前请求的上下文属性填充。您可以操作属性的值,它们通过响应链来回送。
MessageContext 接口从 java.util.Map 接口继承。其内容可以使用 Map 接口的方法来操作。
获取上下文
要在服务实现中获取消息上下文,请执行以下操作:
例 42.2 “在服务实现中获取上下文对象” 显示获取上下文对象的代码。
例 42.2. 在服务实现中获取上下文对象
import javax.xml.ws.*; import javax.xml.ws.handler.*; import javax.annotation.*; @WebServiceProvider public class WidgetServiceImpl { @Resource WebServiceContext wsc; @WebMethod public String getColor(String itemNum) { MessageContext context = wsc.getMessageContext(); } ... }
从上下文读取属性
获取用于实现的 MessageContext 对象后,您可以使用 例 42.3 “The MessageContext.get()
Method” 中显示的 get ()
方法访问存储的属性。
例 42.3. The MessageContext.get()
Method
v
get
Object
key
这个 get ()
从 Map 接口继承。
key
参数是代表您要从上下文检索的属性的字符串。get ()
返回必须广播到 属性的正确类型的对象。表 42.1 “服务实施上下文中可用的属性” 列出服务实施上下文中可用的很多属性。
更改从上下文返回的对象值也会更改上下文中 属性的值。
例 42.4 “从服务的消息上下文获取属性” 显示获取代表调用操作的 WSDL 操作
元素的名称的代码。
例 42.4. 从服务的消息上下文获取属性
import javax.xml.ws.handler.MessageContext; import org.apache.cxf.message.Message; ... // MessageContext context retrieved in a previous example QName wsdl_operation = (QName)context.get(Message.WSDL_OPERATION);
在上下文中设置属性
获取用于实现的 MessageContext 对象后,您可以使用 例 42.5 “The MessageContext.put()
Method” 中显示的 put ()
方法设置属性并更改现有属性。
例 42.5. The MessageContext.put()
Method
v
将
K
键
V
value
ClassCastExceptionIllegalArgumentExceptionNullPointerException
如果在消息上下文中已存在要设置的属性,put ()
方法将现有的值替换为新值,并返回旧值。如果消息上下文中不存在 属性,则 put ()
方法设置 属性并返回 null
。
例 42.6 “在服务的消息上下文中设置 Property” 显示用于为 HTTP 请求设置响应代码的代码。
例 42.6. 在服务的消息上下文中设置 Property
import javax.xml.ws.handler.MessageContext; import org.apache.cxf.message.Message; ... // MessageContext context retrieved in a previous example context.put(Message.RESPONSE_CODE, new Integer(404));
支持的上下文
表 42.1 “服务实施上下文中可用的属性” 列出可通过服务实施对象中的上下文访问的属性。
属性名称 | 描述 |
---|---|
| |
PROTOCOL_HEADERS[a] |
指定特定于传输的标头信息。该值保存为 |
RESPONSE_CODE |
指定返回到使用者的响应代码。该值保存为 |
ENDPOINT_ADDRESS |
指定服务提供程序的地址。该值保存为 |
HTTP_REQUEST_METHOD |
指定通过请求发送的 HTTP 动词。该值保存为 |
PATH_INFO |
指定请求的资源的路径。该值保存为
该路径是主机名之后的 URI 部分,在任何查询字符串之前。例如,如果端点的 URI 是 http://cxf.apache.org/demo/widgets,则路径为 |
QUERY_STRING |
指定查询(若有)附加到用于调用请求的 URI。该值保存为
查询在 URI 的末尾出现在 |
MTOM_ENABLED |
指定服务供应商是否可以将 MTOM 用于 SOAP 附加。该值保存为 |
SCHEMA_VALIDATION_ENABLED |
指定服务提供商是否针对 schema 验证消息。该值保存为 |
FAULT_STACKTRACE_ENABLED |
指定运行时是否提供堆栈追踪以及出错信息。该值保存为 |
CONTENT_TYPE |
指定消息的 MIME 类型。该值保存为 |
BASE_PATH |
指定请求的资源的路径。该值保存为
该路径是主机名之后的 URI 部分,在任何查询字符串之前。例如,如果端点的 URL 是 http://cxf.apache.org/demo/widgets 基础路径为 |
编码 |
指定消息的编码。该值保存为 |
FIXED_PARAMETER_ORDER |
指定参数是否必须以特定顺序显示。该值保存为 |
MAINTAIN_SESSION |
指定消费者是否希望为将来的请求维护当前会话。该值保存为 |
WSDL_DESCRIPTION |
指定定义所实施服务的 WSDL 文档。该值保存为 |
WSDL_SERVICE |
指定定义正在实施服务的 |
WSDL_PORT |
指定定义用于访问服务的端点的 |
WSDL_INTERFACE |
指定定义正在实施服务的 |
WSDL_OPERATION |
指定 |
| |
MESSAGE_OUTBOUND_PROPERTY |
指定消息是否出站。该值保存为 |
INBOUND_MESSAGE_ATTACHMENTS |
包含请求消息中包含的任何附件。该值保存为 映射的键值是标头的 MIME Content-ID。 |
OUTBOUND_MESSAGE_ATTACHMENTS |
包含响应消息的任何附件。该值保存为 映射的键值是标头的 MIME Content-ID。 |
WSDL_DESCRIPTION |
指定定义所实施服务的 WSDL 文档。该值保存为 |
WSDL_SERVICE |
指定定义正在实施服务的 |
WSDL_PORT |
指定定义用于访问服务的端点的 |
WSDL_INTERFACE |
指定定义正在实施服务的 |
WSDL_OPERATION |
指定 |
HTTP_RESPONSE_CODE |
指定返回到使用者的响应代码。该值保存为 |
HTTP_REQUEST_HEADERS |
指定请求的 HTTP 标头。该值保存为 |
HTTP_RESPONSE_HEADERS |
指定响应的 HTTP 标头。该值保存为 |
HTTP_REQUEST_METHOD |
指定通过请求发送的 HTTP 动词。该值保存为 |
SERVLET_REQUEST |
包含 servlet 的请求对象。该值保存为 |
SERVLET_RESPONSE |
包含 servlet 的响应对象。该值保存为 |
SERVLET_CONTEXT |
包含 servlet 的上下文对象。该值保存为 |
PATH_INFO |
指定请求的资源的路径。该值保存为
该路径是主机名之后的 URI 部分,在任何查询字符串之前。例如,如果端点的 URL 是 http://cxf.apache.org/demo/widgets 路径为 |
QUERY_STRING |
指定查询(若有)附加到用于调用请求的 URI。该值保存为
查询在 URI 的末尾出现在 |
REFERENCE_PARAMETERS |
指定 WS-Addressing 参考参数。这包括其 |
| |
JMS_SERVER_HEADERS | 包含 JMS 消息标头。更多信息请参阅 第 42.4 节 “使用 JMS 消息属性”。 |
[a]
使用 HTTP 此属性时,与标准 JAX-WS 定义的属性相同。
|