DSpace システム説明書: ディレクトとファイル

目次に戻る

概要

インストールが完了したDSpaceは、次の3つの独立したディレクトリツリーで構成されています。

ソースディレクトリ:

これは（驚くべき）ソースコードが置かれている場所である。ここにある設定ファイルは、初期インストールの際に使用されるだけであることに注意すること。インストール後は、インストールディレクトリの設定ファイルを修正しなけらばならない。この文書では、[dspace-source]で示されている。

インストールディレクトリ:

このディレクトリはインストール時によく訪れることになる。また、実行時にDSpaceも使用している。このディレクトリには、設定ファイル、コマンドラインツール（と、実行に必要なライブラリ）、および、通常（DSpaceの設定により必ずではないが）DSpaceアーカイブのコンテンツが置かれている。初期のコンパイルとインストール後は、設定ファイルの変更はこのディレクトリにあるファイルにする必要がある。この文書では、 [dspace]で示されている。

Web配備ディレクトリ:

このディレクトリは、Webサーバがwebappsディレクトリにdspace.warファイルがあることを最初に見つけた際に作成される。このディレクトリには、解凍されたdspace.warの内容、すなわち、DSpaceの実行に必要なJSP、javaクラス、ライブラリが置かれている。このディレクトリにあるファイルを直接編集してはならない。インストールしたDSpaceを変更したい場合は、ソースディレクトリにあるファイルを編集して再構築する必要がある。このディレクトリはまったく自動的に作成されるものであるので、ここではその内容を示さない。この文書では通常、[tomcat]/webapps/dspaceで示されている。

ソースディレクトリのレイアウト

• [dspace-source]
  • build.xml - Antが使用するビルドファイル
  • CHANGES - バージョン間で行われたプログラム変更の詳細なリスト
  • KNOWN_BUGS - 現行バージョンにおける既知のバグ
  • LICENSE - DSpaceソースコードのライスセンス
  • README - お決まりの基本的情報を記述したファイル
  • bin/ - DSpaceのコマンドラインタスクを実行するシェルスクリプトとPerlスクリプト
  • config/ -設定ファイル
    • dspace.cfg - DSpaceのプロパティ設定ファイル
    • dc2mods.cfg - METSエクスポートのためのダブリンコアメタデータからMODSへのマッピング
    • default.license - アイテムの投稿時にユーザが同意しなければならないデフォルトのライセンス
    • dstat.cfg, dspace.map - 統計レポートの設定ファイル
    • input-forms.xml - 投稿UIにおけるメタデータフィールド設定ファイル
    • mediafilter.cfg - メディアフィルター設定ファイル
    • news-side.html - フロントページのサイドバー・ニュースのテキスト
    • news-top.html - フロントページのトップ・ニュースのテキスト
    • emails/ - システムが送信するメールの本文テキスト
    • language-packs/ - 「辞書ファイル」を置く -- 様々な言語によるユーザインターフェーステキストを含むJavaプロパティファイル
    • registries/ - ビットストリームフォーマットレジストリとダブリンコア要素/限定子レジストリの初期データ。これらのファイルはシステムの初期構築時にのみ使用され、以後はデータベースで管理される。
    • templates/ - ライブラリや外部アプリケーション（ApacheやTomcatなど）用の設定ファイルをここに置いて、編集する。これらの設定ファイルは、DSpaceプロパティ設定ファイルにある該当するプロパティを見つけて、参照することができる。これらのファイルを変更した場合は、コマンドラインツールを使って、dspace.cfgから該当するプロパティ値を読み込んでファイルに埋め込み、適当な場所にファイルをコピーする（それゆえ「テンプレート」という名前がついている）。
  • etc/ - DSpaceのインストールには必要だが、システムの設定には関係しないその他のファイル。たとえば、PostgreSQLのデータベーススキーマや、システムの構築時には使用されるが運用システムには使用されない設定ファイルなどである。また、Web UIとOAI-PMHサポート.warファイルの配備記述子（web.xmlファイル）も置かれている。
    • oracle/ - Oracle用のデータベーススキーマと更新用SQLスクリプト
  • jsp/ - Web UI用のJSPファイル。できるだけJavaコードを少なくし単純なHTMLとした。ビジネスロジックはサーブレットに存在する。
  • lib/ - システムで使用されるライブラリのJARファイル
    • README - サードパーティ製ライブラリパッケージ（JAR）のリストとその利用法
    • licenses - 各JARのライセンスが置かれている
  • src/ - DSpaceシステムのソースコード。レイアウトの詳細は、Javadocの概要ページを参照のこと。

インストールディレクトリのレイアウト

以下は、デフォルトの設定を使用した場合のDSpaceインストールディレクトリの基本的なレイアウトです。これらのパスは必要に応じて設定することができます。

• [dspace]
  • assetstore/ - 情報資産格納ファイル
  • bin/ - シェルおよびPerlスクリプト
  • config/ - 設定ファイル。ソースディレクトと同じサブディレクトリ構造を持つ
  • handle-server/ - ハンドルサーバ用のファイル
  • history/ - 履歴ファイル（通常、RDF/XMLファイル）を格納する
  • lib/ - JARファイル。DSpaceのクラスが入っているdspace.jar を含む
  • log/ - ログファイル
  • reports/ - 統計レポート作成ツールにより作成される統計レポート
  • search/ - Lucene検索インデックスファイル
  • upload/ - ファイルのアップロードなどで使用される一時ディレクトリ

Webアプリケーションの内容

DSpace附属のAntビルドファイルは、以下の構造を持つ.warファイルを作成します。

• （トップレベルディレクトリ）
  • JSPファイル
  • WEB-INF/
    • web.xml - [dspace-source]/etc/dspace-web.xmlに、該当する設定パラメタ（DSpaceインストールディレクトリなど）が埋め込まれて作成される
    • dspace-tags.tld - DSpaceカスタムタグ記述子
    • fmt.tld - 国際化のためのJSTLメッセージフォーマットタグ記述子
    • lib/ - DSpaceの実行に必要な全てのサードパーティ製JARファイル
    • classes/ - DSpaceのクラスファイルと全てのMessages_xx.propertiesファイル。後者はここに置くことによりCLASSPATHが通っている場所に置かれることになり、リソースバンドルとして発見されることができる。

ログファイル

混乱する可能性が最も高いものはログファイルです。 DSpaceは多くのサードパーティ製ツールを使用していますので、様々な場所で問題が生じる可能性があります。 下の表は、標準的な構成のDSpaceで使用されている主なログファイルをリストアップしたものです。 表示されているログファイルの配置場所はデフォルトの場所です。DSpaceとサードパーティ製ツールをデフォルトとは異なる場所にインストールした場合は、ログファイルの場所も異なる可能性があります。 リストの順番は、問題やエラーが発生した場合にその詳細について調べるファイルのおおよその優先順位を表しています。