JavaTM 2 Platform
Standard Ed. 6

javax.jws
注释类型 WebParam


@Retention(value=RUNTIME)
@Target(value=PARAMETER)
public @interface WebParam

定制单个参数到 Web Service 消息部分和 XML 元素的映射关系。


可选元素摘要
 boolean header
          如果为 true,则参数是从消息头而不是消息正文获取的。
 WebParam.Mode mode
          参数的流向(IN、OUT 或 INOUT 之一)。
 String name
          参数名称。
 String partName
          表示此参数的 wsdl:part 的名称。
 String targetNamespace
          参数的 XML 名称空间。
 

name

public abstract String name
参数名称。

如果该操作是 rpc 样式的,并且尚未指定 @WebParam.partName,则此名称是表示参数的 wsdl:part 的名称。
如果该操作是文档样式的,或者参数映射到某一个头,则此名称是表示参数的 XML 元素的本地名称。

如果操作是文档样式的,参数样式为 BARE 并且模式为 OUT 或 INOUT,则必须指定一个名称。

默认值:
""

partName

public abstract String partName
表示此参数的 wsdl:part 的名称。

此名称仅在操作是 rpc 样式,或者操作是文档样式且参数样式为 BARE 时使用。

从以下版本开始:
2.0
默认值:
""

targetNamespace

public abstract String targetNamespace
参数的 XML 名称空间。

仅在操作是文档样式或者参数映射到某一个头时使用。如果目标名称空间被设置为 "",则此名称空间表示空名称空间。

默认值:
""

mode

public abstract WebParam.Mode mode
参数的流向(IN、OUT 或 INOUT 之一)。

OUT 和 INOUT 模式只是为那些符合 Holder 类型定义(JAX-WS 2.0 [5] 的第 2.3.3 节)的参数类型所指定的。Holder 类型的参数必须为 OUT 或 INOUT。

默认值:
javax.jws.WebParam.Mode.IN

header

public abstract boolean header
如果为 true,则参数是从消息头而不是消息正文获取的。

默认值:
false

JavaTM 2 Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java 2 SDK SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2004 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策