public final class W3CEndpointReferenceBuilder extends ObjectSE
W3CEndpointReference
インスタンスを構築するために使用されます。この clsss の使用目的は、同じ Jakarta EE アプリケーションによって公開された Web サービスエンドポイントの W3CEndpointReference
を作成するための、ファクトリコンポーネントなどのアプリケーションコンポーネントです。また、address
プロパティを提供することにより、JavaSE ベースのエンドポイントの W3CEndpointReferences
を作成するために使用することもできます。 同じ Jakarta EE アプリケーションによって公開されていないエンドポイントの W3CEndpointReference
を作成する場合は、address
プロパティを指定する必要があります。
同じ Jakarta EE アプリケーションによって公開されたエンドポイントの W3CEndpointReference
を作成する場合、address
プロパティは null
である可能性がありますが、serviceName
と endpointName
は同じ Jakarta EE アプリケーションによって公開されたエンドポイントを指定する必要があります。
wsdlDocumentLocation
が指定されている場合、有効な WSDL ドキュメントを参照する必要があり、serviceName
と endpointName
(指定されている場合)は WSDL ドキュメントのサービスとポートと一致する必要があります。
コンストラクターと説明 |
---|
W3CEndpointReferenceBuilder() 新しい W3CEndpointReferenceBuilder インスタンスを作成します。 |
修飾子と型 | メソッドと説明 |
---|---|
W3CEndpointReferenceBuilder | address(StringSE address) address を W3CEndpointReference インスタンスの wsa:Address に設定します。 |
W3CEndpointReferenceBuilder | attribute(QNameSE name, StringSE value) W3CEndpointReference インスタンスの wsa:EndpointReference 要素に拡張属性を追加します。 |
W3CEndpointReference | build() この W3CEndpointReferenceBuilder インスタンスに設定された累積プロパティから W3CEndpointReference を構築します。 |
W3CEndpointReferenceBuilder | element(ElementSE element) W3CEndpointReference インスタンスの wsa:EndpointReference 要素に拡張要素を追加します。 |
W3CEndpointReferenceBuilder | endpointName(QNameSE endpointName) wsa:Metadata 要素で endpointName を wsam:ServiceName/@EndpointName として設定します。 |
W3CEndpointReferenceBuilder | interfaceName(QNameSE interfaceName) interfaceName を wsa:Metadata 要素の wsam:InterfaceName 要素として設定します。 |
W3CEndpointReferenceBuilder | metadata(ElementSE metadataElement) metadataElement を W3CEndpointReference インスタンスの wsa:Metadata 要素に追加します。 |
W3CEndpointReferenceBuilder | referenceParameter(ElementSE referenceParameter) referenceParameter を W3CEndpointReference インスタンス wsa:ReferenceParameters 要素に追加します。 |
W3CEndpointReferenceBuilder | serviceName(QNameSE serviceName) serviceName を wsa:Metadata 要素の wsam:ServiceName 要素として設定します。 |
W3CEndpointReferenceBuilder | wsdlDocumentLocation(StringSE wsdlDocumentLocation) wsa:Metadata/@wsdli:wsdlLocation として参照される wsdlDocumentLocation を設定します。 |
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE
public W3CEndpointReferenceBuilder()
W3CEndpointReferenceBuilder
インスタンスを作成します。public W3CEndpointReferenceBuilder address(StringSE address)
address
を W3CEndpointReference
インスタンスの wsa:Address
に設定します。 同じ Jakarta EE アプリケーションによって公開されていない Web サービスエンドポイントの W3CEndpointReference
を構築する場合、または Java SE で実行する場合は、address
を非 null
値に設定する必要があります。
address
- 返された W3CEndpointReference
のターゲットとなるエンドポイントのアドレス。address
が wsa:Address
に設定された W3CEndpointReferenceBuilder
インスタンス。public W3CEndpointReferenceBuilder interfaceName(QNameSE interfaceName)
interfaceName
を wsa:Metadata
要素の wsam:InterfaceName
要素として設定します。詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。interfaceName
- 返された W3CEndpointReference
の対象となるエンドポイントのポート型名。wsa:Metadata
要素に wsam:InterfaceName
要素として interfaceName
が追加された W3CEndpointReferenceBuilder
インスタンス public W3CEndpointReferenceBuilder serviceName(QNameSE serviceName)
serviceName
を wsa:Metadata
要素の wsam:ServiceName
要素として設定します。詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。serviceName
- 返される W3CEndpointReference
の対象となるエンドポイントのサービス名。このプロパティは、同じ Jakarta EE アプリケーションによって公開される Web サービスエンドポイントの address
を検索するために、endpointName
(portName) プロパティとともに使用することもできます。wsa:Metadata
要素に wsam:ServiceName
要素として serviceName
が追加された W3CEndpointReferenceBuilder
インスタンス public W3CEndpointReferenceBuilder endpointName(QNameSE endpointName)
wsa:Metadata
要素で endpointName
を wsam:ServiceName/@EndpointName
として設定します。このメソッドは、serviceName(QName)
メソッドが呼び出された後にのみ呼び出すことができます。詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。
endpointName
- 返される W3CEndpointReference
の対象となるエンドポイントの名前。endpointName
(portName) プロパティは、同じ Jakarta EE アプリケーションによって公開された Web サービスエンドポイントの address
を検索するために、serviceName
プロパティとともに使用することもできます。wsa:Metadata
エレメント内の wsam:ServiceName/@EndpointName
として endpointName
を持つ W3CEndpointReferenceBuilder
インスタンス。IllegalStateExceptionSE
- serviceName
が設定されていない場合 IllegalArgumentExceptionSE
- endpointName
の名前空間 URI が serviceName
の名前空間 URI と一致しない場合 public W3CEndpointReferenceBuilder wsdlDocumentLocation(StringSE wsdlDocumentLocation)
wsa:Metadata/@wsdli:wsdlLocation
として参照される wsdlDocumentLocation
を設定します。wsdli:wsdlLocation の値の名前空間名は、WSDL 自体から取得できます。詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。
wsdlDocumentLocation
- W3CEndpointReference
の wsa:Metadata
で参照される WSDL ドキュメントの場所。wsdlDocumentLocation
を持つ W3CEndpointReferenceBuilder
インスタンス。public W3CEndpointReferenceBuilder referenceParameter(ElementSE referenceParameter)
referenceParameter
を W3CEndpointReference
インスタンス wsa:ReferenceParameters
要素に追加します。referenceParameter
- wsa:ReferenceParameters
要素に追加される要素。referenceParameter
が wsa:ReferenceParameters
要素に追加された W3CEndpointReferenceBuilder
インスタンス。IllegalArgumentExceptionSE
- referenceParameter
が null
の場合。public W3CEndpointReferenceBuilder metadata(ElementSE metadataElement)
metadataElement
を W3CEndpointReference
インスタンスの wsa:Metadata
要素に追加します。metadataElement
- wsa:Metadata
要素に追加される要素。metadataElement
が wsa:Metadata
要素に追加された W3CEndpointReferenceBuilder
インスタンス。IllegalArgumentExceptionSE
- metadataElement
が null
の場合。public W3CEndpointReferenceBuilder element(ElementSE element)
W3CEndpointReference
インスタンスの wsa:EndpointReference
要素に拡張要素を追加します。element
- W3CEndpointReference
に追加される拡張要素 W3CEndpointReference
インスタンスに拡張子 element
が追加された W3CEndpointReferenceBuilder
インスタンス。IllegalArgumentExceptionSE
- element
が null
の場合。public W3CEndpointReferenceBuilder attribute(QNameSE name, StringSE value)
W3CEndpointReference
インスタンスの wsa:EndpointReference
要素に拡張属性を追加します。name
- W3CEndpointReference
に追加される拡張属性の名前 value
- 拡張属性値 W3CEndpointReference
インスタンスに追加された W3CEndpointReferenceBuilder
インスタンス。IllegalArgumentExceptionSE
- name
または value
が null
の場合。public W3CEndpointReference build()
W3CEndpointReferenceBuilder
インスタンスに設定された累積プロパティから W3CEndpointReference
を構築します。 このメソッドを使用して、address
プロパティを他の必要なプロパティとともに指定することにより、任意のエンドポイントの W3CEndpointReference
を作成できます。このメソッドを使用して、同じ Jakarta EE アプリケーションによって公開されるエンドポイントの W3CEndpointReference
を作成することもできます。このメソッドは、serviceName
および endpointName
プロパティによって識別される同じ Jakarta EE アプリケーションによって公開されたエンドポイントの address
を自動的に判別できます。address
が null
であり、serviceName
と endpointName
が同じ Jakarta EE アプリケーションによって公開されたエンドポイントを識別しない場合、java.lang.IllegalStateException
をスローする必要があります。
W3CEndpointReferenceBuilder
インスタンスに設定された累積プロパティからの W3CEndpointReference
。このメソッドは null
を返すことはありません。IllegalStateExceptionSE
-address
、serviceName
、endpointName
がすべて null
の場合。serviceName
サービスが null
で、endpointName
が null
ではない場合。address
プロパティが null
で、serviceName
と endpointName
が同じ Jakarta EE アプリケーションによって公開された有効なエンドポイントを指定していない場合。serviceName
が null
ではなく、指定された WSDL に存在しない場合。endpointName
ポートが null
ではなく、WSDL の serviceName
サービスに存在しない場合。wsdlDocumentLocation
が null
ではなく、有効な WSDL を表していない場合。WebServiceException
- W3CEndpointReference
の作成中にエラーが発生した場合。Copyright © 2018,2020 Eclipse Foundation.
Use is subject to license terms.