WebService (Java EE 5)

Java EE API


javax.jws Annotation Type WebService


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

Implements: Annotation
@Retention(value=RUNTIME)
@Target(value=TYPE)

将 Java 类标记为实现 Web Service,或者将 Java 接口标记为定义 Web Service 接口。
英文文档:

Marks a Java class as implementing a Web Service, or a Java interface as defining a Web Service interface.

Author:
Copyright (c) 2004 by BEA Systems, Inc. All Rights Reserved.

Optional Element Summary
 String
 String
 String
 String
 String
 String
 

abstract public String name()
Web Service 的名称。

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

specdefault Java 类或接口的简单名称。

英文文档:

name

public abstract String name
The name of the Web Service.

Used as the name of the wsdl:portType when mapped to WSDL 1.1.

Default:
""

abstract public 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 元素)。

specdefault 随实现而定,正如 JAX-WS 2.0 [5] 第 3.2 节中描述的那样。

英文文档:

targetNamespace

public abstract String targetNamespace
If the @WebService.targetNamespace annotation is on a service endpoint interface, the targetNamespace is used for the namespace for the wsdl:portType (and associated XML elements).

If the @WebService.targetNamespace annotation is on a service implementation bean that does NOT reference a service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for both the wsdl:portType and the wsdl:service (and associated XML elements).

If the @WebService.targetNamespace annotation is on a service implementation bean that does reference a service endpoint interface (through the endpointInterface attribute), the targetNamespace is used for only the wsdl:service (and associated XML elements).

Default:
""

abstract public String serviceName()
Web Service 的服务名称。

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

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

specdefault Java class + Service 的简单名称。

英文文档:

serviceName

public abstract String serviceName
The service name of the Web Service.

Used as the name of the wsdl:service when mapped to WSDL 1.1.

This member-value is not allowed on endpoint interfaces.

Default:
""

abstract public String portName()
Web Service 的端口名称。

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

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

specdefault
@WebService.name+?Port?.
since2.0

英文文档:

portName

public abstract String portName
The port name of the Web Service.

Used as the name of the wsdl:port when mapped to WSDL 1.1.

This member-value is not allowed on endpoint interfaces.

Since:
2.0
Default:
""

abstract public String wsdlLocation()
描述服务的预定义 WSDL 的位置。

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

英文文档:

wsdlLocation

public abstract String wsdlLocation
The location of a pre-defined WSDL describing the service.

The wsdlLocation is a URL (relative or absolute) that refers to a pre-existing WSDL file. The presence of a wsdlLocation value indicates that the service implementation bean is implementing a pre-defined WSDL contract. The JSR-181 tool MUST provide feedback if the service implementation bean is inconsistent with the portType and bindings declared in this WSDL. Note that a single WSDL file might contain multiple portTypes and multiple bindings. The annotations on the service implementation bean determine the specific portType and bindings that correspond to the Web Service.

Default:
""

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

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

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

英文文档:

endpointInterface

public abstract String endpointInterface
The complete name of the service endpoint interface defining the service?s abstract Web Service contract.

This annotation allows the developer to separate the interface contract from the implementation. If this annotation is present, the service endpoint interface is used to determine the abstract WSDL contract (portType and bindings). The service endpoint interface MAY include JSR-181 annotations to customize the mapping from Java to WSDL.
The service implementation bean MAY implement the service endpoint interface, but is not REQUIRED to do so.
If this member-value is not present, the Web Service contract is generated from annotations on the service implementation bean. If a service endpoint interface is required by the target environment, it will be generated into an implementation-defined package with an implementation- defined name

This member-value is not allowed on endpoint interfaces.

Default:
""


Submit a bug or feature

Copyright 2007 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.

一看就知道只有菜鸟才干这么无知的事啦。

PS : 未经我党受权你也可自由散发此文档。 如有任何错误请自行修正;若因此而造成任何损失请直接找人民主席,请勿与本人联系。谢谢!