42.2. 在服务实现中使用上下文

概述

使用 WebServiceContext 接口,将上下文信息提供给服务实施。从 WebServiceContext 对象,您可以获取填充了应用程序范围内当前请求的上下文属性的 MessageContext 对象。您可以操作属性的值,并通过响应链重新传播它们。

注意

MessageContext 接口继承自 java.util.Map 接口。其内容可以通过 Map 接口的方法操作。

获取上下文

要在服务实现中获取信息上下文,请执行以下操作:

  1. 声明类型为 WebServiceContext 的变量。
  2. 使用 javax.annotation.Resource 注解来声明 变量的变量,以指明上下文信息被注入到变量中。
  3. 使用 get MessageContext () 方法从 WebServiceContext 对象获取 MessageContext 对象。

    重要

    getMessageContext() 只能用于解码 @WebMethod 注释的方法。

例 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 “MessageContext.get() 方法” 中显示的 get() 方法访问存储的属性。

例 42.3. MessageContext.get() 方法

v获取对象密钥

注意

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 “MessageContext.put() 方法” 中显示的 put() 方法设置属性和更改现有属性。

例 42.5. MessageContext.put() 方法

vputKkeyVvalueClassCastExceptionIllegalArgumentExceptionNullPointerException

如果消息上下文中已存在属性,put() 方法将现有的值替换为新值,并返回旧值。如果消息上下文中不存在 属性,put() 方法将设置属性并返回 null

例 42.6 “在服务的消息上下文中设置保护” 显示为 HTTP 请求设置响应代码的代码。

例 42.6. 在服务的消息上下文中设置保护

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 “服务实施上下文中可用的属性” 列出服务实施对象中上下文访问的属性。

表 42.1. 服务实施上下文中可用的属性

属性名称描述

org.apache.cxf.message.Message

PROTOCOL_HEADERS[a]

指定传输特定标头信息。该值存储为 java.util.Map<String, List<String>>

RESPONSE_CODE

指定返回到消费者的响应代码。该值保存为 Integer 对象。

ENDPOINT_ADDRESS

指定服务提供商的地址。该值存储为 String

HTTP_REQUEST_METHOD

指定通过请求发送的 HTTP 动词。该值存储为 String

PATH_INFO

指定正在请求的资源的路径。该值存储为 String

该路径是主机名后面和任何查询字符串之前 URI 的部分。例如,如果端点的 URI 为 http://cxf.apache.org/demo/widgets,其路径是 /demo/widgets

QUERY_STRING

指定查询(若有)附加到用于调用请求的 URI。该值存储为 String

查询会显示在 URI 的末尾 .例如,如果向 http://cxf.apache.org/demo/widgets?color 发出请求,则查询为 颜色

MTOM_ENABLED

指定服务提供商是否可以将 MTOM 用于 SOAP 附加。该值存储为 布尔值

SCHEMA_VALIDATION_ENABLED

指定服务提供商是否对 schema 验证消息。该值存储为 布尔值

FAULT_STACKTRACE_ENABLED

指定运行时是否提供堆栈追踪以及故障消息。该值存储为 布尔值

CONTENT_TYPE

指定消息的 MIME 类型。该值存储为 String

BASE_PATH

指定正在请求的资源的路径。该值存储为 java.net.URL

该路径是主机名后面和任何查询字符串之前 URI 的部分。例如,如果端点的 URL 为 http://cxf.apache.org/demo/widgets,基本路径为 /demo/widgets

ENCODING

指定消息的编码。该值存储为 String

FIXED_PARAMETER_ORDER

指定参数是否必须以特定顺序显示在消息中。该值存储为 布尔值

MAINTAIN_SESSION

指定消费者是否希望为将来的请求维护当前会话。该值存储为 布尔值

WSDL_DESCRIPTION

指定定义所实施服务的 WSDL 文档。该值保存为 org.xml.sax.InputSource 对象。

WSDL_SERVICE

指定定义所实施服务的 wsdl:service 元素的限定名称。该值保存为 QName

WSDL_PORT

指定用于定义访问该服务的端点的 wsdl:port 元素的限定名称。该值保存为 QName

WSDL_INTERFACE

指定定义所实施服务的 wsdl:portType 元素的限定名称。该值保存为 QName

WSDL_OPERATION

指定与消费者调用的操作对应的 wsdl:operation 元素的限定名称。该值保存为 QName

javax.xml.ws.handler.MessageContext

MESSAGE_OUTBOUND_PROPERTY

指定消息是否被出站。该值存储为 布尔值true 指定信息是出站的。

INBOUND_MESSAGE_ATTACHMENTS

包含请求消息中包含的任何附件。该值存储为 java.util.Map<String, DataHandler >。

映射的键值是标头的 MIME Content-ID。

OUTBOUND_MESSAGE_ATTACHMENTS

包含响应消息的任何附件。该值存储为 java.util.Map<String, DataHandler >。

映射的键值是标头的 MIME Content-ID。

WSDL_DESCRIPTION

指定定义所实施服务的 WSDL 文档。该值保存为 org.xml.sax.InputSource 对象。

WSDL_SERVICE

指定定义所实施服务的 wsdl:service 元素的限定名称。该值保存为 QName

WSDL_PORT

指定用于定义访问该服务的端点的 wsdl:port 元素的限定名称。该值保存为 QName

WSDL_INTERFACE

指定定义所实施服务的 wsdl:portType 元素的限定名称。该值保存为 QName

WSDL_OPERATION

指定与消费者调用的操作对应的 wsdl:operation 元素的限定名称。该值保存为 QName

HTTP_RESPONSE_CODE

指定返回到消费者的响应代码。该值保存为 Integer 对象。

HTTP_REQUEST_HEADERS

指定请求上的 HTTP 标头。该值存储为 java.util.Map<String, List<String>>

HTTP_RESPONSE_HEADERS

指定响应的 HTTP 标头。该值存储为 java.util.Map<String, List<String>>

HTTP_REQUEST_METHOD

指定通过请求发送的 HTTP 动词。该值存储为 String

SERVLET_REQUEST

包含 servlet 的请求对象。该值存储为 javax.servlet.http.HttpServletRequest

SERVLET_RESPONSE

包含 servlet 的响应对象。该值存储为 javax.servlet.http.HttpResponse

SERVLET_CONTEXT

包含 servlet 的上下文对象。该值存储为 javax.servlet.ServletContext

PATH_INFO

指定正在请求的资源的路径。该值存储为 String

该路径是主机名后面和任何查询字符串之前 URI 的部分。例如,如果端点的 URL 是 http://cxf.apache.org/demo/widgets,其路径是 /demo/widgets

QUERY_STRING

指定查询(若有)附加到用于调用请求的 URI。该值存储为 String

查询会显示在 URI 的末尾 .例如,如果向 http://cxf.apache.org/demo/widgets?color 发出请求,则查询字符串为 颜色

REFERENCE_PARAMETERS

指定 WS-Addressing 参考参数。这包括其 wsa:IsReferenceParameter 属性设为 true 的所有 SOAP 标头。该值存储为 java.util.List

org.apache.cxf.transport.jms.JMSConstants

JMS_SERVER_HEADERS

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

[a] 使用 HTTP 此属性时,与标准 JAX-WS 定义的属性相同。