javax.xml.ws.spi

Class Provider

java.lang.Object

javax.xml.ws.spi.Provider

public abstract class Provider
extends Object

ServiceDelegate和 Endpoint对象的服务提供商。

从以下版本开始：

JAX-WS 2.0

Field Summary

Fields

Modifier and Type	Field and Description
static String	JAXWSPROVIDER_PROPERTY 表示用于查找 Provider实现类的名称的属性的常量。

构造方法摘要

构造方法

Modifier	Constructor and Description
protected	Provider() 创建一个新的Provider实例

方法摘要

Modifier and Type	Method and Description
abstract Endpoint	createAndPublishEndpoint(String address, Object implementor) 创建并发布具有指定地址和实现对象的端点对象。
Endpoint	createAndPublishEndpoint(String address, Object implementor, WebServiceFeature... features) 创建并发布具有指定地址，实现对象和Web服务功能的端点对象。
Endpoint	createEndpoint(String bindingId, 类<?> implementorClass, Invoker invoker, WebServiceFeature... features) 使用提供的绑定，实现类，调用者和Web服务功能创建端点对象。
abstract Endpoint	createEndpoint(String bindingId, Object implementor) 使用提供的绑定和实现对象创建端点对象。
Endpoint	createEndpoint(String bindingId, Object implementor, WebServiceFeature... features) 使用提供的绑定，实现对象和Web服务功能创建端点对象。
abstract ServiceDelegate	createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, 类<? extends Service> serviceClass) 创建服务委托对象。
ServiceDelegate	createServiceDelegate(URL wsdlDocumentLocation, QName serviceName, 类<? extends Service> serviceClass, WebServiceFeature... features) 创建服务委托对象。
abstract W3CEndpointReference	createW3CEndpointReference(String address, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters) 工厂方法创建一个 W3CEndpointReference 。
W3CEndpointReference	createW3CEndpointReference(String address, QName interfaceName, QName serviceName, QName portName, List<Element> metadata, String wsdlDocumentLocation, List<Element> referenceParameters, List<Element> elements, Map<QName,String> attributes) 工厂方法创建一个 W3CEndpointReference 。
abstract <T> T	getPort(EndpointReference endpointReference, 类<T> serviceEndpointInterface, WebServiceFeature... features) getPort方法返回代理。
static Provider	provider() 创建一个新的提供者对象。
abstract EndpointReference	readEndpointReference(Source eprInfoset) 从eprInfoset中的信息集读取 eprInfoset 。

Methods inherited from class java.lang.Object

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

字段详细信息

JAXWSPROVIDER_PROPERTY

public static final String JAXWSPROVIDER_PROPERTY

一个常量，表示用于查找 Provider实现类名称的属性。

另请参见：

Constant Field Values

构造方法详细信息

Provider

protected Provider()

创建一个新的Provider实例

方法详细信息

provider

public static Provider provider()

创建一个新的提供者对象。

用于定位要使用的提供者子类的算法包括以下步骤：

• 如果存在名称为META-INF/services/javax.xml.ws.spi.Provider的资源，则将其第一行（如果存在）用作实现类的UTF-8编码名称。
• 如果$ java.home / lib / jaxws.properties文件存在，并且它可以被java.util.Properties.load(InputStream)方法读取，并且它包含一个条目，其密钥为javax.xml.ws.spi.Provider ，则该条目的值将用作实现类的名称。
• 如果定义了名称为javax.xml.ws.spi.Provider的系统属性，则将其值用作实现类的名称。
• 最后，使用默认实现类名。

createServiceDelegate

public abstract ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation,
                                                      QName serviceName,
                                                      类<? extends Service> serviceClass)

创建服务委托对象。

参数

wsdlDocumentLocation - 指向服务的WSDL文档的URL，如果没有， null 。

serviceName - 服务的限定名称。

serviceClass - 服务类，必须是 javax.xml.ws.Service或其子类。

结果

新创建的服务委托。

createServiceDelegate

public ServiceDelegate createServiceDelegate(URL wsdlDocumentLocation,
                                             QName serviceName,
                                             类<? extends Service> serviceClass,
                                             WebServiceFeature... features)

创建服务委托对象。

参数

wsdlDocumentLocation - 指向服务的WSDL文档的URL，如果没有一个 null 。

serviceName - 服务的限定名称。

serviceClass - 服务类，必须是 javax.xml.ws.Service或其子类。

features - 必须在服务上配置的Web Service功能。 如果提供程序不了解某项功能，则必须抛出WebServiceException。

结果

新创建的服务委托。

从以下版本开始：

JAX-WS 2.2

createEndpoint

public abstract Endpoint createEndpoint(String bindingId,
                                        Object implementor)

使用提供的绑定和实现对象创建端点对象。

参数

bindingId - 指定所需绑定的URI（例如SOAP / HTTP）

implementor - 将要调度传入请求的服务实现对象。 相应的类必须使用所有必要的Web服务注释进行注释。

结果

新创建的端点。

createAndPublishEndpoint

public abstract Endpoint createAndPublishEndpoint(String address,
                                                  Object implementor)

创建并发布具有指定地址和实现对象的端点对象。

参数

address - 指定要使用的地址和传输/协议的URI。 http：URI必须导致使用SOAP 1.1 / HTTP绑定。 实现可能支持其他URI方案。

implementor - 将要调度传入请求的服务实现对象。 相应的类必须使用所有必要的Web服务注释进行注释。

结果

新创建的端点。

readEndpointReference

public abstract EndpointReference readEndpointReference(Source eprInfoset)

从eprInfoset中 eprInfoset的信息集读取 eprInfoset 。

参数

eprInfoset - 用于EndpointReference的信息集

结果

该EndpointReference从解组eprInfoset 。 此方法从不返回null 。

异常

WebServiceException -如果有错误创建 EndpointReference从指定的 eprInfoset 。

NullPointerException - 如果给出了 null eprInfoset值。

从以下版本开始：

JAX-WS 2.1

getPort

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

getPort方法返回代理。 如果有在任何参考参数endpointReference ，则这些参考参数必须显示为SOAP标头，指示它们是参照参数，对发送到端点的所有消息。 参数serviceEndpointInterface指定返回代理支持的服务端点接口。 参数endpointReference指定返回的代理将调用的端点。 在此方法的实施中，JAX-WS运行时系统需要选择协议绑定（和端口）和来自的WSDL元数据相应地配置代理的责任serviceEndpointInterface和EndpointReference 。 为了成功返回代理的方法，WSDL元数据必须可用，并且endpointReference必须包含一个理解为serviceName元数据的实现。

参数

endpointReference - 返回的代理将调用的EndpointReference。

serviceEndpointInterface - 服务端点接口

features - 要在代理上配置的WebServiceFeatures列表。 支持的功能不是在features参数将其默认值。

结果

支持指定服务端点接口的Object Proxy实例

异常

WebServiceException -

• 如果在创建代理时出现错误
• 如果这个方法需要有任何遗漏的WSDL元数据}
• 如果这个endpointReference是非法的
• 如果非法serviceEndpointInterface指定
• 如果启用了与该端口不兼容或不受支持的功能。

从以下版本开始：

JAX-WS 2.1

另请参见：

WebServiceFeature

createW3CEndpointReference

public abstract W3CEndpointReference createW3CEndpointReference(String address,
                                                                QName serviceName,
                                                                QName portName,
                                                                List<Element> metadata,
                                                                String wsdlDocumentLocation,
                                                                List<Element> referenceParameters)

工厂方法创建一个W3CEndpointReference 。

该方法可用于为任何端点创建W3CEndpointReference ，方法是指定address属性以及任何其他所需的属性。 这种方法也可以用来创建一个W3CEndpointReference对于由同一个Java EE应用程序发布的端点。 这样做address可以提供财产或这种方法能自动判断address由同一个Java EE应用程序公布，并通过识别端点的serviceName个portName化子性质。 如果address为null ，并且serviceName和portName未标识同一Java EE应用程序发布的端点， javax.lang.IllegalStateException必须抛出javax.lang.IllegalStateException 。

参数

address - 指定目标端点的地址

serviceName - WSDL中服务的合格名称。

portName - WSDL中端点的合格名称。

metadata - 应添加到 W3CEndpointReference实例 wsa:metadata元素的元素列表。

wsdlDocumentLocation - 服务的WSDL文档位置的URL。

referenceParameters - 与返回的 EndpointReference实例相关联的 EndpointReference参数。

结果

该W3CEndpointReference从创建serviceName ， portName ， metadata ， wsdlDocumentLocation和referenceParameters 。 这种方法永远不会返回null 。

异常

IllegalStateException -

• 如果address ， serviceName和portName都null 。
• 如果serviceName服务是null和portName不是null 。
• 如果address属性为null ，并且serviceName和portName未指定由同一Java EE应用程序发布的有效端点。
• 如果serviceName不是null并且不在指定的WSDL中。
• 如果portName端口不是null ，并且它不存在于WSDL中的serviceName服务中。
• 如果wsdlDocumentLocation不是null并且不表示有效的WSDL。

WebServiceException - 如果在创建 W3CEndpointReference时发生错误。

从以下版本开始：

JAX-WS 2.1

createW3CEndpointReference

public W3CEndpointReference createW3CEndpointReference(String address,
                                                       QName interfaceName,
                                                       QName serviceName,
                                                       QName portName,
                                                       List<Element> metadata,
                                                       String wsdlDocumentLocation,
                                                       List<Element> referenceParameters,
                                                       List<Element> elements,
                                                       Map<QName,String> attributes)

工厂方法创建一个W3CEndpointReference 。 使用此方法，可以使用扩展元素和属性创建W3CEndpointReference实例。 Provider实现必须覆盖默认实现。

这种方法可以被用来创建一个W3CEndpointReference通过指定任何端点address与任何其它所需的性质沿属性。 这种方法也可以用来创建一个W3CEndpointReference对于由同一个Java EE应用程序发布的端点。 这样做address可以提供财产或这种方法能自动判断address由同一个Java EE应用程序公布，并通过识别端点的serviceName个portName化子性质。 如果address为null ，并且serviceName和portName未标识同一Java EE应用程序发布的端点， javax.lang.IllegalStateException必须抛出javax.lang.IllegalStateException 。

参数

address - 指定目标端点的地址

interfaceName - wsam:InterfaceName元素在 wsa:Metadata元素。

serviceName - WSDL中服务的合格名称。

portName - WSDL中端点的合格名称。

metadata - 应添加到 W3CEndpointReference实例 wsa:metadata元素的元素列表。

wsdlDocumentLocation - 服务的WSDL文档位置的URL。

referenceParameters - 与返回的 EndpointReference实例相关联的 EndpointReference参数。

elements - 与返回的 EndpointReference实例相关联的扩展元素。

attributes - 与返回的 EndpointReference实例相关联的 EndpointReference属性。

结果

该W3CEndpointReference从创建serviceName ， portName ， metadata ， wsdlDocumentLocation和referenceParameters 。 这种方法永远不会返回null 。

异常

IllegalStateException -

• 如果address ， serviceName和portName都null 。
• 如果serviceName服务是null和portName不是null 。
• 如果address属性为null ，并且serviceName和portName未指定由同一Java EE应用程序发布的有效端点。
• 如果serviceName不是null并且不在指定的WSDL中。
• 如果portName端口不是null ，并且它不存在于WSDL中的serviceName服务中。
• 如果wsdlDocumentLocation不是null并且不表示有效的WSDL。
• 如果wsdlDocumentLocation不是null但是wsdli：wsdlLocation的命名空间名称不能从可用的元数据获得。

WebServiceException - 如果在创建 W3CEndpointReference时发生错误。

从以下版本开始：

JAX-WS 2.2

createAndPublishEndpoint

public Endpoint createAndPublishEndpoint(String address,
                                         Object implementor,
                                         WebServiceFeature... features)

创建并发布具有指定地址，实现对象和Web服务功能的端点对象。 Provider实现必须覆盖默认实现。

参数

address - 指定要使用的地址和传输/协议的URI。 http：URI必须导致使用SOAP 1.1 / HTTP绑定。 实现可能支持其他URI方案。

implementor - 要发送传入请求的服务实现对象。 相应的类必须使用所有必要的Web服务注释进行注释。

features - 要在端点上配置的WebServiceFeatures列表。 支持的功能不是在features参数将其默认值。

结果

新创建的端点。

从以下版本开始：

JAX-WS 2.2

createEndpoint

public Endpoint createEndpoint(String bindingId,
                               Object implementor,
                               WebServiceFeature... features)

使用提供的绑定，实现对象和Web服务功能创建端点对象。 Provider实现必须覆盖默认实现。

参数

bindingId - 指定所需绑定的URI（例如SOAP / HTTP）

implementor - 将要调度传入请求的服务实现对象。 相应的类必须使用所有必要的Web服务注释进行注释。

features - 要在端点上配置的WebServiceFeatures的列表。 支持的功能不是在features参数将其默认值。

结果

新创建的端点。

从以下版本开始：

JAX-WS 2.2

createEndpoint

public Endpoint createEndpoint(String bindingId,
                               类<?> implementorClass,
                               Invoker invoker,
                               WebServiceFeature... features)

使用提供的绑定，实现类，调用者和Web服务功能创建端点对象。 容器通常使用它来创建Endpoint对象。 Provider实现必须覆盖默认实现。

参数

bindingId - 指定所需绑定的URI（例如SOAP / HTTP）。 可以为null。

implementorClass - 必须使用所有必需的Web服务注释注释的服务实现类。

invoker - 对服务实例进行实际调用。

features - 要在端点上配置的WebServiceFeatures列表。 支持的功能不是在features参数将其默认值。

结果

新创建的端点。

从以下版本开始：

JAX-WS 2.2