jp.go.aist.rtm.RTC

クラス ManagerConfig

java.lang.Object

jp.go.aist.rtm.RTC.ManagerConfig

 class ManagerConfig
extends java.lang.Object

Managerのコンフィグレーションを表現するクラスです。

コマンドライン引数や環境変数、設定ファイルを読み込み・解析して コンフィグレーション情報を生成します。 各設定の優先度は次の通りです。

1. コマンドラインオプション -f
2. 環境変数 RTC_MANAGER_CONFIG
3. デフォルト設定ファイル ./rtc.conf
4. デフォルト設定ファイル /etc/rtc.conf
5. デフォルト設定ファイル /etc/rtc/rtc.conf
6. デフォルト設定ファイル /usr/local/etc/rtc.conf
7. デフォルト設定ファイル /usr/local/etc/rtc/rtc.conf
8. 埋め込みコンフィギュレーション値

ただし、コマンドラインオプション -d が指定された場合は、 （たとえ -f で設定ファイルを指定しても）埋め込みコンフィグレーション値を 優先的に使用します。

フィールドのサマリー

フィールド

修飾子とタイプ	フィールドと説明
static java.lang.String	CONFIG_FILE_ENV デフォルト・コンフィグレーションのファイル・パスを識別する 環境変数です。
protected Properties	m_argprop 引数から渡されるプロパティ
protected java.lang.String	m_configFile 使用されるコンフィグレーションファイルのパス
protected boolean	m_isMaster Manager マスタフラグ true:マスタ,false:スレーブ

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ManagerConfig() コンストラクタ。
ManagerConfig(java.lang.String[] args) コンストラクタ 与えられた引数によりコンフィギュレーション情報の初期化を行う。

メソッドのサマリー

メソッド

修飾子とタイプ	メソッドと説明
void	configure(Properties properties) Configuration 情報を Property に設定する Manager のConfiguration 情報を指定された Property に設定する。
protected boolean	fileExist(java.lang.String filePath) ファイルの存在確認 指定されたファイルが存在するか確認する。
protected boolean	findConfigFile() Configuration file の検索。
void	init(java.lang.String[] args) 初期化を行います。
protected void	parseArgs(java.lang.String[] args) コマンド引数をパースする。
protected void	setSystemInformation(Properties properties) システム情報を設定する。

クラスから継承されたメソッド java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

CONFIG_FILE_ENV

public static final java.lang.String CONFIG_FILE_ENV

デフォルト・コンフィグレーションのファイル・パスを識別する 環境変数です。

関連項目:

定数フィールド値

m_configFile

protected java.lang.String m_configFile

使用されるコンフィグレーションファイルのパス

m_isMaster

protected boolean m_isMaster

Manager マスタフラグ true:マスタ,false:スレーブ

m_argprop

protected Properties m_argprop

引数から渡されるプロパティ

コンストラクタの詳細

ManagerConfig

public ManagerConfig()

コンストラクタ。

ManagerConfig

public ManagerConfig(java.lang.String[] args)
              throws java.lang.Exception

コンストラクタ

与えられた引数によりコンフィギュレーション情報の初期化を行う。

パラメータ:

args - コマンドライン引数

例外:

java.lang.Exception

メソッドの詳細

init

public void init(java.lang.String[] args)
          throws java.lang.Exception

初期化を行います。

ココマンドライン引数を受け取り、 コンフィグレーション情報を構成します。 マンドラインオプションには、以下のものを使用できます。

• -f filePath : コンフィグレーションファイルのパスを指定します。
• -l module : ロードするモジュールを指定します。（未実装）
• -o options : その他のオプションを指定します。
• -d : デフォルトコンフィグレーションを使用します。（未実装）

パラメータ:

args - コマンドライン引数

例外:

java.lang.Exception

configure

public void configure(Properties properties)
               throws java.io.FileNotFoundException,
                      java.io.IOException

Configuration 情報を Property に設定する

Manager のConfiguration 情報を指定された Property に設定する。

パラメータ:

properties - コンフィグレーション情報を受け取って格納する Propertiesオブジェクト

例外:

java.io.IOException - コンフィグレーションファイル読み取りエラーの場合にスローされる

java.io.FileNotFoundException

parseArgs

protected void parseArgs(java.lang.String[] args)
                  throws java.lang.IllegalArgumentException

コマンド引数をパースする。

• -a : Create manager's corba service or not.
• -f file : コンフィギュレーションファイルを指定する。
• -l module : ロードするモジュールを指定する。(未実装)
• -o options : その他オプションを指定する。
• -p endpoint: Multiple endpoint option.
• -d : デフォルトのコンフィギュレーションを使う。(未実装)

パラメータ:

args - コマンドライン引数

例外:

java.lang.IllegalArgumentException - コマンドライン引数を解析できなかった場合にスローされる。

findConfigFile

protected boolean findConfigFile()

Configuration file の検索。

使用すべきコンフィグレーションファイルを検索して特定します。 すでに特定済みの場合は、そのファイルの存在有無のみをチェックします。 なお、次の順序でコンフィグレーションファイルを検索します。

1. コマンドラインオプション -f
2. 環境変数 RTC_MANAGER_CONFIG
3. デフォルト設定ファイル ./rtc.conf
4. デフォルト設定ファイル /etc/rtc.conf
5. デフォルト設定ファイル /etc/rtc/rtc.conf
6. デフォルト設定ファイル /usr/local/etc/rtc.conf
7. デフォルト設定ファイル /usr/local/etc/rtc/rtc.conf

戻り値:

• コンフィグレーションファイル未特定の場合 : 使用すべきコンフィグレーションファイルを検索・特定できた場合は trueを、さもなくばfalseを返します。
• コンフィグレーションファイル特定済みの場合 : 特定済みのコンフィグレーションファイルが存在すればtrueを、 さもなくばfalseを返します。

setSystemInformation

protected void setSystemInformation(Properties properties)

システム情報を設定する。

システム情報を取得しプロパティにセットする。 設定されるキーは以下の通り。

• os.name : OS名
• os.release : OSリリース名
• os.version : OSバージョン名
• os.arch : OSアーキテクチャ
• os.hostname: ホスト名
• manager.pid : プロセスID

パラメータ:

properties - システム情報を設定したプロパティ

fileExist

protected boolean fileExist(java.lang.String filePath)

ファイルの存在確認

指定されたファイルが存在するか確認する。

パラメータ:

filePath - ファイルパス

戻り値:

対象ファイル確認結果(存在する場合にtrue)