12.2 Homeインタフェースの作成

Homeインタフェースは、RMIインタフェースの形で記述します。

Homeインタフェースには、クライアントより EJB objectを createするためのメソッドを定義します。ビジネスメソッドで利用する固有の型も定義できます。

また、EJB2.0規約以降に準拠したEJBアプリケーションでは、STATEFUL Session Beanだけcreateで始まる任意の名前を記述できます。
これにより、createメソッド名に意味のある名前を記述できるため、EJBアプリケーションをわかりやすく作成できます。

Interstage Studioを使用して開発を行った場合、Homeインタフェースのひな形が自動生成されます。

以下に、Homeインタフェースの記述形式を示します。

記述形式

    public interface  Homeインタフェース名  extends  javax.ejb.EJBHome 
    {
        public  Remoteインタフェースタイプ  create(任意の引数<STATEFULのみ>) 
            throws javax.ejb.CreateException, 
            java.rmi.RemoteException; 
    }

規約

Homeインタフェースは以下の規約を満たしていなければなりません。

Homeインタフェースは、1つ以上の createメソッドを定義します。
各 createメソッドは createで始まる任意の名前でなければなりません。
また、Enterprise Beanクラスに定義されたejbCreateメソッドの1つに一致しなくてはなりません。
一致するejbCreateメソッドは引数の数と型が同じでなければなりません(返却値は違っていてもかまいません)。
createメソッドの返却値のタイプは、Enterprise BeanのRemoteインタフェースタイプでなければなりません(Enterprise BeanクラスのejbCreateメソッドの返却値はvoid固定です)。
createメソッドは、引数のタイプと数が、Enterprise Beanクラスに定義されたejbCreateメソッドの1つに一致しなくてはなりません(返却値のタイプは違っていてもかまいません)。
STATELESSの場合、createメソッドに引数は指定できません。
Homeインタフェースは javax.ejb.EJBHomeインタフェースを継承しなければなりません。
Homeインタフェースで定義されたメソッドは、RMI over IIOPの規約に従わなくてはなりません。
引数と戻り値がRMI/IIOPの有効な型であり、throws節がjava.rmi.RemoteExceptionを含まなければなりません。
Enterprise BeanクラスのejbCreateメソッドに定義されたすべての例外は、一致する createメソッドのthrows句に定義されなければなりません。
また、throws句には、javax.ejb.CreateExceptionを含まなければなりません。
throws句には、javax.ejb.CreateExceptionを含まなければなりません。
throws句には、java.rmi.RemoteExceptionを含まなければなりません。
Homeインタフェースは、スーパーインタフェースをもつことができます。
インタフェース継承の仕様は、RMI over IIOP上の規約におけるRemoteインタフェースの定義に従わなくてはなりません。

注意

Homeインタフェースの作成における注意事項

throws句に宣言する例外の数は、5以下にしてください。多数宣言されている場合、配備時間に影響します。