W3CEndpointReferenceBuilder (Java Platform SE 7)

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()` 新しい `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` を設定します。

クラス 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 インスタンス。
  - 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 インスタンス
  - 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 メソッドを呼び出したあとにのみ呼び出すことができます。
    詳細については、「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 の場合。
    導入されたバージョン:
    
    JAX-WS 2.2
  - attribute
```
public W3CEndpointReferenceBuilder attribute(QName name,
                                    String value)
```
    拡張属性を W3CEndpointReference インスタンスの wsa:EndpointReference 要素に追加します。
    
    パラメータ:
    name - W3CEndpointReference に追加された拡張属性の名前
    value - 拡張属性値
    
    戻り値:
    拡張属性が W3CEndpointReference インスタンスに追加された W3CEndpointReferenceBuilder インスタンス。
    
    例外:
    
    IllegalArgumentException - name または value が null の場合
    導入されたバージョン:
    
    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 の作成中にエラーが発生した場合。

バグまたは機能を送信
詳細な API リファレンスおよび開発者ドキュメントについては、Java SE のドキュメントを参照してください。そのドキュメントには、概念的な概要、用語の定義、回避方法、有効なコード例などの、開発者を対象にしたより詳細な説明が含まれています。
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.

クラス W3CEndpointReferenceBuilder

コンストラクタのサマリー

メソッドのサマリー

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

コンストラクタの詳細

W3CEndpointReferenceBuilder

メソッドの詳細

address

interfaceName

serviceName

endpointName

wsdlDocumentLocation

referenceParameter

metadata

element

attribute

build