コンストラクターの詳細

• W3CEndpointReferenceBuilder

  public W3CEndpointReferenceBuilder()

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

メソッドの詳細

• address

  public W3CEndpointReferenceBuilder address​(StringSE address)

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

  同じ Jakarta EE アプリケーションによって公開されていない Web サービスエンドポイントの W3CEndpointReference を構築する場合、または Java SE で実行する場合は、address を非 null 値に設定する必要があります。

  パラメーター:

  address - 返された W3CEndpointReference のターゲットとなるエンドポイントのアドレス。

  戻り値:

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

• interfaceName

  public W3CEndpointReferenceBuilder interfaceName​(QNameSE interfaceName)

  interfaceName を wsa:Metadata 要素の wsam:InterfaceName 要素として設定します。詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。

  パラメーター:

  interfaceName - 返された W3CEndpointReference の対象となるエンドポイントのポート型名。

  戻り値:

  wsa:Metadata 要素に wsam:InterfaceName 要素として interfaceName が追加された W3CEndpointReferenceBuilder インスタンス

  導入:

  1.7

• serviceName

  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 インスタンス

• endpointName

  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 と一致しない場合

• wsdlDocumentLocation

  public W3CEndpointReferenceBuilder wsdlDocumentLocation​(StringSE wsdlDocumentLocation)

  wsa:Metadata/@wsdli:wsdlLocation として参照される wsdlDocumentLocation を設定します。wsdli:wsdlLocation の値の名前空間名は、WSDL 自体から取得できます。

  詳細については、2.1 EPR からの WSDL メタデータの参照を参照してください。

  パラメーター:

  wsdlDocumentLocation - W3CEndpointReference の wsa:Metadata で参照される WSDL ドキュメントの場所。

  戻り値:

  参照される wsdlDocumentLocation を持つ W3CEndpointReferenceBuilder インスタンス。

• referenceParameter

  public W3CEndpointReferenceBuilder referenceParameter​(ElementSE referenceParameter)

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

  パラメーター:

  referenceParameter - wsa:ReferenceParameters 要素に追加される要素。

  戻り値:

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

  例外:

  IllegalArgumentExceptionSE - referenceParameter が null の場合。

• metadata

  public W3CEndpointReferenceBuilder metadata​(ElementSE metadataElement)

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

  パラメーター:

  metadataElement - wsa:Metadata 要素に追加される要素。

  戻り値:

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

  例外:

  IllegalArgumentExceptionSE - metadataElement が null の場合。

• element

  public W3CEndpointReferenceBuilder element​(ElementSE element)

  W3CEndpointReference インスタンスの wsa:EndpointReference 要素に拡張要素を追加します。

  パラメーター:

  element - W3CEndpointReference に追加される拡張要素

  戻り値:

  W3CEndpointReference インスタンスに拡張子 element が追加された W3CEndpointReferenceBuilder インスタンス。

  例外:

  IllegalArgumentExceptionSE - element が null の場合。

  導入:

  1.7、JAX-WS 2.2

• attribute

  public W3CEndpointReferenceBuilder attribute​(QNameSE name,
                                               StringSE value)

  W3CEndpointReference インスタンスの wsa:EndpointReference 要素に拡張属性を追加します。

  パラメーター:

  name - W3CEndpointReference に追加される拡張属性の名前

  value - 拡張属性値

  戻り値:

  拡張属性が W3CEndpointReference インスタンスに追加された W3CEndpointReferenceBuilder インスタンス。

  例外:

  IllegalArgumentExceptionSE - name または value が null の場合。

  導入:

  1.7、JAX-WS 2.2

• build

  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 の作成中にエラーが発生した場合。