パッケージ jakarta.xml.ws

クラス EndpointReference

  • 既知の直属サブクラス
    W3CEndpointReference
    public abstract class EndpointReference
extends ObjectSE
    このクラスは、Web サービスエンドポイントへのリモート参照である WS-Addressing EndpointReference を表します。WS-Addressing EndpointReferences の詳細については、1.0 に対応する Web サービス - コアを参照してください。

    通常の Web サービス開発者はその内容を気にする必要がないため、このクラスは不変です。Web サービス開発者は、リモート Web サービスエンドポイントを参照するメカニズムとしてこのクラスを厳密に使用する必要があります。クライアントが EndpointReference を利用するために使用できる Service API を参照してください。公開されたエンドポイント用に EndpointReferences を作成する方法については、Endpoint および BindingProvider API を参照してください。

    このクラスの具体的な実装は、特定のバージョンのアドレッシングの EndpointReference を表します。たとえば、W3CEndpointReference は、1.0 に対応する W3C Web サービスで使用するためのものです - コア推奨事項。Jakarta XML Web Services 実装者が異なるバージョンのアドレス指定をサポートする必要がある場合は、そのバージョン用に独自の EndpointReference サブクラスを作成する必要があります。これにより、Jakarta XML Web Services 実装は、ベンダーが異なるバージョンのアドレス指定にフラグを立てるために使用できるベンダー固有の EndpointReferences を作成できるようになります。

    SEI の Java メソッドで EndpointReference を渡したり返したりしたい Web サービス開発者は、W3CEndpointReference などの EndpointReference の具象インスタンスを使用する必要があります。このようにして、SEI からマップされたスキーマは、渡されるエンドポイント参照の型をより説明します。

    Jakarta XML Web Services 実装者は、writeTo(javax.xml.transform.Result) メソッドを使用して EndpointReferece から XML 情報セットを抽出することが期待されています。

    Jakarta XML Binding はこのクラスを xs:anyType にバインドします。より適切なバインドが必要な場合、Web サービス開発者は W3CEndpointReference などの具象サブクラスを使用する必要があります。

    導入:
    1.6、JAX-WS 2.1
    関連事項:
    W3CEndpointReference, Service

    • コンストラクターの詳細

      • EndpointReference

        protected EndpointReference()
        デフォルトコンストラクター。

    • メソッドの詳細

      • readFrom

        public static EndpointReference readFrom​(SourceSE eprInfoset)
        eprInfoset に含まれる情報セットから EndpointReference を読み取るファクトリメソッド。このメソッドは、Provider.readEndpointReference(javax.xml.transform.Source) メソッドのベンダー固有の実装に委譲します。
        パラメーター:
        eprInfoset - マーシャリングされない EndpointReference 情報セット
        戻り値:
        eprInfoset からマーシャリングされていない EndpointReference は決して null ではありません
        例外:
        WebServiceException - eprInfoset から EndpointReference を作成中にエラーが発生した場合
        IllegalArgumentExceptionSE - nulleprInfoset 値が指定されている場合。

      • writeTo

        public abstract void writeTo​(ResultSE result)
        この EndpointReference を指定された情報セット形式に書き込みます
        パラメーター:
        result - 情報セットを書くため
        例外:
        WebServiceException - 指定された result への EndpointReference の書き込み中にエラーが発生した場合。
        IllegalArgumentExceptionSE - null の場合 result 値が指定されています。

      • getPort

        public <T> T getPort​(ClassSE<T> serviceEndpointInterface,
                     WebServiceFeature... features)
        getPort メソッドはプロキシを返します。EndpointReference インスタンスに参照パラメーターがある場合、それらの参照パラメーターは、エンドポイントに送信されるすべてのメッセージで、参照パラメーターであることを示す SOAP ヘッダーとして表示される必要があります。パラメーター serviceEndpointInterface は、返されたプロキシによってサポートされるサービスエンドポイントインターフェースを指定します。EndpointReference インスタンスは、返されたプロキシによって呼び出されるエンドポイントを指定します。このメソッドの実装では、Jakarta XML Web Services ランタイムシステムがプロトコルバインディング（およびポート）を選択し、それに応じてこの EndpointReference の WSDL メタデータまたは serviceEndpointInterface のアノテーションからプロキシを構成する責任を負います。このメソッドがプロキシを正常に返すには、WSDL メタデータが使用可能である必要があり、EndpointReference インスタンスには実装で理解される serviceName メタデータが含まれている必要があります。

        このポートは Service オブジェクトから作成されていないため、ハンドラーは自動的に構成されず、HandlerResolver および Executor をこのポートに取得または設定することはできません。BindingProvider().getBinding().setHandlerChain() メソッドを使用して、このポートのハンドラーを手動で構成できます。

        型パラメーター:
        T - サービスエンドポイントインターフェース
        パラメーター:
        serviceEndpointInterface - サービスエンドポイントインターフェース
        features - プロキシで構成する WebServiceFeatures の配列。features  パラメーターに含まれていないサポートされている機能には、デフォルト値があります。
        戻り値:
        指定されたサービスエンドポイントインターフェースをサポートするオブジェクトプロキシインスタンス
        例外:
        WebServiceException -
        • プロキシの作成中にエラーが発生した場合
        • このメソッドで必要とされる WSDL メタデータが欠落している場合
        • この endpointReference が無効な場合
        • 不正な serviceEndpointInterface が指定された場合
        • このポートと互換性がない、またはサポートされていない機能が有効になっている場合。
        関連事項:
        ProxySE, WebServiceFeature

      • toString

        public StringSE toString()
        デバッグに便利な EPR 情報セットを表示します。
        オーバーライド:
        クラス ObjectSE の toString 
        戻り値:
        オブジェクトの文字列表現