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

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

デフォルト:

""