モジュール java.xml.ws
パッケージ 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

        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インスタンス
        導入されたバージョン:
        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の作成中にエラーが発生した場合。