javax.xml.ws.wsaddressing
クラス W3CEndpointReferenceBuilder

java.lang.Object
  javax.xml.ws.wsaddressing.W3CEndpointReferenceBuilder

public final class W3CEndpointReferenceBuilder
extends Object

このクラスは、W3CEndpointReference インスタンスを構築するために使用されます。このクラスは、同じ Java EE アプリケーションによって発行された Web サービス端点の W3CEndpointReference をファクトリコンポーネントなどのアプリケーションコンポーネントで作成する場合に使用されます。address プロパティーを指定することにより、Java SE ベースの端点の W3CEndpointReferences も作成できます。

同じ Java EE アプリケーションによって発行されたものでない端点の W3CEndpointReference を作成する場合は、address プロパティーを指定する必要があります。

同じ Java EE アプリケーションによって発行された端点の W3CEndpointReference を作成する場合は、address プロパティーは null でもかまいません。ただしその場合は、serviceName と endpointName が同じ Java EE アプリケーションによって発行された端点を指定する必要があります。

wsdlDocumentLocation を指定する場合、それは有効な WSDL 文書を参照している必要があり、serviceName と endpointName は (指定された場合) WSDL 文書内のサービスとポートに一致する必要があります。

導入されたバージョン:

JAX-WS 2.1

コンストラクタの概要

W3CEndpointReferenceBuilder()
新しい W3CEndpointReferenceBuilder インスタンスを作成します。

メソッドの概要

W3CEndpointReferenceBuilder	address(String address) address を W3CEndpointReference インスタンスの wsa:Address に設定します。
W3CEndpointReference	build() この W3CEndpointReferenceBuilder インスタンスに設定されたプロパティーの累積から W3CEndpointReference を構築します。
W3CEndpointReferenceBuilder	endpointName(QName endpointName) 戻り値の W3CEndpointRefernce のターゲットとなる端点の endpointName を設定します。
W3CEndpointReferenceBuilder	metadata(Element metadataElement) W3CEndpointReference インスタンスの wsa:Metadata 要素に metadataElement を追加します。
W3CEndpointReferenceBuilder	referenceParameter(Element referenceParameter) W3CEndpointReference インスタンスの wsa:ReferenceParameters 要素に referenceParameter を追加します。
W3CEndpointReferenceBuilder	serviceName(QName serviceName) 戻り値の W3CEndpointReference のターゲットとなる端点の serviceName を設定します。
W3CEndpointReferenceBuilder	wsdlDocumentLocation(String wsdlDocumentLocation) ターゲットである W3CEndpointReference に関連付けられる wsdlDocumentLocation を設定します。

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

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

コンストラクタの詳細

W3CEndpointReferenceBuilder

public W3CEndpointReferenceBuilder()

新しい W3CEndpointReferenceBuilder インスタンスを作成します。

メソッドの詳細

address

public W3CEndpointReferenceBuilder address(String address)

address を W3CEndpointReference インスタンスの wsa:Address に設定します。

同じ Java EE アプリケーションによって発行されたものでない Web サービス端点の W3CEndpointReference を構築する場合や、Java SE で実行されている場合は、address を null 以外の値に設定する必要があります。

パラメータ:

address - 戻り値の W3CEndpointReference のターゲットとなる端点のアドレス

戻り値:

address が wsa:Address に設定された W3CEndpointReferenceBuilder インスタンス

serviceName

public W3CEndpointReferenceBuilder serviceName(QName serviceName)

戻り値の W3CEndpointReference のターゲットとなる端点の serviceName を設定します。

パラメータ:

serviceName - 戻り値の W3CEndpointReference のターゲットとなる端点のサービス名。このプロパティーを endpointName (portName) プロパティーとともに使用して、同じ Java EE アプリケーションによって発行された Web サービス端点の address を検索することもできる

戻り値:

serviceName プロパティーが設定された W3CEndpointReferenceBuilder インスタンス

endpointName

public W3CEndpointReferenceBuilder endpointName(QName endpointName)

戻り値の W3CEndpointRefernce のターゲットとなる端点の endpointName を設定します。このメソッドは、serviceName メソッドを呼び出したあとにのみ呼び出すことができます。

パラメータ:

endpointName - 戻り値の W3CEndpointReference のターゲットとなる端点の名前。endpointName (portName) プロパティーを serviceName プロパティーとともに使用して、同じ Java EE アプリケーションによって発行された Web サービス端点の address を検索することもできる

戻り値:

endpointName プロパティーが設定された W3CEndpointReferenceBuilder インスタンス

例外:

IllegalStateException - serviceName が設定されていない場合

wsdlDocumentLocation

public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation)

ターゲットである W3CEndpointReference に関連付けられる wsdlDocumentLocation を設定します。

パラメータ:

wsdlDocumentLocation - ターゲットである W3CEndpointReference に関連付けられる WSDL 文書の位置

戻り値:

wsdlDocumentLocation プロパティーが設定された W3CEndpointReferenceBuilder インスタンス

referenceParameter

public W3CEndpointReferenceBuilder referenceParameter(Element referenceParameter)

W3CEndpointReference インスタンスの wsa:ReferenceParameters 要素に referenceParameter を追加します。

パラメータ:

referenceParameter - wsa:ReferenceParameters 要素に追加する要素

戻り値:

referenceParameter が wsa:ReferenceParameters 要素に追加された W3CEndpointReferenceBuilder インスタンス

例外:

IllegalArgumentException - referenceParameter が null の場合

metadata

public W3CEndpointReferenceBuilder metadata(Element metadataElement)

W3CEndpointReference インスタンスの wsa:Metadata 要素に metadataElement を追加します。

パラメータ:

metadataElement - wsa:Metadata 要素に追加する要素

戻り値:

metadataElement が wsa:Metadata 要素に追加された W3CEndpointReferenceBuilder インスタンス

例外:

IllegalArgumentException - metadataElement が null の場合

build

public W3CEndpointReference build()

この W3CEndpointReferenceBuilder インスタンスに設定されたプロパティーの累積から W3CEndpointReference を構築します。

このメソッドを使用して、address プロパティーと必要なほかのプロパティーを指定することにより、任意の端点の W3CEndpointReference を作成できます。このメソッドを使用して、同じ Java EE アプリケーションによって発行される端点の W3CEndpointReference を作成することもできます。このメソッドは、serviceName および endpointName プロパティーで識別される同じ Java EE アプリケーションによって発行された端点の address を自動的に判定することができます。address が null の場合に、serviceName と endpointName で識別される対象が同じ Java EE アプリケーションから発行された端点でないときは、java.lang.IllegalStateException をスローする必要があります。

戻り値:

この W3CEndpointReferenceBuilder インスタンスに設定されたプロパティーの累積から構築された W3CEndpointReference。このメソッドが null を返すことはない

例外:

IllegalStateException -

• address、serviceName、および endpointName がすべて null の場合
• serviceName サービスが null で、endpointName が null でない場合
• address プロパティーが null の場合に、serviceName と endpointName で指定される対象が同じ Java EE アプリケーションから発行された有効な端点でないとき
• serviceName が null でなく、指定の WSDL 内に存在しない場合
• endpointName ポートが null でなく、WSDL の serviceName サービス内に存在しない場合
• wsdlDocumentLocation が null でなく、有効な WSDL を表していない場合

WebServiceException - W3CEndpointReference の作成中にエラーが発生した場合