WebLogic エンタープライズ JavaBeans (EJB) プログラマーズ ガイド
EJBGen リファレンス
weblogic.jar に含まれません。その代わりに、独立したアーカイブとして提供されます (WebLogic Server 配布キットの WL_HOME/server/lib の ejbgen.jar)。EJBGen を使用するには、CLASSPATH で ejbgen.jar を指定してください。
WL_HOME\samples\server\examples\src\examples\ejb20\relationships を参照してください。
javadoc -docletpath ejbgen.jar -doclet weblogic.tools.ejbgen.EJBGen (YourBean).java
ejbgen.jar がない場合は、次のように weblogic.jar にパスを追加します。
javadoc -docletpath <path_to_ejbgen.jar> ejbgen.jar -doclet weblogic.tools.ejbgen.EJBGen (YourBean).java
javadoc -docletpath ejbgen.jar -doclet weblogic.tools.ejbgen.EJBGen (YourBean).java (RelatedBean).java
|
|
|
|
|
-checkTags
|
|
|
|
-classpath
|
|
|
|
-d [directory]
|
|
|
|
-descriptorDir [directory]
|
|
|
|
-docTag tagName
|
|
.java クラスを指定しなくてはならない。これをしないと、このフラグを認識したにもかかわらず、Javadoc はエラーメッセージを返す。
|
|
-docTags
|
|
.java クラスを指定しなくてはならない。これをしないと、このフラグを認識したにもかかわらず、Javadoc はエラーメッセージを返す。
|
|
-docTagsHtml
|
|
-docTags と同じであるが、HTML 文書を生成する。
|
|
-ejbPrefix [string]
|
|
|
|
-ejbSuffix [string]
|
|
|
|
-ejbgenQuiet [boolean]
|
|
|
|
-ejbgenVerbose [boolean]
|
|
|
|
errorFile
|
|
|
|
exitOnError [boolean]
|
|
|
|
-homeBaseClass [string (className)]
|
|
|
|
-experimental [boolean]
|
|
|
|
-extractTemplates [directory]
|
|
|
|
-forceGeneration [boolean]
|
|
|
|
-homeBaseClass [string (className)]
|
|
|
|
-ignorePackage
|
|
|
|
-jndiPrefix [string]
|
|
|
|
-jndiSuffix [string]
|
|
|
|
-localBaseClass [string (className)]
|
|
|
|
localHomeBaseClass [className]
|
|
|
|
-localHomePrefix [string]
|
|
|
|
-localHomeSuffix [string]
|
|
|
|
-localPrefix [string]
|
|
|
|
-localSuffix [string] (
|
|
|
|
-noImports [boolean]
|
|
|
|
-noLocalInterfaces
|
|
|
|
-noRedirection noRedirection ejbgen.noRedirection [boolean]
|
|
|
|
-noRemoteInterfaces [boolean]
|
|
|
|
-noticeFile [file]
|
|
|
|
-noValueClasses [boolean]
|
|
|
|
-pfd1
|
|
|
|
-pfd2
|
|
|
|
-primaryKeyBaseClass [string (class name)]
|
|
|
|
-printDiagnostic [boolean]
|
|
|
|
-printTags [boolean]
|
|
|
|
-propertyFile [fileName]
|
|
|
|
-remoteBaseClass [string (className)]
|
|
|
|
-remoteHomePrefix [string]
|
|
|
|
-remoteHomeSuffix [string]
|
|
|
|
-remotePrefix [string]
|
|
|
|
-remoteSuffix [string]
|
|
|
|
source [version number]
|
|
|
|
-sourcepath [directory]
|
|
|
|
-templateDir [directory]
|
|
|
|
-toStringForPrimitivesOnly
|
|
toString() メソッドはプリミティブであるコンテナ管理による永続性フィールドのみを表示する。このフラグは、値オブジェクト間での循環的な参照の問題 (AValue.toString() が BValue.toString() を呼び出し、それがさらに AValue.toString() を呼び出すなど) を解消する。
|
|
-valueBaseClass [string (class name)]
|
|
|
|
-valueObjectPrefix [string]
|
|
|
|
-valueObjectSuffix [string]
|
|
|
|
-valuePackage [string (package name)]
|
|
|
|
verbose [boolean]
|
|
|
|
-wls6 [boolean]
|
|
|
|
-wls7 [boolean]
|
|
|
|
-wls71 [boolean]
|
|
|
|
-wls81 [boolean]
|
|
|
|
-wls9 [boolean]
|
|
|
|
-workshopDocTags [boolean]
|
|
|
|
-xmlEncoding [string]
|
|
|
javac コンパイル エラーのようなものを出力します。
C:\toddk\dev\issues\cr100528\src\test\po\PurchaseOrderBean.java:29: cannot resolve symbol [javadoc] symbol : class PurchaseOrder [javadoc] location: class test.po.PurchaseOrderBean [javadoc] public boolean submitPO(PurchaseOrder po) throws SubmitException {
[javadoc] C:\toddk\dev\issues\cr100528\src\test\po\PurchaseOrderBean.java:29: cannot resolve symbol [javadoc] symbol : class SubmitException [javadoc] location: class test.po.PurchaseOrderBean [javadoc] public boolean submitPO(PurchaseOrder po) throws SubmitException {
@ejbgen:file-generation を使用して選択的に無効化できます。これは、Bean ごとに実行できます。次のコード サンプルでは、値クラスが生成されないようにしています。
/**
* @ejbgen:file-generation
* value-class = False
*/
-noValueClasses、-noRemoteInterfaces、または -noLocalInterfaces は、Bean で見つかったすべてのタグをオーバーライドします。
EJBGen にプロパティ ファイルの解析を指示するには、-propertyFile オプションを使用します。コード リスト 8-7 は、サンプルのプロパティ ファイルを示しています。
#
remote-jndi-name = Account
-propertyFile オプションを指定して EJBGen を呼び出すには、次の構文を使用します。
remote = ${remote-jndi-name}
#
# property-file
jndi-name-tag = remote = RemoteAccount local = LocalAccount
remote.baseClass
home.baseClass
これを指定すると、この変数の値は生成されたすべてのリモート ホーム クラスの基本クラスとして使用されます。 local.baseClass
localHome.baseClass
value.baseClass
value.package
value.interfaces
EJBName をプレフィックスとすることでより特定的にできます。たとえば、次のようなプロパティ ファイルの場合を考えます。
# property-file
#
Account.home.baseClass = BaseAccountHome
home.baseClass = BaseHome
value.package = value
containerManaged.value.package=valuePackageForContainerManaged
BaseHome を拡張します。ただし、EJB「Account」のホームは例外で、BaseAccountHome を拡張します。
EJBGen のアノテーションは、Java での場合と同じようにして継承されます。たとえば、コード リスト 8-10 に示すように基本クラス BaseAccount の AccountEJB という名前が付けられた EJB があるとします。
* @ejbgen:jndi-name
* remote="BaseRemote"
*/
// ...
}
* @ejbgen:entity
* ejb-name = containerManaged
* table-name = ejbAccounts
* data-source-name = examples-dataSource-demoPool
*
* BaseAccount で定義される JNDI 名を継承
*/
// ...
max-beans-in-cache のようなすべての EJB に共通の設定を定義することもできます。
* @ejbgen:entity
* max-beans-in-cache = 300
*/
public class BaseAccount implements EntityBean {
// ...
}
* @ejbgen:entity
* ejb-name = containerManaged
* table-name = ejbAccounts
* data-source-name = examples-dataSource-demoPool
*
* // 属性 max-beans-in-cache = 300 を自動的に継承
*/
// ...
max-beans-in-cache のデフォルト値を 300 から 400 に変更できます。
* @ejbgen:entity
* ejb-name = containerManaged
* table-name = ejbAccounts
* data-source-name = examples-dataSource-demoPool
* max-beans-in-cache = 400
*
* // 上の設定で基本クラスの定義内容がオーバーライドされる
*/
// ...
AccountBean.java がメインの Bean クラスです。
* @ejbgen:entity
* ejb-name = AccountEJB-OneToMany
* data-source-name = examples-dataSource-demoPool
* table-name = Accounts
* prim-key-class = java.lang.String
*
* local = one2many.AccountHome
*
* signature = "Account findAccount(double balanceEqual)"
* ejb-ql = "WHERE balance = ?1"
*
* signature = "Collection findBigAccounts(double balanceGreaterThan)"
* ejb-ql = "WHERE balance > ?1"
*
* name = Customer-Account
* target-ejb = CustomerEJB-OneToMany
* multiplicity = many
* cmr-field = customer
*
*/
/**
* @ejbgen:cmp-field column = acct_id
* @ejbgen:primkey-field
* @ejbgen:remote-method transaction-attribute = Required
*/
abstract public void setAccountId(String val);
// ....
}
Account.java AccountHome.java ejb-jar.xml weblogic-ejb-jar.xml weblogic-cmp-jar.xml
@ejbgen:entity に属性 table-name を指定して 1 つのテーブルにマップされます。エンティティ Bean を複数のテーブルにマップする場合には、個々の @ejbgen:cmp-fields で table-name 属性を使用できます。table-name 属性のないコンテナ管理による永続性フィールドはすべて、@ejbgen:entity で指定したテーブルを使用します (したがって、これを「デフォルト」テーブルと考えることができます)。
table-name 属性において (およびカラム上で) カンマ区切りのテーブル リストを指定する必要があります。次に例を示します。
@ejbgen:relationship-caching タグを使用して、リレーションシップ キャッシング要素を指定できます。この XML 要素は、ネストできます (再帰的)。つまり、キャッシュしたいリレーションシップ要素をすべて表す、ツリーを指定できます。
@ejbgen:relationship-caching には id および parent-id という 2 つの属性があります。これらの属性はどの XML にも対応しません。単に、これらを使うとツリー構造が指定できるというだけです。
id (たとえば「root0」) と、その名前に等しい B および C の parent-id を指定するだけですみます。
* @ejbgen:relationship-caching-element
* caching-name = cacheMoreBeans
* cmr-field = employee
* group-name = emp-group
* id = A
*
* @ejbgen:relationship-caching-element
* caching-name = cacheMoreBeans
* cmr-field = employee_ssn
* group-name = emp-group
* parent-id = A
*
* @ejbgen:relationship-caching-element
* caching-name = cacheMoreBeans
* cmr-field = employee_zip
* group-name = emp-group
* * parent-id = A
@ejbgen:jndi-name
remote = AccountHome
local = AccountLocalHome
@ejbgen:local-method タグを追加します。1 つのメソッドが @ejbgen:local-method と @ejbgen:remote-method の両方を持つことが可能です。
**
* @ejbgen:cmr-field
*
* @ejbgen:remote-method
* @ejbgen:local-method
*/
abstract public LocalCustomer getCustomer();
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(OracleClob | OracleBlob) このカラムのタイプ。
|
|
|
|
(True | False) True であれば、このフィールドは値オブジェクトにおいて生成されない。
|
|
|
|
|
|
|
|
|
|
|
|
(True | False) このフィールドが複合主キーの一部であるかどうか。
|
|
|
|
(True | False) True であれば、値オブジェクトのこのフィールドでゲッターしか生成されない。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(True | False) True であれば、値オブジェクトのこのフィールドでゲッターしか生成されない。
|
|
|
|
|
|
|
|
(True|False) OracleBlob にマップされた byte[] 型の cmp-field がシリアライズされるべきかどうか。
|
|
|
|
|
|
|
|
CreateOnly | Disabled | DropAndCreate | DropAndCreateAlways | AlterOrCreate)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(javax.ejb.MessageDrivenBean|javax.ejb.EntityBean|javax.ejb.SessionBean) この EJB のタイプを指定する。このタグは通常は使用しない。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Entity | Session)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ejb-name の値が使用される。
|
|
|
|
True | False) エンティティ Bean の永続データをトランザクション間でキャッシュするかどうか。
|
|
|
|
True | False) コンテナが各メソッド呼び出しについて Bean の有無をチェックするかどうか。
|
|
|
|
Optimistic|ReadOnly | Exclusive | Database) この Bean の同時方式を定義する。
|
|
|
|
config.xml ファイルで宣言したのと同じ)。
|
|
|
|
|
|
|
|
True | False)
|
|
|
|
|
|
|
|
|
|
|
|
ejbCreate | ejbPostCreate)
|
|
|
|
(True|False) トランザクション コミット後に更新が送信されるかどうかを指定する。
|
|
|
|
|
|
|
|
(True|False) バッチ処理を実行するかどうかを指定する。
|
|
|
|
True | False) コンテナがこの EJB を参照で呼び出すかどうか。
|
|
|
|
True | False) 動的クエリが有効化されているかどうか。
|
|
|
|
True | False) これを True に設定した場合、Bean はファインダによってすぐにキャッシュにロードされる。
|
|
|
|
|
|
|
|
True | False) この Bean をクラスタ内の複数のサーバにデプロイできるかどうか。
|
|
|
|
RoundRobin | Random | WeightBased) このホームのレプリカ間でロード バランシングを行うためのアルゴリズム。
|
|
|
|
|
|
|
|
|
|
|
|
(AccessOrder|ValueOrder) このエンティティ Bean のロック順序。
|
|
|
|
ejb-name。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CMP | BMP) この Bean の永続性がコンテナ管理によるものであるか Bean 管理によるものであるか。
|
|
|
|
True | False)。このキーワードを指定した場合、EJBGen は (各自が提供するものと仮定して) 主キー クラスを生成しなくなる。
|
|
|
|
ejbLoad() を呼び出す間隔の秒数。
|
|
|
|
True | False)
|
|
|
|
role-name を指定する。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この EJB が呼び出し側の ID を使用するかどうか。
|
|
|
|
True | False) データベースから Bean がロードされるときに SELECT ... FOR UPDATE 句が使用される。
|
|
|
|
MetaData | TableQuery) EJB コンテナによって作成されるテーブルの検証に使用されるメソッド。
|
|
|
|
Read|Modified | Version | Timestamp) オプティミスティックな同時実行性が、トランザクション中に修正対象となるカラムが修正されていないことを確認する方法。
|
|
|
|
Read|Modified) オプティミスティックな同時実行性が、トランザクション中に修正対象となる行が修正されていないことを確認する方法。
|
|
|
|
|
|
|
|
True | False) エンティティ Bean の永続データをトランザクション間でキャッシュするかどうか。
|
|
|
|
Optimistic|ReadOnly | Exclusive | Database) この Bean の同時方式を定義する。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
java.lang であっても完全修飾しなければならない)。
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この EJB のローカル インタフェースを生成するかどうか。
|
|
|
|
|
|
|
|
True | False) この EJB のローカル ホーム インタフェースを生成するかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この EJB の主キー クラスを生成するかどうか。
|
|
|
|
True | False) この EJB のリモート インタフェースを生成するかどうか。
|
|
|
|
|
|
|
|
True | False) この EJB のリモート ホーム インタフェースを生成するかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この EJB の値クラスを生成するかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Local | Remote) このファインダの生成場所となるホーム。指定がなければ両方。
|
|
|
|
|
|
|
|
True | False) 現在のトランザクション中の更新を必ずクエリの結果に反映するかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
java.lang であっても完全修飾したタイプを必ず指定する。
|
|
|
|
True | False) 生成された SQL 'SELECT' に 'DISTINCT' 修飾子が含まれるかどうか。
|
|
|
|
NotSupported | Supports | Required | RequiresNew | Mandatory | Never) このローカル メソッドのトランザクション属性。指定されない場合、デフォルトのトランザクション属性が使用される。このタグを付けたメソッドが、ローカル クラス上に生成される。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ejbc の実行時に無効化する警告のカンマ区切りのリスト。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(True|False) このメソッドが多重呼び出し不変かどうかを指定する。
|
|
|
|
(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) このメソッドのトランザクション アイソレーションのタイプを指定する。
|
|
|
|
(0..n) このメソッドが生成されたクラス内に置かれるべき順番を指定する。省略可能
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False) このメソッドが多重呼び出し不変かどうか。
|
|
|
|
|
|
|
|
0..n) このメソッドが生成されたクラス内に置かれるべき順番。
|
|
|
|
|
|
|
|
NotSupported | Supports | Required | RequiresNew | Mandatory | Never) このローカル メソッドのトランザクション属性。 指定されない場合、デフォルトのトランザクション属性が使用される。 このタグを付けたメソッドが、ローカル クラス上に生成される。
|
|
|
|
|
|
|
|
auto-acknowledge | dups-ok-acknowledge) 確認応答モード。
|
|
|
|
(True|False) クライアントが同じサーバ上の EJB と連結されるかどうかを指定する。
|
|
|
|
ejbCreate が匿名プリンシパルで実行される場合に使用するプリンシパルの名前。
|
|
|
|
|
|
|
|
|
|
|
|
javax.jms.Queue | javax.jms.Topic) JMS 送り先タイプ。
|
|
|
|
|
|
|
|
True | False) destination-type が Topic の場合、この属性を True に設定するとサブスクリプションが恒久になる。
|
|
|
|
|
|
|
|
True | False) コンテナがこの EJB を参照で呼び出すかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ejbPassivate が匿名プリンシパルで実行される場合に使用するプリンシパルの名前。
|
|
|
|
ejbRemove が匿名プリンシパルで実行される場合に使用するプリンシパルの名前。
|
|
|
|
|
|
|
|
|
|
|
|
(Bean|Container) この EJB のトランザクションがどこで管理されるのかを指定する。
|
|
|
|
|
|
|
|
True | False) この EJB が呼び出し側の ID を使用するかどうか。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Home | Remote | LocalHome | Local) このパーミッション パターンが適用されるインタフェース。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False)
|
|
|
|
fk-column 属性も合わせて指定する。
|
|
|
|
True | False) カスケード削除で、基盤の DBMS に組み込みのカスケード削除機能を使用するかどうか。
|
|
|
|
|
|
|
|
foreign-key を含む DBMS テーブルの名前。
|
|
|
|
|
|
|
|
One | Many)
|
|
|
|
|
|
|
|
primary-key を含む DBMS テーブルの名前。
|
|
|
|
ParentHasChildren)。指定されない場合、EJBGen が代わりにこれを生成する。関係を継続的に使用しようとする場合には、role-name を指定する必要がある。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(True|False) このメソッドが多重呼び出し不変かどうかを指定する。省略可能
|
|
|
|
(TransactionSerializable|TransactionReadCommitted|TransactionReadUncommitted|TransactionRepeatableRead) このメソッドのトランザクション アイソレーションのタイプを指定する。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(Application | Container)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
(True | False) このロールが外部で定義される場合は True。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
ejbSelect から始めること。
|
|
|
|
|
|
|
|
True | False) 現在のトランザクション中の更新を必ずクエリの結果に反映するかどうか。
|
|
|
|
|
|
|
|
0..n) このメソッドが生成されたクラス内に置かれるべき順番。
|
|
|
|
Remote | Local) 返されたオブジェクトを EJBLocalObject または EJBObject にマップするかどうか。
|
|
|
|
True|False) 生成された SQL SELECT に DISTINCT 修飾子が含まれるかどうかを指定する。
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この EJB に対し同時呼び出しを許可するかどうか。
|
|
|
|
(True|False) トランザクションの過程で remove() を呼び出せるかどうかを指定する。
|
|
|
|
|
|
|
|
(NRU|LRU) このステートフル セッション Bean のキャッシュのタイプを指定する。
|
|
|
|
|
|
|
|
(True|False) クライアントが同じサーバ上の EJB と連結されるかどうかを指定する。
|
|
|
|
ejbCreate が匿名プリンシパルで実行される場合に使用するプリンシパルの名前。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True | False) コンテナがこの EJB を参照で呼び出すかどうか。
|
|
|
|
|
|
|
|
True | False) この Bean をクラスタ内の複数のサーバにデプロイできるかどうか。
|
|
|
|
RoundRobin | Random | WeightBased) このホームのレプリカ間でロード バランシングを行うためのアルゴリズム。
|
|
|
|
|
|
|
|
|
|
|
|
True | False) この Bean がクラスタ対応かどうか。
|
|
|
|
RoundRobin|Random | WeightBased) このホームのレプリカ間でバランシングを行うためのアルゴリズム。
|
|
|
|
|
|
|
|
|
|
|
|
True | False) このステートレス セッション Bean のメソッドが多重呼び出し不変であるかどうか。
|
|
|
|
ejbPassivate が匿名プリンシパルで実行される場合に使用するプリンシパルの名前。
|
|
|
|
|
|
|
|
|
|
|
|
InMemory | None) クラスタ内でステートフル セッション Bean をレプリケートする方法。
|
|
|
|
role-name を指定する。
|
|
|
|
|
|
|
|
Bean | Container) この EJB のトランザクションが Bean 管理であるかコンテナ管理であるか。
|
|
|
|
|
|
|
|
Stateless | Stateful) セッション Bean のタイプ。この属性が指定されない場合、EJBGen は各自のクラスの ejbCreate() メソッドを調べることによってこのタイプを正確に推測する。
|
|
|
|
True | False) この EJB が呼び出し側の ID を使用するかどうか。
|
|
|
|
|
|
|
|
Local | Value) 他の EJB のクラスにアクセスする時に、Value オブジェクト クラスがどのオブジェクトを参照すべきかを指定する。
|
|
