javax.xml.ws

インタフェース BindingProvider

既知のすべてのサブインタフェース:

Dispatch<T>

public interface BindingProvider

BindingProvider インタフェースは、要求および応答メッセージ処理のためのプロトコルバインディングと関連付けられたコンテキストオブジェクトへのアクセスを提供します。

導入されたバージョン:

JAX-WS 2.0

関連項目:

Binding

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	ENDPOINT_ADDRESS_PROPERTY 標準プロパティー:ターゲットサービス端点アドレス。
static String	PASSWORD_PROPERTY 標準プロパティー:認証用のパスワード。
static String	SESSION_MAINTAIN_PROPERTY 標準プロパティー:この boolean プロパティーは、サービス端点とのセッションに参加するかどうかを示すためにサービスクライアントによって使用されます。
static String	SOAPACTION_URI_PROPERTY SOAPAction の標準プロパティー。
static String	SOAPACTION_USE_PROPERTY SOAPAction の標準プロパティー。
static String	USERNAME_PROPERTY 標準プロパティー: 認証用のユーザー名。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
Binding	getBinding() このバインディングプロバイダのバインディングを取得します。
EndpointReference	getEndpointReference() この BindingProvider インスタンスに関連付けられた EndpointReference を返します。
<T extends EndpointReference> T	getEndpointReference(Class<T> clazz) この BindingProvider インスタンスに関連付けられた EndpointReference を返します。
Map<String,Object>	getRequestContext() 要求メッセージのメッセージコンテキストを初期化するために使用されるコンテキストを取得します。
Map<String,Object>	getResponseContext() 応答メッセージを処理することによって得られたコンテキストを取得します。

フィールドの詳細

USERNAME_PROPERTY

static final String USERNAME_PROPERTY

標準プロパティー: 認証用のユーザー名。

型: java.lang.String

関連項目:

定数フィールド値

PASSWORD_PROPERTY

static final String PASSWORD_PROPERTY

標準プロパティー: 認証用のパスワード。

型: java.lang.String

関連項目:

定数フィールド値

ENDPOINT_ADDRESS_PROPERTY

static final String ENDPOINT_ADDRESS_PROPERTY

標準プロパティー:ターゲットサービス端点アドレス。端点アドレス仕様の URI スキームは、使用するバインディングのプロトコルまたはトランスポートバインディングに対応している必要があります。

型: java.lang.String

関連項目:

定数フィールド値

SESSION_MAINTAIN_PROPERTY

static final String SESSION_MAINTAIN_PROPERTY

標準プロパティー: この boolean プロパティーは、サービス端点とのセッションに参加するかどうかを示すためにサービスクライアントによって使用されます。このプロパティーが true に設定されている場合、サービスクライアントはセッションの保持を望んでいることを示します。false に設定されている場合、セッションは保持されません。このプロパティーのデフォルト値は false です。

型: java.lang.Boolean

関連項目:

定数フィールド値

SOAPACTION_USE_PROPERTY

static final String SOAPACTION_USE_PROPERTY

SOAPAction の標準プロパティー。この boolean プロパティーは、javax.xml.ws.soap.http.soapaction.uri プロパティーの値が SOAPAction の値に使用されるかどうかを示します。このプロパティーのデフォルト値は false で、javax.xml.ws.soap.http.soapaction.uri プロパティーが SOAPAction の値に使用されないことを示します。ただし、WS-Addressing が有効になっている場合、デフォルト値は true です。

型: java.lang.Boolean

関連項目:

定数フィールド値

SOAPACTION_URI_PROPERTY

static final String SOAPACTION_URI_PROPERTY

SOAPAction の標準プロパティー。javax.xml.ws.soap.http.soapaction.use プロパティーが true に設定されている場合、SOAPAction URI を示します。WS-Addressing が有効になっている場合、この値は WS-Addressing の Action ヘッダーの値にも使用されます。このプロパティーが設定されていない場合は、デフォルトの SOAPAction と WS-Addressing Action が送信されます。

型: java.lang.String

関連項目:

定数フィールド値

メソッドの詳細

getRequestContext

Map<String,Object> getRequestContext()

要求メッセージのメッセージコンテキストを初期化するために使用されるコンテキストを取得します。 要求コンテキストへの変更は、すでに開始している同期または非同期操作のメッセージコンテキストに影響を与えません。

戻り値:

要求メッセージを処理するときに使用されるコンテキスト。

getResponseContext

Map<String,Object> getResponseContext()

応答メッセージを処理することによって得られたコンテキストを取得します。 戻り値のコンテキストは、もっとも最近完了した同期操作のコンテキストです。後続の同期操作呼び出しは、応答コンテキストを上書きします。非同期操作は、Response インタフェースを介して自身の応答コンテキストを返します。

戻り値:

最後の応答メッセージを処理することによって得られるコンテキスト。

getBinding

Binding getBinding()

このバインディングプロバイダのバインディングを取得します。

戻り値:

このバインディングプロバイダのバインディング。

getEndpointReference

EndpointReference getEndpointReference()

この BindingProvider インスタンスに関連付けられた EndpointReference を返します。

この bindingProvider のバインディングが SOAP1.1/HTTP または SOAP1.2/HTTP の場合は、W3CEndpointReference を返す必要があります。

戻り値:

この BindingProvider インスタンスに関連したターゲット端点の EndpointReference。

例外:

UnsupportedOperationException - この BindingProvider が XML/HTTP バインディングを使用している場合。

導入されたバージョン:

JAX-WS 2.1

関連項目:

W3CEndpointReference

getEndpointReference

<T extends EndpointReference> T getEndpointReference(Class<T> clazz)

この BindingProvider インスタンスに関連付けられた EndpointReference を返します。返されるインスタンスの型は clazz になります。

パラメータ:

clazz - 取得する必要のある EndpointReference の型を指定する。

戻り値:

この BindingProvider インスタンスに関連したターゲット端点の EndpointReference。clazz 型でなければいけない。

例外:

WebServiceException - この実装が Class clazz をサポートしていない場合。

UnsupportedOperationException - この BindingProvider が XML/HTTP バインディングを使用している場合。

導入されたバージョン:

JAX-WS 2.1