パッケージ jakarta.annotation

アノテーションインターフェース Resource


Resource アノテーションは、アプリケーションが必要とするリソースをマークします。このアノテーションは、アプリケーションコンポーネントクラス、またはコンポーネントクラスのフィールドまたはメソッドに適用できます。アノテーションがフィールドまたはメソッドに適用されると、コンテナーは、コンポーネントが初期化されるときに、リクエストされたリソースのインスタンスをアプリケーションコンポーネントに挿入します。アノテーションがコンポーネントクラスに適用される場合、アノテーションは、アプリケーションが実行時に検索するリソースを宣言します。

このアノテーションは Inherited とマークされていませんが、デプロイツールは、コンポーネントクラスのすべてのスーパークラスを調べて、すべてのスーパークラスでこのアノテーションのすべての使用箇所を見つける必要があります。このようなすべてのアノテーションインスタンスは、アプリケーションコンポーネントに必要なリソースを指定します。このアノテーションは、スーパークラスのプライベートフィールドとメソッドに表示される場合があることに注意してください。これらの場合にも、コンテナーは注入を行う必要があります。

導入:
1.6、共通のアノテーション 1.0
  • ネストされたクラスの要約

    ネストされたクラス
    修飾子と型
    クラス
    説明
    static enum
    リソースの 2 つの可能な認証型。
  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    このリソースに使用する認証型。
    このリソースの説明。
    参照が指すリソースの名前。
    このリソースをマップする必要がある製品固有の名前。
    リソースの JNDI 名。
    boolean
    このリソースをこのコンポーネントと他のコンポーネントの間で共有できるかどうかを示します。
    リソースの Java 型。
  • 要素の詳細

    • name

      StringSE name
      リソースの JNDI 名。フィールドアノテーションの場合、デフォルトはフィールド名です。メソッドアノテーションの場合、デフォルトはメソッドに対応する JavaBeans プロパティ名です。クラスアノテーションの場合、デフォルトはなく、これを指定する必要があります。
      デフォルト:
      ""
    • lookup

      StringSE lookup
      参照が指すリソースの名前。グローバル JNDI 名を使用して、互換性のあるリソースにリンクできます。
      導入:
      1.7、共通のアノテーション 1.1
      デフォルト:
      ""
    • type

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

      Resource.AuthenticationType authenticationType
      このリソースに使用する認証型。これは、サポートされている任意の型の接続ファクトリを表すリソースに指定できます。他の型のリソースには指定しないでください。
      デフォルト:
      CONTAINER
    • shareable

      boolean shareable
      このリソースをこのコンポーネントと他のコンポーネントの間で共有できるかどうかを示します。これは、サポートされている任意の型の接続ファクトリを表すリソースに指定できます。他の型のリソースには指定しないでください。
      デフォルト:
      true
    • mappedName

      StringSE mappedName
      このリソースをマップする必要がある製品固有の名前。mappedName 要素は、リソース参照をアプリケーションサーバーに認識されているリソースの名前にマッピングするために提供されます。マップされた名前は任意の形式にすることができます。

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

      デフォルト:
      ""
    • description

      StringSE description
      このリソースの説明。説明は、アプリケーションがデプロイされているシステムのデフォルト言語であることが想定されています。説明は、適切なリソースの選択に役立つようにデプロイヤーに提示できます。
      デフォルト:
      ""