技術情報

GroupSessionのファイル、ディレクトリ構造

-- 2014.09.24 GroupSession Version4.3.0 --

はじめに

GroupSessionのカスタマイズ、機能追加を行う上でファイル構成、ディレクトリ構造について把握しておく必要があります。


ここでは開発に必要となるファイル、ディレクトリについてのみご説明いたします。

前提条件

Java,Strutsについての知識のある方を対象としています。

目的別索引

下記は目的別の索引になります。

第一階層

まずは第一階層のファイル・ディレクトリについてご説明いたします。


ディレクトリ/gsession

ディレクトリcommon

ディレクトリhelp

ディレクトリ${プラグインID}

ディレクトリWEB-INF

ファイルbuild.xml

ファイルindex.html

  • common・・・共通で使用する画像、スタイルシート、JavaScriptを格納。
  • help・・・ヘルプで共通で使用する画像、スタイルシート、JavaScriptを格納。
  • ${プラグインID}・・・各プラグインで使用する静的な画像、スタイルシート、JavaScriptを格納。
  • WEB-INF・・・プログラムやデータ等のファイルが格納されています。詳細は後に記載。
  • build.xml・・・apache antのビルドファイルです。
  • index.html・・・ブラウザからhttp://サーバ名:8080/gsession/にアクセスした際に一瞬「Now Loading ......」と表示しているのがこのファイルです。

※WEB-INF以外のディレクトリ・ファイルはログインしていない状態でもアクセスできることに注意が必要です。

/gsession/WEB-INF/

ディレクトリ/gsession/WEB-INF

ディレクトリbackup

ディレクトリclasses

ディレクトリconf

ディレクトリconvert

ディレクトリdb

ディレクトリdb_init

ディレクトリdsedit

ディレクトリfile

ディレクトリfilekanri

ディレクトリhelp_init

ディレクトリlib

ディレクトリlog

ディレクトリmsgconf

ディレクトリplugin

ディレクトリwebmail

ファイル*.tld

ファイルweb.xml

  • backup・・・自動バックアップで作成されたバックアップファイルを格納
         参考:データベースファイルのバックアップ、リストア
  • classes・・・Javaクラスを格納(共通で使用するクラスのみ)
  • conf・・・各設定ファイル
  • convert・・・V2.5.2からV2.5.3にコンバートするためのプログラムを格納
  • db・・・データベースファイル。起動することによって作成される
  • dsedit・・・DB接続のパスワードを変更するプログラムを格納
         参考:DB接続ユーザ、パスワードの変更方法
  • file・・・GroupSessionから添付した添付ファイルを格納
  • filekanri・・・ファイル管理プラグインで登録したファイルを格納
  • help_init・・・ヘルプファイルの検索インデックス作成プログラムを格納
         参考:ヘルプ機能を実装する方法
  • lib・・・GroupSessionが使用するライブラリ(拡張子jarファイル)を格納
  • log・・・ログを格納。
  • msgconf・・・メッセージの一覧を格納。起動時に自動生成される。
  • plugin・・・各プラグインを格納
  • webmail・・・WEBメールプラグインで送受信したメールの添付ファイルを格納
  • *.tld・・・タグライブラリ設定ファイル
  • web.xml・・・webアプリケーション設定ファイル
/gsession/WEB-INF/conf

ディレクトリ/gsession/WEB-INF/conf

ファイルdataSource.xml

ファイルgsdata.conf

ファイルlog4j.xml

ファイルlog4j_tmp.xml

ファイルmailserver.conf

ファイルportal.conf

ファイルservername.conf

ファイルversionTable.conf

ファイルwebmail.conf

  • dataSource.xml・・・データベースへの接続情報を格納するファイル
  • gsdata.conf・・・GroupSessionのデータを任意の場所に格納する様に変更したい場合に設定するファイル。
         参考:データ保存先変更方法
  • log4j.xml・・・起動時に自動生成されるログ出力の設定を行うファイル。このファイルを変更しても起動時に書き換えられるため意味がない。
  • log4j_tmp.xml・・・上記log4j.xmlを生成する際に使用するテンプレートファイル。ログ内容を変更したい場合はこのファイルを変更する。
  • mailserver.conf・・・ショートメールPOPサーバ機能のポート番号を指定するファイル。
  • portal.conf・・・ポータルプラグインに関する設定を行うファイル。
  • servername.conf・・・CSRF対策の一つとして、ログイン画面を除き、指定したサーバ名からの画面遷移のみ受付ける様にすることができます。このファイルはそのサーバ名を指定するファイルになります。
         参考:CSRF対策設定方法
  • versionTable.conf・・・GroupSessionとGSモバイルのバージョンマッピングファイル。
  • webmail.conf・・・WEBメールプラグインに関する設定を行うファイル。
/gsession/WEB-INF/plugin/

ディレクトリ/gsession/WEB-INF/plugin

ディレクトリ${プラグインID}

ディレクトリ ・

ディレクトリ ・

ディレクトリ ・

  • ${プラグインID}・・・各プラグインのjavaクラスファイル、jsp、sql、設定ファイル、他を格納
    詳細は次の項に記載。
/gsession/WEB-INF/plugin/${プラグインID}

ディレクトリ/gsession/WEB-INF/plugin/${プラグインID}

ディレクトリclasses

ディレクトリjsp

ディレクトリsql

ディレクトリsrc

ファイルplugin.xml

ファイルstruts_config.xml

  • classes・・・javaクラスファイルを格納。
  • jsp・・・jspファイルを格納。
  • sql・・・create tableや初期データのinsert文を格納
  • src・・・javaソースファイルを格納。


Copyright 日本トータルシステム株式会社