WebService (Java Platform SE 6) - JavaTM 2 Platform Standard Edition 6.0 API 规范中文版

概述

软件包

类

使用

树

已过时

索引

帮助

Java^TM Platform
Standard Ed. 6

上一个类 下一个类

框架 无框架

摘要：必需 | 可选

详细信息：元素

javax.jws
注释类型 WebService

@Retention(value=RUNTIME) @Target(value=TYPE) public @interface WebService

将 Java 类标记为实现 Web Service，或者将 Java 接口标记为定义 Web Service 接口。

可选元素摘要

String endpointInterface
          定义服务抽象 Web Service 协定的服务端点接口的完整名称。

String name
          Web Service 的名称。

String portName
          Web Service 的端口名称。

String serviceName
          Web Service 的服务名称。

String targetNamespace
          如果 @WebService.targetNamespace 注释是关于某一服务端点接口的，则 targetNamespace 用于 wsdl:portType（以及关联的 XML 元素）的名称空间。

String wsdlLocation
          描述服务的预定义 WSDL 的位置。

可选元素摘要
`String`	`endpointInterface` 定义服务抽象 Web Service 协定的服务端点接口的完整名称。
`String`	`name` Web Service 的名称。
`String`	`portName` Web Service 的端口名称。
`String`	`serviceName` Web Service 的服务名称。
`String`	`targetNamespace` 如果 @WebService.targetNamespace 注释是关于某一服务端点接口的，则 targetNamespace 用于 wsdl:portType（以及关联的 XML 元素）的名称空间。
`String`	`wsdlLocation` 描述服务的预定义 WSDL 的位置。

name

public abstract String name

Web Service 的名称。

当映射到 WSDL 1.1 时，该名称被用作 wsdl:portType 的名称。

默认值：: ""

targetNamespace

public abstract String targetNamespace

如果 @WebService.targetNamespace 注释是关于某一服务端点接口的，则 targetNamespace 用于 wsdl:portType（以及关联的 XML 元素）的名称空间。

如果 @WebService.targetNamespace 注释是关于某个没有引用服务端点接口（通过 endpointInterface 属性）的服务实现 bean 的，则 targetNamespace 既可以用于 wsdl:portType 也可以用于 wsdl:service（以及关联的 XML 元素）。

如果 @WebService.targetNamespace 注释是关于某个引用服务端点接口（通过 endpointInterface 属性）的服务实现 bean 的，则 targetNamespace 仅用于 wsdl:service（以及关联的 XML 元素）。

默认值：: ""

serviceName

public abstract String serviceName

Web Service 的服务名称。

当映射到 WSDL 1.1 时，此名称被用作 wsdl:service 的名称。

不允许在端点接口上使用此成员值。

默认值：: ""

portName

public abstract String portName

Web Service 的端口名称。

当映射到 WSDL 1.1 时，此名称被用作 wsdl:port 的名称。

不允许在端点接口上使用此成员值。

从以下版本开始：: 2.0

默认值：: ""

wsdlLocation

public abstract String wsdlLocation

描述服务的预定义 WSDL 的位置。

wsdlLocation 是引用预先存在的 WSDL 文件的 URL（相对或绝对）。wsdlLocation 值的存在指示服务实现 bean 将实现预先定义的 WSDL 协定。如果服务实现 bean 与此 WSDL 中声明的 portType 和绑定不一致，则 JSR-181 工具必须提供反馈。注意，单个 WSDL 文件可能包含多个 portType 和多个绑定。服务实现 bean 上的注释确定对应于 Web Service 的特定 portType 和绑定。

默认值：: ""

endpointInterface

public abstract String endpointInterface

定义服务抽象 Web Service 协定的服务端点接口的完整名称。

此注释允许开发人员将接口协定与实现分离。如果此注释存在，则使用服务端点接口来确定抽象 WSDL 协定（portType 和绑定）。服务端点接口可以包含用来定制 Java 到 WSDL 的映射关系的 JSR-181 注释。
服务实现 bean 可以实现服务端点接口，但并不要求这样做。
如果此成员值不存在，则 Web Service 协定是根据服务实现 bean 上的注释生成的。如果目标环境需要一个服务端点接口，则将生成一个由实现定义的包，该包具有由实现定义的名称。

不允许在端点接口上使用此成员值。