JAX-WS 2.2规约解析--Annotations Defined by JSR-181

JAX-WS 2.0中使用了一些在JSR-181中定义的注释。

 

1. javax.jws.WebService

@Target({TYPE}) public @interface WebService { String name() default ""; String targetNamespace() default ""; String serviceName() default ""; String wsdlLocation() default ""; String endpointInterface() default ""; String portName() default ""; };

 

说明：

当实现 Web Service 时，@WebService 注释标记 Java 类。实现Web Service 接口时，标记服务端点接口（SEI）。

要点：

• 实现 Web Service 的 Java 类必须指定 @WebService 或 @WebServiceProvider 注释。不能同时提供这两种注释。此注释适用于客户机/服务器 SEI 或 JavaBeans 端点的服务器端点实现类。

• 如果注释通过 endpointInterface 属性引用了某个 SEI，那么还必须使用 @WebService注释来注释该 SEI。

属性：

名称	说明	数据类型
name	wsdl:portType 的名称。缺省值为 Java 类或接口的非限定名称。	String
targetNamespace	指定从 Web Service 生成的 WSDL 和 XML 元素的 XML 命名空间。缺省值为从包含该 Web Service 的包名映射的命名空间。	String
serviceName	指定 Web Service 的服务名称：wsdl:service。缺省值为 Java 类的简单名称 + Service。	String
serviceName	指定 Web Service 的服务名称：wsdl:service。缺省值为 Java 类的简单名称 + Service。	String
endpointInterface	指定用于定义服务的抽象 Web Service 约定的服务端点接口的限定名。如果指定了此限定名，那么会使用该服务端点接口来确定抽象 WSDL 约定。	String
portName	wsdl:portName。缺省值为 WebService.name+Port。	String
wsdlLocation	指定用于定义 Web Service 的 WSDL 文档的 Web 地址。Web 地址可以是相对路径或绝对路径。	String

 

2.javax.jws.WebMethod

@Target({METHOD}) public @interface WebMethod { String operationName() default ""; String action() default "" ; boolean exclude() default false; };

 

 

说明：

@WebMethod 注释表示此为一个Web Service的操作方法。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于JavaBeans 端点的服务器端点实现类。

要点：

• 仅支持在使用 @WebService 注释来注释的类上使用 @WebMethod 注释。

属性：

名称	说明	数据类型
operationName	指定与此方法相匹配的 wsdl:operation 的名称。缺省值为 Java 方法的名称。	String
action	定义此操作的行为。对于 SOAP 绑定，此值将确定 SOAPAction 头的值。缺省值为 Java 方法的名称。	String
exclude	指定是否从 Web Service 中排除某一方法。缺省值为 false。	Boolean

 

 

3.javax.jws.OneWay

@Target({METHOD}) public @interface Oneway { };

 

说明

@Oneway 注释将一个方法表示为只有输入消息而没有输出消息的 Web Service单向操作。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于 JavaBeans 端点的服务器端点实现类。

4.javax.jws.WebParam

@Target({PARAMETER}) public @interface WebParam { public enum Mode { IN, OUT, INOUT }; String name() default ""; String targetNamespace() default ""; Mode mode() default Mode.IN; boolean header() default false; String partName() default "";  };

 

说明：

@WebParam 注释用于定制从单个参数至 Web Service 消息部件和 XML 

元素的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，

或者应用于 JavaBeans 端点的服务器端点实现类。

属性：

名称	说明	数据类型
name	参数的名称。如果操作是远程过程调用（RPC）类型并且未指定 partName 属性，那么这是用于表示参数的 wsdl:part 属性的名称。如果操作是文档类型或者参数映射至某个头，那么 -name 是用于表示该参数的 XML 元素的局部名称。如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT，那么必须指定此属性。	String
partName	定义用于表示此参数的 wsdl:part 属性的名称。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。	String
targetNamespace	指定参数的 XML 元素的 XML 名称空间。当属性映射至 XML 元素时，仅应用于文档绑定。缺省值为 StringWeb Service 的 targetNamespace。
mode	此值表示此方法的参数流的方向。有效值为 IN、INOUT 和 OUT。	String
header	指定参数是在消息头还是消息体中。缺省值为 false。	Booealn

 

 

5.javax.jws.WebResult

@Target({METHOD}) public @interface WebResult { String name() default "return"; String targetNamespace() default ""; boolean header() default false; String partName() default ""; };

 

说明: 

@WebResult 注释用于定制从返回值至 WSDL 部件或 XML 元素的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的方法，或者应用于JavaBeans 端点的服务器端点实现类。

属性：

名称	说明	数据类型
name	当返回值列示在 WSDL 文件中并且在连接上的消息中找到该返回值时，指定该返回值的名称。对于 RPC 绑定，这是用于表示返回值的 wsdl:part 属性的名称。对于文档绑定，-name 参数是用于表示返回值的 XML 元素的局部名。对于 RPC 和 DOCUMENT/WRAPPED 绑定，缺省值为 return。对于 DOCUMENT/BARE 绑定，缺省值为方法名 + Response。	String
targetNamespace	指定返回值的 XML 名称空间。仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。	String
header	指定头中是否附带结果。缺省值为 false。	Boolean
partName	指定 RPC 或 DOCUMENT/BARE 操作的结果的部件名称。缺省值为 @WebResult.name。	String

 

6.javax.jws.SOAPBinding

@Target({TYPE, METHOD}) public @interface SOAPBinding { public enum Style { DOCUMENT, RPC } public enum Use { LITERAL, ENCODED } public enum ParameterStyle { BARE, WRAPPED } Style style() default Style.DOCUMENT; Use use() default Use.LITERAL; ParameterStyle parameterStyle() default ParameterStyle.WRAPPED; }

 

说明：

   @SOAPBinding 注释指定 Web Service 与 SOAP 消息协议之间的映射。将此注释应用于客户机或服务器服务端点接口（SEI）上的类型或方法，或者应用于JavaBeans 端点的服务器端点实现类。

    方法级别的注释仅限于它可以指定的对象，仅当 style 属性为 DOCUMENT 时才使用该注释。如果未指定方法级别的注释，那么将使用类型的 @SOAPBinding行为。

属性：

名称	说明	数据类型
style	定义发送至 Web Service 和来自 Web Service 的消息的编码样式。有效值为 DOCUMENT 和 RPC。缺省值为 DOCUMENT。	String
use	定义用于发送至 Web Service 和来自 Web Service 的消息的格式。缺省值为 LITERAL。ENCODED 在 Feature Pack for Web Services 中不受支持。	String
parameterStyle	确定方法的参数是否表示整个消息体，或者参数是否是封装在执行操作之后命名的顶级元素中的元素。有效值为 WRAPPED 或 BARE。对于 DOCUMENT 类型的绑定只能使用 BARE 值。缺省值为 WRAPPED。	String

 

 

7.javax.jws.HandlerChain

@Target({TYPE}) public @interface HandlerChain { String file(); String name() default ""; }

 

说明：

@HandlerChain 注释用于使 Web Service 与外部定义的处理程序链相关联。只能通过对 SEI 或实现类使用 @HandlerChain 注释来配置服务器端的处理程序。但是可以使用多种方法来配置客户端的处理程序。可以通过对生成的服务类或者SEI 使用 @HandlerChain 注释来配置客户端的处理程序。此外，可以按程序在服务上注册您自己的 HandlerResolver 接口实现，或者按程序在绑定对象上设置处理程序链。

属性：

名称	说明	数据类型
file	指定处理程序链文件所在的位置。文件位置可以是采用外部格式的绝对 java.net.URL，也可以是类文件中的相对路径。	String
name	指定配置文件中处理程序链的名称。	String