javax.xml.ws

インタフェースDispatch<T>

すべてのスーパー・インタフェース:

BindingProvider

public interface Dispatch<T>
extends BindingProvider

Dispatchインタフェースは、サービス端点操作の動的な呼出しのサポートを提供します。javax.xml.ws.Serviceクラスは、Dispatchインスタンスを作成するためのファクトリとして動作します。

導入されたバージョン:

JAX-WS 2.0

フィールドのサマリー

インタフェース javax.xml.ws.BindingProviderから継承されたフィールド

ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, SOAPACTION_URI_PROPERTY, SOAPACTION_USE_PROPERTY, USERNAME_PROPERTY

メソッドのサマリー

修飾子と型	メソッドと説明
T	invoke(T msg) サービス操作を同期的に呼び出します。
Response<T>	invokeAsync(T msg) サービス操作を非同期的に呼び出します。
Future<?>	invokeAsync(T msg, AsyncHandler<T> handler) サービス操作を非同期的に呼び出します。
void	invokeOneWay(T msg) 一方向対話モードを使用してサービス操作を呼び出します。

インタフェース javax.xml.ws.BindingProviderから継承されたメソッド

getBinding, getEndpointReference, getEndpointReference, getRequestContext, getResponseContext

メソッドの詳細

invoke

T invoke(T msg)

サービス操作を同期的に呼び出します。クライアントは、使用しているプロトコル・バインディングの要件に従って、整列化時にmsgオブジェクトが形成されることを保証します。

パラメータ:

msg - 操作を呼び出すために使用されるメッセージまたはメッセージのペイロードを形成するオブジェクト。

戻り値:

操作の呼出しに対する応答メッセージまたはメッセージ・ペイロード。

例外:

WebServiceException - サービスとの通信中に障害が発生した場合

WebServiceException - Dispatchインスタンスの構成にエラーがあった場合

invokeAsync

Response<T> invokeAsync(T msg)

サービス操作を非同期的に呼び出します。このメソッドは、操作呼出しに対する応答を待つことなく返し、操作の結果は戻り値のResponseをポーリングすることによって取得されます。

クライアントは、使用しているプロトコル・バインディングの要件に従って、整列化時にmsgオブジェクトが形成されることを保証します。

パラメータ:

msg - 操作を呼び出すために使用されるメッセージまたはメッセージのペイロードを形成するオブジェクト。

戻り値:

操作の呼出しに対する応答メッセージまたはメッセージ・ペイロード。

例外:

WebServiceException - Dispatchインスタンスの構成にエラーがあった場合

invokeAsync

Future<?> invokeAsync(T msg,
                      AsyncHandler<T> handler)

サービス操作を非同期的に呼び出します。このメソッドは、操作呼出しに対する応答を待つことなく返し、操作の結果はhandlerを渡すことによってクライアントに通知されます。

クライアントは、使用しているプロトコル・バインディングの要件に従って、整列化時にmsgオブジェクトが形成されることを保証します。

パラメータ:

msg - 操作を呼び出すために使用されるメッセージまたはメッセージのペイロードを形成するオブジェクト。

handler - 操作の呼出しに対する応答を受け取るハンドラ・オブジェクト。

戻り値:

操作呼出しのステータスをチェックするために使用される可能性があるFutureオブジェクト。このオブジェクトは、操作の結果の取得を試みるために使用してはならない。Future<?>.get()から返されるオブジェクトは実装依存であり、その使用は移植性のない動作の原因となる。

例外:

WebServiceException - Dispatchインスタンスの構成にエラーがあった場合

invokeOneWay

void invokeOneWay(T msg)

一方向対話モードを使用してサービス操作を呼び出します。操作の呼出しは、論理的に非ブロッキングであり、基盤プロトコルの機能によって左右され、結果が返されません。使用するプロトコルがSOAP/HTTPの場合、HTTP応答コードの受信が完了するまでこのメソッドはブロックする必要があり、そうならない場合、エラーが発生します。

クライアントは、使用しているプロトコル・バインディングの要件に従って、整列化時にmsgオブジェクトが形成されることを保証します。

パラメータ:

msg - 操作を呼び出すために使用されるメッセージまたはメッセージのペイロードを形成するオブジェクト。

例外:

WebServiceException - Dispatchインスタンスの構成にエラーがあった場合、または呼出し中にエラーが発生した場合。