Index

wrapper.app.parameter.<n> プロパティ群

対応バージョン :1.0.0
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

このプロパティには、アプリケーションのメインメソッドへ引き渡すパラメータを設定します。

wrapper.java.mainclass]プロパティの値が [org.tanukisoftware.wrapper.WrapperSimpleApp]であるとき、 アプリケーションへの最初のパラメータは、ご利用のメインメソッドを含むクラス名でなければなりません。 その後、他の全てのパラメータが、アプリケーションのメインメソッドへ順に引き渡されます。 さらに詳しくは、インテグレーション方法の概要を参照ください。

<n> コンポーネント部:

各要素は、[wrapper.app.parameter.]で始まるプロパティ名を持ち、 プロパティ名の「<n>」コンポーネント部には、 「1」からカウントアップしていくインテージャー(整数値)のナンバリング数値を入れて指定します。 デフォルトでは、連番であり欠番で飛ぶことはないはずです。 [wrapper.ignore_sequence_gaps]プロパティは、 シーケンス内でギャップ(途切れ)を「許可する/許可しない」を任意に設定にすることができます。

引用符:

各エントリーで、相当する引用符の削除フラグ (stripquotesプロパティ=TRUE)を設定して、 Linux/UNIX 上で動作するとき、 要素からエスケープ(無視)されていない引用符を取り除くこともできます。 これは、スペース(空白)を含むファイル参照も考慮するために必要です。 次にあげるパラメータのように、 どんなケースで引用符を取り除き、どんなケースでそのまま残すのか、決断することは可能ではありません。 従って、下記以外の他の文字は、全て変更せずに、そのまま残されます。

  • \\」は、「\」になります
  • \"」は、「"」になります
  • "」は、「」になります
設定例:
wrapper.java.mainclass=org.tanukisoftware.wrapper.WrapperSimpleApp
wrapper.app.parameter.1=com.widgetsrus.MyAppMain
wrapper.app.parameter.2=-d
wrapper.app.parameter.3=-c"../conf/myapp.conf"
wrapper.app.parameter.3.stripquotes=TRUE
wrapper.app.parameter.4=-p4

注意

個別のパラメータエントリ:

アプリケーションパラメータは、個別のパラメータエントリで書くように設計されています。 もし[-c conf/myconffile.conf] のようにパラメータを指定した場合、Windows 上では問題なく正しく動作するでしょう。 なぜならば、 [-c]と [conf/myconffile.conf]パラメータは、 Java が起動したときに、正しく解釈されるからです。 しかし、UNIX システム上では、そのパラメータを、1つのパラメータ [-c conf/myconffile.conf]として間違えて解釈されます。

誤:
wrapper.app.parameter.1=-c conf/myconffile.conf
正:
wrapper.app.parameter.1=-c
wrapper.app.parameter.2=conf/myconffile.conf

wrapper.app.parameter.<n>.stripquotes プロパティ

対応バージョン :3.5.17
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :Windows (未対応)Mac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

もし、1つの「wrapper.app.parameter.<n>」の値は引用符を含むと、Windows 上では 引用符に囲まれている内容が1つの要素として Java アプリケーションへ引き渡されます。 しかし、UNIX システム上では、引用符が引数の一部として追加されます。 殆どの場合、これは UNIX での正しい挙動ではないが、下位互換性を維持するためにそうなっています。

wrapper.app.parameter.<n>.stripquotes]プロパティは、Wrapper にUNIX 上で自動的にその引用符を取り除くようにします。 Windows 上ではこのプロパティは無視されます。

デフォルト値は、[wrapper.app.parameter.default.stripquotes]プロパティの値で、そのデフォルト値は「FALSE」です。

引用符を取り除くときは、以下の置き換えが行われます。 その他の文字は変更されません。

  • \\」は、「\」になります
  • \"」は、「"」になります
  • "」は、「」になります
設定例:
wrapper.app.parameter.1="parm1"
wrapper.app.parameter.1.stripquotes=TRUE
wrapper.app.parameter.2=parm=\"value\"
wrapper.app.parameter.2.stripquotes=TRUE

wrapper.app.parameter.default.stripquotes プロパティ

対応バージョン :3.5.17
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :Windows (未対応)Mac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

UNIX 上ですべての[wrapper.app.parameter.<n>]プロパティ値に 同じデフォルト動作を設定したい場合、引用符取り除きのデフォルト動作の変更を可能にします。 デフォルト値は、「FALSE」です。 Windows 上では、このプロパティは無視されます。

設定例:
wrapper.app.parameter.default.stripquotes=FALSE

wrapper.app.parameter_file プロパティ

対応バージョン :3.5.17
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

一部のケースでは、Wrapper コンフィギュレーションファイル内に Java パラメータをリスト化すると、不便な場合もあります。 このプロパティで、一つ、若しくは複数のパラメータを含むファイルを指定して、起動時に JVM へ引き渡すことが可能です。 これは、インストーラ経由または直接的にパラメータリストを生成する必要がある場合に、とても便利です。

標準の[wrapper.app.parameter.<n>]プロパティで定義されたものが先で、 その後に、このファイル定義によるパラメータが適用されます。

Wrapper バージョン 3.2.23 から、ファイルの環境変数参照が拡大されます。

パラメータファイルの記述形式:

ファイルの記述形式はシンプルです。

  • まず、Wrapper コンフィギュレーションファイルと同様に、 一行目はエンコードディレクティブで始めなければなりません。 これは、Wrapper がファイルを読み込む際のエンコードを明示して、ファイルを正しく解釈するために必要です。 もし、このディレクティブ行が記述されていない場合、Wrapper は、ログに警告を記録して、処理の試みを続けます。 このファイルで利用されているエンコードが、他のコンフィギュレーションファイルのエンコードとは異なる場合もあります。
  • 各パラメータをスペースで区切って、一行に複数のパラメータを書くことができます。
  • パラメータを複数行に分けて記述することも可能です。
  • 「#」記号は、コメント文字として解釈されますので、 プロパティ値に「#」記号を含める場合には、引用符で囲うか("#")、あるいはエスケープ文字として「#」を2つ書きます。
  • いずれかの値にスペースを含む必要がある場合、 ファイルがすべてのプラットフォームで一貫して動作することを確認するために、 以下のルールに従って引用符を追加する必要があります。
パラメータファイル UTF-8 記述例:
#encoding=UTF-8
# パラメータ記述例:一行に複数のパラメータをスペース(空白)区切りで
-DTEST1=Value1 -DTEST2=Value2

# 行を分けてパラメータを追記
-DTEST3=Value3

wrapper.app.parameter_file.required プロパティ

対応バージョン :3.5.36
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :WindowsMac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

このプロパティには、パラメータファイルが必要かどうか設定されます。 必要な時にそのファイルが検出できない場合、Wrapper は JVM を起動せず、停止します。 必要でない場合は検出されなくても無視されます。

デフォルト値は、「TRUE」です。

設定例:
wrapper.app.parameter_file.required=FALSE

wrapper.app.parameter_file.stripquotes プロパティ

対応バージョン :3.5.17
対応エディション :プロフェッショナル版スタンダード版コミュニティー版
対応プラットフォーム :Windows (未対応)Mac OSXLinuxIBM AIXFreeBSDHP-UXSolarisIBM z/OSIBM z/Linux

異なるプラットフォームごとに、スペース(空白)を含むパラメータの取り扱い方法が異なります。 一貫性を持たせコンフィギュレーションを正しく動かすために、 その引数(プロパティ値)を引用符で常に囲む必要があります。 Windows 上ではそのまま扱われ問題ありませんが、 UNIX 上では、引用符は取り除かれ、コマンドラインの各パラメータがリスト化されます。

ほとんど全てのケースにおいて、引用符を取り除くことを希望する方が多いでしょう。 このプロパティのデフォルト値は「FALSE」です。

設定例:
wrapper.app.parameter_file.stripquotes=FALSE
パラメータファイル UTF-8 記述例:
#encoding=UTF-8
-DTEST1=Value1 -DTEST2="Test Value with spaces."

参照: パラメータ