javax.xml.ws.soap

クラス AddressingFeature

java.lang.Object

javax.xml.ws.WebServiceFeature

javax.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 インスタンスの作成には使用できません。

この機能を有効または無効にした場合の影響は次のとおりです。

• 有効:このモードでは、WS-Addressing が有効になります。端点は WS-Addressing をサポートしますが、WS-Addressing の使用が必要となるわけではありません。送信側は、WS-Addressing ヘッダー付きのメッセージを送信することも、WS-Addressing ヘッダーのないメッセージを送信することもできます。ただし、受信側はどちらのタイプのメッセージも消費する必要があります。
• 無効:このモードでは、WS-Addressing が無効になります。送信側も受信側も、実行時に WS-Addressing ヘッダーを使用してはいけません。

この機能が有効な場合、required プロパティーは端点で WS-Addressing が必要であるかどうかを判別します。true に設定されている場合、インバウンドメッセージとアウトバウンドメッセージに WS-Addressing ヘッダーが含まれている必要があります。デフォルトでは、required プロパティーは false です。

Web サービス開発者がこの機能を明示的に有効にしていない場合、WSDL の wsam:Addressing ポリシーアサーションを使用して WS-Addressing の用途を探します。アプリケーションは、この機能を明示的に使用することで、WSDL によって示された WS-Addressing の用途をオーバーライドします。場合によっては、これが実際に必要となることがあります。たとえば、アプリケーションが WS-Addressing そのものを実装している場合は、この機能を使用してアドレス指定を無効にできます。つまり、JAX-WS の実装が WS-Addressing ヘッダーを消費することも、生成することもないということです。

アドレス指定が有効になると、3.1 WS-Policy Assertions に準じて、WSDL に対応する wsam:Addressing ポリシーアサーションを生成する必要があります。

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

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

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

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

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

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

WS-Addressing の詳細については、Web Services Addressing - Core、Web Services Addressing 1.0 - SOAP Binding、および Web Services Addressing 1.0 - Metadata を参照してください。

導入されたバージョン:

JAX-WS 2.1

関連項目:

Addressing

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型	クラスと説明
static class	AddressingFeature.Responses アドレス指定が有効な場合、このプロパティーは端点で匿名応答のみ、非匿名応答のみ、またはすべての使用を必要とするかどうかを判別します。

フィールドのサマリー

フィールド

修飾子と型	フィールドと説明
static String	ID AddressingFeature を識別する定数です
protected boolean	required アドレス指定が有効な場合、このプロパティーはエンドポイントで WS-Addressing が必要であるかどうかを判別します。

クラス javax.xml.ws.WebServiceFeature から継承されたフィールド

enabled

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

コンストラクタ

コンストラクタと説明
AddressingFeature() アドレス指定要件を使用して、AddressingFeature を作成し、構成します。
AddressingFeature(boolean enabled) アドレス指定要件を使用して、AddressingFeature を作成し、構成します。
AddressingFeature(boolean enabled, boolean required) アドレス指定要件を使用して、AddressingFeature を作成し、構成します。
AddressingFeature(boolean enabled, boolean required, AddressingFeature.Responses responses) アドレス指定要件を使用して、AddressingFeature を作成し、構成します。

メソッドのサマリー

メソッド

修飾子と型	メソッドと説明
String	getID() この WebServiceFeature の一意の識別子を取得します。
AddressingFeature.Responses	getResponses() アドレス指定が有効な場合、このプロパティーは端点で匿名応答または非匿名応答またはすべての応答の使用を必要とするかどうかを判別します。
boolean	isRequired() アドレス指定が有効な場合、このプロパティーはエンドポイントで WS-Addressing が必要であるかどうかを判別します。

クラス javax.xml.ws.WebServiceFeature から継承されたメソッド

isEnabled

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

ID

public static final String ID

AddressingFeature を識別する定数です

関連項目:

定数フィールド値

required

protected boolean required

アドレス指定が有効な場合、このプロパティーはエンドポイントで WS-Addressing が必要であるかどうかを判別します。required が true の場合、インバウンドメッセージとアウトバウンドメッセージに WS-Addressing ヘッダーが含まれている必要があります。

コンストラクタの詳細

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 - 必要な応答のタイプを指定します

導入されたバージョン:

JAX-WS 2.2

メソッドの詳細

getID

public String getID()

この WebServiceFeature の一意の識別子を取得します。

定義:

getID、クラス: WebServiceFeature

戻り値:

この機能の一意の識別子。

isRequired

public boolean isRequired()

アドレス指定が有効な場合、このプロパティーはエンドポイントで WS-Addressing が必要であるかどうかを判別します。required が true の場合、インバウンドメッセージとアウトバウンドメッセージに WS-Addressing ヘッダーが含まれている必要があります。

戻り値:

required の現在の値

getResponses

public AddressingFeature.Responses getResponses()

アドレス指定が有効な場合、このプロパティーは端点で匿名応答または非匿名応答またはすべての応答の使用を必要とするかどうかを判別します。

戻り値:

端点がすべてのタイプの応答をサポートする場合は AddressingFeature.Responses.ALL、端点で匿名の応答のみ使用する必要がある場合は AddressingFeature.Responses.ANONYMOUS、端点で匿名以外の応答のみ使用する必要がある場合は AddressingFeature.Responses.NON_ANONYMOUS

導入されたバージョン:

JAX-WS 2.2