Endpoint (Java Platform SE 6)

概要

パッケージ

クラス

使用

階層ツリー

非推奨 API

索引

ヘルプ

Java^TM Platform
Standard Ed. 6

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

javax.xml.ws
クラス Endpoint

java.lang.Object
  javax.xml.ws.Endpoint

public abstract class Endpoint
extends Object
extends Object

Web サービス端点。

端点は、このクラスに定義された static メソッドを使用して作成されます。端点は常に 1 つの Binding と 1 つの implementor に結合され、端点の作成時にこの両方が設定されます。

端点は、発行または未発行のいずれかの状態を取ります。publish メソッドは、端点の発行を開始するために使用できます。発行が開始されると、着信要求の受け入れが開始されます。逆に、stop メソッドを使用すると、着信要求の受け入れを中止し、端点を停止させることができます。停止後、端点を再び発行することはできません。

着信要求をディスパッチするために使用されるスレッドをより強力に制御するため、Executor が端点に設定されることもあります。たとえば、ThreadPoolExecutor を作成し、端点にそれを登録することによって、特定のパラメータを持つスレッドプールを有効にすることができます。

包含する Binding を使用して、ハンドラチェーンを設定することができます。

端点は、それにバインドされているメタデータ文書 (WSDL、XMLSchema 文書など) のリストを含むことがあります。発行時に、JAX-WS 実装は、implementor に存在する注釈に基づいて新規生成するのではなく、メタデータのできるだけ多くを再利用しようとします。

導入されたバージョン:: JAX-WS 2.0
関連項目:: Binding, BindingType, SOAPBinding, Executor

フィールドの概要
`static String`	`WSDL_PORT` 標準プロパティー:WSDL ポートの名前。
`static String`	`WSDL_SERVICE` 標準プロパティー:WSDL サービスの名前。

コンストラクタの概要
`Endpoint()`

メソッドの概要

static Endpoint create(Object implementor)
指定された implementor オブジェクトを持つ端点を作成します。

static Endpoint create(String bindingId, Object implementor)
指定されたバインディング型と implementor オブジェクトを使用して端点を作成します。

abstract Binding getBinding()
この端点のバインディングを返します。

abstract 



<T extends EndpointReference> 


T

getEndpointReference(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 オブジェクトの端点を作成および発行します。

abstract void setExecutor(Executor executor)
この Endpoint インスタンスの executor を設定します。

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 サービスの名前。

関連項目:: 定数フィールド値

WSDL_PORT

public static final String WSDL_PORT

標準プロパティー:WSDL ポートの名前。

関連項目:: 定数フィールド値

コンストラクタの詳細

Endpoint

public Endpoint()

メソッドの詳細

create

public static Endpoint create(Object implementor)

指定された implementor オブジェクトを持つ端点を作成します。BindingType 注釈を介して指定されたバインディングがある場合、それを使用しなければならず、そうでない場合、デフォルトの SOAP 1.1 / HTTP バインディングを使用しなければいけません。

新しく作成された端点は、publish(String) および publish(Object) メソッドのいずれかを呼び出すことによって発行できます。

パラメータ:: implementor - 端点の implementor
戻り値:: 新しく作成された端点

create

public static Endpoint create(String bindingId,
                              Object implementor)

指定されたバインディング型と implementor オブジェクトを使用して端点を作成します。

新しく作成された端点は、publish(String) および publish(Object) メソッドのいずれかを呼び出すことによって発行できます。

パラメータ:: bindingId - 使用するバインディングを指定する URI。bindingID が null で、BindingType 注釈を介してバインディングが指定されていない場合は、デフォルトの SOAP 1.1 / HTTP バインディングを使用する必要がある; implementor - 端点の implementor
戻り値:: 新しく作成された端点

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 - 端点の implementor
戻り値:: 新しく作成された端点
例外:: SecurityException - java.lang.SecurityManger が使用されている場合で、アプリケーションに WebServicePermission("publishEndpoint") アクセス権がないとき

publish

public abstract void publish(Object serverContext)

指定されたサーバーコンテキストでこの端点を発行します。サーバーコンテキストは、サーバーインフラストラクチャーおよび特定のトランスポートのアドレッシング情報をカプセル化します。このメソッドの呼び出しを成功させるには、それに引数として渡されるサーバーコンテキストが端点のバインディングと互換性がなくてはいけません。

パラメータ:: serverContext - 端点を発行するために使用されるサーバーコンテキストを表すオブジェクト
例外:: IllegalArgumentException - 指定されたサーバーコンテキストが実装によってサポートされていない、または、端点のバインディングとともに使用できないことが判明した場合; IllegalStateException - 端点が既に発行されている、または、既に停止されている場合; SecurityException - java.lang.SecurityManger が使用されている場合で、アプリケーションに WebServicePermission("publishEndpoint") アクセス権がないとき

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 バインディングを使用している場合
導入されたバージョン:: JAX-WS 2.1
関連項目:: W3CEndpointReference

getEndpointReference

public abstract <T extends EndpointReference> T getEndpointReference(Class<T> clazz,
                                                                     Element... referenceParameters)

この Endpoint インスタンスに関連した EndpointReference を返します。

パラメータ:: clazz - 取得する必要のある EndpointReference の型を指定する; referenceParameters - 返される EndpointReference インスタンスに関連付けられる参照パラメータ
戻り値:: この Endpoint インスタンスの clazz 型の EndpointReference。返される EndpointReference が W3CEndpointReference 型の場合は、指定された referenceParameters を含む必要がある
例外:: WebServiceException - EndpointReference の作成でエラーが発生した場合、Endpoint が発行されている状態でない場合、または EndpointReference の型として clazz がサポートされていない場合; UnsupportedOperationException - この BindingProvider が XML/HTTP バインディングを使用している場合
導入されたバージョン:: JAX-WS 2.1