4.1.1 プラグイン情報プロパティファイルの編集
プラグイン情報プロパティファイルとは,ひな形プラグインを作成するための情報を定義したプロパティファイルです。ひな形プラグイン作成コマンドを実行すると,プラグイン情報プロパティファイルに定義した情報に基づいたファイルやフォルダが生成されます。
次に示すサンプルファイルを編集して,プラグイン情報プロパティファイルを作成してください。
Navigation Platform for Developersインストールディレクトリ\pluginSDK\plugin.properties.sam
編集後のファイル名は「任意の文字列.properties」としてください。
- 〈この項の構成〉
(1) プロパティファイル作成時の注意
サンプルファイルを編集してプラグイン情報プロパティファイルを作成する際の注意事項を次に示します。
-
プロパティファイルの文字は,ISO 8859-1(Latin1)でエンコードされます。ISO 8859-1以外の文字コードの文字は使用できません。
-
Windowsの予約デバイス名(CON,AUX,COMn(nは1〜9),LPTn(nは1〜9),PRN,NUL,CLOCK$)は使用できません。
-
行頭文字に「#」または「!」を指定した場合,行全体がコメントと見なされます。
-
行頭に続く空白文字(半角スペース,タブまたは改行)は無視されます。
(2) プロパティファイルの記述形式
プロパティファイルの記述形式の例を次に示します。なお,説明中の「空白文字」は半角スペース,タブまたは改行を指します。
プロパティキー=値
-
プロパティキーと値の間には「:」または「=」を記述してください。プロパティキー,「:」または「=」,値の間に空白文字を指定しても無視されます。
-
プロパティキーの次の文字(空白文字を除く)が「:」または「=」の場合,その次の文字(空白文字を除く)から行末文字までが値として解釈されます。
-
プロパティキーの次の文字(空白文字を除く)が「:」または「=」でない場合,その文字から行末文字までが値として解釈されます。
-
値の後ろに空白文字を付加した場合,値の一部と解釈されます。
-
値の中に「:」,「=」,「#」,または「!」が使用されている場合,値の一部と解釈されます。
(3) すべてのプラグインで使用するプロパティキーの詳細
プラグイン情報プロパティファイルに指定するプロパティキーのうち,すべてのプラグインに必要なプロパティキーの詳細を説明します。
- userplugin.id
-
プラグインIDを指定します。プラグインIDはシステム内でユニークになるようにしてください。なお,中断再開プラグインの場合,必ず固定値「ucnp.plugin.suspend」を指定してください。
- 使用できる文字
-
半角英数字
半角ピリオド(.)
半角アンダースコア(_)
- 重要
-
使用できる文字の組み合わせの制限を次に示します。
-
中断再開プラグインはシステム内で一つしか登録できないため,固定値「ucnp.plugin.suspend」で指定する必要があります。
-
入出力プラグインまたはカスタム画面プラグインの場合,末尾にピリオドは指定しないでください。また,「ucnp」で始まるIDは指定できません。なお,「ucnp」の大文字,小文字は区別されないため,「UCNP」や「uCnp」も指定できません。
-
- 指定できる文字列長
-
1〜64バイト
- 指定する値の例
-
userplugin
- userplugin.name
-
プラグイン名を指定します。プラグイン名はシステム内でユニークになるようにしてください。
- 使用できる文字
-
半角英数字
- 使用できないプラグイン名
-
「ucnp」で始まるプラグイン名(大文字と小文字は区別しない)
env
AppName
- 指定できる文字列長
-
1〜31バイト
- 指定する値の例
-
userplugin
- userplugin.type
-
プラグインの種類を指定します。
- 使用できる文字
-
入出力プラグインの場合:TYPE_IO
中断再開プラグインの場合:TYPE_SUSPEND
カスタム画面プラグインの場合:TYPE_WINDOW
- userplugin.version
-
プラグインのバージョンを指定します。
- 使用できる文字
-
半角英数字
半角ピリオド(.)
半角アンダースコア(_)
半角ハイフン(-)
- 指定できる文字列長
-
1〜32バイト
- 指定する値の例
-
00.01
- userplugin.java.package
-
Javaパッケージ名を指定します。
- 使用できる文字
-
半角英数字
半角ピリオド(.)
Javaパッケージ名称として有効な文字列
Windowsの予約デバイス名となるディレクトリが作られないような文字列
- 使用できないパッケージ名
-
「jp.co.hitachi.soft.ucnp」から始まるパッケージ名
- 指定できる文字列長
-
1バイト以上
ただし,「Javaパッケージ名+プラグインID+入出力アクションコントローラクラス名」または「Javaパッケージ名+プラグインID+中断再開アクションコントローラクラス名」の合計が128バイト以内になるよう指定してください。
- 指定する値の例
-
sample.userplugin
(4) 入出力プラグインで使用するプロパティキーの詳細
userplugin.typeプロパティキーにTYPE_IOを指定した場合に設定が必要なプロパティキーを次に示します。
- userplugin.server.controller.ioaction
-
入出力アクションコントローラクラス名を指定します。「4.1.2 ひな形プラグイン作成コマンドの実行」では,このクラス名を基にコントローラクラスが生成されます。
- 使用できる文字
-
半角英数字
半角アンダースコア(_)
Javaクラス名称として有効な文字列
Windowsの予約デバイス名を含まない文字列
Javaパッケージ名と組み合わせた値がシステム内でユニークになる文字列
- 指定できる文字列長
-
1バイト以上
ただし,「Javaパッケージ名+プラグインID+入出力アクションコントローラクラス名」の合計が128バイト以内になるよう指定してください。
- 指定する値の例
-
IoPluginController
- userplugin.server.controller.ioaction.type
-
入出力アクションコントローラクラスを識別する文字列を指定します。システム内でユニークになるようにしてください。「4.1.2 ひな形プラグイン作成コマンドの実行」では,この文字列を基に入出力プラグイン用XMLファイル(ioaction.xml)が生成されます。なお,入出力プラグイン用XMLファイルとは,業務編集画面に表示される[Plugins]パレットおよびプラグインパーツの表示内容を定義したファイルです。一般には,生成するひな形プラグインのIDと同じ値を指定しますが,異なる値も指定できます。
- 使用できる文字
-
半角英数字
半角ピリオド(.)
半角アンダースコア(_)
半角ハイフン(-)
- 指定できる文字列長
-
1〜64バイト
- 指定する値の例
-
userplugin
(5) 中断再開プラグインで使用するプロパティキーの詳細
userplugin.typeプロパティキーにTYPE_SUSPENDを指定した場合に設定が必要なプロパティキーを次に示します。
(6) プロパティファイルの記述例
プラグイン情報プロパティファイルの記述例を次に示します。
入出力プラグインの場合
userplugin.id = example.inputdata userplugin.name = InputData userplugin.type = TYPE_IO userplugin.version = 01.00 userplugin.java.package = com.example.inputdata userplugin.server.controller.ioaction = InputDataController userplugin.server.controller.ioaction.type = example.inputdata
中断再開プラグインの場合
userplugin.id = ucnp.plugin.suspend userplugin.name = Suspend userplugin.type = TYPE_SUSPEND userplugin.version = 01.00 userplugin.java.package = com.example.suspend userplugin.server.controller.suspend = SuspendActionController
カスタム画面プラグインの場合
userplugin.id = example.contentslist userplugin.name = ContentsList userplugin.type = TYPE_WINDOW userplugin.version = 01.00 userplugin.java.package = com.example.customwindow