javax.annotation

注釈型 Resource

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

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

この注釈には Inherited のマークは付けられませんが、配備ツールがコンポーネントクラスのすべてのスーパークラスを検査して、すべてのスーパークラス内でのこの注釈の使用をすべて検出する必要があります。この種の注釈インスタンスはすべて、アプリケーションコンポーネントが必要とするリソースを指定します。この注釈は、スーパークラスの private フィールドおよびメソッドに表示される可能性があります。これらの場合でも、コンテナは注入を実行することが必要です。

導入されたバージョン:

Common Annotations 1.0

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

省略可能な要素

修飾子と型	省略可能な要素と説明
Resource.AuthenticationType	authenticationType このリソースで使用する認証タイプ。
String	description このリソースの説明。
String	lookup 参照が示すリソースの名前です。
String	mappedName このリソースがマップされる製品固有の名前。
String	name リソースの JNDI 名。
boolean	shareable このコンポーネントとほかのコンポーネントの間で、このリソースを共有できるかどうかを示します。
Class	type リソースの Java 型です。

要素の詳細

name

public abstract String name

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

デフォルトは、

""

lookup

public abstract String lookup

参照が示すリソースの名前です。グローバルな JNDI 名を使用している互換性のある任意のリソースにリンクできます。

導入されたバージョン:

Common Annotations 1.1

デフォルトは、

""

type

public abstract Class type

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

デフォルトは、

java.lang.Object.class

authenticationType

public abstract Resource.AuthenticationType authenticationType

このリソースで使用する認証タイプ。これを指定できるのは、サポートされる任意のタイプの接続ファクトリを表すリソースに対してです。その他のタイプのリソースに対して指定することはできません。

デフォルトは、

javax.annotation.Resource.AuthenticationType.CONTAINER

shareable

public abstract boolean shareable

このコンポーネントとほかのコンポーネントの間で、このリソースを共有できるかどうかを示します。これを指定できるのは、サポートされる任意のタイプの接続ファクトリを表すリソースに対してです。その他のタイプのリソースに対して指定することはできません。

デフォルトは、

true

mappedName

public abstract String mappedName

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

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

デフォルトは、

""

description

public abstract String description

このリソースの説明。説明の言語は、アプリケーションが配置されたシステムのデフォルト言語であると想定されます。説明を表示することで、配置者が適正なリソースを選択できるようにします。

デフォルトは、

""