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

戻り値:

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