- 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文書内のサービスとポートに一致する必要があります。- 導入されたバージョン:
- 1.6, JAX-WS 2.1
-
-
コンストラクタのサマリー
コンストラクタ コンストラクタ 説明 W3CEndpointReferenceBuilder()
新しいW3CEndpointReferenceBuilder
のインスタンスを作成します。
-
メソッドのサマリー
すべてのメソッド インスタンス・メソッド 具象メソッド 修飾子と型 メソッド 説明 W3CEndpointReferenceBuilder
address(String address)
address
をW3CEndpointReference
インスタンスのwsa:Address
に設定します。W3CEndpointReferenceBuilder
attribute(QName name, String value)
拡張属性をW3CEndpointReference
インスタンスのwsa:EndpointReference
要素に追加します。W3CEndpointReference
build()
このW3CEndpointReferenceBuilder
インスタンスに設定されたプロパティの累積からW3CEndpointReference
を構築します。W3CEndpointReferenceBuilder
element(Element element)
拡張要素をW3CEndpointReference
インスタンスのwsa:EndpointReference
要素に追加します。W3CEndpointReferenceBuilder
endpointName(QName endpointName)
endpointName
をwsam:ServiceName/@EndpointName
としてwsa:Metadata
要素に設定します。W3CEndpointReferenceBuilder
interfaceName(QName interfaceName)
interfaceName
をwsam:InterfaceName
要素としてwsa:Metadata
要素に設定します。W3CEndpointReferenceBuilder
metadata(Element metadataElement)
W3CEndpointReference
インスタンスのwsa:Metadata
要素にmetadataElement
を追加します。W3CEndpointReferenceBuilder
referenceParameter(Element referenceParameter)
W3CEndpointReference
インスタンスのwsa:ReferenceParameters
要素にreferenceParameter
を追加します。W3CEndpointReferenceBuilder
serviceName(QName serviceName)
serviceName
をwsam:ServiceName
要素としてwsa:Metadata
要素に設定します。W3CEndpointReferenceBuilder
wsdlDocumentLocation(String wsdlDocumentLocation)
wsa:Metadata/@wsdli:wsdlLocation
として参照されるwsdlDocumentLocation
を設定します。
-
-
-
メソッドの詳細
-
address
public W3CEndpointReferenceBuilder address(String address)
address
をW3CEndpointReference
インスタンスのwsa:Address
に設定します。同じJava EEアプリケーションによって発行されたものでないWebサービス端点の
W3CEndpointReference
を構築する場合や、Java SEで実行されている場合は、address
をnull
以外の値に設定する必要があります。- パラメータ:
address
- 戻り値のW3CEndpointReference
のターゲットとなる端点のアドレス。- 戻り値:
address
がwsa:Address
に設定されたW3CEndpointReferenceBuilder
インスタンス。
-
interfaceName
public W3CEndpointReferenceBuilder interfaceName(QName interfaceName)
interfaceName
をwsam:InterfaceName
要素としてwsa:Metadata
要素に設定します。 詳細については、「2.1 Referencing WSDL Metadata from an EPR」を参照してください。- パラメータ:
interfaceName
- 戻り値のW3CEndpointReference
のターゲットとなる端点のポート型名。- 戻り値:
interfaceName
がwsam:InterfaceName
要素としてwsa:Metadata
要素に追加されたW3CEndpointReferenceBuilder
インスタンス- 導入されたバージョン:
- 1.7
-
serviceName
public W3CEndpointReferenceBuilder serviceName(QName serviceName)
serviceName
をwsam:ServiceName
要素としてwsa:Metadata
要素に設定します。 詳細については、「2.1 Referencing WSDL Metadata from an EPR」を参照してください。- パラメータ:
serviceName
- 戻り値のW3CEndpointReference
のターゲットとなる端点のサービス名。 このプロパティをendpointName
(portName)プロパティとともに使用して、同じJava EEアプリケーションによって発行されたWebサービス端点のaddress
を検索することもできる。- 戻り値:
serviceName
がwsam:ServiceName
要素としてwsa:Metadata
要素に追加されたW3CEndpointReferenceBuilder
インスタンス
-
endpointName
public W3CEndpointReferenceBuilder endpointName(QName endpointName)
endpointName
をwsam:ServiceName/@EndpointName
としてwsa:Metadata
要素に設定します。 このメソッドは、serviceName(QName)
メソッドが呼び出された後にのみ呼び出すことができます。詳細については、「2.1 Referencing WSDL Metadata from an EPR」を参照してください。
- パラメータ:
endpointName
- 戻り値のW3CEndpointReference
のターゲットとなる端点の名前。endpointName
(portName)プロパティをserviceName
プロパティとともに使用して、同じJava EEアプリケーションによって発行されたWebサービス端点のaddress
を検索することもできる。- 戻り値:
wsa:Metadata
要素でendpointName
がwsam:ServiceName/@EndpointName
として使用されるW3CEndpointReferenceBuilder
インスタンス。- 例外:
IllegalStateException
-serviceName
が設定されていない場合IllegalArgumentException
-endpointName
ネームスペースURIがserviceName
ネームスペースURIと一致しない場合
-
wsdlDocumentLocation
public W3CEndpointReferenceBuilder wsdlDocumentLocation(String wsdlDocumentLocation)
wsa:Metadata/@wsdli:wsdlLocation
として参照されるwsdlDocumentLocation
を設定します。 wsdli:wsdlLocationの値の名前空間の名前は、WSDL自体から取得できます。詳細については、「2.1 Referencing WSDL Metadata from an EPR」を参照してください。
- パラメータ:
wsdlDocumentLocation
-W3CEndpointReference
のwsa:Metadata
で参照される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
の場合。
-
element
public W3CEndpointReferenceBuilder element(Element element)
拡張要素をW3CEndpointReference
インスタンスのwsa:EndpointReference
要素に追加します。- パラメータ:
element
-W3CEndpointReference
に追加される拡張要素- 戻り値:
- 拡張
element
がW3CEndpointReference
インスタンスに追加されたW3CEndpointReferenceBuilder
インスタンス。 - 例外:
IllegalArgumentException
-element
がnull
の場合。- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
attribute
public W3CEndpointReferenceBuilder attribute(QName name, String value)
拡張属性をW3CEndpointReference
インスタンスのwsa:EndpointReference
要素に追加します。- パラメータ:
name
-W3CEndpointReference
に追加された拡張属性の名前value
- 拡張属性値- 戻り値:
- 拡張属性が
W3CEndpointReference
インスタンスに追加されたW3CEndpointReferenceBuilder
インスタンス。 - 例外:
IllegalArgumentException
-name
またはvalue
がnull
の場合- 導入されたバージョン:
- 1.7, JAX-WS 2.2
-
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
の作成中にエラーが発生した場合。
-
-