ejb-jar.xmlリファレンス

作成　2002/11/9
更新　2002/11/24

作成中

ejb-jar_2_0.dtd に基づくリファレンスです。

要素ツリー(概要)

要素ツリー(詳細)

1. <ejb-jar>
   1. <description>?
   2. <display-name>?
   3. <small-icon>?
   4. <large-icon>?
   5. <enterprise-beans>
      +
      • <session>
        1. <description>?
        2. <display-name>?
        3. <small-icon>?
        4. <large-icon>?
        5. <ejb-name>
        6. <home>?
        7. <remote>?
        8. <local-home>?
        9. <local>?
        10. <ejb-class>
        11. <session-type> Stateless | Stateful
        12. <transaction-type> Bean | Container
        13. <env-entry>*
            1. <description>?
            2. <env-entry-name>
            3. <env-entry-type>
            4. <env-entry-value>?
        14. <ejb-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <home>
            5. <remote>
            6. <ejb-link>?
        15. <ejb-local-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <local-home>
            5. <local>
            6. <ejb-link>?
        16. <security-role-ref>*
            1. <description>?
            2. <role-name>
            3. <role-link>?
        17. <security-identity>?
            1. <description>?
            2. +
               • <use-caller-identity>
               • <run-as>
                 1. <description>?
                 2. <role-name>
        18. <resource-ref>*
            1. <description>?
            2. <res-ref-name>
            3. <res-type>
            4. <res-auth> Application | Container
            5. <res-sharing-scope>? Shareable | Unshareable
        19. <resource-env-ref>*
      • <entity>
        1. <description>?
        2. <display-name>?
        3. <small-icon>?
        4. <large-icon>?
        5. <ejb-name>
        6. <home>?
        7. <remote>?
        8. <local-home>?
        9. <local>?
        10. <ejb-class>
        11. <persistence-type> Bean | Container
        12. <prim-key-class>
        13. <reentrant> True | False
        14. <cmp-version>? 1.x | 2.x
        15. <abstract-schema-name>?
        16. <cmp-field>*
            1. <description>?
            2. <field-name>
        17. <primkey-field>?
        18. <env-entry>*
            1. <description>?
            2. <env-entry-name>
            3. <env-entry-type>
            4. <env-entry-value>?
        19. <ejb-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <home>
            5. <remote>
            6. <ejb-link>?
        20. <ejb-local-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <local-home>
            5. <local>
            6. <ejb-link>?
        21. <security-role-ref>*
            1. <description>?
            2. <role-name>
            3. <role-link>?
        22. <security-identity>?
            1. <description>?
            2. +
               • <use-caller-identity>
               • <run-as>;
                 1. <description>?
                 2. <role-name>
        23. <resource-ref>*
            1. <description>?
            2. <res-ref-name>
            3. <res-type>
            4. <res-auth> Application | Container
            5. <res-sharing-scope>? Shareable | Unshareable
        24. <resource-env-ref>*
        25. <query>*
            1. <description>?
            2. <query-method>
               1. <method-name>
               2. <method-params>?
                  1. <method-param>*
            3. <result-type-mapping>? Local | Remote
            4. <ejb-ql>
      • <message-driven>
        1. <description>?
        2. <display-name>?
        3. <small-icon>?
        4. <large-icon>?
        5. <ejb-class>
        6. <transaction-type>
        7. <message-selector>?
        8. <acknowledge-mode>? Auto-acknowlege | Dups-ok-Acknowkege
        9. <message-driven-destination>?
           1. <destination-type> javax.jms.Queue | javax.jms.Topic
           2. <subscription-durability>? Durable | NonDurable
        10. <env-entry>*
            1. <description>?
            2. <env-entry-name>
            3. <env-entry-type>
            4. <env-entry-value>?
        11. <ejb-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <home>
            5. <remote>
            6. <ejb-link>?
        12. <ejb-local-ref>*
            1. <description>?
            2. <ejb-ref-name>
            3. <ejb-ref-type>
            4. <local-home>
            5. <local>
            6. <ejb-link>?
        13. <security-role-ref>*
            1. <description>?
            2. <role-name>
            3. <role-link>?
        14. <security-identity>?
            1. <description>?
            2. +
               • <use-caller-identity>
               • <run-as>;
                 1. <description>?
                 2. <role-name>
        15. <resource-ref>*
            1. <description>?
            2. <res-ref-name>
            3. <res-type>
            4. <res-auth> Application | Container
            5. <res-sharing-scope>? Shareable | Unshareable
        16. <resource-env-ref>*
   6. <relationships>?
      1. <description>?
      2. <ejb-relation>+
         1. <description>?
         2. <ejb-relation-name>?
         3. <ejb-relationship-role>
            1. <description>?
            2. <ejb-relationship-role-name>?
            3. <multiplicity> One | Many
            4. <cascade-delete>?
            5. <relationship-role-source>
               1. <description>?
               2. <ejb-name>
            6. <cmr-field>?
               1. <description>?
               2. <cmr-field-name>
               3. <cmr-field-type>? java.util.Collection | java.util.Set
         4. <ejb-relationship-role>
   7. <assembly-descriptor>?
      1. <security-role>*
         1. <description>?
         2. <role-name>
      2. <method-permission>
         1. <description>?
         2. +
            • <role-name>+
            • <unchecked>
         3. <method>+
      3. <container-transaction>*
         1. <description>?
         2. <method>+
            1. <description>?
            2. <ejb-name>
            3. <method-intf>? Home | Remote | LocalHome | Local
            4. <method-name>
            5. <method-params>?
               1. <method-param>*
         3. <trans-attribute> NotSupported | Supports | Required | RequiresNew | Mandatory | Never
      4. <exclude-list>?
         1. <description>?
         2. <method>+
            1. <description>?
            2. <ejb-name>
            3. <method-intf>? Home | Remote | LocalHome | Local
            4. <method-name>
            5. <method-params>?
               1. <method-param>*
   8. <ejb-client-jar>?

表示、説明要素

DTDの説明を記述したり、ツール上で表示される名前やアイコンを指定します。
必須要素はありませんが、説明などはなるべく入れておいた方がよいでしょう。

<description>

説明を記述

<display-name>

表示名

<small-icon>

アイコン(小)

<large-icon>

アイコン(大)

主要素

ルート要素

<enterprise-beans>

EJB要素。
子要素に1つ以上のセッションBean、エンティティーBean、メッセージドリブンBeanを指定します。

<assembly-descriptor>

トランザクションとセキュリティー指定の要素

セッションbean

セッションBeanの要素

<ejb-name>

EJBの名前
単なる表示名と異なり、 他のEJB参照、リソース参照、トランザクション、セキュリティーメソッド指定などで、 この名前が使われます。

<home>

ホームインターフェイスの完全指定クラス名

<remote>

リモートコンポーネントインターフェイスの完全指定クラス名。

<local-home>

ローカルホームインターフェイスの完全指定クラス名

<local>

ローカルコンポーネントインターフェイスの完全指定クラス名。

<ejb-class>

EJBビーンクラスの完全指定クラス名。

<sesion-type>

セッションBeanのタイプ
ステートレスの場合はStateless、 ステートフルの場合はStateful を指定します。

<transaction-type>

トランザクションのタイプ。
BMTの場合はBean、CMTの場合はContainerを指定します。

例、ステートレスとステートフルのセッションBean

<?xml version="1.0" encoding="Shift_JIS"?>

<!DOCTYPE ejb-jar PUBLIC '-//Sun Microsystems, Inc.//DTD Enterprise JavaBeans 2.0//EN' 'http://java.sun.com/dtd/ejb-jar_2_0.dtd'>

<ejb-jar>

  <enterprise-beans>
    <session>
      <ejb-name>HelloEJB</ejb-name>
      <home>hello.HelloHome</home>
      <remote>hello.Hello</remote>
      <ejb-class>hello.HelloBean</ejb-class>
      <session-type>Stateless</session-type>
      <transaction-type>Container</transaction-type>
     </session>

    <session>
      <ejb-name>CounterEJB</ejb-name>
      <home>counter.CounterHome</home>
      <remote>counter.Counter</remote>
      <ejb-class>counter.CounterBean</ejb-class>
      <session-type>Stateful</session-type>
      <transaction-type>Container</transaction-type>
    </session>

  </enterprise-beans>

</ejb-jar>

エンティティーbean

エンティティBeanの要素

<persistence-type>

永続化のタイプ
BMPはBean、 CMPContainer を指定。

<prim-key-class>

プライマリキークラスの完全指定クラス名

<reentrant>

再入可能性
Trueにすると再入可能。 再入可能にした場合に問題におこる場合があるので、必要なければFalseにするべき。

<cmp-version>

CMPのバージョン

<abstract-schema-name>

SQL QLで使われる名前

<cmp-field>

CMPフィールド要素

<field-name>

フィールド名

<primkey-field>

プライマリキーのフィールド名

<query>

EJBクエリ言語の要素

<query-method>

メッセージドリブンbean

メッセージドリブンBeanの要素

<message-selector>

確認応答の方法を指定。
指定できる値は以下
Auto-acknowlege
Dups-ok-Acknowkege

<message-driven-destination>

Beanがキューとトピックのどちら向けの設計かを指定

<destination-type>

Beanがサブスクライブするキューのタイプ
指定できる値は以下
javax.jms.Queue
javax.jms.Topic

<subscription-durability>

トピックのサブスクライブの種類を指定
指定できる値は以下
Durable
NonDurable

CMPの関連

CMP間の関連を指定します。

リソース参照

環境エントリ要素

<env-entry-name>

環境エントリ名

<env-entry-type>

環境エントリのクラス名

<env-entry-value>

環境エントリの値

<ejb-ref>

EJB参照の要素

<ejb-local-ref>

ローカルEJB参照の要素

<ejb-ref-name>

EJB参照名

<ejb-ref-type>

参照するEJBのクラス名

<ejb-link>

EJBリンク

<security-role-ref>

セキュリティーロール参照

<role-name>

リソース参照

<res-ref-name>

リソース参照の名前

<res-type>

リソース参照の型

<res-auth>

認証方法

<res-sharing-scope>

共有スコープ

<resource-env-ref>

リソース環境参照

トランザクション

コンテナトランザクションの要素

<ejb-name>

指定するEJB名を記述。

<method>

メソッドを指定

<method-intf>

ejb-nameの補足要素。 同じメソッドがHomeインターフェイスとRemoteインターフェイス にある場合にインターフェイスを特定するために指定。

<method-name>

指定するメソッド名を記述。ワイルドカード(*)で全メソッド指定可

<method-params>

指定するメソッドが、複数ある場合、 メソッドの引数を子要素のmethod-paramで指定する。

<method-param>

メソッドの引数を指定。配列は[]

<trans-attribute>

トランザクション属性を記述

<exclude-list>

除外リストを指定
Beanに実装されているが、呼び出されたくないメソッドのリストを 指定します。既存のBeanを使う場合に必要外のメソッドを指定したり、 デバッグ用のメソッドを運用時に指定したりします(たぶん)。

<>