SeamFramework.orgCommunity Documentation
GlassFish は、Java EE 5 を完全に実装したオープンソースのアプリケーションサーバです。最新の安定リリースは v2 UR2 です。
まず最初に GlassFish 環境について述べて、どのように jee5 サンプルをデプロイするのかを詳しく説明します。次に、jpa サンプルアプリケーションをデプロイします。最後に、seam-gen により生成されたアプリケーションをどのようにして GlassFish 上で動作させるのかを示します。
この章のサンプルと情報は、すべて執筆時の GlassFish の最新バージョンに基づいています。
GlassFish をダウンロードして、インストールしてください:
$ java -Xmx256m -jar glassfish-installer-v2ur2-b04-linux.jar
インストールした後に、GlassFish をセットアップしてください:
$ cd glassfish; ant -f setup.xml
作成されたドメインの名前はdomain1 です。
次に、組み込み JavaDB サーバを起動します:
$ bin/asadmin start-database
JavaDB は、HSQLDB が JBoss AS に含まれているのと同様に、GlassFish の組み込みデータベースです。
最後に、GlassFish サーバを起動してください:
$ bin/asadmin start-domain domain1
Web 管理コンソールは、http://localhost:4848/ からアクセス可能です。Web 管理コンソールには、デフォルトユーザ名 (admin) とパスワード (adminadmin) でアクセスすることができます。 別の方法としては、EAR / WAR ファイルを glassfish/domains/domain1/autodeploy にコピーしてデプロイすることもできます。
サーバとデータベースを停止するには、以下のようにしてください:
$ bin/asadmin stop-domain domain1; bin/asadmin stop-database
jee5/booking サンプルは、(JBoss AS 上で動作する) ホテル予約サンプルに基づいています。そのままで GlassFish 上で動作するように設計されています。このサンプルは $SEAM_DIST/examples/jee5/booking にあります。
GlassFish 管理コンソールを利用して GlassFish にアプリケーションをデプロイします。
http://localhost:4848 から管理コンソールにログインします。
左側のサイドメニュー Applications (アプリケーション) の下にあるメニューオプションで Enterprise Applications (エンタープライズアプリケーション) にアクセスしてください。
Enterprise Application (エンタープライズアプリケーション) テーブルのトップで Deploy (配備) を選択してください。以下のヒントを使って、ウィザードを最後まで進めてください:
アプリケーションのインストール準備
ブラウザで examples/jee5/booking/dist/jboss-seam-jee5.ear を指定してください。
OK ボタンを選択してください。
http://localhost:8081/seam-jee5/ からアプリケーションにアクセスすることができます。
これは、Hibernate JPA と JPA トランザクションを利用して Seam POJO で実装されたホテル予約サンプルです。アプリケーションサーバで動作させるのに、EJB3 サポートを必要としません。
サンプルには、GlassFish も含めた多くのコンテナ用のコンフィグレーションとビルドスクリプトが既に用意されています。
サンプルをビルドするためには、glassfish ターゲットを使用します:
$ ant glassfish
これによりコンテナに対応した dist-glassfish ディレクトリと exploded-archives-glassfish ディレクトリが作成されます。
これは 項39.2.1. 「GlassFish へのアプリケーションのデプロイ」 の jee5 サンプルと非常に類似しています。
管理コンソールへログインしてください:
http://localhost:4848
左側のサイドメニュー Applications (アプリケーション) の下にあるメニューオプションで Web Applications (Web アプリケーション) にアクセスしてください。
アプリケーションのインストール準備
ブラウザで examples/jpa/dist-glassfish/jboss-seam-jpa.war を指定してください。
OK ボタンを選択してください。
http://localhost:8081/jboss-seam-jpa/ からアプリケーションにアクセスすることができます。
examples/jpa/resources-glassfish/WEB-INF/classes/GlassFishDerbyDialect.class は、GlassFish サーバにおける Derby のバグを避けるハックです。もし GlassFish で Derby を使用するのであれば、これを Hibernate ダイアレクトとして使用しなければなりません。 コンフィグレーションファイルの変更
META-INF/persistence.xml — 必要な主な変更点は、データソース JNDI の変更、トランザクションマネージャのルックアップクラスを GlassFish トランザクションマネージャのルックアップクラスに変更、Hibernate ダイアレクトを GlassFishDerbyDialect に変更することです。
WEB-INF/classes/GlassFishDerbyDialect.class — このクラスは、Hibernate ダイアレクトを GlassFishDerbyDialect に変更するのに必要です。
import.sql — ダイアレクトと Derby DB のいずれでも ID カラムは生成されないので、このファイルから削除します。
seam-gen は、開発者が素早くアプリケーションを準備して動作させるのにとても役に立つツールで、独自の機能を追加するための雛形を用意します。seam-gen はそのままで JBoss AS で動作するようにコンフィグレーションされたアプリケーションを生成します。以下の手順では、GlassFish 上で動作させるために必要なステップを示します。項39.2. 「jee5/booking サンプル」 で述べたように、EJB3 や Seam POJO アプリケーションを GlassFish にデプロイすることは簡単です。
第一ステップは、雛形となるプロジェクトを生成できるように seam-gen をセットアップすることです。以下に実行したように、設定すべき項目がいくつかあります。特に、データソースと Hibernate の設定値は、プロジェクトを生成する環境に合わせて設定します。
$ ./seam setup Buildfile: build.xml init: setup: [echo] Welcome to seam-gen :-) [input] Enter your Java project workspace (the directory that contains your Seam projects) [C:/Projects] [C:/Projects] /projects [input] Enter your JBoss home directory [C:/Program Files/jboss-4.2.3.GA] [C:/Program Files/jboss-4.2.3.GA] [input] Enter the project name [myproject] [myproject] seamgen_example [echo] Accepted project name as: seamgen_example [input] Do you want to use ICEfaces instead of RichFaces [n] (y, [n]) [input] skipping input as property icefaces.home.new has already been set. [input] Select a RichFaces skin [blueSky] ([blueSky], classic, ruby, wine, deepMarine, emeraldTown, japanCherry, DEFAULT) [input] Is this project deployed as an EAR (with EJB components) or a WAR (with no EJB support) [ear] ([ear], war) [input] Enter the Java package name for your session beans [com.mydomain.seamgen_example] [com.mydomain.seamgen_example] org.jboss.seam.tutorial.glassfish.action [input] Enter the Java package name for your entity beans [org.jboss.seam.tutorial.glassfish.action] [org.jboss.seam.tutorial.glassfish.action] org.jboss.seam.tutorial.glassfish.model [input] Enter the Java package name for your test cases [org.jboss.seam.tutorial.glassfish.action.test] [org.jboss.seam.tutorial.glassfish.action.test] org.jboss.seam.tutorial.glassfish.test [input] What kind of database are you using? [hsql] ([hsql], mysql, oracle, postgres, mssql, db2, sybase, enterprisedb, h2) [input] Enter the Hibernate dialect for your database [org.hibernate.dialect.HSQLDialect] [org.hibernate.dialect.HSQLDialect] [input] Enter the filesystem path to the JDBC driver jar [/tmp/seam/lib/hsqldb.jar] [/tmp/seam/lib/hsqldb.jar] [input] Enter JDBC driver class for your database [org.hsqldb.jdbcDriver] [org.hsqldb.jdbcDriver] [input] Enter the JDBC URL for your database [jdbc:hsqldb:.] [jdbc:hsqldb:.] [input] Enter database username [sa] [sa] [input] Enter database password [] [] [input] Enter the database schema name (it is OK to leave this blank) [] [] [input] Enter the database catalog name (it is OK to leave this blank) [] [] [input] Are you working with tables that already exist in the database? [n] (y, [n]) [input] Do you want to drop and recreate the database tables and data in import.sql each time you deploy? [n] (y, [n]) [propertyfile] Creating new property file: /home/mnovotny/workspaces/jboss/jboss-seam/seam-gen/build.properties [echo] Installing JDBC driver jar to JBoss server [copy] Copying 1 file to /home/mnovotny/workspaces/jboss/jboss-seam/seam-gen/C:/Program Files/jboss-4.2.3.GA/server/default/lib [echo] Type 'seam create-project' to create the new project BUILD SUCCESSFUL Total time: 4 minutes 5 seconds
プロジェクトを作成するためには、$ ./seam new-project と入力してください。そして cd /projects/seamgen_example と入力して新しく作成されたディレクトリへ移動してください。
生成されたプロジェクトに変更を行う必要があります。
resources/META-INF/persistence-dev.xml
jta-data-source を jdbc/__default に修正してください。組み込みの GlassFish Derby DB を使用します。
以下のプロパティを追加修正してください。項39.2. 「jee5/booking サンプル」 に詳細が説明されています:
<property name="hibernate.dialect" value="GlassFishDerbyDialect"/>
<property name="hibernate.hbm2ddl.auto" value="update"/>
<property name="hibernate.show_sql" value="true"/>
<property name="hibernate.format_sql" value="true"/>
<property name="hibernate.cache.provider_class"
value="org.hibernate.cache.HashtableCacheProvider"/>
<property name="hibernate.transaction.manager_lookup_class"
value="org.hibernate.transaction.SunONETransactionManagerLookup"/>
prod プロファイルを使用して GlassFish にデプロイしたければ、persistence-prod.xml も同様に修正する必要があります。
resources/GlassFishDerbyDialect.class
他のサンプルと同様に、データベースサポートのためのこのクラスを含める必要があります。jpa サンプルから seamgen_example/resources ディレクトリへコピーしてください。
$ cp \
$SEAM_DIST/examples/jpa/resources-glassfish/WEB-INF/classes/GlassFishDerbyDialect.class \
./resources
resources/META-INF/jboss-app.xml
JBoss AS にはデプロイしないのでこのファイルを削除することができます (JBoss AS では jboss-app.xml を使用して、クラスローディングの分離を有効にします)
resources/*-ds.xml
JBoss AS にはデプロイしないのでこのファイルを削除することができます (これらのファイルは、JBoss AS ではデータソースを定義していますが、GlassFish ではデフォルトのデータソースを使用しています)
resources/WEB-INF/components.xml
コンテナ管理トランザクション統合を有効にします - <transaction:ejb-transaction/> コンポーネントと、そのネームスペース宣言 xmlns:transaction="http://jboss.com/products/seam/transaction" を追記してください
jndi-pattern を java:comp/env/seamgen_example/#{ejbName}/local に修正します
resources/WEB-INF/web.xml
jee5/booking サンプルと同様に、web.xml に EJB 参照を加える必要があります。これらの EJB 参照には、GlassFish が適切なバインディングを実行するために空の local-home を設定することが必要となります。
<ejb-local-ref>
<ejb-ref-name
>seamgen_example/AuthenticatorAction</ejb-ref-name>
<ejb-ref-type
>Session</ejb-ref-type>
<local-home
></local-home>
<local
>org.jboss.seam.tutorial.glassfish.action.Authenticator</local>
</ejb-local-ref>
<ejb-local-ref>
<ejb-ref-name
>seamgen_example/EjbSynchronizations</ejb-ref-name>
<ejb-ref-type
>Session</ejb-ref-type>
<local-home
></local-home>
<local
>org.jboss.seam.transaction.LocalEjbSynchronizations</local>
</ejb-local-ref>
既存の Authenticator Seam POJO コンポーネントを利用して、EJB3 を作成します。
クラス名を AuthenticatorAction に変更します。
@Stateless アノテーションを新しい AuthenticatorAction クラスに付与します。
AuthenticatorAction が実装する Authenticator という名前のインタフェースを作成してください (EJB3 ではセッション Bean にローカルインタフェースが必要)。インタフェースに @Local アノテーションを付与し、AuthenticatorAction の authenticate と同じシグニチャのメソッドを一つ追加してください。
@Name("authenticator")
@Stateless
public class AuthenticatorAction implements Authenticator {
@Local
public interface Authenticator {
public boolean authenticate();
}
すでに web.xml ファイルには EJB 参照を追加したので、次に進めます。
このアプリケーションは、jee5/booking サンプルと同様の変更が必要となります。
デフォルトのターゲットを archive に変更します (GlassFish への自動的なデプロイを行いません)。
<project name="seamgen_example" default="archive" basedir=".">
GlassFish は、seamgen_example.jar のルートではなく war ファイルのルートで drools の /security.drl ファイルを探すので、ビルド時には正しい場所へ移動させるように build.xml に設定する必要があります。以下の変更は、<target name="war" depends="compile" description="Build the distribution .war file"
> ターゲットの先頭に追加しなければなりません。
<copy todir="${war.dir}">
<fileset dir="${basedir}/resources">
<include name="*.drl" />
</fileset>
</copy>
GlassFishDerbyDialect.class をアプリケーション jar に含める必要があります。そのためには、jar タスクを見つけ、その先頭を以下のように修正します:
<target name="jar" depends="compile,copyclasses" description="Build the distribution .jar file">
<copy todir="${jar.dir}">
<fileset dir="${basedir}/resources">
<include name="seam.properties" />
<include name="*.drl" />
<include name="GlassFishDerbyDialect.class" />
</fileset>
</copy>
...
次に、jboss-seam.jar を EAR ファイルのベースに入れる必要があります。GlassFish へのデプロイには、/lib ディレクトリとEAR のベースの両方に jar が必要になります。archive タスクに以下を追加しなければなりません:
<fileset dir="${lib.dir}">
<include name="jboss-seam.jar" >
</fileset>
以上で全体の archive タスクは以下のようになります:
<target name="archive" depends="jar,war,ear" description="Package the archives">
<jar jarfile="${dist.dir}/${project.name}.jar" basedir="${jar.dir}"/>
<jar jarfile="${dist.dir}/${project.name}.war" basedir="${war.dir}"/>
<jar jarfile="${dist.dir}/${project.name}.ear">
<fileset dir="${ear.dir}"/>
<fileset dir="${dist.dir}">
<include name="${project.name}.jar"/>
<include name="${project.name}.war"/>
</fileset>
<fileset dir="${lib.dir}">
<include name="jboss-seam.jar" />
</fileset>
</jar>
</target>
追加の jar を build.xml に入れる必要があります。以下のタスクの <fileset dir="${basedir}"
> セクションを探してください。fileset の最後に新しい include を追加してください。
<target name="ear" description="Build the EAR">
<copy todir="${ear.dir}">
<fileset dir="${basedir}/resources">
<include name="*jpdl.xml" />
<include name="*hibernate.cfg.xml" />
<include name="jbpm.cfg.xml" />
</fileset>
<fileset dir="${lib.dir}">
<include name="jboss-seam.jar" />
</fileset>
<fileset dir="${basedir}">
<include name="lib/jbpm*.jar" />
<include name="lib/jboss-el.jar" />
<include name="lib/drools-*.jar"/>
<include name="lib/core.jar"/>
<include name="lib/janino*.jar"/>
<include name="lib/antlr-*.jar"/>
<include name="lib/mvel*.jar"/>
<include name="lib/richfaces-api*.jar" />
</fileset>
</copy>
<copy todir="${ear.dir}/META-INF">
<fileset dir="${basedir}/resources/META-INF">
<include name="application.xml" />
<include name="jboss-app.xml" />
</fileset>
</copy>
</target>
Hibernate 依存関係を追加してください。
<!-- Hibernate and deps -->
<include name="lib/hibernate.jar"/>
<include name="lib/hibernate-commons-annotations.jar"/>
<include name="lib/hibernate-annotations.jar"/>
<include name="lib/hibernate-entitymanager.jar"/>
<include name="lib/hibernate-validator.jar"/>
<include name="lib/jboss-common-core.jar"/>
JSF 依存関係を追加してください。$SEAM_DIST/lib ディレクトリから el-ri.jar をコピーする必要があります。
<!-- jsf libs -->
<include name="lib/jsf-api.jar" />
<include name="lib/jsf-impl.jar" />
<include name="lib/el-api.jar" />
<include name="lib/el-ri.jar"/>
サードパーティ依存関係を追加してください。
<!-- 3rd party and supporting jars -->
<include name="lib/javassist.jar"/>
<include name="lib/dom4j.jar"/>
<include name="lib/concurrent.jar" />
<include name="lib/cglib.jar"/>
<include name="lib/asm.jar"/>
<include name="lib/antlr.jar" />
<include name="lib/commons-logging.jar" />
<include name="lib/commons-collections.jar" />
最後には以下のようになります:
<fileset dir="${basedir}">
<include name="lib/jbpm*.jar" />
<include name="lib/jboss-el.jar" />
<include name="lib/drools-*.jar"/>
<include name="lib/core.jar"/>
<include name="lib/janino*.jar"/>
<include name="lib/antlr-*.jar"/>
<include name="lib/mvel*.jar"/>
<include name="lib/richfaces-api*.jar" />
<!-- Hibernate and deps -->
<include name="lib/hibernate.jar"/>
<include name="lib/hibernate-commons-annotations.jar"/>
<include name="lib/hibernate-annotations.jar"/>
<include name="lib/hibernate-entitymanager.jar"/>
<include name="lib/hibernate-validator.jar"/>
<include name="lib/jboss-common-core.jar" />
<!-- jsf libs -->
<include name="lib/jsf-api.jar" />
<include name="lib/jsf-impl.jar" />
<include name="lib/el-api.jar" />
<include name="lib/el-ri.jar"/>
<!-- 3rd party and supporting jars -->
<include name="lib/javassist.jar" />
<include name="lib/dom4j.jar" />
<include name="lib/concurrent.jar" />
<include name="lib/cglib.jar" />
<include name="lib/asm.jar" />
<include name="lib/antlr.jar" />
<include name="lib/commons-logging.jar" />
<include name="lib/commons-collections.jar" />
</fileset>
プロジェクトのベースディレクトリ(例えば /projects/seamgen-example)で ant を実行してアプリケーションをビルドしてください。ビルドされるターゲットファイルは dist/seamgen-example.ear です。
アプリケーションをデプロイするには、 項39.2.1. 「GlassFish へのアプリケーションのデプロイ」 の手順に従ってください 。但し、jboss-seam-jee5 の代わりにこのプロジェクト seamgen-example へ置き換えて使用してください。
http://localhost:8081/seamgen_example/ をブラウズしてアプリケーションを確認してください。