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 インスタンスの構成にエラーがあった場合、または呼び出し中にエラーが発生した場合。