パッケージ jakarta.xml.ws

アノテーション型 WebServiceRef

  • @TargetSE({TYPESE,METHODSE,FIELDSE})
@RetentionSE(RUNTIMESE)
@DocumentedSE
@RepeatableSE(WebServiceRefs.class)
public @interface WebServiceRef
    WebServiceRef アノテーションは、Web サービスへの参照と（オプションで）そのインジェクションターゲットを定義するために使用されます。これは、サービスインスタンスとプロキシインスタンスの両方を挿入するために使用できます。これらの挿入された参照はスレッドセーフではありません。参照が複数のスレッドによってアクセスされる場合、通常の同期技術を使用して複数のスレッドをサポートできます。

    Web サービス参照は、Jakarta EE の意味でのリソースです。メタアノテーション WebServiceFeatureAnnotation でアノテーションが付けられたアノテーション（たとえば、Addressing）は、WebServiceRef と組み合わせて使用できます。作成された参照は、アノテーションの Web サービス機能を使用して構成する必要があります。

    例: 以下のコードでは、挿入された StockQuoteProvider プロキシで、Addressing アノテーションで指定されている WS-Addressing を有効にする必要があります。

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

    Jakarta XML Web Services 実装で、WebServiceRef で指定された WebServiceFeatureAnnotation でアノテーションが付けられた、サポートされていない、認識されないアノテーションが検出された場合、エラーを指定する必要があります。

    導入:
    1.6、JAX-WS 2.0
    関連事項:
    "jakarta.annotation.Resource" , WebServiceFeatureAnnotation

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

      オプション要素  
      修飾子と型 オプションの要素 説明
      StringSElookup
      ターゲット Web サービス参照に解決されるポータブル JNDI ルックアップ名。
      StringSEmappedName
      このリソースをマップする必要がある製品固有の名前。
      StringSEname
      リソースの JNDI 名。
      ClassSE<?>type
      リソースの Java 型。
      ClassSE<? extends Service>value
      サービスクラス、常に jakarta.xml.ws.Service を継承する型。
      StringSEwsdlLocation
      Web サービスの WSDL ドキュメントを指す URL。

    • 要素の詳細

      • name

        StringSE name
        リソースの JNDI 名。フィールドアノテーションの場合、デフォルトはフィールド名です。メソッドアノテーションの場合、デフォルトはメソッドに対応する JavaBeans プロパティ名です。クラスアノテーションの場合、デフォルトはなく、これを指定する必要があります。JNDI 名は、絶対（任意の論理名前空間を使用）または JNDI java:comp/env 名前空間からの相対名にすることができます。
        戻り値:
        絶対または相対 JNDI 名
        デフォルト:
        ""

      • type

        ClassSE<?> type
        リソースの Java 型。フィールドアノテーションの場合、デフォルトはフィールドの型です。メソッドアノテーションの場合、デフォルトは JavaBeans プロパティの型です。クラスアノテーションの場合、デフォルトはなく、これを指定する必要があります。
        戻り値:
        リソースの型
        デフォルト:
        java.lang.Object.class

      • mappedName

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

        アプリケーションサーバーは、特定の形式または型のマップ名をサポートする必要はなく、マップ名を使用する機能も必要ありません。マップされた名前は製品に依存し、多くの場合インストールに依存します。マップされた名前を使用することはできません。

        戻り値:
        製品固有のリソース名
        デフォルト:
        ""

      • value

        ClassSE<? extends Service> value
        サービスクラス、常に jakarta.xml.ws.Service を継承する型。この要素は、参照の型がサービスエンドポイントインターフェースである場合は常に指定する必要があります。
        戻り値:
        jakarta.xml.ws.Service を継承するサービスクラス
        デフォルト:
        jakarta.xml.ws.Service.class

      • wsdlLocation

        StringSE wsdlLocation
        Web サービスの WSDL ドキュメントを指す URL。指定しない場合は、代わりにリソース型のアノテーションで指定された WSDL の場所が使用されます。
        戻り値:
        WSDL ドキュメントを指す URL
        デフォルト:
        ""

      • lookup

        StringSE lookup
        ターゲット Web サービス参照に解決されるポータブル JNDI ルックアップ名。
        戻り値:
        ポータブル JNDI ルックアップ名
        導入:
        1.7、JAX-WS 2.2
        デフォルト:
        ""