intra-mart Accel Platform 設定ファイルリファレンス 第23版 2019-08-01

ストレージ設定ファイル

概要

ストレージの利用に関する設定ファイルです。

モジュール コアモジュール
フォーマットファイル(xsd) WEB-INF/schema/storage-config.xsd
設定場所 WEB-INF/conf/storage-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<storage-config xmlns="http://jp/co/intra-mart/foundation/service/client/file/config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://jp/co/intra-mart/foundation/service/client/file/config ../schema/storage-config.xsd ">
  <charset>UTF-8</charset>
  <class-name>jp.co.intra_mart.system.service.client.file.StorageLocalFileImpl</class-name>
  <unable-charactors>
    <unable-charactor>\</unable-charactor>
    <unable-charactor>:</unable-charactor>
    <unable-charactor>*</unable-charactor>
    <unable-charactor>?</unable-charactor>
    <unable-charactor>&quot;</unable-charactor>
    <unable-charactor>&lt;</unable-charactor>
    <unable-charactor>&gt;</unable-charactor>
    <unable-charactor>|</unable-charactor>
  </unable-charactors>
  <storage-info>
    <root-path-name>/tmp/storage</root-path-name>
    <system-directory-name>system</system-directory-name>
    <public-directory-name>public</public-directory-name>
    <group-directory-name>groups</group-directory-name>
    <configuration-directory-name>conf</configuration-directory-name>
    <conpatible-directory-name>public</conpatible-directory-name>
    <storage-directory-name>storage</storage-directory-name>
    <temporary-directory-name>temp</temporary-directory-name>
  </storage-info>
  <synchronize-info>
    <synchronize-key>im_system_storage_synchronize_key</synchronize-key>
  </synchronize-info>
</storage-config>

リファレンス

文字コード設定

タグ名 charset
テキストファイルの読み込み、書き込み時に利用する文字コードを指定します。

【設定項目】

<storage-config>
  <charset>UTF-8</charset>
  ...
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 テキストファイルの読み込み、書き込み時に利用する文字コードを指定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-config

注意

intra-mart Accel Platform では、利用可能な文字コードをUTF-8のみと定めています、その為この設定を編集しないでください。

ストレージAPI実装クラス設定

タグ名 class-name
Storage APIにおける実装クラスの指定を行います。

【設定項目】

<storage-config>
  ...
  <class-name>jp.co.intra_mart.system.service.client.file.StorageLocalFileImpl</class-name>
  ...
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容
ストレージ対する読み込み、書き込み等の実装クラスを指定します。
指定されるクラスは、jp.co.intra_mart.foundation.service.client.file.Storageインタフェースを実装する必要があります。
標準で提供されている実装はローカルファイルに対しての操作を行うjp.co.intra_mart.system.service.client.file.StorageLocalFileImplクラスが提供されています。
代替となる実装は提供されていません。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-config

注意

この設定はストレージに対する操作を行うための実装を定義したものです、この設定内容の変更は行わないでください。

使用禁止文字群

タグ名 unable-charactors
ファイル名、ディレクトリ名等における使用禁止文字群です。

【設定項目】

<storage-config>
  ...
  <unable-charactors>
    <unable-charactor>\</unable-charactor>
    <unable-charactor>:</unable-charactor>
    <unable-charactor>*</unable-charactor>
    <unable-charactor>?</unable-charactor>
    <unable-charactor>&quot;</unable-charactor>
    <unable-charactor>&lt;</unable-charactor>
    <unable-charactor>&gt;</unable-charactor>
    <unable-charactor>|</unable-charactor>
  </unable-charactors>
  ...
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容
ファイル名、ディレクトリ名等で使用禁止となる文字群を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ storage-config

使用禁止文字設定

タグ名 unable-charactor
ファイル名、ディレクトリ名等における使用禁止文字の設定を行います。

【設定項目】

<storage-config>
  ...
  <unable-charactors>
    <unable-charactor>\</unable-charactor>
    <unable-charactor>:</unable-charactor>
    <unable-charactor>*</unable-charactor>
    <unable-charactor>?</unable-charactor>
    <unable-charactor>&quot;</unable-charactor>
    <unable-charactor>&lt;</unable-charactor>
    <unable-charactor>&gt;</unable-charactor>
    <unable-charactor>|</unable-charactor>
  </unable-charactors>
  ...
</storage-config>

必須項目 ×
複数設定
設定値・設定する内容
ファイル名、ディレクトリ名等で使用禁止となる文字を設定します。
標準で禁止している文字は : * ? ” < > | が設定されています。
単位・型 文字列
省略時のデフォルト値 なし
親タグ unable-charactors

注意

この設定はWindows, Linux等で利用されるファイルシステムで利用できない文字が定義されています、この設定内容の変更は行わないでください。

ストレージ設定

タグ名 storage-info
ストレージのルートパス等を指定します。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
  </storage-info>
  ...
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 ストレージのパス等の情報を設定します。
単位・型 なし
省略時のデフォルト値 なし
親タグ storage-config

ストレージルートパス設定

タグ名 root-path-name
ストレージルートとして利用するファイルシステム上のパスを指定します。
この設定では、システムプロパティの利用が可能です。
${システムプロパティのキー} 形式で記述を行うことによりシステムプロパティの値と置換が行われます。
例えば、Resinを利用した場合は、Resinがインストール(展開)された位置を${resin.home}として指定することが可能です。
その為 ${resin.home}/storage と記述した場合はResinがインストール(展開)されたディレクトリ直下にある storage という名前のディレクトリが指定されます。
この値は通常、ストレージとして利用するNFS等の共有ディスクのパスを指定します。
/tmp等、OS起動時に削除される可能性のあるパス等の指定は行わないでください。

【設定項目】

<storage-config>
  ...
  <storage-info>
    <root-path-name>/tmp/storage</root-path-name>
    ...
  </storage-info>
  ...
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 ストレージルートとして利用するファイルシステム上のパスを指定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

システムストレージディレクトリ名設定

タグ名 system-directory-name
システムストレージとして利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <system-directory-name>system</system-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 システムストレージとして利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、他のストレージディレクトリ名設定(public-directory-name, group-directory-name)と同じ値を設定しないでください。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

パブリックストレージディレクトリ名設定

タグ名 public-directory-name
パブリックストレージとして利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。

intra-mart Accel Platform 2013 Winter以前
指定したディレクトリがパブリックストレージのルートディレクトリです。

intra-mart Accel Platform 2014 Spring以降
指定したディレクトリの直下に作成されるテナントIDをディレクトリ名としたディレクトリがパブリックストレージのルートディレクトリです。
この設定はテナント作成時にストレージルートパスが指定されていない場合に有効です。
テナント作成時にストレージルートパスが指定されている場合は、この設定は使われません。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <public-directory-name>public</public-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 パブリックストレージとして利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、他のストレージディレクトリ名設定(system-directory-name, group-directory-name)と同じ値を設定しないでください。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

グループストレージディレクトリ名設定

タグ名 group-directory-name
グループストレージとして利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <group-directory-name>groups</group-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 グループストレージとして利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、他のストレージディレクトリ名設定(system-directory-name, public-directory-name, group-directory-name)と同じ値を設定しないでください。
グループストレージは過去の互換性および、将来的な利用の為の予約項目です、この設定の変更によりストレージの操作に影響を与えることはありません。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

設定ファイル配置用ディレクトリ名設定

タグ名 configuration-directory-name
設定ファイル配置用として利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <configuration-directory-name>conf</configuration-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 設定ファイル配置用として利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、他のストレージディレクトリ名設定(system-directory-name, public-directory-name, group-directory-name)と同じ値を設定しないでください。
設定ファイル配置用ディレクトリ名設定は、将来的な利用の為の予約項目です、この設定の変更によりストレージの操作に影響を与えることはありません。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

互換モジュール用ディレクトリ名設定

タグ名 compatible-directory-name
互換モジュール用として利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <compatible-directory-name>public</compatible-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 互換モジュール用として利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

互換モジュールを利用した場合のストレージディレクトリはパブリックストレージを指します、その為、この設定はpublic-directory-nameと同じ値を設定してください。
互換モジュール用ディレクトリ名設定は、将来的な利用の為の予約項目です、この設定の変更によりストレージの操作に影響を与えることはありません。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

ストレージディレクトリ名設定

タグ名 storage-directory-name
パブリックストレージ、システムストレージ、テンポラリストレージそれぞれの領域内で利用されるストレージディレクトリ名を設定します。
指定されたディレクトリ名は、パブリックストレージ、システムストレージ、テンポラリストレージ、各それぞれのストレージパス直下に作成されるディレクトリ名として利用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <storage-directory-name>storage</storage-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 ストレージディレクトリとして利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

テンポラリストレージディレクトリ名設定

タグ名 temporary-directory-name
テンポラリストレージとして利用されるディレクトリ名を設定します。
指定されたディレクトリ名は、ストレージルートパス設定が行われたパス直下に作成されるディレクトリ名として利用されます。
このディレクトリは、セッションストレージ等で利用される一時領域として使用されます。

【設定項目】

<storage-config>
  ...
  <storage-info>
    ...
    <temporary-directory-name>temp</temporary-directory-name>
    ...
  </storage-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 テンポラリストレージとして利用されるディレクトリ名を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ storage-info

注意

この設定は、他のストレージディレクトリ名設定(system-directory-name, group-directory-name)と同じ値を設定しないでください。
この設定は、 intra-mart Accel Platform において利用される内部項目です、その為この値の変更は行わないでください。

ファイル同期キー設定

タグ名 synchronize-key
分散環境において、ストレージを操作する際の同期化用ロックキーの設定です。
この項目は将来的な利用の為の予約項目です。

【設定項目】

<storage-config>
 <synchronize-info>
    <synchronize-key>im_system_storage_synchronize_key</synchronize-key>
  </synchronize-info>
</storage-config>

必須項目
複数設定 ×
設定値・設定する内容 同期化用のロックに利用するキー値を設定します。
単位・型 文字列
省略時のデフォルト値 なし
親タグ synchronize-info

シンボリックリンク設定

タグ名 permit-symlink
ストレージのルートパスの配下外に実体をもつシンボリックリンクやジャンクションを許可するかどうかの設定をします。
ストレージのルートパスとは、ストレージ設定で設定される各ストレージのルートディレクトリを指します。
本設定は、 intra-mart Accel Platform 2015 Winter(Lydia) 以降で利用できます。

【設定項目】

<storage-config>
  ...
  <permit-symlink>false</permit-symlink>
  ...
</storage-config>

必須項目 ×
複数設定 ×
設定値・設定する内容
true ストレージのルートパス配下外に実体をもつシンボリックリンクやジャンクションを許可します。
false ストレージのルートパス配下外に実体をもつシンボリックリンクやジャンクションを許可しません。
単位・型 真偽値 (true/false)
省略時のデフォルト値 false
親タグ storage-config

注意

シンボリックリンクやジャンクションを利用した場合、ストレージのルートパスの配下外へアクセスされることを理解の上で利用してください。