javax.xml.ws

Class Service

java.lang.Object

javax.xml.ws.Service

public class Service
extends Object

Service对象提供Web服务的客户端视图。

Service作为下面的工厂：

• 用于目标服务端点的代理。
• 动态面向消息的远程操作调用Dispatch实例。

在提供服务的端口，可以使用getPorts方法列举。或者，你可以通过一个服务端点接口的一元getPort方法让运行时选择一个兼容的端口。

所有的对象的Service创建处理程序链可以设置一个HandlerResolver手段。

一个Executor可能对服务才能更好地控制用于调度异步回调线程。例如，线程池在一定的参数可以通过创建一个ThreadPoolExecutor登记与服务启用。

从以下版本开始：

JAX-WS 2

另请参见：

Provider， HandlerResolver， Executor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Service.Mode 一个动态的客户端或服务的方向。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	Service(URL wsdlDocumentLocation, QName serviceName)
protected	Service(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features)

方法摘要

Modifier and Type	Method and Description
void	addPort(QName portName, String bindingId, String endpointAddress) 为服务创建一个新端口。
static Service	create(QName serviceName) 创建一个 Service实例。
static Service	create(QName serviceName, WebServiceFeature... features) 创建一个 Service实例。
static Service	create(URL wsdlDocumentLocation, QName serviceName) 创建一个 Service实例。
static Service	create(URL wsdlDocumentLocation, QName serviceName, WebServiceFeature... features) 创建一个 Service实例。
<T> Dispatch<T>	createDispatch(EndpointReference endpointReference, 类<T> type, Service.Mode mode, WebServiceFeature... features) 创建一个 Dispatch实例使用的客户选择的对象。
Dispatch<Object>	createDispatch(EndpointReference endpointReference, JAXBContext context, Service.Mode mode, WebServiceFeature... features) 创建一个使用 Dispatch JAXB生成的对象实例。
<T> Dispatch<T>	createDispatch(QName portName, 类<T> type, Service.Mode mode) 创建一个使用该客户的选择对象 Dispatch实例。
<T> Dispatch<T>	createDispatch(QName portName, 类<T> type, Service.Mode mode, WebServiceFeature... features) 创建一个使用该客户的选择对象 Dispatch实例。
Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode) 创建一个使用 Dispatch JAXB生成的对象实例。
Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features) 创建一个使用 Dispatch JAXB生成的对象实例。
Executor	getExecutor() 返回此 Serviceinstance遗嘱执行人。
HandlerResolver	getHandlerResolver() 返回的配置处理程序解析。
<T> T	getPort(类<T> serviceEndpointInterface) 的 getPort方法返回一个代理。
<T> T	getPort(类<T> serviceEndpointInterface, WebServiceFeature... features) 的 getPort方法返回一个代理。
<T> T	getPort(EndpointReference endpointReference, 类<T> serviceEndpointInterface, WebServiceFeature... features) 的 getPort方法返回一个代理。
<T> T	getPort(QName portName, 类<T> serviceEndpointInterface) 的 getPort方法返回一个代理。
<T> T	getPort(QName portName, 类<T> serviceEndpointInterface, WebServiceFeature... features) 的 getPort方法返回一个代理。
Iterator<QName>	getPorts() 返回的服务端点按此服务 QNames列表 Iterator
QName	getServiceName() 获取此服务的名称。
URL	getWSDLDocumentLocation() 获取此服务的WSDL文档的位置。
void	setExecutor(Executor executor) 设置此 Service实例的执行器。
void	setHandlerResolver(HandlerResolver handlerResolver) 设置此 Service实例的 HandlerResolver。

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName,
                  WebServiceFeature... features)

方法详细信息

getPort

public <T> T getPort(QName portName,
                     类<T> serviceEndpointInterface)

的 getPort方法返回一个代理。服务客户端使用此代理来调用目标服务端点上的操作。 serviceEndpointInterface指定的服务端点接口是由创建动态代理实例支持。

参数

在WSDL服务描述的服务端点 portName限定名称。

serviceEndpointInterface -服务端点接口，支持动态代理实例。

结果

支持支持指定的服务端点接口的对象代理实例。

异常

WebServiceException -抛出该异常在下列情况下：

• 如果创建代理的创建有错误。
• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果一个非法serviceEndpointInterface或portName指定。

另请参见：

Proxy， InvocationHandler

getPort

public <T> T getPort(QName portName,
                     类<T> serviceEndpointInterface,
                     WebServiceFeature... features)

的 getPort方法返回一个代理。服务客户端使用此代理来调用目标服务端点上的操作。 serviceEndpointInterface指定的服务端点接口是由创建动态代理实例支持。

参数

在WSDL服务描述的服务端点 portName限定名称。

serviceEndpointInterface -服务端点接口，支持动态代理实例。

features -目录webservicefeatures配置代理。支持的功能不在 features 参数有默认值。

结果

支持支持指定的服务端点接口的对象代理实例。

异常

WebServiceException -抛出该异常在下列情况下：

• 如果创建代理的创建有错误。
• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果一个非法serviceEndpointInterface或portName指定。
• 如果启用了一个不与此端口兼容或不支持的功能。

从以下版本开始：

JAX-WS 2.1

另请参见：

Proxy， InvocationHandler， WebServiceFeature

getPort

public <T> T getPort(类<T> serviceEndpointInterface)

的 getPort方法返回一个代理。参数 serviceEndpointInterface指定服务端点接口，通过返回的代理支持。在这种方法的实施，JAX-WS运行时系统将选择一个协议绑定的责任（和端口）和配置相应的代理。返回的代理不应该被重新配置客户端。

参数

serviceEndpointInterface -服务端点接口。

结果

支持指定的服务端点接口的对象实例。

异常

WebServiceException -

• 如果在创建代理过程中出现错误。
• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果一个非法serviceEndpointInterface指定。

getPort

public <T> T getPort(类<T> serviceEndpointInterface,
                     WebServiceFeature... features)

的 getPort方法返回一个代理。参数 serviceEndpointInterface指定服务端点接口，通过返回的代理支持。在这种方法的实施，JAX-WS运行时系统将选择一个协议绑定的责任（和端口）和配置相应的代理。返回的代理不应该被重新配置客户端。

参数

serviceEndpointInterface -服务端点接口。

features -目录webservicefeatures配置代理。支持的功能不在 features 参数有默认值。

结果

支持指定的服务端点接口的对象实例。

异常

WebServiceException -

• 如果在创建代理过程中出现错误。
• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果一个非法serviceEndpointInterface指定。
• 如果启用了一个不与此端口兼容或不支持的功能。

从以下版本开始：

JAX-WS 2.1

另请参见：

WebServiceFeature

getPort

public <T> T getPort(EndpointReference endpointReference,
                     类<T> serviceEndpointInterface,
                     WebServiceFeature... features)

的 getPort方法返回一个代理。参数 endpointReference指定端点，将通过代理调用返回。如果有任何的 endpointReference参考参数，那么这些参数必须出现在SOAP头，示意他们可以参考参数，在所有的消息发送到终点。的 endpointReference's地址必须用于在端点调用。参数 serviceEndpointInterface指定服务端点接口，通过返回的代理支持。在这种方法的实施，JAX-WS运行时系统将选择一个协议绑定的责任（和端口）和配置相应的代理从WSDL与此相关的 Service实例或从 endpointReference元数据。如果这 Service实例有一个WSDL和 endpointReference元数据也有一个wsdl，然后从这个实例必须使用WSDL。如果这 Service实例没有WSDL和 endpointReference确实有一个wsdl，然后从 endpointReference WSDL可。返回的代理不应该被重新配置客户端。如果这 Service实例有一个已知的代理端口匹配包含WSDL信息，然后代理返回，否则webserviceexception抛出。

调用此方法具有相同的行为如下

port = service.getPort(portName, serviceEndpointInterface);

在 portName获得的 endpointReference元数据或从 serviceEndpointInterface和这个 Service实例关联的WSDL。

参数

endpointReference -目标服务端点，将返回到调用 EndpointReference代理。

serviceEndpointInterface -服务端点接口。

features -目录 WebServiceFeatures配置代理。支持的功能不在 features 参数有默认值。

结果

支持支持指定的服务端点接口的对象代理实例。

异常

WebServiceException -

• 如果在创建代理过程中出现错误。
• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果endpointReference元数据不匹配，这Service实例的serviceName。
• 如果一个portName不能提取或endpointReference WSDL元数据。
• 如果指定了无效的endpointReference。
• 如果指定了无效的serviceEndpointInterface。
• 如果启用了一个不与此端口兼容或不支持的功能。

从以下版本开始：

JAX-WS 2.1

addPort

public void addPort(QName portName,
                    String bindingId,
                    String endpointAddress)

为服务创建一个新端口。以这种方式创建的端口不包含WSDL端口类型信息只能用于创建 Dispatchinstances。

参数

portName限定的名称为目标服务端点。

bindingId -字符串绑定标识符。

endpointAddress地址目标服务的端点的URI。

异常

WebServiceException -如果在港口创造任何错误。

另请参见：

SOAPBinding.SOAP11HTTP_BINDING， SOAPBinding.SOAP12HTTP_BINDING， HTTPBinding.HTTP_BINDING

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
                                      类<T> type,
                                      Service.Mode mode)

创建一个使用该客户的选择对象 Dispatch实例。

参数

portName限定的名称为目标服务端点

type -类对象使用消息或消息有效载荷。实现都必须支持 javax.xml.transform.Source， javax.xml.soap.SOAPMessage和 javax.activation.DataSource，取决于结合使用。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。模式必须的信息时，是SOAPMessage。

结果

调度实例。

异常

WebServiceException -如果在 Dispatch对象创建的任何错误。

另请参见：

Source， SOAPMessage

createDispatch

public <T> Dispatch<T> createDispatch(QName portName,
                                      类<T> type,
                                      Service.Mode mode,
                                      WebServiceFeature... features)

创建一个使用该客户的选择对象 Dispatch实例。

参数

portName限定的名称为目标服务端点

type -类对象使用消息或消息有效载荷。实现都必须支持 javax.xml.transform.Source和 javax.xml.soap.SOAPMessage。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。模式必须 MESSAGE当类型 SOAPMessage。

features -目录 WebServiceFeatures配置代理。支持的功能不在 features 参数有默认值。

结果

调度实例。

异常

WebServiceException -如果在 Dispatch对象的创建或启用，如果不是这个端口兼容或是不支持的是一个功能的任何错误。

从以下版本开始：

JAX-WS 2.1

另请参见：

Source， SOAPMessage， WebServiceFeature

createDispatch

public <T> Dispatch<T> createDispatch(EndpointReference endpointReference,
                                      类<T> type,
                                      Service.Mode mode,
                                      WebServiceFeature... features)

创建一个使用该客户的选择对象 Dispatch实例。如果有任何的 endpointReference参考参数，那么这些参数必须出现在SOAP头，示意他们可以参考参数，在所有的消息发送到终点。的 endpointReference's地址必须用于在端点调用。在这种方法的实施，JAX-WS运行时系统将选择一个协议绑定的责任（和端口）和配置调度相应的WSDL与此相关的 Service实例或从 endpointReference元数据。如果这 Service实例有一个WSDL和 endpointReference也在其元数据的wsdl，然后从这个实例必须使用WSDL。如果这 Service实例没有WSDL和 endpointReference确实有一个wsdl，然后从 endpointReference WSDL可。实现必须能够检索从 endpointReference元数据的 portName。

此方法的行为与调用相同

dispatch = service.createDispatch(portName, type, mode, features);

在 portName检索从WSDL或 EndpointReference元数据。

参数

endpointReference -目标服务端点，将返回的对象调用 EndpointReference Dispatch。

type -类对象使用消息或消息有效载荷。实现都必须支持 javax.xml.transform.Source和 javax.xml.soap.SOAPMessage。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。模式必须 MESSAGE当类型 SOAPMessage。

features - WebServiceFeatures配置代理上的数组。支持的功能不在 features 参数有默认值。

结果

调度实例

异常

WebServiceException -

• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果endpointReference元数据不匹配，与此Service实例关联的WSDL serviceName或portName。
• 如果portName不能从EndpointReference元数据确定。
• 如果在创建对象的Dispatch任何错误。
• 如果启用了一个不与此端口兼容或不支持的功能。

从以下版本开始：

JAX-WS 2.1

另请参见：

Source， SOAPMessage， WebServiceFeature

createDispatch

public Dispatch<Object> createDispatch(QName portName,
                                       JAXBContext context,
                                       Service.Mode mode)

用于创建一个 Dispatch JAXB生成的对象实例。

参数

portName限定的名称为目标服务端点

context - JAXB上下文用于马歇尔和解组的消息或消息有效载荷。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。

结果

调度实例。

异常

WebServiceException -如果在 Dispatch对象创建的任何错误。

另请参见：

JAXBContext

createDispatch

public Dispatch<Object> createDispatch(QName portName,
                                       JAXBContext context,
                                       Service.Mode mode,
                                       WebServiceFeature... features)

用于创建一个 Dispatch JAXB生成的对象实例。

参数

portName限定的名称为目标服务端点

context - JAXB上下文用于马歇尔和解组的消息或消息有效载荷。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。

features -目录 WebServiceFeatures配置代理。支持的功能不在 features 参数有默认值。

结果

调度实例。

异常

WebServiceException -如果在 Dispatch对象的创建或启用，如果不是这个端口兼容或是不支持的是一个功能的任何错误。

从以下版本开始：

JAX-WS 2.1

另请参见：

JAXBContext， WebServiceFeature

createDispatch

public Dispatch<Object> createDispatch(EndpointReference endpointReference,
                                       JAXBContext context,
                                       Service.Mode mode,
                                       WebServiceFeature... features)

创建一个使用 Dispatch JAXB生成的对象实例。如果有任何的 endpointReference参考参数，那么这些参数必须出现在SOAP头，示意他们可以参考参数，在所有的消息发送到终点。的 endpointReference's地址必须用于在端点调用。在这种方法的实施，JAX-WS运行时系统将选择一个协议绑定的责任（和端口）和配置调度相应的WSDL与此相关的 Service实例或从 endpointReference元数据。如果这 Service实例有一个WSDL和 endpointReference也在其元数据的wsdl，然后从这个实例必须使用WSDL。如果这 Service实例没有WSDL和 endpointReference确实有一个wsdl，然后从 endpointReference WSDL可。实现必须能够检索从 endpointReference元数据的 portName。

这种方法称为相同侵权

dispatch = service.createDispatch(portName, context, mode, features);

在 portName检索从WSDL或 endpointReference元数据。

参数

endpointReference -目标服务端点，将返回的对象调用 EndpointReference Dispatch。

context - JAXB上下文用于马歇尔和解组的消息或消息有效载荷。

mode -控制是否创建调度实例消息或负载型，即该客户是否将与完整的协议消息或消息有效载荷。当使用此参数时，此参数将控制客户端是否会使用“消息”或“皂体”的内容。

features - WebServiceFeatures配置代理上的数组。支持的功能不在 features 参数有默认值。

结果

调度实例

异常

WebServiceException -

• 如果有此方法所需的任何丢失的WSDL元数据。
• 如果endpointReference元数据不匹配，与此Service实例关联的WSDL serviceName或portName。
• 如果portName不能从EndpointReference元数据确定。
• 如果在创建对象的Dispatch任何错误。
• 如果启用了一个不与此端口兼容或不支持的功能。

从以下版本开始：

JAX-WS 2.1

另请参见：

JAXBContext， WebServiceFeature

getServiceName

public QName getServiceName()

获取此服务的名称。

结果

此服务的限定名称

getPorts

public Iterator<QName> getPorts()

返回的服务端点按此服务 QNames列表 Iterator

结果

返回 java.util.Iterator与 javax.xml.namespace.QName元素类型。

异常

WebServiceException -如果此服务类不能访问所需的WSDL元数据。

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

获取此服务的WSDL文档的位置。

结果

URL该服务的WSDL文档的位置。

getHandlerResolver

public HandlerResolver getHandlerResolver()

返回的配置处理程序解析。

结果

handlerresolver的 HandlerResolver被这 Service实例使用，或 null如果没有。

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

设置此 Service实例的 HandlerResolver。

该处理程序解析，如果存在，将被调用一次，每个代理或调度实例被创建，并由解析器返回的句柄链将被设置在实例。

参数

handlerResolver - HandlerResolver用于所有随后创建代理/调度对象。

另请参见：

HandlerResolver

getExecutor

public Executor getExecutor()

返回此 Serviceinstance遗嘱执行人。执行器是用于异步调用需要回调。

结果

的 java.util.concurrent.Executor用来调用回调。

另请参见：

Executor

setExecutor

public void setExecutor(Executor executor)

设置此 Service实例的执行器。执行器是用于异步调用需要回调。

参数

executor - java.util.concurrent.Executor用来调用回调。

异常

SecurityException如果实例不支持设置为安全原因执行器（如必要的权限缺失）。

另请参见：

Executor

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName)

创建一个 Service实例。指定的WSDL文件的位置和服务名称必须唯一地标识一个 wsdl:service元。

参数

wsdlDocumentLocation为Web服务的WSDL文件的位置 URL

serviceName -服务 QName

异常

WebServiceException -如果在指定的服务产生的任何错误。

create

public static Service create(URL wsdlDocumentLocation,
                             QName serviceName,
                             WebServiceFeature... features)

创建一个 Service实例。所创建的实例配置与Web服务功能。指定的WSDL文件的位置和服务名称必须唯一地标识一个 wsdl:service元。

参数

wsdlDocumentLocation为Web服务的WSDL文件的位置 URL

serviceName -服务 QName

features Web服务的功能，必须配置的服务。如果供应商不了解的一个特点，它必须把webserviceexception。

异常

WebServiceException -如果在指定的服务产生的任何错误。

从以下版本开始：

JAX-WS 2.2

create

public static Service create(QName serviceName)

创建一个 Service实例。

参数

serviceName -服务 QName

异常

WebServiceException -如果在指定的服务产生的任何错误

create

public static Service create(QName serviceName,
                             WebServiceFeature... features)

创建一个 Service实例。所创建的实例配置与Web服务功能。

参数

serviceName -服务 QName

features Web服务的功能，必须配置的服务。如果供应商不了解的一个特点，它必须把webserviceexception。

异常

WebServiceException -如果在指定的服务产生的任何错误

从以下版本开始：

JAX-WS 2.2