アプリケーションサーバ リファレンス API編

Transcription

1 Cosminexus V9 アプリケーションサーバリファレンス API 編 文法書 Y21-30

2 対象製品 マニュアル アプリケーションサーバ & BPM/ESB 基盤概説 の前書きの対象製品の説明を参照してください 輸出時の注意本製品を輸出される場合には 外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上 必要な手続きをお取りください なお 不明な場合は 弊社担当営業にお問い合わせください 商標類 CORBA は,Object Management Group が提唱する分散処理環境アーキテクチャの名称です IIOP は,OMG 仕様による ORB(Object Request Broker) 間通信のネットワークプロトコルの名称です Microsoft は, 米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です OMG,CORBA,IIOP,UML,Unified Modeling Language,MDA,Model Driven Architecture は,Object Management Group, Inc. の米国及びその他の国における登録商標または商標です Oracle と Java は,Oracle Corporation 及びその子会社, 関連会社の米国及びその他の国における登録商標です SOAP(Simple Object Access Protocol) は, 分散ネットワーク環境において XML ベースの情報を交換するための通信プロトコルの名称です UNIX は,The Open Group の米国ならびに他の国における登録商標です Windows は, 米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です Windows Server は, 米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です Windows Vista は, 米国 Microsoft Corporation の米国およびその他の国における登録商標または商標です その他記載の会社名, 製品名は, それぞれの会社の商標もしくは登録商標です This product includes software developed by the Apache Software Foundation ( マイクロソフト製品の表記について このマニュアルでは, マイクロソフト製品の名称を次のように表記しています 表記 製品名 Windows Windows Server 2008 Windows Server 2008 x86 Microsoft(R) Windows Server(R) 2008 Standard 32-bit 日 本語版 Microsoft(R) Windows Server(R) 2008 Enterprise 32-bit 日本語版 Windows Server 2008 x64 Microsoft(R) Windows Server(R) 2008 Standard 日本語版 Microsoft(R) Windows Server(R) 2008 Enterprise 日本語版 Windows Server 2008 R2 Microsoft(R) Windows Server(R) 2008 R2 Standard 日本語版 Microsoft(R) Windows Server(R) 2008 R2 Enterprise 日本 語版 Microsoft(R) Windows Server(R) 2008 R2 Datacenter 日 本語版 Windows Server 2012 Windows Server 2012 Standard Microsoft(R) Windows Server(R) 2012 Standard 日本語版

3 表記 製品名 Windows Windows Server 2012 Windows Server 2012 Datacenter Microsoft(R) Windows Server(R) 2012 Datacenter 日本語版 Windows XP Microsoft(R) Windows(R) XP Professional Operating System Windows Vista Windows Vista Business Microsoft(R) Windows Vista(R) Business 日本語版 (32 ビット版 ) Windows Vista Enterprise Microsoft(R) Windows Vista(R) Enterprise 日本語版 (32 ビット版 ) Windows Vista Ultimate Microsoft(R) Windows Vista(R) Ultimate 日本語版 (32 ビット版 ) Windows 7 Windows 7 x86 Microsoft(R) Windows(R) 7 Professional 日本語版 (32 ビット版 ) Microsoft(R) Windows(R) 7 Enterprise 日本語版 (32 ビット版 ) Microsoft(R) Windows(R) 7 Ultimate 日本語版 (32 ビット版 ) Windows 7 x64 Microsoft(R) Windows(R) 7 Professional 日本語版 (64 ビッ ト版 ) Microsoft(R) Windows(R) 7 Enterprise 日本語版 (64 ビット版 ) Microsoft(R) Windows(R) 7 Ultimate 日本語版 (64 ビット版 ) Windows 8 Windows 8 x86 Windows(R) 8 Pro 日本語版 (32 ビット版 ) Windows(R) 8 Enterprise 日本語版 (32 ビット版 ) Windows 8 x64 Windows(R) 8 Pro 日本語版 (64 ビット版 ) Windows(R) 8 Enterprise 日本語版 (64 ビット版 ) なお,32 ビット版の Windows を Windows x86 と表記することがあります また,64 ビット版の Windows を Windows x64 と表記することがあります 発行 2013 年 10 月 Y21-30 著作権 All Rights Reserved. Copyright (C) 2012, 2013, Hitachi, Ltd.

4 変更内容 変更内容 ( Y21-30) 追加 変更内容 記載内容は変更なし ( リンク情報だけを変更した ) 変更個所 変更内容 ( Y21-20) 追加 変更内容 記載内容は変更なし ( リンク情報だけを変更した ) 変更内容 ( Y21-10) ucosminexus Application Server 09-50,uCosminexus Application Server(64) 09-50,uCosminexus Client 09-50,uCosminexus Developer 09-50,uCosminexus Service Architect 09-50,uCosminexus Service Platform 09-50,uCosminexus Service Platform(64) 追加 変更内容 Web リソースクライアントの実装で使用する RESTful Web サービス用クライアント API の説明を追加した javax.xml.ws を追加した Bean Validation のアノテーションの定義可能範囲の表を追加した Web コンテナで使用する API に,EADs セッションフェイルオーバ抑止機能の例外クラスを追加した JDK6.0 に対応した 単なる誤字 脱字などはお断りなく訂正しました

5 はじめに このマニュアルをお読みになる際の前提情報については, マニュアル アプリケーションサーバ & BPM/ESB 基 盤概説 のはじめにの説明を参照してください I

6

7 目次 1 API の概要 API とタグライブラリの種類 アノテーションの記述形式 API の記述形式 6 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 対応するアノテーションのサポート範囲 javax.annotation パッケージに含まれるアノテーションのサポート範囲 javax.annotation.security パッケージに含まれるアノテーションのサポート範囲 javax.ejb パッケージに含まれるアノテーションのサポート範囲 javax.interceptor パッケージに含まれるアノテーションのサポート一覧 javax.jws パッケージに含まれるアノテーションのサポート範囲 javax.persistence パッケージに含まれるアノテーションのサポート範囲 javax.servlet.annotation パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws.soap パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws.spi パッケージに含まれるアノテーションのサポート範囲 CDI のアノテーションのサポート一覧 JSF のアノテーションのサポート一覧 Bean Validation のアノテーションのサポート一覧 javax.annotation パッケージ javax.annotation.security パッケージ javax.ejb パッケージ i

8 目次 javax.faces.bean パッケージ javax.interceptor パッケージ javax.persistence パッケージ ii

9 目次 iii

10 目次 アノテーションと O/R マッピングとの対応 javax.servlet.annotation パッケージ アプリケーションサーバが対応する Dependency Injection Web コンテナで使用する API 例外クラス EJB クライアントアプリケーションで使用する API EJB クライアントアプリケーションで使用する API の一覧 EJBClientInitializer クラス 151 initialize メソッド RequestTimeoutConfigFactory クラス 152 getrequesttimeoutconfig メソッド RequestTimeoutConfig クラス 153 setrequesttimeout メソッド ( 形式 1) 153 setrequesttimeout メソッド ( 形式 2) 154 iv

11 目次 unsetrequesttimeout メソッド UserTransactionFactory クラス 156 getusertransaction メソッド 例外クラス TP1 インバウンドアダプタによって OpenTP1 と連携する場合に使用する API TP1 インバウンドアダプタによって OpenTP1 と連携する場合に使用する API の一覧 TP1InMessage インタフェース 161 getinputdata メソッド 161 createoutmessage メソッド TP1MessageListener インタフェース 163 onmessage メソッド TP1OutMessage インタフェース 164 getoutputdata メソッド 164 getmaxoutputlength メソッド スレッドの非同期並行処理で使用する API Timer and Work Manager for Application Servers 仕様と動作が異なるアプリケーションサーバの API の一覧 ユーザログ機能で使用する API ユーザログ機能で使用する API の一覧 CJLogRecord クラス 171 create メソッド ( 形式 1) 173 create メソッド ( 形式 2) 173 create メソッド ( 形式 3) 174 create メソッド ( 形式 4) 174 create メソッド ( 形式 5) 175 create メソッド ( 形式 6) 176 create メソッド ( 形式 7) 176 create メソッド ( 形式 8) 177 create メソッド ( 形式 9) 178 create メソッド ( 形式 10) 178 createp メソッド ( 形式 1) 179 createp メソッド ( 形式 2) 180 createp メソッド ( 形式 3) 180 createp メソッド ( 形式 4) 181 createp メソッド ( 形式 5) 182 createp メソッド ( 形式 6) 182 createp メソッド ( 形式 7) 183 v

12 目次 createp メソッド ( 形式 8) 184 createp メソッド ( 形式 9) 185 createp メソッド ( 形式 10) 186 createrb メソッド ( 形式 1) 186 createrb メソッド ( 形式 2) 187 createrb メソッド ( 形式 3) 188 createrb メソッド ( 形式 4) 189 createrb メソッド ( 形式 5) 190 createrb メソッド ( 形式 6) 190 createrb メソッド ( 形式 7) 191 createrb メソッド ( 形式 8) 192 createrb メソッド ( 形式 9) 193 createrb メソッド ( 形式 10) 監査ログ出力で使用する API 監査ログ出力で使用する API の一覧 AuditLogRecord クラス 199 getafterinfo メソッド 206 getauthority メソッド 207 getbeforeinfo メソッド 207 getcategory メソッド 208 getdetectionpoint メソッド 208 gethaid メソッド 209 getlocation メソッド 209 getmessage メソッド 210 getmessageid メソッド 210 getobjectinfo メソッド 211 getobjectlocation メソッド 211 getoperation メソッド 211 getoutputpoint メソッド 212 getreceiverhost メソッド 212 getreceiverport メソッド 213 getresult メソッド 213 getsenderhost メソッド 214 getsenderport メソッド 214 getserviceinstance メソッド 215 getsubjectid メソッド 215 getsubjectpoint メソッド 216 setafterinfo メソッド 216 setauthority メソッド 217 vi

13 目次 setbeforeinfo メソッド 217 setcategory メソッド 218 setdetectionpoint メソッド 218 sethaid メソッド 219 setlocation メソッド 219 setmessage メソッド 220 setmessageid メソッド 220 setobjectinfo メソッド 221 setobjectlocation メソッド 221 setoperation メソッド 222 setoutputpoint メソッド 222 setreceiverhost メソッド 223 setreceiverport メソッド 223 setresult メソッド 224 setsenderhost メソッド 224 setsenderport メソッド 225 setserviceinstance メソッド 225 setsubjectid メソッド 226 setsubjectpoint メソッド UserAuditLogger クラス 228 getlogger メソッド 228 isenabled メソッド 229 isloggable メソッド 229 log メソッド 例外クラス 性能解析トレースで使用する API 性能解析トレースで使用する API の一覧 CprfTrace クラス 235 getrootapinfo メソッド JavaVM で使用する API JavaVM で使用する API の一覧 BasicExplicitMemory クラス 239 BasicExplicitMemory コンストラクタ ( 形式 1) 239 BasicExplicitMemory コンストラクタ ( 形式 2) 240 getname メソッド ExplicitMemory クラス 242 countexplicitmemories メソッド 242 freememory メソッド 243 vii

14 目次 getmemoryusage メソッド 244 isactive メソッド 244 isreclaimed メソッド 245 newarray メソッド ( 形式 1) 246 newarray メソッド ( 形式 2) 246 newinstance メソッド ( 形式 1) 247 newinstance メソッド ( 形式 2) 249 newinstance メソッド ( 形式 3) 250 reclaim メソッド ( 形式 1) 251 reclaim メソッド ( 形式 2) 252 reclaim メソッド ( 形式 3) 253 reclaim メソッド ( 形式 4) 254 setname メソッド 255 tostring メソッド 255 totalmemory メソッド 256 usedmemory メソッド MemoryArea クラス MemoryInfo クラス 259 getedenfreememory メソッド 259 getedenmaxmemory メソッド 260 getedentotalmemory メソッド 260 getpermfreememory メソッド 261 getpermmaxmemory メソッド 261 getpermtotalmemory メソッド 261 getsurvivorfreememory メソッド 262 getsurvivormaxmemory メソッド 262 getsurvivortotalmemory メソッド 263 gettenuredfreememory メソッド 263 gettenuredmaxmemory メソッド 263 gettenuredtotalmemory メソッド Explicit メモリブロックを制御する処理のエラーチェック ( 共通エラーチェック ) 例外クラス アプリケーション開発時に使用できるプロパティ バッチアプリケーションで使用できるプロパティ 268 ejbserver.batch.currentdir プロパティ 268 付録 269 付録 A Java ヒープメモリのリークを起こしやすい JavaAPI クラス 270 viii

15 目次 付録 B JavaVM 内部で暗黙にスレッドを生成する JavaAPI クラス 272 付録 B.1 スレッド生成処理一覧 272 索引 277 ix

16

17 1 API の概要 この章では, アプリケーションサーバで使用する API とタグライブラリの種類, およびこのマニュアルでの記述形式について説明します 1

18 1 API の概要 1.1 API とタグライブラリの種類 アプリケーションサーバで使用する API とタグライブラリの種類について説明します このマニュアルでは, アプリケーションごとに使用できる API とタグライブラリを三つに分類して説明します J2EE アプリケーションで使用できる API とタグライブラリ バッチアプリケーションまたは EJB クライアントアプリケーションで使用できる API Web サービスを実行するシステムで使用できる API J2EE アプリケーションで使用できる API とタグライブラリを次の表に示します 表 1 1 J2EE アプリケーションで使用できる API API とタグライブラリの種類 Web コンテナで使用する API API とタグライブラリの説明参照先マニュアル参照先 Web コンテナで使用する API です このマニュアル 3 章 EJB クライアントアプリケーションで使用する API EJB クライアントのセキュリティや通信タイムアウトなどを設定するための API です 4 章 TP1 インバウンドアダプタによって OpenTP1 と連携する場合に使用する API TP1 インバウンドアダプタによって OpenTP1 と連携する場合に使用する API です 5 章 スレッドの非同期並行処理で使用する API スレッドの非同期並行処理で使用する API です 6 章 統合ユーザ管理フレームワークで使用する API 統合ユーザ管理機能を使用する場合に, ユーザ認証を実装するために使用する, 統合ユーザ管理フレームワークのライブラリです アプリケーションサーバ機能解説セキュリティ管理機能編 15 章 統合ユーザ管理フレームワークで使用するタグライブラリ 統合ユーザ管理機能を使用する場合に, ユーザ認証を実装するために使用する, 統合ユーザ管理フレームワークの JSP タグライブラリです アプリケーションサーバ機能解説セキュリティ管理機能編 16 章 ユーザログ機能で使用する API J2EE アプリケーションが出力するログ ( ユーザログ ) をトレース共通ライブラリ形式で出力する場合に, ユーザログ出力を実装するための API です このマニュアル 7 章 監査ログ出力で使用する API J2EE アプリケーションで監査ログを出力するための API です 8 章 性能解析トレースで使用する API 性能解析トレースでアプリケーションサーバの処理性能を解析する場合に, ルートアプリケーション情報を文字列表現で取得するための API です 9 章 JavaVM で使用する API Java プログラムから直接ガーベージコレクションのメモリ情報を取得するための API です 10 章 2

19 1 API の概要 API とタグライブラリの種 類 API とタグライブラリの説明参照先マニュアル参照先 DABroker Library で使用 する API DABroker Library を使用してデータベースに接続す る場合に, データベースの情報などを設定するための API です アプリケーション サーバ機能解説互換 編 4 章 なお,API とタグライブラリのほかに, アノテーションと Dependency Injection も使用できます アノテーションと Dependency Injection については, 2. アプリケーションサーバが対応しているアノテーションおよび Dependency Injection を参照してください バッチアプリケーションまたは EJB クライアントアプリケーションで使用できる API を次の表に示します 表 1 2 バッチアプリケーションまたは EJB クライアントアプリケーションで使用できる API API とタグライブラリの種 類 API とタグライブラリの説明参照先マニュアル参照先 EJB クライアントアプリケーションで使用する API EJB クライアントアプリケーションのセキュリティや通信タイムアウトなどを設定するための API です このマニュアル 4 章 ユーザログ機能で使用する API バッチアプリケーションまたは EJB クライアントアプリケーションが出力するログ ( ユーザログ ) をトレース共通ライブラリ形式で出力する場合に, ユーザログ出力を実装するための API です 7 章 監査ログ出力で使用する API バッチアプリケーションまたは EJB クライアントアプリケーションで監査ログを出力するための API です 8 章 性能解析トレースで使用する API 性能解析トレースでアプリケーションサーバの処理性能を解析する場合に, ルートアプリケーション情報を文字列表現で取得するための API です 9 章 JavaVM で使用する API Java プログラムから直接ガーベージコレクションのメモリ情報を取得するための API です 10 章 DABroker Library で使用する API DABroker Library を使用してデータベースに接続する場合に, データベースの情報などを設定するための API です アプリケーションサーバ機能解説互換編 4 章 Web サービスを実行するシステムで使用できる API を次の表に示します 表 1 3 Web サービスを実行するシステムで使用できる API API の種類 API の説明参照先マニュアル参照先 JAX-WS 2.2 仕様に対応した SOAP Web サービスの開発で使用する API SOAP Web サービスや Web サービスクライアントを開発するときに使用します アプリケーション サーバ Web サービ ス開発ガイド 19 章 JAX-RS 1.1 仕様に対応した RESTful Web サービスの開発で使用する API RESTful Web サービス (Web リソース ) を開発するときに使用します なお,HTTP クライアントは, RESTful Web サービス用クライアント API か, または標準的な Java API を使用して開発します 24 章 3

20 1 API の概要 API の種類 API の説明参照先マニュアル参照先 Web リソースクライアントの実装で使用する RESTful Web サービス用クライアント API RESTful Web サービス (Web リソース ) のクライア ントを RESTful Web サービス用クライアント API で実装するときに使用します アプリケーション サーバ Web サービ ス開発ガイド 25 章 4

21 1 API の概要 1.2 アノテーションの記述形式 2 章では, アノテーションについて次の形式で説明します なお, 各アノテーションはアルファベットの順に説明します (1) 説明アノテーションの機能について説明します (2) 属性アノテーションに含まれる属性について説明します 各属性については, 次の形式で説明します (a) 属性名型属性の型を示します 説明属性の機能について説明します デフォルト値属性のデフォルト値を示します 5

22 1 API の概要 1.3 API の記述形式 3 章から 10 章では,API について次の形式で説明します なお, 各 API は, アルファベットの順に説明します 説明 API の機能について説明します 形式 API の記述形式を示します パラメタ API のパラメタについて説明します 例外 API を利用する際に発生する例外について説明します 戻り値 API の戻り値について説明しています 注意事項 API を利用する上での注意事項について説明します 6

23 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection この章では, アプリケーションサーバが対応しているアノテーションおよび Dependency Injection について説明します なお, アノテーション参照抑止機能を使用している場合, アノテーションの指定は参照されません アノテーション参照抑止機能については, マニュアル アプリケーションサーバ機能解説基本 開発編 ( コンテナ共通機能 ) の 12.5 アノテーションの参照抑止 を参照してください 7

24 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 2.1 対応するアノテーションのサポート範囲 アノテーションは, ソースコードに注釈を付けることができる言語仕様です アプリケーションサーバが対応しているアノテーションの一覧を次に示します javax.annotation パッケージに含まれるアノテーションのサポート範囲 javax.annotation パッケージのアノテーションの適用範囲を説明します ここでは, コンポーネントごと に記述できるアノテーションを説明します (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 1 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.annotation パッケー ジ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an (JSF ) es ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない 注 JSF に依存するアノテーションです サポート範囲については,JSF 仕様のドキュメントを参照してください (2) WAR ファイル (Servlet 2.5 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 8

25 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 2 WAR ファイル (Servlet 2.5 対応 ) に記述できるアノテーション (javax.annotation パッケー ジ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット フィルタ イベント リスナ JSP ファ イル タグハンドラ クラシッ シンプル クタグハ タグハン ンドラ ドラ タグライブラリイベントリスナ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (3) EJB-JAR ファイル (EJB3.1/3.0 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 表 2 3 EJB-JAR ファイル (EJB3.1/3.0 対応 ) に記述できるアノテーション (javax.annotation パッケージ ) Enterprise Bean インターセプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 9

26 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (4) ライブラリ JAR ファイル ( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションの一覧を示します 表 2 4 ライブラリ JAR( サーブレット /JSP) に記述できるアノテーション (javax.annotation パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット (API) サーブレットフィルタ サーブレットフィルタ (API) イベン トリス ナ イベントリスナ (API) JSP ファイ ル タグハンドラ クラ シンプ シック ルタグ タグハ ハンド ンドラ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (5) ライブラリ JAR ファイル (Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, またはその他のクラスに記述できるアノテーションの一覧を示します 表 2 5 ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) に記述できるアノテーション (javax.annotation パッケージ ) Enterprise Bean アノテーション名 インタ フェース Session Bean Entity Bean Messag e-driven Bean インター セプタ 例外クラ ス ( 凡例 ) : 対応する 10

27 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection : アプリケーションサーバでは対応しない : 標準仕様で対応していない javax.annotation.security パッケージに含まれるアノテーションのサポート範囲 javax.annotation.security パッケージのアノテーションの適用範囲を説明します ここでは, コンポーネ ントごとに記述できるアノテーションを説明します (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 6 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.annotation.security パッケージ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an (JSF ) ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (2) WAR ファイル (Servlet 2.5 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 7 WAR ファイル (Servlet 2.5 対応 ) に記述できるアノテーション (javax.annotation.security パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット フィルタ イベント リスナ JSP ファ イル タグハンドラ クラシッ シンプル クタグハ タグハン ンドラ ドラ タグライブラリイベントリスナ 11

28 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection ( 凡例 ) : 対応する : 標準仕様で対応していない (3) EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 表 2 8 EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) に記述できるアノテーション (javax.annotation.security パッケージ ) Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ @RunAs ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (4) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションの一覧を示します 12

29 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 9 ライブラリ JAR( サーブレット /JSP) に記述できるアノテーション (javax.annotation.security パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット (API) サーブレットフィルタ サーブレットフィルタ (API) イベン トリス ナ イベントリスナ (API) JSP ファイ ル タグハンドラ クラ シンプ シック ルタグ タグハ ハンド ンドラ ラ ( 凡例 ) : 対応する : 標準仕様で対応していない (5) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, またはその他のクラスに記述できるアノテーションは ありません javax.ejb パッケージに含まれるアノテーションのサポート範囲 javax.ejb パッケージのアノテーションの適用範囲を説明します ここでは, コンポーネントごとに記述できるアノテーションを説明します (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 10 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.ejb パッケージ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an (JSF ) ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない 13

30 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (2) WAR ファイル (Servlet 2.5 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 11 WAR ファイル (Servlet 2.5 対応 ) に記述できるアノテーション (javax.ejb パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット フィルタ イベント リスナ JSP ファ イル タグハンドラ クラシッ シンプル クタグハ タグハン ンドラ ドラ タグライブラリイベントリスナ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (3) EJB-JAR ファイル (EJB3.1 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 表 2 12 EJB-JAR ファイル (EJB3.1 対応 ) に記述できるアノテーション (javax.ejb パッケージ ) Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス ion 14

31 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス gement @LocalBean

32 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス gement ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない 注 1 Singleton Session Bean の場合にだけ使用できます 注 2 Stateful Session Bean の場合にだけ使用できます 注 3 Stateless Session Bean と Singleton Session Bean の場合にだけ使用できます 注 4 Stateless Session Bean の場合にだけ使用できます (4) EJB-JAR ファイル (EJB3.0 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 16

33 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 13 EJB-JAR ファイル (EJB3.0 対応 ) に記述できるアノテーション (javax.ejb パッケージ ) Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス gement ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない 注 1 Stateful Session Bean の場合にだけ使用できます 17

34 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 注 2 Stateless Session Bean の場合にだけ使用できます (5) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションの一覧を示します 表 2 14 ライブラリ JAR( サーブレット /JSP) に記述できるアノテーション (javax.ejb パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット (API) サーブレットフィルタ サーブレットフィルタ (API) イベン トリス ナ イベントリスナ (API) JSP ファイ ル タグハンドラ クラ シンプ シック ルタグ タグハ ハンド ンドラ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (6) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, またはその他のクラスに記述できるアノテーションの一覧を示します 表 2 15 ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) に記述できるアノテーション (javax.ejb パッケージ ) Enterprise Bean アノテーション名 インタ フェース Session Bean Entity Bean Messag e-driven Bean インター セプタ 例外クラ ス @Remote ( 凡例 ) : 対応する : 標準仕様で対応していない 18

35 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection javax.interceptor パッケージに含まれるアノテーションのサポート一覧 javax.interceptor パッケージのアノテーションの適用範囲を説明します ここでは, コンポーネントごと に記述できるアノテーションを説明します javax.interceptor パッケージのアノテーションは,CDI アプリケーションでも利用できます ただし, EJB と組み合わせて利用する場合は注意が必要です 注意事項の詳細は, マニュアル アプリケーション サーバ機能解説基本 開発編 ( コンテナ共通機能 ) の 9. アプリケーションサーバでの CDI の利用 を 参照してください (1) WAR ファイル (Servlet 3.0/Servlet 2.5 対応 ) WAR ファイルに記述できるアノテーションはありません (2) EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 表 2 16 EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) に記述できるアノテーション (javax.interceptor パッケージ ) Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない 19

36 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (3) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションはありません (4) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, およびその他のクラスに記述できるアノテーションの一覧を示します 表 2 17 ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) に記述できるアノテーション (javax.interceptor パッケージ ) Enterprise Bean アノテーション名 インタ フェース Session Bean Entity Bean Messagedriven Bean インターセ プタ ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない javax.jws パッケージに含まれるアノテーションのサポート範囲 javax.jws パッケージに含まれるアノテーションのサポート範囲, および各アノテーションの詳細について, マニュアル アプリケーションサーバ Web サービス開発ガイド の 16.2 Java から WSDL へのマッピングのカスタマイズ を参照してください javax.persistence パッケージに含まれるアノテーションのサポート範囲 javax.persistence パッケージのアノテーションは,JPA プロバイダに依存する場合としない場合で記述で きるコンポーネントが異なります ここでは,JPA プロバイダに依存するアノテーションと JPA プロバイ ダに依存しないアノテーションに分けて説明します (1) JPA プロバイダに依存するアノテーションの場合 JPA プロバイダに依存するアノテーションの適用範囲を説明します ここでは, コンポーネントごとに記述 できるアノテーションを説明します (a) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 20

37 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 18 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.persistence パッケー ジ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an(j SF) nceconte nceconte nceproper nceunits ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (b) WAR ファイル (Servlet 2.5 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 19 WAR ファイル (Servlet 2.5 対応 ) に記述できるアノテーション (javax.persistence パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット フィルタ イベント リスナ JSP ファ イル タグハンドラ クラシッ シンプル クタグハ タグハン ンドラ ドラ タグライブラリイベントリスナ その他の ts 21

38 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット フィルタ イベント リスナ JSP ファ イル タグハンドラ クラシッ シンプル クタグハ タグハン ンドラ ドラ タグライブラリイベントリスナ その他の y ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (c) EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 表 2 20 EJB-JAR ファイル (EJB3.1/EJB3.0 対応 ) に記述できるアノテーション (javax.persistence パッケージ ) Enterprise Bean インターセプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス y 22

39 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (d) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションの一覧を示します 表 2 21 ライブラリ JAR( サーブレット /JSP) に記述できるアノテーション (javax.persistence パッケージ ) Servlet 仕様 JSP 仕様 アノテーション名 サーブ レット サーブ レット (API) サーブレットフィルタ サーブレットフィルタ (API) イベン トリス ナ イベントリスナ (API) JSP ファイ ル タグハンドラ クラ シンプ シック ルタグ タグハ ハンド ンドラ @PersistenceUnits ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (e) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, またはその他のクラスに記述できるアノテーションの一覧を示します 表 2 22 ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) に記述できるアノテーション (javax.persistence パッケージ ) Enterprise Bean アノテーション名 インタ フェース Session Bean Entity Bean Messagedriven Bean インターセ @PersistenceUnits 23

40 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない : 標準仕様で対応していない (2) JPA プロバイダに依存しないアノテーションの場合 JPA プロバイダに依存しないアノテーションは, ファイルの種類に関係なく, エンティティクラス内に記述できます javax.persistence パッケージに含まれるアノテーションの一覧については, 2.7 javax.persistence パッケージ のアノテーション一覧を参照してください javax.servlet.annotation パッケージに含まれるアノテーションのサポート範囲 javax.servlet.annotation パッケージのアノテーションの適用範囲を説明します ここでは, コンポーネン トごとに記述できるアノテーションを説明します (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 23 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.servlet.annotation パッケージ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an(j SF) hodconstr er 24

41 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an(j SF) vlet ( 凡例 ) : 対応する : 標準仕様で対応していない (2) EJB-JAR ファイル EJB-JAR ファイルに記述できるアノテーションはありません (3) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションはありません (4) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, およびその他のクラスに記述できるアノテーションはありません javax.xml.ws パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws パッケージに含まれるアノテーションのサポート範囲, および各アノテーションの詳細につ いては, マニュアル アプリケーションサーバ Web サービス開発ガイド の 16.2 Java から WSDL へのマッピングのカスタマイズ を参照してください javax.xml.ws.soap パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws.soap パッケージに含まれるアノテーションのサポート範囲, および各アノテーションの詳 細については, マニュアル アプリケーションサーバ Web サービス開発ガイド の 16.2 Java から WSDL へのマッピングのカスタマイズ を参照してください 25

42 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection javax.xml.ws.spi パッケージに含まれるアノテーションのサポート範囲 javax.xml.ws.spi パッケージに含まれるアノテーションのサポート範囲, および各アノテーションの詳細 については, マニュアル アプリケーションサーバ Web サービス開発ガイド の 16.2 Java から WSDL へのマッピングのカスタマイズ を参照してください CDI のアノテーションのサポート一覧 CDI のアノテーションのサポート一覧を次の表に示します パッケージ @SessionScoped @Singleton 26

43 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection ここでは, コンポーネントごとに記述できるアノテーション アノテーション ) を説明します なお,@inject アノテーション以外のアノテーションについては,CDI に依存します CDI に依存するアノテーションについては,CDI 仕様のドキュメントを参照してください (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 表 2 24 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.inject パッケージ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an (JSF ) ( 凡例 ) : 対応する : 標準仕様で対応していない : アプリケーションサーバでは対応しない 注 該当するコンポーネントが CDI の機能を含むコンポーネントの場合だけ使用できます (2) EJB-JAR ファイル (EJB3.1 対応 ) EJB-JAR ファイルに記述できるアノテーションの一覧を示します 27

44 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 25 EJB-JAR ファイル (EJB3.0 対応 ) に記述できるアノテーション (javax.inject パッケージ ) Enterprise Bean インター セプタ デ アノテーション名 インタフェース Session Bean Entity Bean Messagedriven Bean フォルトインターセプタ以外 デフォルトインターセプタ 例外クラス ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない 注 該当するコンポーネントが CDI の機能を含むコンポーネントの場合だけ使用できます (3) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションはありません (4) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, またはその他のクラスに記述できるアノテーションの一覧を示します 表 2 26 ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) に記述できるアノテーション (javax.inject パッケージ ) Enterprise Bean アノテーション名 インタ フェース Session Bean Entity Bean Messag e-driven Bean インター セプタ 例外クラ ス その他の ( 凡例 ) : 対応する : アプリケーションサーバでは対応しない 注 該当するコンポーネントが CDI の機能を含むコンポーネントの場合だけ使用できます 28

45 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection JSF のアノテーションのサポート一覧 JSF のアノテーションのサポート一覧を次の表に示します javax.faces.application @ViewScoped javax.faces.component javax.faces.component.behavior @FacesRenderer ここでは, コンポーネントごとに記述できるアノテーション アノテーション ) を説明します なお,@ManagedBean アノテーション以外のアノテーションについては,JSF に依存します JSF に依存するアノテーションについては,JSF 仕様のドキュメントを参照してください (1) WAR ファイル (Servlet 3.0 対応 ) WAR ファイルに記述できるアノテーションの一覧を示します 29

46 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 表 2 27 WAR ファイル (Servlet 3.0 対応 ) に記述できるアノテーション (javax.faces.bean パッケー ジ ) Servlet 仕様 JSP 仕様 アノテー ション名 サーブレット サーブレット (API ) サーブレットフィルタ サーブレットフィルタ (API ) イベントリスナ イベントリスナ (API ) JSP ファ イル タグハンドラクラシンシップルクタタググハハンンドドララ タグライブラリイベントリスナ 例外 クラ ス Man age dbe an (JSF ) dbean ( 凡例 ) : 対応する : 標準仕様で対応していない (2) EJB-JAR ファイル (EJB3.1 対応 ) EJB-JAR ファイルに記述できるアノテーションはありません (3) ライブラリ JAR( サーブレット /JSP) ライブラリ JAR のサーブレットまたは JSP に記述できるアノテーションはありません (4) ライブラリ JAR(Enterprise Bean/ 例外クラス / その他のクラス ) ライブラリ JAR の Enterprise Bean, 例外クラス, およびその他のクラスに記述できるアノテーションはありません Bean Validation のアノテーションのサポート一覧 Bean Validation のアノテーションのサポート一覧を次の表に示します なお, アプリケーションサーバ では,Bean Validation は JSF と CDI から使用できます パッケージ 30

47 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection パッケージ @Pattern.List Bean Validation のアノテーションについては,Bean Validation 仕様のドキュメントを参照してくださ い Bean Validation のアノテーションの定義可能範囲を次の表に示します 項番 連携対象 javax.validation パッケージ javax.validation.constraints パッ ケージ サポートバージョン 1 JSF 連携 クラスパス上のクラス 2 CDI 連携 クラスパス上の を指定したクラス JavaBeans クラス

48 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 項番 連携対象 javax.validation パッケージ javax.validation.constraints パッ ケージ サポートバージョン 2 ユーザアプリ ケーション クラスパス上の クラス JavaBeans クラス 注 JavaBeans クラスのインスタンスをユーザプログラムが管理する場合, そのクラスでは Bean Validation のアノテーションを使用できます JavaBeans クラスのインスタンスをコンテナが管理する場合 (Servlet/EJB など ), そのクラスでは Bean Validation のアノテーションを使用できません 32

49 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 2.2 javax.annotation パッケージ javax.annotation パッケージに含まれるアノテーションの一覧を次の表に示します 機能サーブレット,Enterprise Bean インスタンスなどが生成された直後にコールバックするメソッドを設定します サーブレット,Enterprise Bean インスタンスなどが削除される直前にコールバックするメソッドを設定します を複数設定します それぞれのアノテーションの詳細について, 次に説明します (1) 説明サーブレット,Enterprise Bean インスタンスなどが生成された直後にコールバックするメソッドを設定します (2) の属性はありません (1) 説明サーブレット,Enterprise Bean インスタンスなどが削除される直前にコールバックするメソッドを設定します (2) の属性はありません (1) 説明リソースへの参照を宣言します クラス, メソッド, およびフィールドに設定できます メソッドやフィールドに設定した場合,Dependency Injection の対象となります ただし, メソッドは set メソッドである必要があります (2) の属性の一覧を次の表に示します 33

50 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 属性名 機能 name type authenticationtype shareable mappedname lookup description リソース参照の名称を設定します 設定した名称は JNDI 名として使用されます アノテーションをメソッドまたはフィールドに設定する場合, 省略できます リソースの Java タイプを設定します アノテーションをメソッドまたはフィールドに設定する場合, 省略できます リソースに使用する認証タイプを設定します リソースを共用するかどうかを設定します 参照先リソースを特定するためにリソース表示名やキュー名を設定します 参照する別のリソース参照の Portable Global JNDI 名, またはリソースの別名を設定します リソースの説明を設定します 各属性の詳細を次に示します (a) name 属性型 String 説明リソース参照の名称を設定します 設定した名称は JNDI 名として使用されます アノテーションをメソッドまたはフィールドに設定する場合, 省略できます なお, リソースの別名を指定することもできます J2EE リソースの別名の設定については, マニュアル アプリケーションサーバ機能解説基本 開発編 ( コンテナ共通機能 ) の J2EE リソースの別名の設定 を参照してください デフォルト値 メソッドに設定した場合アノテーションを設定したクラス名 /set メソッドのプロパティ フィールドに設定した場合アノテーションを設定したクラス名 / フィールド名 (b) type 属性型 Class 説明リソースの Java タイプを設定します アノテーションをメソッドまたはフィールドに設定する場合, 省略できます デフォルト値 メソッド設定した場合メソッドの引数の型 フィールドに設定した場合フィールドの型 34

51 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection type 属性と DD の対応 type 属性は J2EE 仕様と異なり, 設定値 (Java Type) によって対応する DD が変わります Java Type によって異なる DD の対応を次の表に示します 表 2 28 type 属性による DD の対応表 type 属性 J2EE 仕様で対応する DD のタグ アプリケーションサーバ仕様で対 応する DD のタグ 1 java.lang.string 2 env-entry env-entry java.lang.character 2 env-entry env-entry java.lang.integer 2 env-entry env-entry java.lang.boolean 2 env-entry env-entry java.lang.double 2 env-entry env-entry java.lang.byte 2 env-entry env-entry java.lang.short 2 env-entry env-entry java.lang.long 2 env-entry env-entry java.lang.float 2 env-entry env-entry javax.xml.rpc.service service-ref 例外 3 javax.xml.ws.service service-ref 例外 3 javax.jws.webservice service-ref 例外 3 javax.sql.datasource resource-ref resource-ref javax.jms.connectionfactory resource-ref resource-ref javax.jms.queueconnectionfactory resource-ref resource-ref javax.jms.topicconnectionfactory resource-ref resource-ref javax.mail.session resource-ref resource-ref java.net.url resource-ref 例外 3 javax.resource.cci.connectionfactory resource-ref resource-ref org.omg.corba_2_3.orb resource-ref resource-ref リソースアダプタによって定義されるほかのコ ネクションファクトリ resource-ref resource-env-ref javax.jms.queue message-destination-ref resource-env-ref javax.jms.topic message-destination-ref resource-env-ref javax.resource.cci.interactionspec resource-env-ref 例外 3 javax.transaction.usertransaction resource-env-ref resource-env-ref javax.xml.ws.webservicecontext 未定義 resource-env-ref 4 35

52 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection type 属性 J2EE 仕様で対応する DD のタグ アプリケーションサーバ仕様で対 応する DD のタグ 1 上記以外のすべてのタイプ 5 resource-env-ref resource-env-ref 注 1 mappedname 要素に!# が含まれていた場合は,Java Type とは関係なく,<resource-env-ref> タグに対応づけます 注 2 標準 DD から値を取得できないため, 属性ファイルには表示しますが,DI は行いません 注 3 インポート時に例外となります 注 より前のアプリケーションサーバでは, 上記以外のすべてのタイプとして扱われます 注 以降のアプリケーションサーバでは,java.lang.Class と java.lang.enum のサブクラスは <env-entry> で扱われません (c) authenticationtype 属性型 AuthenticationType 説明リソースに使用する認証タイプを設定します デフォルト値 CONTAINER (d) shareable 属性型 boolean 説明リソースを共用するかどうかを設定します デフォルト値 true (e) mappedname 属性型 String 説明参照先リソースを特定するためにリソース表示名やキュー名を設定します リソース表示名に半角英数字およびアンダースコア (_) 以外の文字を含む場合, 半角英数字およびアンダースコア (_) 以外の文字をアンダースコア (_) に置き換えて設定してください デフォルト値 "" 36

53 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection mappedname 属性の設定条件 mappedname 属性は type での mappedname 属性の設定条件を次の表に示します 表 2 の mappedname() の設定条件 設定条件 (Java Type, リソースなど ) 使用可否 1 java.lang.string java.lang.character java.lang.integer java.lang.boolean java.lang.double java.lang.byte java.lang.short java.lang.long java.lang.float javax.xml.rpc.service javax.sql.datasource javax.jms.connectionfactory javax.jms.queueconnectionfactory javax.jms.topicconnectionfactory javax.mail.session java.net.url javax.resource.cci.connectionfactory org.omg.corba_2_3.orb javax.jms.queue 2 javax.jms.topic javax.resource.cci.interactionspec javax.transaction.usertransaction javax.ejb.ejbcontext javax.ejb.sessioncontext javax.ejb.timerservice JavaBeans リソース ( 凡例 ) : 使用できます : 使用できません 37

54 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 注 1 管理対象オブジェクトへの対応づけは,Java Type に関係なく,mappedName 要素で対応づけます リソースアダプタの表示名と管理対象オブジェクト名の区切り文字には,!# を使用してください 注 2 TP1/Message Queue - Access または Reliable Messaging を使用時に javax.jms.queue を使用する場合, リソースアダプタの表示名とキューの表示名の区切り文字には, # を使用してください (f) lookup 属性型 String 説明参照する別のリソース参照の Portable Global JNDI 名, またはリソースの別名を設定します デフォルト値 "" (g) description 属性型 String 説明リソースの説明を設定します デフォルト値 "" (1) を複数設定します なお, クラスにだけ設定できます (2) の属性の一覧を次の表に示します 属性名 機能 value 複数のリソース (@Resource) を定義します 各属性の詳細を次に示します (a) value 属性型 Resource[] 説明複数のリソース (@Resource) を定義します デフォルト値なし 38

55 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 2.3 javax.annotation.security パッケージ javax.annotation.security パッケージに含まれるアノテーションの一覧を次の表に示します @RunAs 機能セキュリティロールの参照を設定します すべてのセキュリティロールに対して, アクセスを拒否するメソッドに設定します すべてのセキュリティロールに対して, アクセスを許可するクラスまたはメソッドに設定します クラスまたはメソッドに対してアクセスを許可するセキュリティロールを設定します サーブレット, または Enterprise Bean を実行する際に適用するセキュリティロールを設定します (1) 説明セキュリティロールの参照を設定します なお, クラスにだけ設定できます (2) の属性の一覧を次の表に示します 属性名 機能 value 参照するセキュリティロール名を設定します 各属性の詳細を次に示します (a) value 属性型 String[] 説明参照するセキュリティロール名を設定します デフォルト値なし (1) 説明 すべてのセキュリティロールに対して, アクセスを拒否するメソッドまたはクラスに設定します 39

56 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (2) の属性はありません (1) 説明すべてのセキュリティロールに対して, アクセスを許可するクラスまたはメソッドに設定します (2) の属性はありません (1) 説明クラスまたはメソッドに対してアクセスを許可するセキュリティロールを設定します (2) の属性の一覧を次の表に示します 属性名 機能 value アプリケーションでのメソッドにアクセスするのが許可されたロールリストを設定し ます 各属性の詳細を次に示します (a) value 属性型 String[] 説明アプリケーションでのメソッドにアクセスするのが許可されたロールリストを設定します デフォルト値なし (1) 説明サーブレット, または Enterprise Bean を実行する際に適用するセキュリティロールを設定します なお, クラスにだけ設定できます (2) の属性の一覧を次の表に示します 40

57 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 属性名 機能 value Enterprise Bean を実行する際に適用するセキュリティロール名を設定します 各属性の詳細を次に示します (a) value 属性 型 String 説明サーブレット, または Enterprise Bean を実行する際に適用するセキュリティロール名を設定します デフォルト値なし 41

58 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 2.4 javax.ejb パッケージ javax.ejb パッケージに含まれるアノテーションの一覧を次の表に示します 機能 Container Managed Concurrency が設定された Singleton Session Bean の, 同時アクセスのタイムアウト値を設定します Stateful Session Bean の, トランザクション開始直後にコールバックされるメソッドに設定します Stateful Session Bean の, トランザクション決着後にコールバックされるメソッドに設定します アプリケーション例外とする例外クラスに設定します 非同期で実行するビジネスメソッドに設定します Stateless Session Bean または Singleton Session Bean のクラス, メソッドに設定します Stateful Session Bean の, トランザクション決着直前にコールバックされるメソッドに設定します Singleton Session Bean の ConcurrencyManagement の種類を設定します Singleton Session Bean のクラスにだけ設定します Singleton Session Bean 同士の依存関係を指定するために設定します Singleton Session Bean のクラスにだけ設定します EJB を複数設定します Stateful Session Bean のホームインタフェースで定義した create<method>() を実行した際, コールバックするメソッドに設定します Enterprise Bean のローカルビジネスインタフェースを設定します Session Bean を No-Interface view として指定する場合に設定します Session Bean のクラスにだけ設定します ローカルホームインタフェース, およびローカルコンポーネントインタフェースを使用した呼び出しをサポートする Enterprise Bean のクラスに設定します Container Managed Concurrency が設定された Singleton Session Bean の, ビジネスメソッドへのアクセス時の排他制御の方法を設定します Stateful Session Bean が活性化された直後にコールバックするメソッドに設定します Stateful Session Bean が非活性化される直前にコールバックするメソッドに設定します Enterprise Bean のリモートビジネスインタフェースを設定します アノテーションをインタフェースに設定した場合, そのインタフェースがリモートビジネスインタフェースとなります 42

59 2 アプリケーションサーバが対応しているアノテーションおよび Dependency @TransactionManagement 機能リモートホームインタフェース, およびリモートコンポーネントインタフェースを使用した呼び出しをサポートする Enterprise Bean のクラスに設定します Stateful Session Bean を削除する働きを持つビジネスメソッドに設定します EJB タイマーサービスの, を複数設定します コールバックされるタイムアウトメソッドに設定します Singleton Session Bean のクラスに設定します アプリケーション開始時に Singleton Session Bean を同時に開始する場合に設定します Singleton Session Bean のクラスに設定します Stateful Session Bean のクラスに設定します Stateless Session Bean のクラスに設定します TimerService 使用時にコールバックするタイムアウトメソッドに設定します Enterprise Bean が CMT で動作する場合のトランザクション属性を設定します Enterprise Bean のトランザクション管理種別を設定します (1) 説明 Container Managed Concurrency が設定された Singleton Session Bean の, 同時アクセスのタイムアウト値を設定します (2) の属性の一覧を次の表に示します 属性名 機能 value unit タイムアウト値を設定します タイムアウト値の単位を設定します 各属性の詳細を次に示します (a) value 属性型 long 説明タイムアウト値を設定します デフォルト値なし 43

60 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (b) unit 属性型 TimeUnit 説明タイムアウト値の単位を設定します デフォルト値 MILLISECONDS (1) 説明 Stateful Session Bean の, トランザクション開始直後にコールバックされるメソッドに設定します (2) の属性はありません (1) 説明 Stateful Session Bean の, トランザクション決着後にコールバックされるメソッドに設定します (2) の属性はありません (1) 説明アプリケーション例外とする例外クラスに設定します (2) の属性の一覧を次の表に示します 属性名 機能 rollback inherited 例外発生時にコンテナがトランザクションをロールバックするかどうかを設定します アプリケーション例外とするかどうかについて, クラスで設定されている定義をサブク ラスにも適用するかどうかを設定します 各属性の詳細を次に示します (a) rollback 属性型 boolean 44

61 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 説明例外発生時にコンテナがトランザクションをロールバックするかどうかを設定します デフォルト値 false (b) inherited 属性型 boolean 説明アプリケーション例外とするかどうかについて, クラスで設定されている定義をサブクラスにも適用するかどうかを設定します デフォルト値 true (1) 説明非同期で実行するビジネスメソッドに設定します Stateless Session Bean, または Singleton Session Bean のクラスおよびメソッドに設定します (2) の属性はありません (1) 説明 Stateful Session Bean の, トランザクション決着直前にコールバックされるメソッドに設定します (2) の属性はありません (1) 説明 Singleton Session Bean の ConcurrencyManagement の種類を設定します Singleton Session Bean のクラスにだけ設定します (2) の属性の一覧を次の表に示します 属性名 機能 value Singleton Session Bean の ConcurrencyManagement の種類を設定します 45

62 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 各属性の詳細を次に示します (a) value 属性型 ConcurrencyManagementType 説明 Singleton Session Bean の ConcurrencyManagement の種類を設定します デフォルト値 CONTAINER (1) 説明 Singleton Session Bean 同士の依存関係を指定するために設定します Singleton Session Bean のクラスにだけ設定します (2) の属性の一覧を次の表に示します 属性名 機能 value 依存する Singleton Session Bean の EJB 名を列挙します 各属性の詳細を次に示します (a) value 属性型 String[] 説明依存する Singleton Session Bean の EJB 名を列挙します デフォルト値なし (1) 説明 EJB のビジネスインタフェースまたはホームインタフェースへの参照を設定します クラス, メソッド, およびフィールドに設定できます メソッドやフィールドに設定した場合,Dependency Injection の対象となります ただし, メソッドは set メソッドである必要があります (2) の属性の一覧を次の表に示します 46

63 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 属性名 機能 name beaninterface beanname リソース参照の名称を設定します 設定した名称は JNDI 名として使用されます アノテーションをメソッドまたはフィールドに設定する場合, 省略できます ビジネスインタフェースまたはホームインタフェースのクラスを設定します アノテーションをメソッドまたはフィールドに設定する場合, 省略できます 参照する EJB のパッケージなしクラス名を設定します ただし, 参照する EJB クラスを定義するアノテーション に name 属性が設定されている場合,name 属性の値を設定します また,DD による定義をサポートする EJB の場合,DD の <ejb-name> タグの値を設定します mappedname 参照する EJB の Portable Global JNDI 名, または EJB の別名を設定します ただし, beanname 属性が設定されている場合,beanName 属性の設定が優先されます lookup 参照する EJB の Portable Global JNDI 名, または EJB の別名を設定します ただし, beanname 属性や mappedname 属性が設定されている場合,beanName 属性や mappedname 属性の設定が優先されます description 参照する EJB の説明を設定します 各属性の詳細を次に示します (a) name 属性型 String 説明リソース参照の名称を設定します 設定した名称は JNDI 名として使用されます アノテーションをメソッドまたはフィールドに設定する場合, 省略できます デフォルト値 メソッドに設定した場合アノテーションを設定したクラス名 /set メソッドのプロパティ フィールドに設定した場合アノテーションを設定したクラス名 / フィールド名 (b) beaninterface 属性型 Class 説明ビジネスインタフェースまたはホームインタフェースのクラスを設定します アノテーションをメソッドまたはフィールドに設定する場合, 省略できます デフォルト値 メソッド設定した場合メソッドの引数の型 フィールドに設定した場合フィールドの型 47

64 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (c) beanname 属性型 String 説明参照する EJB のパッケージなしクラス名を設定します ただし, 参照する EJB クラスを定義するアノテーション に name 属性が設定されている場合,name 属性の値を設定します また,DD による定義をサポートする EJB の場合,DD の <ejb-name> タグの値を設定します デフォルト値 "" (d) mappedname 属性型 String 説明参照する EJB の Portable Global JNDI 名, または EJB の別名を設定します ただし,beanName 属性が設定されている場合,beanName 属性の設定が優先されます デフォルト値 "" (e) lookup 属性型 String 説明参照する EJB の Portable Global JNDI 名, または EJB の別名を設定します ただし,beanName 属性や mappedname 属性が設定されている場合,beanName 属性や mappedname 属性の設定が優先されます デフォルト値 "" (f) description 属性型 String 説明参照する EJB の説明を設定します デフォルト値 "" (1) を複数設定します なお, クラスにだけ設定できます 48

65 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (2) の属性の一覧を次の表に示します 属性名 機能 を設定します 各属性の詳細を次に示します (a) value 属性型 EJB[] を設定します デフォルト値なし (1) 説明 Stateful Session Bean のホームインタフェースで定義した create<method>() を実行した際, コールバックするメソッドに設定します (2) の属性の一覧を次の表に示します 属性名 機能 value 対応する create<method>() 名を設定します 各属性の詳細を次に示します (a) value 属性型 String 説明対応する create<method>() 名を設定します デフォルト値 "" 49

66 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (1) 説明 Enterprise Bean のローカルビジネスインタフェースを設定します アノテーションをインタフェースに設定した場合, そのインタフェースがローカルビジネスインタフェースとなります Bean クラスに設定した場合,value 属性にローカルビジネスインタフェースを設定する必要があります (2) の属性の一覧を次の表に示します 属性名 機能 value アノテーションを Bean クラスに設定した場合, ローカルビジネスインタフェースのク ラスを設定します 各属性の詳細を次に示します (a) value 属性型 Class[] 説明アノテーションを Bean クラスに設定した場合, ローカルビジネスインタフェースのクラスを設定します デフォルト値 {} (1) 説明 Session Bean を No-Interface view として指定する場合に設定します Session Bean のクラスにだけ設定します (2) の属性はありません (1) 説明ローカルホームインタフェース, およびローカルコンポーネントインタフェースを使用した呼び出しをサポートする Enterprise Bean のクラスに設定します (2) の属性の一覧を次の表に示します 50

67 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection 属性名 機能 value ローカルホームインタフェースを設定します 各属性の詳細を次に示します (a) value 属性型 Class 説明ローカルホームインタフェースを設定します デフォルト値なし (1) 説明 Container Managed Concurrency が設定された Singleton Session Bean の, ビジネスメソッドへのアクセス時の排他制御の方法を設定します (2) の属性の一覧を次の表に示します 属性名 機能 value ビジネスメソッドへのアクセス時に, 同時アクセスを許可する (READ) か, 許可しな い (WRITE) かを設定します 各属性の詳細を次に示します (a) value 属性型 LockType 説明ビジネスメソッドへのアクセス時に, 同時アクセスを許可する (READ) か, 許可しない (WRITE) かを設定します デフォルト値 WRITE (1) 説明 Stateful Session Bean が活性化された直後にコールバックするメソッドに設定します アノテーションを設定できますが, 活性化, 非活性化の状態変化をサポートしないため, 動作しません 51

68 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (2) の属性はありません (1) 説明 Stateful Session Bean が非活性化される直前にコールバックするメソッドに設定します アノテーションを設定できますが, 活性化, 非活性化の状態変化をサポートしないため, 動作しません (2) の属性はありません (1) 説明 Enterprise Bean のリモートビジネスインタフェースを設定します アノテーションをインタフェースに設定した場合, そのインタフェースがリモートビジネスインタフェースとなります Bean クラスに設定した場合,value 属性にリモートビジネスインタフェースを設定する必要があります (2) の属性の一覧を次の表に示します 属性名 機能 value アノテーションを Bean クラスに設定した場合, リモートビジネスインタフェースのク ラスを設定します 各属性の詳細を次に示します (a) value 属性型 Class[] 説明アノテーションを Bean クラスに設定した場合, リモートビジネスインタフェースのクラスを設定します デフォルト値 {} (1) 説明リモートホームインタフェース, およびリモートコンポーネントインタフェースを使用した呼び出しをサポートする Enterprise Bean のクラスに設定します 52

69 2 アプリケーションサーバが対応しているアノテーションおよび Dependency Injection (2) の属性の一覧を次の表に示します 属性名 機能 value リモートホームインタフェースを設定します 各属性の詳細を次に示します (a) value 属性型 Class 説明リモートホームインタフェースを設定します デフォルト値なし (1) 説明 Stateful Session Bean を削除する働きを持つビジネスメソッドに設定します (2) の属性の一覧を次の表に示します 属性名 retainifexception 機能 メソッドがアプリケーション例外で異常終了した場合に削除するかどうかを設定しま す 各属性の詳細を次に示します (a) retainifexception 属性型 boolean 説明メソッドがアプリケーション例外で異常終了した場合に削除するかどうかを設定します デフォルト値 false (1) 説明 EJB タイマーサービスの, カレンダーベースの自動生成タイマーがコールバックされるタイムアウトメソッドに設定します 53