JAX-WS 注释

• 注释目标：类型
• 属性：

  - name

  wsdl:portType 的名称。 缺省值是 Java 类或接口的非限定名。 (字符串)

  - targetNamespace

  指定从 Web Service 生成的 WSDL 和 XML 元素的 XML 名称空间。 缺省值为从包含该 Web Service 的包名映射的名称空间。 (字符串)

  - serviceName

  指定 Web Service 的服务名称：wsdl:service。 缺省值是 Java 类 + 服务的简单名称。 (字符串)

  - endpointInterface

  指定用于定义服务的抽象 Web Service 约定的服务端点接口的限定名。 如果指定了此限定名，那么会使用该服务端点接口来确定抽象 WSDL 约定。 (字符串)

  - portName

  wsdl:portName。 缺省值为 WebService.name+Port。 (字符串)

  - wsdlLocation

  指定用于定义 Web Service 的 WSDL 文档的 Web 地址。 Web 地址可以是相对地址或绝对地址。 (字符串)

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：方法
• 属性：

  - operationName

  指定与此方法相匹配的 wsdl:operation 的名称。 缺省值是 Java 方法的名称。 (字符串)

  - action

  定义此操作的行为。 对于 SOAP 绑定，此值将确定 SOAPAction 头的值，您必须显式设置此值。

  - exclude

  指定是否从 Web Service 中排除某一方法。 缺省值为 false。 (布尔值)

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：方法
• 没有适用于 Oneway 注释的属性。

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：参数
• 属性：

  - name

  参数的名称。 如果操作是远程过程调用 (RPC) 类型并且未指定 partName 属性，那么这是用于表示参数的 wsdl:part 属性的名称。 如果操作是文档类型或者参数映射到某个头，那么 -name 是用于表示该参数的 XML 元素的局部名称。 如果操作是文档类型、参数类型为 BARE 并且方式为 OUT 或 INOUT，那么必须指定此属性。 (字符串)

  - partName

  定义用于表示此参数的 wsdl:part 属性的名称。 仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。 (字符串)

  - targetNamespace

  指定参数的 XML 元素的 XML 名称空间。 当属性映射到 XML 元素时，仅应用于文档绑定。 缺省值为 Web Service 的 targetNamespace。 (字符串)

  - mode

  此值表示此方法的参数流的方向。 有效值为 IN、INOUT 和 OUT。 (字符串)

  - header

  指定参数是在消息头还是消息体中。 缺省值为 false。 (布尔值)

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：方法
• 属性：

  - name

  当返回值列出在 WSDL 文件中并且在连接上的消息中找到该返回值时，指定该返回值的名称。 对于 RPC 绑定，这是用于表示返回值的 wsdl:part 属性的名称。 对于文档绑定，-name 参数是用于表示返回值的 XML 元素的局部名。 对于 RPC 和 DOCUMENT/WRAPPED 绑定，缺省值为 return。 对于 DOCUMENT/BARE 绑定，缺省值为方法名 + Response。 (字符串)

  - targetNamespace

  指定返回值的 XML 名称空间。 仅当操作类型为 RPC 或者操作是文档类型并且参数类型为 BARE 时才使用此参数。 (字符串)

  - header

  指定头中是否附带结果。 缺省值为 false。 (布尔值)

  - partName

  指定 RPC 或 DOCUMENT/BARE 操作的结果的部件名称。 缺省值为 @WebResult.name。 (字符串)

只能通过对服务端点接口 (SEI) 或服务器端点实现类使用 @HandlerChain 注释来配置服务器端的处理程序。

但是可以使用多种方法来配置客户端的处理程序。 可以通过对生成的服务类或者 SEI 使用 @HandlerChain 注释来配置客户端的处理程序。 另外，可以按编程方式在服务上注册您自己的 HandlerResolver 接口实现，或者按编程方式在绑定对象上设置处理程序链。

• 注释目标：类型
• 属性：

  - file

  指定处理程序链文件所在的位置。 文件位置可以是采用外部格式的绝对 java.net.URL，也可以是类文件中的相对路径。 (字符串)

  - name

  指定配置文件中处理程序链的名称。 (字符串)

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的类型或方法，或者应用于服务器端点实现类。

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

• 注释目标：类型或方法
• 属性：

  - style

  定义发送到 Web Service 和来自 Web Service 的消息的编码样式。 有效值为 DOCUMENT 和 RPC。 缺省值为 DOCUMENT。 (字符串)

  - use

  定义用于发送到 Web Service 和来自 Web Service 的消息的格式。 缺省值为 LITERAL。 不支持 ENCODED。 (字符串)

  - parameterStyle

  确定方法的参数是否表示整个消息体，或者参数是否是封装在执行操作之后命名的顶级元素中的元素。 有效值为WRAPPED或BARE。 对于 DOCUMENT 类型的绑定只能使用 BARE 值。 缺省值为 WRAPPED。 (字符串)

如果您将此注释与特定方法配合使用，并生成相应的 WSDL 文档，那么会将 WS-Addressing 操作扩展属性添加到与该方法对应的 WSDL 操作的 input 和 output 元素。

要将此属性添加到 WSDL 操作，您还必须在服务器端点实现类上指定 @Addressing 注释。 如果不想使用 @Addressing 注释，那么可以提供您自己的已定义 Action 属性的 WSDL 文档。

• 注释目标：方法
• 属性：

  - fault

  为操作的 wsdl:fault 指定 FaultAction 数组。 (字符串)

  - input

  为操作的 wsdl:input 指定操作。 (字符串)

  - output

  为操作的 wsdl:output 指定操作。 (字符串)

将此注释应用于服务器端点实现类。

• 注释目标：类型
• 属性：

  - value

  指示绑定标识 Web 地址。 有效值为 javax.xml.ws.soap.SOAPBinding.SOAP11HTTP_BINDING、javax.xml.ws.soap.SOAPBinding.SOAP12HTTP_BINDING 和 javax.xml.ws.http.HTTPBinding.HTTP2HTTP_BINDING。 缺省值为 javax.xml.ws.soap.SOAPBinding.SOAP11HTTP_BINDING。 (字符串)

此注释必须包含在 @Action 注释中。

如果您将此注释与特定方法配合使用，那么会将 WS-Addressing FaultAction 扩展属性添加到与该方法对应的 WSDL 操作的 fault 元素。

要将此属性添加到 WSDL 操作，您还必须在服务器端点实现类上指定 @Addressing 注释。 如果不想使用 @Addressing 注释，那么可以提供您自己的已定义 Action 属性的 WSDL 文档。

• 注释目标：方法
• 属性：

  - value

  为操作的 wsdl:fault 指定操作。 (字符串)

  - output

  指定异常类的名称。 (字符串)

  - className

  指定用于表示请求包装器的类的名称。 (字符串)

从 Java 对象开始时，此元素用于解决文档文字方式下的重载冲突。 在这种情况下，只有 className 属性是必需的。

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：方法
• 属性：

  - localName

  指定用于表示请求包装器的 XML 模式元素的局部名称。 缺省值为在 javax.jws.WebMethod 注释中定义的 operationName。 (字符串)

  - targetNamespace

  指定请求包装器方法的 XML 名称空间。 缺省值为 SEI 的目标名称空间。 (字符串)

  - className

  指定用于表示请求包装器的类的名称。 (字符串)

  - partName

  指定 wsdl:part 属性的名称，该属性用于表示 RequestWrapper 类的 XML 模式元素。 此属性适用于 JAX-WS 2.2 及更高版本。 (字符串)

从 Java 对象开始时，此元素用于解决文档文字方式下的重载冲突。 在这种情况下，只有 className 属性是必需的。

将此注释应用于客户机或服务器服务端点接口 (SEI) 上的方法，或者应用于服务器端点实现类。

• 注释目标：方法
• 属性：

  - localName

  指定用于表示请求包装器的 XML 模式元素的局部名称。 缺省值为 operationName + Response。 operationName 是在 javax.jws.WebMethod 注释中定义的。 (字符串)

  - targetNamespace

  指定请求包装器方法的 XML 名称空间。 缺省值为 SEI 的目标名称空间。 (字符串)

  - className

  指定代表响应包装器的类的名称。 (字符串)

  - partName

  指定 wsdl:part 属性的名称，该属性用于表示 ResponseWrapper 类的 XML 模式元素。 此属性适用于 JAX-WS 2.2 及更高版本。 (字符串)

如果指定此注释，那么会执行检查以确保支持 enabled 属性设为 true 的所有必需 WSDL 可扩展性元素。

将此注释应用于服务器端点实现类上的方法。

• 注释目标：方法
• 属性：

  - enabled

  指定是否必须使用 wsdl:binding。 缺省值为 true。 (布尔值)

• 注释目标：类型
• 属性：

  - value

  指示提供者类是接受消息的有效内容 PAYLOAD 还是整个消息 MESSAGE。 缺省值为 PAYLOAD。 (字符串)

将此注释应用于服务器端点实现类上的方法。

• 注释目标：类型
• 属性：

  - enabled

  指定是否启用 WS-Addressing。 缺省值为 true。 (布尔值)

  - required

  指定 WS-Addressing 头必须存在于入局消息上。 缺省值为 false。 (布尔值)

  - responses

  指定要使用的消息交换模式。 缺省值为 Responses.ALL。 此属性适用于 JAX-WS 2.2 及更高版本。 (字符串)

将此注释应用于服务端点实现类。

• 注释目标：类
• 属性：

  - enabled

  指定是否对 JAX-WS 端点启用 MTOM。 缺省值为 true。 (布尔值)

  - threshold

  指定使用 MTOM 来发送的消息的最小大小。 如果消息大小小于此指定的整数，那么会将消息作为基本 64 位或 hexBinary 数据直接插入 XML 文档中。 (整数)

此注释只能应用于客户机或服务器上的故障实现类。

• 注释目标：类型
• 属性：

  - name

  指定在 WSDL 文件中表示相应故障的 XML 元素的本地名称。 必须指定实际值。 (字符串)

  - targetNamespace

  指定用于表示 WSDL 文件中相应故障的 XML 元素的名称空间。 (字符串)

  - faultBean

  指定故障 Bean 类的名称。 (字符串)

  - messageName

  指定 wsdl:message 属性的名称，该属性用于表示 WSDL 文件中相应的故障。 此属性适用于 JAX-WS 2.2 及更高版本。 (字符串)

• 注释目标：类型
• 属性：

  - targetNamespace

  指定从 Web Service 生成的 WSDL 和 XML 元素的 XML 名称空间。 缺省值为从包含该 Web Service 的包名映射的名称空间。 (字符串)

  - serviceName

  指定 Web Service 的服务名称：wsdl:service。 缺省值是 Java 类 + 服务的简单名称。 (字符串)

  - portName

  wsdl:portName。 缺省值为类的名称 + Port。 (字符串)

  - wsdlLocation

  这是定义 Web Service 的 WSDL 文档的 Web 地址。 此属性是必需的。 (字符串)

• 注释目标：类型、字段或方法
• 属性：

  - name

  指定资源的 JNDI 名称。 字段名称是字段注释的缺省值。 对应于方法的 JavaBeans 属性名是方法注释的缺省值。 因为没有缺省值，所以您必须指定类注释的值。 (字符串)

  - type

  指示资源的 Java 类型。 字段类型是字段注释的缺省值。 JavaBeans 属性的类型是方法注释的缺省值。 因为没有缺省值，所以您必须指定类注释的值。 (类)

  - mappedName

  指定要将此资源映射到的名称。 (字符串)

  - value

  指示服务类的值，且指示该服务类是对 javax.xml.ws.Service 进行扩展的类型。 当引用类型是服务端点接口时，此属性是必需的。 (类)

  - wsdlLocation

  这是定义 Web Service 的 WSDL 文档的 Web 地址。 此属性是必需的。 (字符串)

  - lookup

  指定目标 Web Service 的 JNDI 查找名称。 此属性适用于 JAX-WS 2.2 及更高版本。 (字符串)

• 注释目标：类型
• 属性：

  - value

  为多个 Web Service 引用声明指定一个数组。 此属性是必需的。

• 注释目标：字段或方法
• 属性：

  - type

  指示资源的 Java 类型。 您需要使用缺省值 java.lang.Object 或 javax.xml.ws.Web ServiceContext 值。 如果类型是缺省值，那么必须将资源添加到字段或方法中。 在这种情况下，该字段的类型或该方法定义的 JavaBeans 属性的类型必须为 javax.xml.ws.WebServiceContext。 (类)

  如果使用此注释来插入 Web Service，请参阅 @WebServiceRef type 属性的描述。

• 注释目标：字段或方法
• 属性：

  - value

  为多个 @Resource 注释指定一个数组。 此属性是必需的。

将此注释应用于 JAX-WS 应用程序处理程序或服务器端点实现类。

• 注释目标：方法

将此注释应用于 JAX-WS 应用程序处理程序或服务器端点实现类。

• 注释目标：方法

此注释是 JAX-WS 2.1 规范的 IBM 实现的一部分。

将此注释应用于服务器端点实现类上的方法。

• 注释目标：类型
• 属性：

  - enabled

  指定是否启用 WS-Addressing。 缺省值为 true。 (布尔值)

  - required

  指定 WS-Addressing 头必须存在于入局消息上。 缺省值为 false。 (布尔值)