javax.xml.ws
類別 Service

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

public class Service
extends Object

Service 物件提供 Web 服務的客戶端視圖。

Service 作為以下內容的處理器：

• 目標服務端點的代理。
• 用於遠端操作的動態導向訊息調用的 javax.xml.ws.Dispatch 實例。

使用 getPorts 方法可以對服務上可用的埠號進行列舉。此外，還可以將一個服務端點介面傳遞給一元的 getPort 方法，並允許運行時選擇相容的埠號。

可以通過 HandlerResolver 設置由 Service 創建的所有物件的處理程序鏈。

可以在服務上設置 Executor 以便更好地控制用來指派非同步回調的執行緒。例如，通過創建 ThreadPoolExecutor 並向服務註冊它可以啟用帶有特定參數的執行緒池。

從以下版本開始：

JAX-WS 2.0

另請參見：

Provider, HandlerResolver, Executor

巢狀類別摘要

static class

Service.Mode 動態客戶端或服務的方向。

建構子摘要

protected

Service(URL wsdlDocumentLocation, QName serviceName)

方法摘要

void	addPort(QName portName, String bindingId, String endpointAddress) 為服務創建新的埠號。
static Service	create(QName serviceName) 創建 Service 實例。
static Service	create(URL wsdlDocumentLocation, QName serviceName) 創建 Service 實例。
<T> Dispatch<T>	createDispatch(QName portName, Class<T> type, Service.Mode mode) 創建與使用者選擇的物件一起使用的 Dispatch 實例。
Dispatch<Object>	createDispatch(QName portName, JAXBContext context, Service.Mode mode) 創建與產生的 JAXB 物件一起使用的 Dispatch 實例。
Executor	getExecutor() 返回此 Service 實例的執行程序。
HandlerResolver	getHandlerResolver() 返回已配置的處理程序解析器。
<T> T	getPort(Class<T> serviceEndpointInterface) getPort 返回 stub。
<T> T	getPort(QName portName, Class<T> serviceEndpointInterface) getPort 方法返回 stub。
Iterator<QName>	getPorts() 返回一個 Iterator，它用於此服務所組合的服務端點的 QName 列表。
QName	getServiceName() 獲取此服務的名稱。
URL	getWSDLDocumentLocation() 獲取此 Service 的 WSDL 文檔的位置。
void	setExecutor(Executor executor) 設置此 Service 實例的執行程序。
void	setHandlerResolver(HandlerResolver handlerResolver) 設置此 Service 實例的 HandlerResolver。

從類別 java.lang.Object 繼承的方法

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

建構子詳細資訊

Service

protected Service(URL wsdlDocumentLocation,
                  QName serviceName)

方法詳細資訊

getPort

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

getPort 方法返回 stub。服務客戶端使用此 stub 調用目標服務端點上的操作。serviceEndpointInterface 指定創建的動態代理或 stub 實例所支持的服務端點介面。

參數：

portName - WSDL 服務描述中服務端點的限定名稱

serviceEndpointInterface - 動態代理或 stub 實例所支持的服務端點介面

返回：

支持指定服務端點介面的物件代理實例

拋出：

WebServiceException - 在以下情況下拋出此異常：

• 如果創建代理的過程中出現錯誤
• 如果缺少此方法所需的任何 WSDL 元資料
• 如果指定了非法的 serviceEndpointInterface 或 portName

另請參見：

Proxy, InvocationHandler

getPort

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

getPort 返回 stub。參數 serviceEndpointInterface 指定返回的代理所支持的服務端點介面。在此方法的實作中，JAX-WS 運行時系統承擔選擇協議綁定（和埠號）以及配置相應代理的責任。返回的代理不應該由客戶端進行配置。

參數：

serviceEndpointInterface - 服務端點介面

返回：

支持指定服務端點介面的物件實例

拋出：

WebServiceException -

• 如果創建代理的過程中出現錯誤
• 如果缺少此方法所需的任何 WSDL 元資料
• 如果指定了非法的 serviceEndpointInterface

addPort

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

為服務創建新的埠號。以這種方法創建的埠號不包含 WSDL 埠號型別資訊，並且只能用於創建 Dispatch 實例。

參數：

portName - 目標服務端點的限定名稱

bindingId - 綁定的 String 標識符。

endpointAddress - URI 形式的目標服務端點位址

拋出：

WebServiceException - 如果創建埠號的過程中出現錯誤

另請參見：

SOAPBinding.SOAP11HTTP_BINDING, SOAPBinding.SOAP12HTTP_BINDING, HTTPBinding.HTTP_BINDING

createDispatch

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

創建與使用者選擇的物件一起使用的 Dispatch 實例。

參數：

portName - 目標服務端點的限定名稱

type - 用於訊息或訊息負載的物件類別。要求實作支持 javax.xml.transform.Source、javax.xml.soap.SOAPMessage 和 javax.activation.DataSource，具體取決於使用的綁定。

mode - 控制創建的 Dispatch 實例是訊息還是所導向的淨荷，即使用者使用完整的協議訊息還是訊息負載。例如，當使用 SOAP 協議時，此參數控制使用者將使用 SOAP 訊息還是使用 SOAP 正文的內容。當型別為 SOAPMessage 時，網要必須為 MESSAGE。

返回：

Dispatch 實例

拋出：

WebServiceException - 如果創建 Dispatch 物件的過程中出現錯誤

另請參見：

Source, SOAPMessage

createDispatch

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

創建與產生的 JAXB 物件一起使用的 Dispatch 實例。

參數：

portName - 目標服務端點的限定名稱

context - 用來對訊息或訊息負載進行編組和解組的 JAXB 上下文。

mode - 控制創建的 Dispatch 實例是訊息還是所導向的淨荷，即使用者使用完整的協議訊息還是訊息負載。例如，當使用 SOAP 協議時，此參數控制使用者將使用 SOAP 訊息還是使用 SOAP 正文的內容。

返回：

Dispatch 實例

拋出：

ServiceException - 如果創建 Dispatch 物件的過程中出現錯誤

另請參見：

JAXBContext

getServiceName

public QName getServiceName()

獲取此服務的名稱。

返回：

此服務的限定名稱

getPorts

public Iterator<QName> getPorts()

返回一個 Iterator，它用於此服務所組合的服務端點的 QName 列表。

返回：

返回元素型別為 javax.xml.namespace.QName 的 java.util.Iterator

拋出：

WebServiceException - 如果此 Service 類別沒有對所需 WSDL 元資料的存取權限

getWSDLDocumentLocation

public URL getWSDLDocumentLocation()

獲取此 Service 的 WSDL 文檔的位置。

返回：

此服務 WSDL 文檔位置的 URL

getHandlerResolver

public HandlerResolver getHandlerResolver()

返回已配置的處理程序解析器。

返回：

HandlerResolver，此 Service 實例所使用的 HandlerResolver，如果不存在，則返回 null。

setHandlerResolver

public void setHandlerResolver(HandlerResolver handlerResolver)

設置此 Service 實例的 HandlerResolver。

如果存在處理程序解析器，則創建每個代理或 Dispatch 實例時將調用一次該解析器，並且將在實例上設置解析器所返回的處理程序鏈。

參數：

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 - 服務 WSDL 文檔位置的 URL

serviceName - 服務的 QName

拋出：

WebServiceException - 如果在創建指定服務的過程中發生任何錯誤

create

public static Service create(QName serviceName)

創建 Service 實例。

參數：

serviceName - 服務的 QName

拋出：

WebServiceException - 如果在創建指定服務的過程中發生任何錯誤