JavaTM 2 Platform
Standard Ed. 6

javax.xml.ws
類別 Endpoint

java.lang.Object
  繼承者 javax.xml.ws.Endpoint

public abstract class Endpoint
extends Object

Web 服務端點。

使用在此類別中定義的靜態方法創建端點。一個端點總是綁定到一個 Binding 和一個實作者,這兩項都是在創建端點時設置的。

端點要麼處於已發佈狀態,要麼處於未發佈狀態。可以使用 publish 方法開始發佈端點,此時端點開始接受傳入請求。相反,可以使用 stop 方法停止接受傳入請求並取消端點。一旦停止,就不能再次發佈該端點。

可以在端點上設置 Executor 以便更好地控制用來指派傳入請求的執行緒。例如,通過創建 ThreadPoolExecutor 並向端點註冊可以啟用帶有特定參數的執行緒池。

處理程序鏈可以使用所含的 Binding 來設置。

端點可以使一個元資料文檔(如 WSDL 和 XMLSchema 文檔)列表與之綁定。發佈時,JAX-WS 實作將根據實作者上存在的註釋,盡可能多地重用這些元資料,而不是產生新的元資料。

從以下版本開始:
JAX-WS 2.0
另請參見:
Binding, BindingType, SOAPBinding, Executor

欄位摘要
static String WSDL_PORT
          標準屬性:WSDL 埠號的名稱。
static String WSDL_SERVICE
          標準屬性:WSDL 服務的名稱。
 
建構子摘要
Endpoint()
           
 
方法摘要
static Endpoint create(Object implementor)
          創建具有指定實作者物件的端點。
static Endpoint create(String bindingId, Object implementor)
          創建具有指定綁定型別和實作者物件的端點。
abstract  Binding getBinding()
          返回此端點的綁定。
abstract  Executor getExecutor()
          返回此 Endpoint 實例的執行程序。
abstract  Object getImplementor()
          返回此端點的實作物件。
abstract  List<Source> getMetadata()
          返回服務的元資料文檔列表。
abstract  Map<String,Object> getProperties()
          返回此 Endpoint 實例的屬性套件。
abstract  boolean isPublished()
          如果端點已處於發佈狀態,則返回 true。
abstract  void publish(Object serverContext)
          在提供的伺服器上下文中發佈此端點。
abstract  void publish(String address)
          在給定位址處發佈此端點。
static Endpoint publish(String address, Object implementor)
          在給定位址處針對指定的實作者物件創建共時布端點。
abstract  void setExecutor(Executor executor)
          設置此 Endpoint 實例的執行程序。
abstract  void setMetadata(List<Source> metadata)
          設置此端點的元資料。
abstract  void setProperties(Map<String,Object> properties)
          設置此 Endpoint 實例的屬性套件。
abstract  void stop()
          停止發佈此端點。
 
從類別 java.lang.Object 繼承的方法
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

欄位詳細資訊

WSDL_SERVICE

public static final String WSDL_SERVICE
標準屬性:WSDL 服務的名稱。

型別:javax.xml.namespace.QName

另請參見:
常數欄位值

WSDL_PORT

public static final String WSDL_PORT
標準屬性:WSDL 埠號的名稱。

型別:javax.xml.namespace.QName

另請參見:
常數欄位值
建構子詳細資訊

Endpoint

public Endpoint()
方法詳細資訊

create

public static Endpoint create(Object implementor)
創建具有指定實作者物件的端點。如果存在通過 BindingType 註釋指定的綁定,則必須使用該綁定,否則必須使用預設的 SOAP 1.1 / HTTP 綁定。

可以通過調用 javax.xml.ws.Endpoint#publish(String) 和 javax.xml.ws.Endpoint#publish(Object) 方法之一來發佈新創建的端點。

參數:
implementor - 端點實作者。
返回:
新創建的端點。

create

public static Endpoint create(String bindingId,
                              Object implementor)
創建具有指定綁定型別和實作者物件的端點。

可以通過調用 javax.xml.ws.Endpoint#publish(String) 和 javax.xml.ws.Endpoint#publish(Object) 方法之一來發佈新創建的端點。

參數:
bindingId - 一個 URI,指定要使用的綁定。如果 bindingID 為 null 並且沒有通過 BindingType 註釋指定任何綁定,則必須使用預設的 SOAP 1.1 / HTTP 綁定。
implementor - 端點實作者。
返回:
新創建的端點。

getBinding

public abstract Binding getBinding()
返回此端點的綁定。

返回:
此端點的綁定

getImplementor

public abstract Object getImplementor()
返回此端點的實作物件。

返回:
此端點的實作者

publish

public abstract void publish(String address)
在給定位址處發佈此端點。JAX-WS 實作將使用一些預設的配置創建和配置所需的伺服器基礎設施。若要更多地控制伺服器配置,請使用 javax.xml.ws.Endpoint#publish(Object) 方法。

參數:
address - 一個 URI,指定要使用的位址。位址必須與創建端點時指定的綁定相容。
拋出:
IllegalArgumentException - 如果提供的位址 URI 不能與端點的綁定結合使用。
IllegalStateException - 如果已發佈端點或者已停止端點。

publish

public static Endpoint publish(String address,
                               Object implementor)
在給定位址處針對指定的實作者物件創建共時布端點。

JAX-WS 實作將使用一些預設的配置創建和配置所需的伺服器基礎設施。 若要更多地控制伺服器配置,請使用 javax.xml.ws.Endpoint#create(String,Object) 和 javax.xml.ws.Endpoint#publish(Object) 方法。

參數:
address - 一個 URI,指定要使用的位址和傳輸/協議。http:URI 一定會導致使用 SOAP 1.1/HTTP 綁定。實作可以支持其他 URI 方案。
implementor - 端點實作者。
返回:
新創建的端點。

publish

public abstract void publish(Object serverContext)
在提供的伺服器上下文中發佈此端點。伺服器上下文封裝了用於特定傳輸的伺服器基礎設施和尋址資訊。要成功調用該方法,作為參數傳遞給它的伺服器上下文必須與端點的綁定相容。

參數:
serverContext - 表示發佈端點所用伺服器上下文的物件。
拋出:
IllegalArgumentException - 如果實作不支持提供的伺服器上下文,或者被證明無法與端點的綁定結合使用。
IllegalStateException - 如果已發佈端點或者已停止端點。

stop

public abstract void stop()
停止發佈此端點。 如果端點未處於已發佈狀態,則此方法無效。


isPublished

public abstract boolean isPublished()
如果端點已處於發佈狀態,則返回 true。

返回:
如果端點已處於發佈狀態,則返回 true

getMetadata

public abstract List<Source> getMetadata()
返回服務的元資料文檔列表。

返回:
List<javax.xml.transform.Source> 服務的元資料文檔列表

setMetadata

public abstract void setMetadata(List<Source> metadata)
設置此端點的元資料。

參數:
metadata - 套件含端點元資料資訊的 XML 文檔源(例如,WSDL 或 XML 網要文檔)列表
拋出:
IllegalStateException - 如果已發佈端點。

getExecutor

public abstract Executor getExecutor()
返回此 Endpoint 實例的執行程序。 執行程序用於向實作者物件指派傳入請求。

返回:
將用來指派請求的 java.util.concurrent.Executor
另請參見:
Executor

setExecutor

public abstract void setExecutor(Executor executor)
設置此 Endpoint 實例的執行程序。 執行程序用於向實作者物件指派傳入請求。 如果此 Endpoint 使用 publish(Object) 方法發佈,並且指定的伺服器上下文定義它自己的執行緒行為,則可以忽略執行程序。

參數:
executor - 將用來指派請求的 java.util.concurrent.Executor
拋出:
SecurityException - 如果出於安全的原因(例如,缺少必要的權限),實例不支持設置執行程序。
另請參見:
Executor

getProperties

public abstract Map<String,Object> getProperties()
返回此 Endpoint 實例的屬性套件。

返回:
Map<String,Object>,與此實例關聯的屬性套件。

setProperties

public abstract void setProperties(Map<String,Object> properties)
設置此 Endpoint 實例的屬性套件。

參數:
properties - 與此實例關聯的屬性套件。

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only