- java.lang.Object
-
- javax.xml.ws.Endpoint
-
public abstract class Endpoint extends Object
Webサービス端点。端点は、このクラスに定義されたstaticメソッドを使用して作成されます。 端点は常に1つの
Binding
と1つのimplementorに結合され、端点の作成時にこの両方が設定されます。端点は、発行または未発行のいずれかの状態をとります。
publish
メソッドは、端点の発行を開始するために使用できます。発行が開始されると、着信要求の受入れが開始されます。 逆に、stop
メソッドを使用すると、着信要求の受入れを中止し、端点を停止させることができます。 停止後、端点を再び発行することはできません。着信要求をディスパッチするために使用されるスレッドをより強力に制御するため、
Executor
が端点に設定されることもあります。 たとえば、ThreadPoolExecutor
を作成し、端点にそれを登録することによって、特定のパラメータを持つスレッド・プールを有効にすることができます。包含する
Binding
を使用して、ハンドラ・チェーンを設定することができます。端点は、それにバインドされているメタデータ文書(WSDL、XMLSchema文書など)のリストを含むことがあります。 発行時に、JAX-WS実装は、implementorに存在する注釈に基づいて新規生成するのではなく、メタデータのできるだけ多くを再利用しようとします。
- 導入されたバージョン:
- 1.6, JAX-WS 2.0
- 関連項目:
Binding
,BindingType
,SOAPBinding
,Executor
-
-
フィールドのサマリー
フィールド 修飾子と型 フィールド 説明 static String
WSDL_PORT
標準プロパティ: WSDLポートの名前。static String
WSDL_SERVICE
標準プロパティ: WSDLサービスの名前。
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 Endpoint()
-
メソッドのサマリー
すべてのメソッド staticメソッド インスタンス・メソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 static Endpoint
create(Object implementor)
指定されたimplementorオブジェクトを持つ端点を作成します。static Endpoint
create(Object implementor, WebServiceFeature... features)
指定されたimplementorオブジェクトおよびWebサービス機能を持つ端点を作成します。static Endpoint
create(String bindingId, Object implementor)
指定されたバインディング型とimplementorオブジェクトを使用して端点を作成します。static Endpoint
create(String bindingId, Object implementor, WebServiceFeature... features)
指定されたバインディング・タイプ、実装オブジェクト、およびWebサービス機能を持つ端点を作成します。abstract Binding
getBinding()
この端点のバインディングを返します。abstract <T extends EndpointReference>
TgetEndpointReference(Class<T> clazz, Element... referenceParameters)
このEndpoint
インスタンスに関連付けられたEndpointReference
を返します。abstract EndpointReference
getEndpointReference(Element... referenceParameters)
このEndpoint
インスタンスに関連付けられたEndpointReference
を返します。abstract Executor
getExecutor()
このEndpoint
インスタンスのexecutorを返します。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)
指定されたアドレスで、指定されたimplementorオブジェクトの端点を作成および発行します。static Endpoint
publish(String address, Object implementor, WebServiceFeature... features)
指定されたアドレスで、指定されたimplementorオブジェクトの端点を作成および発行します。void
publish(HttpContext serverContext)
指定されたサーバー・コンテキストでこの端点を発行します。void
setEndpointContext(EndpointContext ctxt)
EndpointContext
を設定することにより、JAX-WSランタイムはアプリケーション内の他のエンドポイントのアドレスを知ることができます。abstract void
setExecutor(Executor executor)
このEndpoint
インスタンスのexecutorを設定します。abstract void
setMetadata(List<Source> metadata)
この端点のメタデータを設定します。abstract void
setProperties(Map<String,Object> properties)
このEndpoint
インスタンスのプロパティ・バッグを設定します。abstract void
stop()
発行中のこの端点を停止します。
-
-
-
メソッドの詳細
-
create
public static Endpoint create(Object implementor)
指定されたimplementorオブジェクトを持つ端点を作成します。 BindingType注釈を介して指定されたバインディングがある場合、それを使用しなければならず、そうでない場合、デフォルトのSOAP 1.1 /HTTPバインディングを使用しなければいけません。新しく作成された端点は、
publish(String)
およびpublish(Object)
メソッドのいずれかを呼び出すことによって発行できます。- パラメータ:
implementor
- 端点の実装者。- 戻り値:
- 新しく作成された端点。
-
create
public static Endpoint create(Object implementor, WebServiceFeature... features)
指定されたimplementorオブジェクトおよびWebサービス機能を持つ端点を作成します。 BindingType注釈を介して指定されたバインディングがある場合、それを使用しなければならず、そうでない場合、デフォルトのSOAP 1.1 /HTTPバインディングを使用しなければいけません。新しく作成された端点は、
publish(String)
およびpublish(Object)
メソッドのいずれかを呼び出すことによって発行できます。- パラメータ:
implementor
- 端点の実装者。features
- 端点に構成するWebServiceFeatureのリスト。features
パラメータに含まれていないサポートされる機能には、デフォルト値が設定される。- 戻り値:
- 新しく作成された端点。
- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
create
public static Endpoint create(String bindingId, Object implementor)
指定されたバインディング型とimplementorオブジェクトを使用して端点を作成します。新しく作成された端点は、
publish(String)
およびpublish(Object)
メソッドのいずれかを呼び出すことによって発行できます。- パラメータ:
bindingId
- 使用するバインディングを指定するURI。 bindingIDがnull
で、BindingType注釈を介してバインディングが指定されていない場合は、デフォルトのSOAP 1.1 /HTTPバインディングを使用する必要がある。implementor
- 端点の実装者。- 戻り値:
- 新しく作成された端点。
-
create
public static Endpoint create(String bindingId, Object implementor, WebServiceFeature... features)
指定されたバインディング・タイプ、実装オブジェクト、およびWebサービス機能を持つ端点を作成します。新しく作成された端点は、
publish(String)
およびpublish(Object)
メソッドのいずれかを呼び出すことによって発行できます。- パラメータ:
bindingId
- 使用するバインディングを指定するURI。 bindingIDがnull
で、BindingType注釈を介してバインディングが指定されていない場合は、デフォルトのSOAP 1.1 /HTTPバインディングを使用する必要がある。implementor
- 端点の実装者。features
- 端点に構成するWebServiceFeatureのリスト。features
パラメータに含まれていないサポートされる機能には、デフォルト値が設定される。- 戻り値:
- 新しく作成された端点。
- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
getBinding
public abstract Binding getBinding()
この端点のバインディングを返します。- 戻り値:
- この端点のバインディング
-
getImplementor
public abstract Object getImplementor()
この端点の実装オブジェクトを返します。- 戻り値:
- この端点のimplementor
-
publish
public abstract void publish(String address)
指定されたアドレスでこの端点を発行します。 必要なサーバー・インフラストラクチャは、JAX-WS実装により、デフォルト設定を使用して作成および構成されます。 サーバー構成をより詳細に制御するには、publish(Object)
メソッドを代わりに使用してください。- パラメータ:
address
- 使用するアドレスを指定するURI。 このアドレスは、端点作成時に指定したバインディングに対応していなくてはならない。- 例外:
IllegalArgumentException
- 指定したアドレスURIを端点のバインディングとともに使用できない場合。IllegalStateException
- 端点がすでに発行されている、または、すでに停止されている場合。SecurityException
-java.lang.SecurityManger
が使用されている場合で、アプリケーションにWebServicePermission("publishEndpoint")
アクセス権がないとき。
-
publish
public static Endpoint publish(String address, Object implementor)
指定されたアドレスで、指定されたimplementorオブジェクトの端点を作成および発行します。必要なサーバー・インフラストラクチャは、JAX-WS実装により、デフォルト設定を使用して作成および構成されます。 サーバー構成をより詳細に制御するには、
create(String,Object)
メソッドおよびpublish(Object)
メソッドを代わりに使用してください。- パラメータ:
address
- 使用するアドレス、および、トランスポートまたはプロトコルを指定するURI。 http: URIが、使用されているSOAP 1.1/HTTPバインディングに帰着する必要がある。 実装がその他のURIスキームをサポートすることも可能である。implementor
- 端点の実装者。- 戻り値:
- 新しく作成された端点。
- 例外:
SecurityException
-java.lang.SecurityManger
が使用されている場合で、アプリケーションにWebServicePermission("publishEndpoint")
アクセス権がないとき。
-
publish
public static Endpoint publish(String address, Object implementor, WebServiceFeature... features)
指定されたアドレスで、指定されたimplementorオブジェクトの端点を作成および発行します。 作成される端点はWebサービス機能で構成されます。必要なサーバー・インフラストラクチャは、JAX-WS実装により、デフォルト設定を使用して作成および構成されます。 サーバー構成をより詳細に制御するには、
create(String,Object)
メソッドおよびpublish(Object)
メソッドを代わりに使用してください。- パラメータ:
address
- 使用するアドレス、および、トランスポートまたはプロトコルを指定するURI。 http: URIが、使用されているSOAP 1.1/HTTPバインディングに帰着する必要がある。 実装がその他のURIスキームをサポートすることも可能である。implementor
- 端点の実装者。features
- 端点に構成するWebServiceFeatureのリスト。features
パラメータに含まれていないサポートされる機能には、デフォルト値が設定される。- 戻り値:
- 新しく作成された端点。
- 例外:
SecurityException
-java.lang.SecurityManger
が使用されている場合で、アプリケーションにWebServicePermission("publishEndpoint")
アクセス権がないとき。- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
publish
public abstract void publish(Object serverContext)
指定されたサーバー・コンテキストでこの端点を発行します。 サーバー・コンテキストは、サーバー・インフラストラクチャおよび特定のトランスポートのアドレッシング情報をカプセル化します。 このメソッドの呼出しを成功させるには、それに引数として渡されるサーバー・コンテキストが端点のバインディングと互換性がなくてはいけません。- パラメータ:
serverContext
- 端点を発行するために使用されるサーバー・コンテキストを表すオブジェクト。- 例外:
IllegalArgumentException
- 指定されたサーバー・コンテキストが実装によってサポートされていない、または、端点のバインディングとともに使用できないことが判明した場合。IllegalStateException
- 端点がすでに発行されている、または、すでに停止されている場合。SecurityException
-java.lang.SecurityManger
が使用されている場合で、アプリケーションにWebServicePermission("publishEndpoint")
アクセス権がないとき。
-
publish
public void publish(HttpContext serverContext)
指定されたサーバー・コンテキストでこの端点を発行します。 サーバー・コンテキストは、サーバー・インフラストラクチャおよび特定のトランスポートのアドレッシング情報をカプセル化します。 このメソッドの呼出しを成功させるには、それに引数として渡されるサーバー・コンテキストが端点のバインディングと互換性がなくてはいけません。これは、コンテナ開発者が端点を移植性の高い方法で発行するためのものであり、エンド開発者向けのものではありません。
- パラメータ:
serverContext
- 端点を発行するために使用されるサーバー・コンテキストを表すオブジェクト。- 例外:
IllegalArgumentException
- 指定されたサーバー・コンテキストが実装によってサポートされていない、または、端点のバインディングとともに使用できないことが判明した場合。IllegalStateException
- 端点がすでに発行されている、または、すでに停止されている場合。SecurityException
-java.lang.SecurityManger
が使用されている場合で、アプリケーションにWebServicePermission("publishEndpoint")
アクセス権がないとき。- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
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
インスタンスのexecutorを返します。 executorは、着信要求をimplementorオブジェクトにディスパッチするために使用されます。- 戻り値:
- 要求をディスパッチするために使用される
java.util.concurrent.Executor
。 - 関連項目:
Executor
-
setExecutor
public abstract void setExecutor(Executor executor)
このEndpoint
インスタンスのexecutorを設定します。 executorは、着信要求をimplementorオブジェクトにディスパッチするために使用されます。 このEndpoint
がpublish(Object)
メソッドを使用して発行され、指定したサーバー・コンテキストがそれ自身のスレッド処理動作を定義している場合、executorは無視されることがあります。- パラメータ:
executor
- 要求をディスパッチするために使用されるjava.util.concurrent.Executor
。- 例外:
SecurityException
- セキュリティ上の理由により、インスタンスがexecutorを設定することをサポートしていない場合(たとえば、必要なアクセス権が不足している場合)。- 関連項目:
Executor
-
getProperties
public abstract Map<String,Object> getProperties()
このEndpoint
インスタンスのプロパティ・バッグを返します。- 戻り値:
- Map<String,Object>このインスタンスに関連付けられているプロパティ・バッグ。
-
setProperties
public abstract void setProperties(Map<String,Object> properties)
このEndpoint
インスタンスのプロパティ・バッグを設定します。- パラメータ:
properties
- このインスタンスに関連付けられているプロパティ・バッグ。
-
getEndpointReference
public abstract EndpointReference getEndpointReference(Element... referenceParameters)
このEndpoint
インスタンスに関連付けられたEndpointReference
を返します。この
bindingProvider
のバインディングがSOAP1.1/HTTPまたはSOAP1.2/HTTPの場合は、W3CEndpointReference
を返す必要があります。- パラメータ:
referenceParameters
- 返されるEndpointReference
インスタンスに関連付けられる参照パラメータ。- 戻り値:
- この
Endpoint
インスタンスのEndpointReference。 返されるEndpointReference
がW3CEndpointReference
型の場合は、指定されたreferenceParameters
を含む必要がある。 - 例外:
WebServiceException
-EndpointReference
の作成でエラーが発生した場合、またはEndpoint
が発行されている状態でない場合。UnsupportedOperationException
- このBindingProvider
がXML/HTTPバインディングを使用している場合。- 導入されたバージョン:
- 1.6, JAX-WS 2.1
- 関連項目:
W3CEndpointReference
-
getEndpointReference
public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz, Element... referenceParameters)
このEndpoint
インスタンスに関連付けられたEndpointReference
を返します。- 型パラメータ:
T
- EndpointReferenceのタイプ。- パラメータ:
clazz
- 取得する必要のあるEndpointReferenceの型を指定する。referenceParameters
- 返されるEndpointReference
インスタンスに関連付けられる参照パラメータ。- 戻り値:
- この
Endpoint
インスタンスのclazz
型のEndpointReference。 返されるEndpointReference
がW3CEndpointReference
型の場合は、指定されたreferenceParameters
を含む必要がある。 - 例外:
WebServiceException
-EndpointReference
の作成でエラーが発生した場合、Endpoint
が発行されている状態でない場合、またはEndpointReference
の型としてclazz
がサポートされていない場合。UnsupportedOperationException
- このBindingProvider
がXML/HTTPバインディングを使用している場合。- 導入されたバージョン:
- 1.6, JAX-WS 2.1
-
setEndpointContext
public void setEndpointContext(EndpointContext ctxt)
EndpointContext
を設定することにより、JAX-WSランタイムはアプリケーション内の他のエンドポイントのアドレスを知ることができます。 複数の端点がWSDLの異なるポートを共有する場合、WSDLにアクセスすると、複数のポート・アドレスにパッチが適用されます。端点を発行する前に設定する必要があります。
- パラメータ:
ctxt
- 複数の端点で共有される- 例外:
IllegalStateException
- 端点がすでに発行されている、または、すでに停止されている場合。- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
-