Service (Java Platform SE 8 )

java.lang.Object
- javax.xml.ws.Service

```
public class Service
extends Object
```
Service对象提供Web服务的客户端视图。
Service作为以下工厂：
- 用于目标服务端点的代理。
- 实例Dispatch用于远程操作的动态面向消息的调用。
服务上可用的端口可以使用getPorts方法getPorts 。或者，您可以将服务端点接口传递到一元的getPort方法，并让运行时选择兼容的端口。

用于通过创建的所有对象处理程序链Service可以通过来设定HandlerResolver 。

可以在服务上设置Executor ，以便更好地控制用于分派异步回调的线程。例如，通过创建ThreadPoolExecutor并将其注册到服务，可以启用具有某些参数的线程池。
从以下版本开始：

JAX-WS 2.0

另请参见：

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)` 创建一个用于JAXB生成的对象的 `Dispatch`实例。
`<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)` 创建一个用于JAXB生成的对象的 `Dispatch`实例。
`Dispatch<Object>`	`createDispatch(QName portName, JAXBContext context, Service.Mode mode, WebServiceFeature... features)` 创建一个用于JAXB生成的对象的 `Dispatch`实例。
`Executor`	`getExecutor()` 返回此 `Service`实例的执行程序。
`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()` 返回 `Iterator` ，用于 `QName`服务分组的服务端点QName的列表
`QName`	`getServiceName()` 获取此服务的名称。
`URL`	`getWSDLDocumentLocation()` 获取此服务的WSDL文档的位置。
`void`	`setExecutor(Executor executor)` 设置此 `Service`实例的执行程序。
`void`	`setHandlerResolver(HandlerResolver handlerResolver)` 设置 `HandlerResolver`这个 `Service`实例。

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造方法详细信息
  - 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指定创建的动态代理实例支持的服务端点接口。
    参数
    
    portName - WSDL服务描述中服务端点的合格名称。
    
    serviceEndpointInterface - 动态代理实例支持的服务端点接口。
    
    结果
    
    支持指定服务端点接口的Object Proxy实例。
    
    异常
    WebServiceException - 在以下情况下抛出此异常：
    
    如果创建代理时出现错误。
    
    如果此方法需要缺少WSDL元数据。
    
    如果非法serviceEndpointInterface或portName指定。
    另请参见：
    
    Proxy ， InvocationHandler
  - getPort
```
public <T> T getPort(QName portName,
                     类<T> serviceEndpointInterface,
                     WebServiceFeature... features)
```
    getPort方法返回代理。服务客户端使用此代理来调用目标服务端点上的操作。 serviceEndpointInterface指定创建的动态代理实例支持的服务端点接口。
    参数
    
    portName - WSDL服务描述中服务端点的合格名称。
    
    serviceEndpointInterface - 动态代理实例支持的服务端点接口。
    
    features - 要在代理上配置的WebServiceFeatures的列表。支持的功能不是在features参数将其默认值。
    
    结果
    
    支持指定服务端点接口的Object Proxy实例。
    
    异常
    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将由返回的代理调用的端点。如果有在任何参考参数endpointReference ，则这些参考参数必须显示为SOAP标头，指示它们是参照参数，对发送到端点的所有消息。 endpointReference's地址必须用于端点上的调用。参数serviceEndpointInterface指定返回代理支持的服务端点接口。在实现此方法时，JAX-WS运行时系统负责选择协议绑定（和端口），并从与该Service实例相关联的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和与此相关的WSDL Service实例。
    参数
    
    endpointReference - 将由返回的代理调用的目标服务端点的 EndpointReference 。
    
    serviceEndpointInterface - 服务端点接口。
    
    features - 要在代理上配置的WebServiceFeatures的列表。支持的功能不是在features参数将其默认值。
    
    结果
    
    支持指定服务端点接口的Object Proxy实例。
    
    异常
    WebServiceException -
    
    如果在创建代理时出现错误。
    
    如果此方法需要缺少WSDL元数据。
    
    如果endpointReference元数据与该Service实例的serviceName不匹配。
    
    如果portName不能从WSDL或提取endpointReference元数据。
    
    如果无效endpointReference指定。
    
    如果无效serviceEndpointInterface指定。
    
    如果启用了与该端口不兼容或不受支持的功能。
    从以下版本开始：
    
    JAX-WS 2.1
  - addPort
```
public void addPort(QName portName,
                    String bindingId,
                    String endpointAddress)
```
    为服务创建一个新的端口。以此方式创建的端口不包含WSDL端口类型信息，只能用于创建Dispatch实例。
    
    参数
    
    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 - 控制创建的调度实例是消息还是有效负载，即客户端是否使用完整的协议消息或消息有效载荷。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。当类型为SOAPMessage时，模式必须为MESSAGE。
    
    结果
    
    调度实例。
    
    异常
    
    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 - 控制创建的调度实例是消息还是有效负载，即客户端是否使用完整的协议消息或消息有效载荷。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。模式必须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运行时系统负责选择协议绑定（和端口），并从与此Service实例相关联的WSDL或从Service的元数据相应地endpointReference 。如果此Service实例具有WSDL，并且endpointReference在其元数据中也具有WSDL，则必须使用此实例的WSDL。如果此Service实例没有WSDL，并且endpointReference确实有WSDL，则可以使用endpointReference的WSDL。一个实现必须能够检索portName从endpointReference元。
    此方法的行为与调用相同
```
  dispatch = service.createDispatch(portName, type, mode, features); 
```
    其中portName从WSDL或检索EndpointReference元数据。
    参数
    
    endpointReference -该 EndpointReference用于将由返回调用的目标服务端点 Dispatch对象。
    
    type - 用于消息或消息有效载荷的对象类。执行需要支持javax.xml.transform.Source和javax.xml.soap.SOAPMessage 。
    
    mode - 控制创建的调度实例是消息还是面向有效负载，即客户端是否使用完整的协议消息或消息有效载荷。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。模式必须MESSAGE当类型是SOAPMessage 。
    
    features - 要在代理上配置的WebServiceFeatures数组。支持的功能不是在features参数将其默认值。
    
    结果
    
    调度实例
    
    异常
    WebServiceException -
    
    如果此方法需要缺少WSDL元数据。
    
    如果endpointReference元数据与该Service实例相关portName的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)
```
    创建一个用于JAXB生成的对象的 Dispatch实例。
    
    参数
    
    portName - 目标服务端点的合格名称
    
    context - 用于编组和解组消息或消息有效载荷的JAXB上下文。
    
    mode - 控制创建的调度实例是消息还是有效负载，即客户端是否使用完整的协议消息或消息有效载荷。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。
    
    结果
    
    调度实例。
    
    异常
    
    WebServiceException - 如果在创建 Dispatch对象时有任何错误。
    
    另请参见：
    
    JAXBContext
  - createDispatch
```
public Dispatch<Object> createDispatch(QName portName,
                                       JAXBContext context,
                                       Service.Mode mode,
                                       WebServiceFeature... features)
```
    创建一个用于JAXB生成的对象的 Dispatch实例。
    
    参数
    
    portName - 目标服务端点的合格名称
    
    context - 用于编组和解组消息或消息有效载荷的JAXB上下文。
    
    mode - 控制创建的调度实例是消息还是有效负载，即客户端是否使用完整的协议消息或消息有效负载。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。
    
    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)
```
    创建一个用于JAXB生成的对象的Dispatch实例。如果endpointReference中有endpointReference ，那么在发送到端点的所有消息上，这些引用参数必须显示为SOAP头，表示它们是参考参数。 endpointReference's地址必须用于端点上的调用。在实现此方法时，JAX-WS运行时系统负责选择协议绑定（和端口），并从与此Service实例相关联的WSDL或从Service的元数据相应地endpointReference 。如果此Service实例具有WSDL，并且endpointReference在其元数据中也具有WSDL，则必须使用此实例的WSDL。如果此Service实例没有WSDL，并且endpointReference确实有一个WSDL，则可以使用endpointReference的WSDL。一个实现必须能够检索portName从endpointReference元。
    此方法与调用相同
```
  dispatch = service.createDispatch(portName, context, mode, features); 
```
    其中portName是从WSDL或endpointReference元数据endpointReference 。
    参数
    
    endpointReference -该 EndpointReference用于将由返回调用的目标服务端点 Dispatch对象。
    
    context - 用于编组和解组消息或消息有效载荷的JAXB上下文。
    
    mode - 控制创建的调度实例是消息还是有效负载，即客户端是否使用完整的协议消息或消息有效载荷。例如，当使用SOAP协议时，此参数控制客户端是否使用SOAP消息或SOAP主体的内容。
    
    features -数组WebServiceFeatures配置上的代理。支持的功能不是在features参数将其默认值。
    
    结果
    
    调度实例
    
    异常
    WebServiceException -
    
    如果此方法需要缺少WSDL元数据。
    
    如果endpointReference元数据与与此Service实例相关portName的WSDL的serviceName或portName不匹配。
    
    如果portName不能从EndpointReference元数据确定。
    
    如果任何错误在创建Dispatch对象。
    
    如果启用了与此端口不兼容或不受支持的功能。
    从以下版本开始：
    
    JAX-WS 2.1
    
    另请参见：
    
    JAXBContext ， WebServiceFeature
  - getServiceName
```
public QName getServiceName()
```
    获取此服务的名称。
    
    结果
    
    此服务的合格名称
  - getPorts
```
public Iterator<QName> getPorts()
```
    返回 Iterator的 QName的服务端点列表 QName服务分组
    
    结果
    
    返回 java.util.Iterator ，元素类型为 javax.xml.namespace.QName 。
    
    异常
    
    WebServiceException - 如果此Service类无法访问所需的WSDL元数据。
  - getWSDLDocumentLocation
```
public URL getWSDLDocumentLocation()
```
    获取此服务的WSDL文档的位置。
    
    结果
    
    此服务的WSDL文档的位置的URL。
  - getHandlerResolver
```
public HandlerResolver getHandlerResolver()
```
    返回配置的处理程序解析器。
    
    结果
    
    HandlerResolver HandlerResolver被这个 Service实例使用，或者 null如果没有一个。
  - setHandlerResolver
```
public void setHandlerResolver(HandlerResolver handlerResolver)
```
    设置HandlerResolver这个Service实例。
    处理程序解析器（如果存在）将为创建的每个代理或分派实例调用一次，并且解析器返回的处理程序链将在实例上设置。
    
    参数
    
    handlerResolver -该 HandlerResolver用于所有随后创建的代理/调度对象。
    
    另请参见：
    
    HandlerResolver
  - getExecutor
```
public Executor getExecutor()
```
    返回此Service实例的执行程序。执行器用于需要回调的所有异步调用。
    
    结果
    
    用于调用回调的 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 - URL为服务的WSDL文档位置
    
    serviceName - QName为服务
    
    异常
    
    WebServiceException - 创建指定服务时是否有任何错误。
  - create
```
public static Service create(URL wsdlDocumentLocation,
                             QName serviceName,
                             WebServiceFeature... features)
```
    创建一个Service实例。创建的实例配置了Web服务功能。指定的WSDL文档位置和服务限定名称必须唯一标识wsdl:service元素。
    
    参数
    
    wsdlDocumentLocation - URL ，用于服务的WSDL文档位置
    
    serviceName - QName为服务
    
    features - 必须在服务上配置的Web Service功能。如果提供程序不了解某项功能，则必须抛出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 Service功能。如果提供程序不了解某项功能，则必须抛出WebServiceException。
    
    异常
    
    WebServiceException - 创建指定服务时是否有任何错误
    
    从以下版本开始：
    
    JAX-WS 2.2

Class Service

Nested Class Summary

构造方法摘要

方法摘要

Methods inherited from class java.lang.Object

构造方法详细信息

Service

Service

方法详细信息

getPort

getPort

getPort

getPort

getPort

addPort

createDispatch

createDispatch

createDispatch

createDispatch

createDispatch

createDispatch

getServiceName

getPorts

getWSDLDocumentLocation

getHandlerResolver

setHandlerResolver

getExecutor

setExecutor

create

create

create

create