javax.xml.ws

注釈型 WebServiceRef

@Target(value={TYPE,METHOD,FIELD})
@Retention(value=RUNTIME)
@Documented
public @interface WebServiceRef

WebServiceRef 注釈は、Web サービスへの参照と (オプションで) その注入ターゲットを定義するために使用されます。サービスとプロキシの両方のインスタンスを注入するために使用できます。これらの注入された参照は、スレッドに対して安全ではありません。参照が複数のスレッドからアクセスされた場合、通常の同期技法を使用して、複数のスレッドをサポートできます。

Web サービス参照は、Java EE 5 的な意味でのリソースです。メタ注釈 WebServiceFeatureAnnotation で注釈がされた注釈 (Addressing など) を、WebServiceRef と組み合わせて使用できます。作成された参照は、注釈の Web サービス機能を使用して構成する必要があります。

たとえば、次に示すコードでは、注入された StockQuoteProvider プロキシでは、Addressing 注釈で指定されるように、WS-Addressing が有効になっている必要があります。

    public class MyClient {
       @Addressing
       @WebServiceRef(StockQuoteService.class)
       private StockQuoteProvider stockQuoteProvider;
       ...
    }
 

JAX-WS 実装では、WebServiceRef で指定された、サポートされていないか、または認識されない WebServiceFeatureAnnotation 注釈の付いた注釈が検出された場合、エラーを示す必要があります。

導入されたバージョン:

JAX-WS 2.0

関連項目:

Resource, WebServiceFeatureAnnotation

オプション要素のサマリー

オプションの要素

修飾子と型	オプションの要素と説明
String	lookup ターゲットの Web サービス参照に解決する移植可能な JNDI 検索名。
String	mappedName このリソースがマップされる製品固有の名前。
String	name リソースの JNDI 名。
Class<?>	type リソースの Java 型です。
Class<? extends Service>	value 常に javax.xml.ws.Service を拡張型とするサービスクラス。
String	wsdlLocation Web サービス用の WSDL 文書をポイントする URL。

要素の詳細

name

public abstract String name

リソースの JNDI 名。フィールド注釈の場合、デフォルトはフィールド名です。メソッド注釈の場合、デフォルトはこのメソッドに対応する JavaBeans プロパティー名です。クラス注釈の場合、デフォルトは存在せず、これを指定する必要があります。 JNDI 名は、JNDI java:comp/env 名前空間に対して絶対的 (論理名前空間を持つ) か相対的です。

デフォルト:

""

type

public abstract Class<?> type

リソースの Java 型です。フィールド注釈の場合、デフォルトはフィールドの型です。メソッド注釈の場合、デフォルトは JavaBeans プロパティーの型です。クラス注釈の場合、デフォルトは存在せず、これを指定する必要があります。

デフォルト:

java.lang.Object.class

mappedName

public abstract String mappedName

このリソースがマップされる製品固有の名前。このリソースの名前は、name 要素で定義されるかデフォルトで指定され、リソースを使用するアプリケーションコンポーネントにとってローカルな名前です。(相対 JNDI 名が指定された場合は、JNDI java:comp/env 名前空間内の名前になります。)多くのアプリケーションサーバーは、これらのローカル名を、アプリケーションサーバーで既知のリソース名にマップする方法を提供しています。このマップされた名前はグローバル JNDI 名であることがよくありますが、任意の形式の名前にすることができます。

アプリケーションサーバーは、マップされる名前の特定の形式またはタイプをサポートする必要や、マップされた名前を使用できる必要はありません。マップされた名前は、製品依存であり、多くの場合、インストール依存です。マップされた名前の使用には移植性がありません。

デフォルト:

""

value

public abstract Class<? extends Service> value

常に javax.xml.ws.Service を拡張型とするサービスクラス。参照の型がサービス端点インタフェースの場合はいつでもこの要素を指定する必要があります。

デフォルト:

javax.xml.ws.Service.class

wsdlLocation

public abstract String wsdlLocation

Web サービス用の WSDL 文書をポイントする URL。指定されない場合、リソース型への注釈によって指定された WSDL の位置が代わりに使用されます。

デフォルト:

""

lookup

public abstract String lookup

ターゲットの Web サービス参照に解決する移植可能な JNDI 検索名。

導入されたバージョン:

JAX-WS 2.2

デフォルト:

""