パッケージ jakarta.xml.ws.soap

クラス AddressingFeature


  • public final class AddressingFeature
    extends WebServiceFeature
    AddressingFeature は、SOAP 1.1/HTTP または SOAP 1.2/HTTP バインディングのいずれかを使用した WS-Addressing の使用を表します。この機能を他のバインディングで使用することは定義されていません。

    この機能は、SEI プロキシ、クライアント側の Dispatch インスタンス、サーバー側の Endpoint インスタンスの作成中に使用できます。この機能は、クライアント側での Service インスタンスの作成には使用できません。

    以下に、有効または無効に関するこの機能の効果について説明します。

    • ENABLED: このモードでは、WS-Addressing が有効になります。これは、エンドポイントが WS-Addressing をサポートしているが、その使用を必要としないことを意味します。送信者は、WS-Addressing ヘッダーを使用して、または WS-Addressing ヘッダーを使用せずにメッセージを送信できます。ただし、受信者は両方の型のメッセージを消費する必要があります。
    • DISABLED: このモードでは、WS-Addressing は無効になります。実行時に、WS-Addressing ヘッダーを送信者または受信者が使用してはなりません。

    この機能が有効になっている場合、required プロパティは、エンドポイントが WS-Addressing を必要とするかどうかを決定します。true に設定されている場合、WS-Addressing ヘッダーは受信メッセージと発信メッセージに存在する必要があります。デフォルトでは、required プロパティは false です。

    Web サービス開発者がこの機能を明示的に有効にしていない場合、WSDL の wsam:Addressing ポリシーアサーションを使用して WS-Addressing の使用を検索します。この機能を明示的に使用することにより、アプリケーションは、WSDSAddressing の使用に関する WSDL の指示をオーバーライドします。場合によっては、これは本当に必要です。例: アプリケーションが WS-Addressing 自体を実装している場合、この機能を使用してアドレス指定を無効にすることができます。つまり、Jakarta XML Web Services 実装は、WS-Addressing ヘッダーを消費または生成しません。

    アドレッシングが有効になっている場合、対応する wsam:Addressing ポリシーアサーションを 3.1 WS-Policy アサーションに従って WSDL で生成する必要があります

    例 1: @Addressing 用に生成された WSDL で可能なポリシーアサーション

     
       <wsam:Addressing wsp:Optional="true">
         <wsp:Policy/>
       </wsam:Addressing> 
     

    例 2: @Addressing(required=true) 用に生成された WSDL で可能なポリシーアサーション

     
       <wsam:Addressing>
         <wsp:Policy/>
       </wsam:Addressing> 
     

    例 3: @Addressing(required=true, responses=Responses.ANONYMOUS) 用に生成された WSDL で可能なポリシーアサーション

     
       <wsam:Addressing>
          <wsp:Policy>
            <wsam:AnonymousResponses/>
          </wsp:Policy>
       </wsam:Addressing> 
     

    WS-Addressing の詳細については、Web サービスのアドレス指定 - コア1.0 に対応する Web サービス -SOAP バインディング1.0 に対応する Web サービス - メタデータを参照してください。

    導入:
    1.6、JAX-WS 2.1
    関連事項:
    Addressing
    • ネストされたクラスのサマリー

      ネストされたクラス  
      修飾子と型 クラス 説明
      static class AddressingFeature.Responses
      アドレス指定が有効になっている場合、このプロパティは、エンドポイントで匿名レスポンスのみを使用するか、非匿名レスポンスのみを使用するか、すべてを使用する必要があるかを決定します。
    • フィールドサマリー

      フィールド  
      修飾子と型 フィールド 説明
      static StringSEID
      AddressingFeature を識別する定数値
    • コンストラクターのサマリー

      コンストラクター  
      コンストラクター 説明
      AddressingFeature()
      アドレス指定要件を使用して AddressingFeature を作成および構成します。
      AddressingFeature​(boolean enabled)
      アドレス指定要件を使用して AddressingFeature を作成および構成します。
      AddressingFeature​(boolean enabled, boolean required)
      アドレス指定要件を使用して AddressingFeature を作成および構成します。
      AddressingFeature​(boolean enabled, boolean required, AddressingFeature.Responses responses)
      アドレス指定要件を使用して AddressingFeature を作成および構成します。
    • コンストラクターの詳細

      • AddressingFeature

        public AddressingFeature()
        アドレス指定要件を使用して AddressingFeature を作成および構成します。作成された機能は ws-addressing を有効にします。つまり、ws-addressing をサポートしますが、使用する必要はありません。また、すべてのレスポンス型を受け入れるように構成されています。
      • AddressingFeature

        public AddressingFeature​(boolean enabled)
        アドレス指定要件を使用して AddressingFeature を作成および構成します。enabled が true の場合、ws-addressing を有効にします。つまり、ws-addressing をサポートしますが、使用する必要はありません。また、すべてのレスポンス型を受け入れるように構成します。
        パラメーター:
        enabled - true は、ws-addressing を有効にします。つまり、ws-addressing はサポートされていますが、使用する必要はありません。
      • AddressingFeature

        public AddressingFeature​(boolean enabled,
                                 boolean required)
        アドレス指定要件を使用して AddressingFeature を作成および構成します。enabled と required が true の場合、ws-addressing が有効になり、使用する必要があります。また、すべてのレスポンス型を受け入れるように構成します。
        パラメーター:
        enabled - true は、ws-addressing を有効にします。つまり、ws-addressing はサポートされていますが、使用する必要はありません。
        required - true は、ws-addressing を使用する必要があることを意味します。
      • AddressingFeature

        public AddressingFeature​(boolean enabled,
                                 boolean required,
                                 AddressingFeature.Responses responses)
        アドレス指定要件を使用して AddressingFeature を作成および構成します。enabled と required が true の場合、ws-addressing が有効になり、使用する必要があります。また、レスポンス型は responses パラメーターを使用して構成できます。
        パラメーター:
        enabled - true は、ws-addressing を有効にします。つまり、ws-addressing はサポートされていますが、使用する必要はありません。
        required - true は、ws-addressing を使用する必要があることを意味します。
        responses - 必要なレスポンスの型を指定します
        導入:
        1.7、JAX-WS 2.2
    • メソッドの詳細

      • getID

        public StringSE getID()
        クラスからコピーされた説明: WebServiceFeature
        この WebServiceFeature の一意の識別子を取得します。
        次で指定:
        クラス WebServiceFeaturegetID 
        戻り値:
        この機能の一意の識別子。
      • isRequired

        public boolean isRequired()
        アドレス指定が有効になっている場合、このプロパティはエンドポイントに WS-Addressing が必要かどうかを決定します。required が true の場合、WS-Addressing ヘッダーは受信メッセージと発信メッセージに存在する必要があります。
        戻り値:
        現在必要な値
      • getResponses

        public AddressingFeature.Responses getResponses()
        アドレス指定が有効になっている場合、このプロパティは、エンドポイントで匿名レスポンス、非匿名レスポンス、すべてのレスポンスの使用が必要かどうかを決定します。
        戻り値:
        エンドポイントがすべての型のレスポンスをサポートする場合は AddressingFeature.Responses.ALL、エンドポイントが匿名のレスポンスのみを使用する必要がある場合は AddressingFeature.Responses.ANONYMOUS、エンドポイントが非匿名のレスポンスのみを使用する必要がある場合は AddressingFeature.Responses.NON_ANONYMOUS
        導入:
        1.7、JAX-WS 2.2