javax.xml.ws

クラス EndpointReference

java.lang.Object

javax.xml.ws.EndpointReference

直系の既知のサブクラス:

W3CEndpointReference

public abstract class EndpointReference
extends Object

このクラスは、Web サービス端点へのリモート参照である WS-Addressing EndpointReference を表します。WS-Addressing EndpointReference の詳細については、Web Services Addressing 1.0 - Core を参照してください。

一般に Web サービスの開発者はこのクラスの内容を考慮する必要がないため、このクラスは不変です。Web サービスの開発者は、リモートの Web サービス端点を参照するメカニズムとしてのみこのクラスを使用するようにしてください。クライアントで EndpointReference を利用するために使用できる Service API を参照してください。発行された端点に EndpointReferences を作成する方法については、Endpoint および BindingProvider API を参照してください。

このクラスの固定実装は、特定のバージョンのアドレス指定で使用する EndpointReference を表します。たとえば、W3CEndpointReference は「W3C Web Services Addressing 1.0 - Core Recommendation」で使用します。JAX-WS の実装者が複数のバージョンのアドレス指定をサポートする必要がある場合、そのバージョンに対応する独自の EndpointReference サブクラスを作成する必要があります。これにより、JAX-WS 実装でベンダー固有の EndpointReferences を作成でき、ベンダーはそれを使用して異なるバージョンのアドレス指定を示すことができます。

Web サービスの開発者は、SEI の Java メソッドで引数や戻り値として EndpointReference を使用する場合、W3CEndpointReference といった EndpointReference の具象インスタンスを使用するようにしてください。このようにすると、SEI からマッピングされたスキーマでは、渡される端点の参照の種類がより適切に記述されるようになります。

JAX-WS の実装者は、writeTo(javax.xml.transform.Result) メソッドを使用して XML 情報セットを EndpointReferece から抽出することが想定されています。

JAXB はこのクラスを xs:anyType にバインドします。より適切なバインディングが必要な場合、Web サービスの開発者は、W3CEndpointReference などの具象サブクラスを使用するようにしてください。

導入されたバージョン:

JAX-WS 2.1

関連項目:

W3CEndpointReference, Service

コンストラクタのサマリー

コンストラクタ

修飾子	コンストラクタと説明
protected	EndpointReference()

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
<T> T	getPort(Class<T> serviceEndpointInterface, WebServiceFeature... features) getPort メソッドはプロキシを返します。
static EndpointReference	readFrom(Source eprInfoset) eprInfoset に含まれている情報セットから EndpointReference を読み取るためのファクトリメソッドです。
String	toString() デバッグに役立つように EPR 情報セットを表示します。
abstract void	writeTo(Result result) この EndpointReference を指定された情報セット形式に書き出します。

クラス java.lang.Object から継承されたメソッド

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

コンストラクタの詳細

EndpointReference

protected EndpointReference()

メソッドの詳細

readFrom

public static EndpointReference readFrom(Source eprInfoset)

eprInfoset に含まれている情報セットから EndpointReference を読み取るためのファクトリメソッドです。このメソッドは、Provider.readEndpointReference(javax.xml.transform.Source) メソッドのベンダー固有の実装に処理を委譲します。

パラメータ:

eprInfoset - 非整列化する EndpointReference 情報セット

戻り値:

eprInfoset から非整列化された EndpointReference。null になることはない

例外:

WebServiceException - eprInfoset から EndpointReference の作成中にエラーが発生した場合

IllegalArgumentException - 指定された eprInfoset の値が null の場合。

writeTo

public abstract void writeTo(Result result)

この EndpointReference を指定された情報セット形式に書き出します。

パラメータ:

result - 情報セットの書き込み用

例外:

WebServiceException - EndpointReference を指定の result に書き出すときにエラーが発生した場合。

IllegalArgumentException - 指定された result の値が null の場合。

getPort

public <T> T getPort(Class<T> serviceEndpointInterface,
            WebServiceFeature... features)

getPort メソッドはプロキシを返します。EndpointReference インスタンスに参照パラメータがある場合は、端点に送信されるすべてのメッセージにそれらの参照パラメータを SOAP ヘッダーとして含め、それらが参照パラメータであることを示す必要があります。パラメータ serviceEndpointInterface は、戻り値のプロキシによってサポートされるサービス端点インタフェースを指定します。EndpointReference インスタンスは、戻り値のプロキシによって呼び出される端点を指定します。このメソッドの実装では、この EndpointReference の WSDL メタデータまたは serviceEndpointInterface の注釈に従って、JAX-WS 実行システムがプロトコルバインディング (およびポート) の選択とプロキシの構成を行います。このメソッドで正常にプロキシを取得するには、WSDL メタデータが利用可能であることと、実装で認識されるserviceName メタデータが EndpointReference インスタンスに含まれていることが必要です。

このポートは Service オブジェクトから作成されるのではないため、ハンドラは自動的には構成されず、HandlerResolver と Executor の取得や設定をこのポートから行うことはできません。BindingProvider().getBinding().setHandlerChain() メソッドを使用すると、このポートのハンドラを手動で構成することができます。

パラメータ:

serviceEndpointInterface - サービス端点インタフェース

features - プロキシに構成する WebServiceFeatures の配列。features パラメータに含まれていないサポートされる機能には、デフォルト値が設定される。

戻り値:

指定されたサービス端点インタフェースをサポートする Object Proxy インスタンス

例外:

WebServiceException -

• プロキシの作成中にエラーがあった場合
• このメソッドが必要とする WSDL メタデータが不足している場合
• この endpointReference が無効である場合
• 不正な serviceEndpointInterface が指定された場合
• このポートと互換性のない機能、またはサポートされていない機能を有効にした場合。

関連項目:

Proxy, WebServiceFeature

toString

public String toString()

デバッグに役立つように EPR 情報セットを表示します。

オーバーライド:

toString、クラス: Object

戻り値:

このオブジェクトの文字列表現。