HowToUseFunctionsampleRich - TERASOLUNA Framework Wiki - TERASOLUNA Framework

Server Framework for Java（Rich版）
機能網羅サンプルアプリケーション 導入手順

概要

これはTERASOLUNA Server Framework for Java (Rich版) の機能網羅サンプルアプリケーションを導入する手順書です。
下記手順に従うことで、機能網羅サンプルアプリケーションの実行環境を準備することができます。

前提条件

導入環境には、あらかじめ下記のものが用意されている必要があります。

• Java 2 Runtime Environment Standard Edition 1.5.0
• Eclipse SDK 3.2.2 + WTP 1.5.5
• WebAPサーバ：Apache Tomcat 5.5.23
• Apache Ant 1.6.5 (EclipseのAntプラグインのみでも可)
• PostgreSQL Database Server 8.2またはOracle10g

併記されているバージョンを元に動作確認を行っていますが、このバージョン以外の環境での動作を制限するものではありません。
また、これらのインストール及び設定の手順については、別途Web上の利用ガイド等を参照してください。

（※）このサンプルのTomcat以外のアプリケーションサーバ上の動作は保障しない。

Antタスク一覧

プロジェクトの「\ant」フォルダには、antタスクが記述された「build.xml」が存在します。以下がantタスクの一覧です。

antタスク	説明
clean	作成したwarファイル、コンパイルされたクラスファイルの削除を行う。
compile	コンパイルを行う。
native2ascii	native2asciiにてプロパティファイルのコード変換を行う。
deploy	プロジェクトのデプロイを行う。
createJavaDoc	JavaDocの生成を行う。
callDependentJars	新しいTERASOLUNAのJARファイルを生成し、自プロジェクトにコピーを行う。 また、xmlのルールファイル、DTDファイルを自プロジェクトにコピーを行う。
createTerasolunaSourceZips	TERASOLUNAのソースコードをZipを生成し、自プロジェクトにコピーを行う。
createTerasolunaJavaDoc	TERASOLUNAのJavaDocを自プロジェクトに生成する。
notUseCastorMappingFile	Castor Mappingファイルを使用しない場合、全てリネームを行う。
useCastorMappingFile	Castor Mappingファイルを使用する場合、リネームされたCastor Mappingファイルを元に戻す。

サーバーの追加（WTP環境）

EclipseにWTPプラグインが導入されている場合、以下の手順でサーバーを追加します。

1. Eclipse画面にて「ウィンドウ」＞「ビューの表示」＞「その他」を実行し、「サーバー」を選択し「OK」をクリックします。
2. サーバービューで右クリック「新規」＞「サーバー」を実行します。
3. 「Apache」＞「Tomcat v5.5 サーバー」を選択し、「次へ」をクリックします。
4. 「Tomcat」を選択し、「次へ」をクリックします。
5. 自端末の環境に合った「Tomcat インストール･ディレクトリー」を選択します。
6. 「終了」をクリックします。

Castorマッピングファイルを使用する場合

1. 「ant/build.xml」を右クリック「実行」→「Antビルド...」を選択します。
2. 「ターゲット」タブを選択し、「useCastorMappingFile」にチェックをいれ実行します。
   ※FWではデフォルト（Castorマッピングファイルの無設定化）を推奨しています。

プロジェクトの実行（共通）

機能網羅アプリケーションをEclipseにインポートします。また、データベースの設定を行います。

1.　ZIPファイルの展開

terasoluna-server4jrich-funcsample_(バージョン番号).zipを任意のフォルダに展開します。

展開されたterasoluna-server4jrich-funcsample_(バージョン番号).zipのフォルダ名が「functionsample-rich」であることを確認します。
展開ツールや展開のしかたによっては、フォルダ名が「terasoluna-server4jrich-funcsample_(バージョン番号)」となる場合がありますが、フォルダ名を手動で「functionsample-rich」に変更してください。

2.　Eclipseへのインポート

1. Eclipse画面にて「ファイル」＞「インポート」を選択します。
2. 「既存プロジェクトをワークスペースへ」を選択し「次へ」をクリックします。
3. 「ルート・ディレクトリーの選択」にチェックが入った状態で「参照」をクリックし、ブランクプロジェクトを展開した親フォルダを指定します。
4. 「functionsample-rich」にチェックが入っていることを確認し、「終了」をクリックします。

エラーが出る場合は「備考」を参照し、設定を変更してください。

3.　JDBCドライバの配置

Tomcatがデータベースに接続できるようにJDBCドライバを「<TOMCAT_HOME>/common/lib」にコピーします。JDBCドライバは付属されていないので、利用者各自でで別途入手する必要があります。

• Oracle http://otn.oracle.co.jp/software/tech/java/jdbc/index.html
• PostgreSQL http://jdbc.postgresql.org/download.html

※バージョンが合っていれば、クライアント等をインストールした際に付属しているJDBCドライバをご利用いただけます。

4.　データベース環境の設定

Oracleの場合

1. 前提条件(環境により変更可能)

   設定項目	設定する値
   インスタンス名	functionsampledb
   DBユーザー名/パスワード	sample/sample
   ネットサービス名	SAMPLEDB

2. 「setup_for_Oracle.bat」の編集
   • 「/sql/oracle/setup_for_Oracle.bat」を自端末の環境に合った値に書き換えます。詳細は「/sql/oracle/setup_for_Oracle.bat」を参照してください。
3. テーブル、サンプルデータの作成
   • 「/sql/oracle/setup_for_Oracle.bat」を実行します。(eclipseから実行不可)
   • 「SQL> 」が表示されたら exitと入力して終了します。
     • ※実行時パスの整合性をとるため、必ず当該ファイルが存在するフォルダで実行してください。

PostgreSQLの場合

1. 前提条件(環境により変更可能)
   • pgAdminを起動し、新しいデータベースを作成します。

     設定項目	設定する値
     名前	functionsampledb
     オーナー	postgres
     エンコーディング	UTF8
     Template	なし
     テーブル空間	pg_default

2. 「setup_for_PostgreSQL.bat」の編集
   • 「/sql/postgresql/setup_for_PostgreSQL.bat」を自端末の環境に合った値に書き換えます。詳細は「/sql/postgresql/setup_for_PostgreSQL.bat」を参照してください。
3. テーブル、サンプルデータの作成
   • 「/sql/postgresql/setup_for_PostgreSQL.bat」を実行します。(eclipseから実行不可)
     • ※実行時パスの整合性をとるため、必ず当該ファイルが存在するフォルダで実行してください。

5.　設定ファイルの編集（データソース）

1. 「context.xml」の編集
   • 「/webapps/META-INF/context.xml」を自端末の環境に合った値に書き換えます。詳細は「context.xml」を参照してください。
2. 「dataAccessContext-local.xml」の編集
   • JNDIを使用しない場合は、「/webapps/WEB-INF/dataAccessContext-local.xml」のデータソースのBean定義と「/webapps/WEB-INF/jdbc.properties」を書き換えます。詳細は「dataAccessContext-local.xml」を参照してください。

プロジェクトの実行（WTP環境）

WTPプラグインを利用する場合、以下の手順でプロジェクトを実行します。

6.　サーバーへの追加

サーバービューで「functionsample-rich」のプロジェクトをサーバに追加します。

7.　Tomcatの起動および、実行確認

1. サーバーを始動します。
   • サーバー始動時にエラーダイアログが表示される場合は、「備考」を参照し、設定を変更してください。

プロジェクトの実行（非WTP環境）

WTPプラグインを利用しない場合、以下の手順でプロジェクトを実行します。

6.　antタスクの実行

1. プロジェクトの「/ant/build.properties」を自端末の環境に合った値に書き換えます。
   • 詳細はbuild.propertiesを参照してください。特にパス関連に関しては十分確認してください。
2. 「build.properties」の修正後、「/ant/build.xml」を右クリックしantタスクの「deploy」を選択して実行します。

7.　Tomcatの起動および、実行確認

1. デプロイ先のTomcatを起動します。

備考

インポート後にエラーが出る場合

• 「インポートされた ～～ は見つかりません。」
  • WEB-INF/libフォルダ以下にあるWebアプリケーションライブラリーが認識されてない状態です。Eclipseを再起動することで解決します。

サーバー始動後にエラーが出る場合

• 「リソース ～～はファイル・システムと同期がとれていません。」
  • Eclipse上のキャッシュと実ファイルの同期が取れていない状態です。該当のプロジェクトを「右クリック」＞「更新」すると解決します。
• 「context.xml」の変更が反映されない場合（非WTP環境）
  • 非WTP環境で「context.xml」を修正しても 変更が反映されない場合は、「＜TOMCATホーム＞/conf/Catalina/localhost/functionsample-rich.xml」を削除後に Tomcatを起動してください。